Agent skill
java-dev
Java 开发规范。当用户操作 .java、pom.xml、build.gradle 文件,或涉及 Spring Boot、JPA、MyBatis 开发时触发。 包含命名约定、异常处理、DTO/VO 规范、批量查询、N+1 防范、并发安全、输入校验、Spring Boot 最佳实践等。
Install this agent skill to your Project
npx add-skill https://github.com/doccker/cc-use-exp/tree/main/.cursor/skills/java-dev
SKILL.md
Java 开发规范
参考来源: Google Java Style Guide、阿里巴巴 Java 开发手册
工具链
# Maven
mvn clean compile # 编译
mvn test # 运行测试
# Gradle
./gradlew build # 构建
./gradlew test # 运行测试
命名约定
| 类型 | 规则 | 示例 |
|---|---|---|
| 包名 | 全小写,域名反转 | com.example.project |
| 类名 | 大驼峰,名词/名词短语 | UserService, HttpClient |
| 方法名 | 小驼峰,动词开头 | findById, isValid |
| 常量 | 全大写下划线分隔 | MAX_RETRY_COUNT |
| 布尔返回值 | is/has/can 前缀 | isActive(), hasPermission() |
DTO/VO 类规范
| 规则 | 说明 |
|---|---|
| ❌ 禁止手写 getter/setter | DTO、VO、Request、Response 类一律使用 Lombok |
✅ 使用 @Data |
普通 DTO |
✅ 使用 @Value |
不可变 DTO |
✅ 使用 @Builder |
字段较多时配合使用 |
⚠️ Entity 类慎用 @Data |
JPA Entity 的 equals/hashCode 会影响 Hibernate 代理 |
批量查询规范
| 规则 | 说明 |
|---|---|
| ❌ 禁止 IN 子句超过 500 个参数 | SQL 解析开销大,执行计划不稳定 |
| ✅ 超过时分批查询 | 每批 500,合并结果 |
public static <T, R> List<R> batchQuery(List<T> params, int batchSize,
Function<List<T>, List<R>> queryFn) {
List<R> result = new ArrayList<>();
for (int i = 0; i < params.size(); i += batchSize) {
List<T> batch = params.subList(i, Math.min(i + batchSize, params.size()));
result.addAll(queryFn.apply(batch));
}
return result;
}
N+1 查询防范
| 规则 | 说明 |
|---|---|
| ❌ 禁止循环内调用 Repository/Mapper | stream/forEach/for 内每次迭代触发一次查询 |
| ✅ 循环外批量查询,结果转 Map | 查询次数从 N 降为 1 |
// ✅ 循环外批量查询 + Map 查找
List<String> deviceIds = records.stream()
.map(Record::getDeviceId).distinct().collect(Collectors.toList());
Map<String, Long> countMap = deviceRepo.countByDeviceIdIn(deviceIds).stream()
.collect(Collectors.toMap(CountDTO::getDeviceId, CountDTO::getCount));
records.forEach(r -> r.setDeviceCount(countMap.getOrDefault(r.getDeviceId(), 0L)));
并发安全规范
| 规则 | 说明 |
|---|---|
| ❌ 禁止 read-modify-write | 先读余额再写回,并发下丢失更新 |
| ✅ 使用原子更新 SQL | UPDATE SET balance = balance + :delta WHERE id = :id |
| ✅ 或使用乐观锁 | @Version 字段 + 重试机制 |
| ✅ 唯一索引兜底 | 防重复插入的最后防线 |
异常处理
// ✅ 好:捕获具体异常,添加上下文
try {
user = userRepository.findById(id);
} catch (DataAccessException e) {
throw new ServiceException("Failed to find user: " + id, e);
}
// ✅ 好:资源自动关闭
try (InputStream is = new FileInputStream(file)) {
// 使用资源
}
// ❌ 差:捕获过宽
catch (Exception e) { e.printStackTrace(); }
输入校验规范
| 规则 | 说明 |
|---|---|
❌ 禁止 @RequestBody 不加 @Valid |
所有请求体必须校验 |
| ✅ DTO 字段加约束注解 | @NotBlank、@Size、@Pattern 等 |
| ✅ 数值字段加范围约束 | @Min、@Max、@Positive 等 |
| ✅ 分页参数加上限 | size 必须 @Max(100) 防止大量查询 |
Spring Boot 规范
// ✅ 构造函数注入
@Service
@RequiredArgsConstructor
public class UserService {
private final UserRepository userRepository;
private final EmailService emailService;
}
Auth Filter 降级原则
| 规则 | 说明 |
|---|---|
| ✅ optional-auth 路径遇到无效 token 时降级为匿名访问 | 不应返回 401/403 |
| ❌ 禁止部分凭证用户体验差于匿名用户 | 如:临时 token 在公开接口返回 403 |
Native SQL 规范
高频踩坑保留字:year_month, order, status, key, value, name, type, date, time, rank
| 规则 | 说明 |
|---|---|
| ✅ 使用短别名或缩写 | ym, ord_status, cnt |
| ❌ 禁止直接用保留字做别名 | as year_month、as order、as rank |
测试规范 (JUnit 5)
class UserServiceTest {
@Test
@DisplayName("根据 ID 查找用户 - 用户存在时返回用户")
void findById_whenUserExists_returnsUser() {
// given
when(userRepository.findById(1L)).thenReturn(Optional.of(expected));
// when
Optional<User> result = userService.findById(1L);
// then
assertThat(result).isPresent();
}
}
第三方 API HTTP 客户端选型
| 规则 | 说明 |
|---|---|
❌ 避免 RestTemplate 默认客户端调用国内平台 API |
默认 HttpURLConnection 的 POST 请求与微信/支付宝等 CDN 存在兼容性问题(已知触发 412/403) |
✅ 优先用 java.net.http.HttpClient(JDK 11+) |
现代 HTTP 客户端,无 CDN 兼容性问题 |
✅ 或配置 HttpComponentsClientHttpRequestFactory |
让 RestTemplate 底层走 Apache HttpClient |
诊断特征:HTTP 错误 + body 为空 + response headers 极简(只有 Connection/Content-Length)= CDN 层拦截,不是 API 本身的响应。同一 API 的 GET 正常但 POST 异常时,优先怀疑 HTTP 客户端兼容性。
详细参考
| 文件 | 内容 |
|---|---|
references/java-style.md |
命名约定、异常处理、Spring Boot、测试规范 |
references/collections.md |
不可变集合(Guava)、字符串分割 |
references/concurrency.md |
线程池配置、CompletableFuture 超时 |
references/concurrency-db-patterns.md |
Get-Or-Create 并发、N+1 防范、原子更新 |
references/code-patterns.md |
卫语句、枚举优化、策略工厂模式 |
references/date-time.md |
日期加减、账期计算、禁止月末对齐 |
references/http-client.md |
第三方 API HTTP 客户端选型与 CDN 兼容性 |
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
ops-safety
运维安全规范。当用户执行系统级命令(sysctl、iptables、systemctl、Docker 配置、数据库 DDL) 或进行服务器运维操作时触发。 包含命令风险说明模板、回滚方案要求、问题排查原则、Docker/Cloudflare/数据库场景规则等。
ruanzhu
当用户执行 /ruanzhu 命令或请求生成软著源代码文档时触发。提供软著源代码 DOCX 生成规范。 覆盖项目信息检测、语言扫描规则、页数控制、DOCX 格式规范等。
ui-ux-pro-max
专业级 UI/UX 设计规范,需要高质量界面设计时手动触发或描述"设计感/专业UI"时自动触发。 覆盖视觉层次、配色体系、排版节奏、交互微动效、响应式适配等。 日常前端开发由 frontend-dev skill 覆盖。
bash-style
Bash 编写规范。当用户操作 .sh、Dockerfile、Makefile、.yml、.yaml 文件, 或在 Markdown 中编写 bash/shell 代码块时触发。 包含注释规范、文件写入方式、Heredoc 引号规则、权限路径、脚本规范等。
redis-safety
Redis 安全与性能规范。当用户操作 Redis 相关代码(go-redis、Jedis、redis-py、ioredis)时触发。 包含禁止 KEYS 命令、SCAN 替代、大 key 控制、Pipeline 批量、TTL 规范等。
python-dev
Python 开发规范。当用户操作 .py、pyproject.toml、requirements.txt、setup.py 文件, 或涉及 FastAPI、Django、Flask、pytest、asyncio 开发时触发。 包含 PEP 8 风格、类型注解、异常处理、测试规范、异步编程、性能优化等。
Didn't find tool you were looking for?