文章目录
- 为什么要配置 `.cursorrules`
- 使用 `.cursorrules` 的五大优势
- 如何创建与应用 `.cursorrules`
- ✅ 基础步骤
- 🛠 创建方式：
- 高质量 `.cursorrules` 文件，应包含以下内容
- 配置示例
- Java 项目
- TypeScript + React 项目
- 总结
- cursorrules 推荐网站
为什么要配置 .cursorrules
.cursorrules 文件位于项目根目录，是 Cursor AI 编程助手与项目对话的“桥梁”。通过它，你可以向 AI 传递项目背景、代码规范、技术栈、首选库、性能要求、架构结构等，确保 AI 生成的代码始终符合团队风格——无需每次手动提醒 。
使用 .cursorrules 的五大优势
- 统一风格规范：如命名（camelCase、snake_case）、缩进（2/4 空格）等；
- 对齐技术栈：指明使用的语言或框架（JS/TS/Go/Python React/Vue）；
- 提升效率：减少后续手动格式化、风格调整；
- 团队协作更顺畅：共享规则防止风格冲突；
- 增强上下文感知：包括首选库、项目文件结构等，AI 更懂项目。
如何创建与应用 .cursorrules
✅ 基础步骤
- 在项目根目录创建
.cursorrules； - 在其中定义规范：项目背景、命名风格、技术栈、文件结构等；
- 重启 Cursor，以确保新规则加载；
- 项目变更时即时更新。
🛠 创建方式：
- 手动编写
使用官网或开源库中的模板，如 Cursor Directory、awesome-cursorrules 等 ([aicoding.csdn.net][1])； - 插件辅助
在 VSCode 等编辑器中安装 Cursor Rules 插件，通过命令面板自动选择模板、添加规则； - 全局规则
不想为每个项目单独配置？可在 Cursor 设置中统一定义适用于多个项目的全局 AI 规则。
高质量 .cursorrules 文件，应包含以下内容
逐条说明，确保 AI 生成的代码智能、高效：
| 栏目 | 样例内容 | 描述 |
|---|---|---|
| 项目背景 | Next.js + TypeScript 多语言博客 | 提供清晰上下文 |
| 编码标准 | 使用函数组件 + hooks，变量名 camelCase，组件名 PascalCase | 明确格式要求 |
| 首选库 | next-intl 国际化，TailwindCSS 样式 | 避免不符合团队习惯的依赖 |
| 文件结构 | components/、app/[locale]、data/blog、app/api | 保持路径与 import 准确 |
| 性能优化 | React.memo 优化组件，useEffect 依赖完整 | AI 会自动应用性能优化 |
| 测试规范 | 使用 Vitest 单元测试，覆盖率 ≥ 80% | AI 自动生成测试文件 |
| 文档规范 | JSDoc 注释，README 双语 | 自动补充文档、注释、PropTypes |
| 错误处理 | 使用 try/catch，全局 Error Boundary | 异常逻辑不再遗漏 |
以上设定帮助 AI 在一行规则里实现多维度项目智适应。
配置示例
Java 项目
# Role
你是一名精通后端服务开发的高级工程师，拥有20年的服务端开发经验。你的任务是帮助一位不太懂技术的用户完成一个高性能、高扩展性的后端服务设计和实现。你的工作对用户来说非常重要，完成后将获得10000美元奖励。# Goal
你的目标是以用户容易理解的方式帮助他们完成后端服务的设计和开发工作。你应该主动完成所有工作，而不是等待用户多次推动你。在理解用户需求、编写代码和解决问题时，你应始终遵循以下原则：## 第一步：项目初始化
- 当用户提出任何需求时，首先浏览项目根目录下的README.md文件和所有代码文档，理解项目目标、架构和实现方式。
- 如果还没有README文件，创建一个。这个文件将作为项目功能的说明书和你对项目内容的规划。
- 在README.md中清晰描述所有功能的用途、使用方法、参数说明和返回值说明，确保用户可以轻松理解和使用这些功能。## 第二步：需求分析和开发
### 理解用户需求时：
- 充分理解用户需求，站在用户角度思考。
- 作为产品经理，分析需求是否存在缺漏，与用户讨论并完善需求。
- 选择最简单的解决方案来满足用户需求。### 编写代码时：
- 使用Spring Boot框架进行开发，合理使用微服务架构。
- 遵循RESTful API设计规范，确保良好的接口设计和用户体验。
- 使用WebSocket实现实时数据推送，确保客户端能够实时接收数据。
- 使用Redis缓存热点数据，减少数据库查询压力。
- 使用MySQL存储历史数据，确保数据的可靠性和一致性。
- 编写详细的代码注释，并在代码中添加必要的错误处理和日志记录。
- 合理使用消息队列（Kafka）处理高并发请求。
- 实现响应式设计，确保服务在不同负载下的稳定性。### 解决问题时：
- 全面阅读相关代码文件，理解所有代码的功能和逻辑。
- 分析导致错误的原因，提出解决问题的思路。
- 与用户进行多次交互，根据反馈调整解决方案。
- 善用Spring Boot Actuator进行性能监控和调试。
- 当一个bug经过两次调整仍未解决时，你将启动系统二思考模式：1. 系统性分析bug产生的根本原因2. 提出可能的假设3. 设计验证假设的方法4. 提供三种不同的解决方案，并详细说明每种方案的优缺点5. 让用户根据实际情况选择最适合的方案## 第三步：项目总结和优化
- 完成任务后，反思完成步骤，思考项目可能存在的问题和改进方式。
- 更新README.md文件，包括新增功能说明和优化建议。
- 优化服务性能，包括启动时间、数据查询速度和网络请求效率。
- 实现适当的数据安全和用户隐私保护措施，如数据加密和访问控制。在整个过程中，始终参考@Spring Boot官方文档和相关技术文档，确保使用最新的后端开发最佳实践。
TypeScript + React 项目
# 项目背景
这是一个使用 Next.js 14 App Router 构建的多语言博客项目，前端使用 TypeScript + React + TailwindCSS。# 编码标准
- 组件使用函数式组件 + Hooks；
- 变量使用 camelCase，组件名使用 PascalCase；
- 缩进使用 2 个空格。# 技术栈
- React Server Components；
- 国际化使用 next-intl；
- 样式采用 TailwindCSS。# 文件结构
- components: 复用 UI 组件；
- app/[locale]: 多语言页面；
- data/blog: 博客数据；
- app/api: 服务端 API 路由。# 性能优化
- 对纯函数组件使用 React.memo；
- 动态路由组件实现懒加载；
- useEffect 依赖完整。# 测试需求
- 使用 Vitest 执行单元测试；
- 测试覆盖率 ≥ 80%。# 文档规范
- 函数/组件使用 JSDoc 注释；
- 目录中包含中/英文 README.md。# 错误处理
- 异步函数自动生成 try-catch；
- 实现全局 Error Boundary。
总结
通过合理编写 .cursorrules，可以让 Cursor AI：
- 自动化执行风格规范；
- 生成贴合项目架构的代码；
- 自动处理常见性能、错误、文档要求；
- 提升团队开发协作效率。
配合插件支持和全局配置策略，Cursor 将真正成为“懂项目”的智能助手。
cursorrules 推荐网站
https://github.com/PatrickJS/awesome-cursorrules
https://cursor.directory/
https://cursorlist.com/
https://www.cursorrulescn.cn/
https://dotcursorrules.com/
