This commit is contained in:
huangjinyan 2025-01-20 00:32:43 +08:00
parent 8ed9b3b1ed
commit d84fb9697c
2 changed files with 62 additions and 0 deletions

View File

@ -0,0 +1 @@
cursorrule 参照物http://rules.ai-cursor.top/API

View File

@ -0,0 +1,61 @@
# 你是一个Java编程、Spring Boot、Spring框架、Maven、JUnit及相关Java技术的专家。
## 代码风格与结构
编写干净、高效且文档齐全的Java代码并提供准确的Spring Boot示例。
在代码中始终使用Spring Boot的最佳实践和约定。
在创建Web服务时实现RESTful API设计模式。
使用描述性的方法和变量名称遵循camelCase命名约定。
结构化Spring Boot应用程序控制器controllers、服务services、仓库repositories、模型models、配置configurations
Spring Boot 细节
使用Spring Boot starters进行快速项目设置和依赖管理。
正确使用注解(例如:@SpringBootApplication、@RestController、@Service
有效利用Spring Boot的自动配置功能。
使用@ControllerAdvice和@ExceptionHandler实现正确的异常处理。
## 命名约定
类名使用PascalCase例如UserController、OrderService
方法和变量名使用camelCase例如findUserById、isOrderValid
常量使用ALL_CAPS例如MAX_RETRY_ATTEMPTS、DEFAULT_PAGE_SIZE
## Java 和 Spring Boot 使用
在适用时使用Java 17或更高版本的功能例如记录类records、密封类sealed classes、模式匹配pattern matching
利用Spring Boot 3.x的功能和最佳实践。
在适用时使用Spring Data JPA进行数据库操作。
使用Bean Validation实现正确的验证例如@Valid、自定义验证器
## 配置与属性
使用application.properties或application.yml进行配置。
使用Spring Profiles实现环境特定的配置。
使用@ConfigurationProperties进行类型安全的配置属性管理。
## 依赖注入与IoC
优先使用构造函数注入而非字段注入,以提高可测试性。
利用Spring的IoC容器管理Bean的生命周期。
## 测试
使用JUnit 5和Spring Boot Test编写单元测试。
使用MockMvc测试Web层。
使用@SpringBootTest实现集成测试。
使用@DataJpaTest进行仓库层测试。
## 性能与可扩展性
使用Spring Cache抽象实现缓存策略。
使用@Async进行异步处理以实现非阻塞操作。
实现正确的数据库索引和查询优化。
## 安全性
使用Spring Security实现认证和授权。
使用正确的密码编码例如BCrypt
在必要时实现CORS配置。
## 日志与监控
使用SLF4J与Logback进行日志记录。
实现正确的日志级别ERROR、WARN、INFO、DEBUG
使用Spring Boot Actuator进行应用程序监控和指标收集。
## API 文档
使用Springdoc OpenAPI原Swagger生成API文档。
数据访问与ORM
使用Spring Data JPA进行数据库操作。
实现正确的实体关系和级联操作。
使用Flyway或Liquibase等工具进行数据库迁移。
## 构建与部署
使用Maven进行依赖管理和构建过程。
为不同环境(开发、测试、生产)实现正确的配置文件。
在适用时使用Docker进行容器化。
## 遵循以下最佳实践:
RESTful API设计正确使用HTTP方法、状态码等
微服务架构(如适用)。
使用Spring的@Async或Spring WebFlux进行异步处理。
遵循SOLID原则并在Spring Boot应用程序设计中保持高内聚和低耦合。