Cursor Rules怎么配置Java项目规范?

穿越時空

穿越時空

2026-07-29

961人浏览

原创

必须在项目根目录创建.cursor/rules目录并配置多文件规则体系,取代旧的.cursorrules单文件;按序号命名.mdc文件,分别定义全局强制规范、java编码规范及mybatis专属约束,重启cursor后验证生效。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

cursor rules怎么配置java项目规范?

要在Java项目里让Cursor生成的代码自动遵守团队约定,比如统一用Result包装返回值、Controller必须加@RestController、Service层禁止直接操作数据库,就得配置Rules——不是靠口头提醒AI,而是把规范写进项目根目录的规则文件里。

创建.cursor/rules目录并启用新规则体系

先删掉旧的.cursorrules单文件,新建.cursor/rules文件夹。Cursor 2026年已默认优先读取这个目录下的.mdc文件,旧文件会被忽略。

这一步不能跳过:旧规则体系不支持按语言/模块/环境分层激活,所有规则硬塞进一个文件,AI每次都要加载全部内容,容易稀释关键约束。

在项目根目录执行:mkdir -p .cursor/rules

配置Spring Boot全局强制规范(Always类型)

这类规则适用于整个项目,无论打开哪个Java文件都生效,比如禁用System.out.println、强制返回Result封装、统一异常处理方式。

在.cursor/rules下新建001-springboot-always.mdc文件,内容如下:

```md
Rule Type: Always

### 全局禁止
- 禁止使用System.out.println、e.printStackTrace()、printStackTrace()
- 禁止在Controller层捕获业务异常,必须向上抛出由@GlobalExceptionHandler统一处理
- 禁止直接new对象,必须通过Spring容器注入或工厂方法获取

### 全局必须
- 所有HTTP接口返回值必须封装为com.example.project.common.Result
- 所有Controller类必须使用@RestController注解,禁止使用@Controller
- 所有Service接口必须定义在service包下,实现类必须放在service.impl包下
```

【文件名必须以数字开头并按序号排列】,否则Cursor可能无法正确加载顺序依赖。

按文件路径自动触发Java编码规范(Auto Attached类型)

只在打开.java文件时才加载,避免污染前端或配置文件的生成上下文。

新建002-java-coding.mdc,写入:

Rule Type: Auto Attached
File Pattern: **/*.java

### 命名与结构
- 类名用PascalCase(UserService),方法/变量用camelCase(getUserById)
- 常量全大写下划线(MAX_RETRY_TIMES)
- 包名全小写点分隔(com.example.project.service)
- 不允许接口加I前缀(用UserService,不用IUserService)

Java JDK 25
Java JDK 25

Java JDK 25 来自 OpenJDK 官方归档,版本为 JDK 25,本条下载地址已指向官方 Windows x64 zip 安装包直链,适合调试旧项目或兼容旧版 Java 运行环境。

下载

### 代码风格
- 使用4空格缩进,禁止Tab
- 左大括号不换行,右大括号独占一行
- 每行≤120字符
- import按字母序排列,禁用*通配符

### 注释要求
- 类和公共方法必须有JavaDoc,含@author @date @param @return @throws
- 复杂业务逻辑块必须有中文注释说明意图,禁止无意义注释如“// 获取用户”

为Mapper层单独配置MyBatis规范

方法一:路径匹配精准触发
新建003-mybatis-mapper.mdc,设置File Pattern为**/mapper/**/*.java,内容聚焦SQL层约束:

Rule Type: Auto Attached
File Pattern: **/mapper/**/*.java

### 必须遵守
- Mapper接口方法名必须与XML中id一致
- 所有查询方法必须返回List或T,禁止void或int
- 更新方法必须返回int,表示影响行数
- XML中SQL禁止拼接字符串,必须用#{},禁用${}
- 所有Mapper接口必须继承org.apache.ibatis.annotations.Mapper

方法二:用Agent Requested类型动态激活
新建004-mybatis-smart.mdc,Rule Type设为Agent Requested,description写:“当AI识别到当前文件涉及数据库操作或MyBatis相关关键词时自动加载本规则”。

这样AI在生成带@Select注解的方法时会主动引入这条规则,但写工具类时不会干扰。

验证规则是否生效

第一步:重启Cursor,确保它重新扫描.cursor/rules目录

第二步:打开任意.java文件,输入/让AI写一个UserController,观察返回值是否自动套Result、是否用了@RestController、是否调用了UserService而非直接查库

第三步:在mapper目录下新建UserMapper.java,让AI生成findByEmail方法,检查是否返回User对象、是否用了#{}、是否加了@Mapper注解

如果AI仍生成System.out.println或@Controller,请检查001-springboot-always.mdc是否放在.cursor/rules根下、文件名是否带数字前缀、内容是否用```md包裹。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

3891

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

2861

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

2900

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

638

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

602

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

727

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1318

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

18866

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

647

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

Java 26官方文档
Java 26官方文档

共0课时 | 0人学习