文章目錄
- 為什么要配置 `.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/
