Cursor使用最佳实践总结
#作者:曹付江
文章目录
- 1、需求文档怎么写
- 2. 项目文件夹选择
- 3.技术栈的选择
- 4.最重要:Cursor中的Rules(规则)
- 5.对话模式与模型选择
- 6. New Chat(新建对话)
- 7.自动化测试
- 8.前后端细调的方法
- 9、完整Cursor项目模板(含目录、rules、需求、示例对话)
- 9.1项目目录结构
- 9.2需求文档(requirements.md)
- 9.3开发规则(.rules.md)
- 9.4示例对话(Cursor中使用)
1、需求文档怎么写
- 简洁、具体、清晰:描述项目目标、核心功能、用户角色、主要接口。可以用 Markdown 或表格形式。
- 示例模板:
o 项目名称:AI客服系统
o 功能概述:用户输入问题,系统自动回答或转接人工。
o 模块划分:用户登录、问答接口、后台管理。
o 输入输出示例:API /qa,输入:问题,输出:答案。 - 在 Cursor 中:直接在一个 .md 文件中(如 requirements.md),供AI对话参考。
- 提示:避免含糊不清,列出关键业务流程和约束条件。
2. 项目文件夹选择
- 按功能模块拆分文件夹:
/myproject├── backend/│ ├── api/│ ├── service/│ └── model/├── frontend/│ ├── components/│ ├── pages/│ └── utils/├── tests/├── docker/├── scripts/└── README.md
- 在 Cursor 中定位:用 “Open Folder” 打开根目录,避免散乱。
- 建议:为每一层模块都写好 README 或索引说明,方便AI理解上下文。
3.技术栈的选择
- 结合项目特点:
o Web 后端:Node.js + Express/Koa 或 Go + Gin,支持API和高并发。
o 前端:React + Tailwind + Vite 或 Next.js。
o 数据库:PostgreSQL 或 MySQL。
o 脚本与测试:Python、Shell。 - 在 Cursor 中:在对话中明确说明(如:“用Go写一个REST API服务”)。
4.最重要:Cursor中的Rules(规则)
- 定义 AI 的“行为边界”:
o 技术要求:比如“必须使用PostgreSQL”,“只能用标准库”。
o 代码风格:比如“使用单引号”,“函数命名遵循驼峰”。
o 架构风格:如“前后端分离,后端采用Hexagonal架构”。 - 如何设置:
o 在对话中添加:“请严格遵循以下规则:……”
o 或创建一个 .rules.md 文件专门定义项目规则。
5.对话模式与模型选择
- 对话模式:
o 连续对话:方便深入推理。
o 单轮对话:适合快速测试。 - 模型选择(根据 Cursor 支持):
o 通常:GPT-4(逻辑推理强),Claude(长文档理解佳),DeepSeek(中英文能力均衡)。
o 可指定:“用 GPT-4 帮我生成这段代码”。 - 提示:对话可以分阶段(先架构设计,再模块开发,再测试)。
6. New Chat(新建对话)
- 场景适用:
o 每个模块独立新建对话(如前端、后端、测试、DevOps)。
o 需求、开发、测试分阶段管理,减少上下文污染。 - 命名对话:用功能/模块名(如“API设计”、“数据库迁移脚本”)。
7.自动化测试
- 集成单元测试/集成测试:
o 前端:Jest、Cypress。
o 后端:Go的 testing,Node.js的 Mocha、Jest。
o 数据库:生成迁移测试。 - 在 Cursor 中:对话中要求:“生成对应单元测试用例”,“自动生成测试脚本”。
- 最佳实践:测试代码与业务代码平行存放。
8.前后端细调的方法
- 模块化开发:在 Cursor 中分模块独立对话。
- 接口 Mock:前端用 Mock 数据联调,后端用 Postman/Swagger。
- 多轮对话调试:遇到接口问题,直接在 Cursor 中分析提示。
- 错误调试:
o 向 AI 提供错误日志、请求响应内容。
o 例如:“接口返回 500,日志是……,请帮我定位问题”。 - 最终集成:前后端在 Devbox 环境中启动联调,模拟生产环境
9、完整Cursor项目模板(含目录、rules、需求、示例对话)
Cursor实战项目模板:AI驱动博客系统:
9.1项目目录结构
ai-blog/
├── backend/ # 后端代码
│ ├── api/
│ ├── service/
│ ├── model/
│ ├── database/
│ └── main.go
├── frontend/ # 前端代码
│ ├── components/
│ ├── pages/
│ └── utils/
├── tests/ # 测试代码
│ ├── backend/
│ └── frontend/
├── docker/ # 容器构建文件
│ └── Dockerfile
├── scripts/ # 自动化脚本
│ └── migrate.sh
├── requirements.md # 需求文档
├── .rules.md # Cursor开发规则
└── README.md # 项目总览
9.2需求文档(requirements.md)
# AI驱动博客系统需求文档## 项目目标
构建一个支持AI自动生成内容、前后端分离的博客系统。## 功能模块
- 用户注册与登录
- 博客文章的增删改查
- 评论与点赞
- 后台管理(用户管理、内容审核)
- AI助手(根据主题自动生成文章内容)## 技术栈
- 后端:Go(Gin框架)、PostgreSQL
- 前端:Next.js、Tailwind CSS
- AI接口:OpenAI GPT-4
- 容器:Docker + Devbox(开发环境)## 接口示例
- `POST /api/article` :创建文章
- `GET /api/articles` :获取文章列表
- `POST /api/article/generate` :AI自动生成文章
9.3开发规则(.rules.md)
# Cursor开发规则## 技术与架构
- 后端必须使用Go(Gin框架),禁止使用外部ORM。
- 数据库使用PostgreSQL,表结构按SQL标准。
- 前端使用Next.js,采用Tailwind CSS样式。
- 所有API接口必须返回标准JSON格式。
- AI接口通过GPT-4调用,封装为单独服务层。## 代码规范
- 命名使用驼峰风格(camelCase)。
- 单文件长度不超过300行。
- 单元测试覆盖率不低于80%。## 其他约束
- 必须提供Dockerfile,支持容器化部署。
- 前后端完全分离,通过REST API通信。
9.4示例对话(Cursor中使用)
开发者输入:
基于需求文档,帮我生成Go的RESTful API后端框架,包括:
- /api/article 增删改查接口
- 数据库PostgreSQL建表SQL
- 使用Gin框架
- 符合.rules.md中的约束
AI响应:
- 生成Go后端目录及主要代码:
- 生成PostgreSQL建表SQL:
- 按照规则命名与结构。
开发者输入:
生成Next.js前端页面:
- 博客文章列表(/pages/articles)
- 博客详情(/pages/articles/[id])
- 样式用Tailwind
- 遵循.rules.md约束
AI响应:
- 生成前端页面代码:
- 自动补充组件与API请求逻辑:
- 符合前端开发规范。
测试与联调:
生成单元测试代码(Go和Next.js),覆盖主要接口。
提供Dockerfile以便Devbox中一键启动。
最后结果:你将拥有一个完整的 AI驱动博客系统模板,从需求、架构、代码、测试到容器部署全部覆盖