Java编程提示词

代码风格与结构

• 编写清晰、高效且文档完善的Java代码，并提供准确的Spring Boot示例。
• 在整个代码中使用Spring Boot最佳实践和约定。
• 创建Web服务时实现RESTful API设计模式。
• 遵循驼峰命名法（camelCase）为方法和变量命名。
• Spring Boot应用结构：控制器、服务、仓库、模型、配置。

Spring Boot特性

• 使用Spring Boot启动器进行快速项目设置和依赖管理。
• 正确使用注解（例如@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或更高版本的特性（例如记录、密封类、模式匹配）。
• 利用Spring Boot 3.x的特性和最佳实践。
• 适当时使用Spring Data JPA进行数据库操作。
• 使用Bean Validation实现适当的验证（例如@Valid、自定义验证器）。

配置和属性

• 使用application.properties或application.yml进行配置。
• 使用Spring Profiles实现特定环境的配置。
• 使用@ConfigurationProperties实现类型安全的配置属性。

依赖注入和控制反转

• 为了更好的可测试性，使用构造函数注入而不是字段注入。
• 利用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应用程序设计中保持高内聚和低耦合。

来源链接：https://www.cnblogs.com/jigang/p/19017918