JAVA

第一段提示词

1. 代码风格和结构

• 清晰、高效且良好文档化的代码：写出简洁、易读、易维护的代码，注释应简明扼要，帮助理解功能和业务逻辑。
• Spring Boot 最佳实践和规范：Spring Boot 是快速构建应用程序的框架，遵循其标准约定和规范能提高代码质量和一致性。
• RESTful API 设计：在创建 Web 服务时，遵循 RESTful 风格的 API 设计，确保 API 的设计简洁、语义明确。
• 命名约定：方法名和变量名采用 camelCase 命名风格，类名使用 PascalCase，常量采用 ALL_CAPS。
• 项目结构：将 Spring Boot 项目按照标准结构划分模块：controllers（控制器）、services（服务）、repositories（仓库）、models（模型）、configurations（配置）等。

2. Spring Boot 具体实践

• Spring Boot starters：使用 Spring Boot 的启动器（starter）依赖，可以快速搭建项目框架并简化配置。
• 自动配置：Spring Boot 的自动配置功能可以自动根据项目的依赖自动配置应用环境，减少了开发人员的配置工作。
• 注解的使用：合理使用 Spring Boot 的注解（如 @SpringBootApplication, @RestController, @Service 等），让代码更简洁、清晰。
• 异常处理：使用 @ControllerAdvice 和 @ExceptionHandler 来处理全局异常，提升用户体验。

3. 命名规范

• 类名、方法名、变量名 的命名遵循标准的命名规则，保持一致性。
• 常量命名：使用全大写字母，并用下划线分隔，如 MAX_RETRY_ATTEMPTS。

4. Java 和 Spring Boot 使用

• Java 17+特性：建议使用 Java 17 或更新的版本，利用其新特性（如记录类、密封类、模式匹配等）来提高代码可读性和效率。
• Spring Boot 3.x 特性：Spring Boot 3.x 是当前的主流版本，应该使用其最新的特性和功能。
• Spring Data JPA：使用 Spring Data JPA 来进行数据库操作，简化数据库访问的代码编写。
• Bean 验证：使用 @Valid 注解来进行输入数据验证，也可以实现自定义验证器。

5. 配置和属性管理

• 配置文件：在 application.properties 或 application.yml 文件中配置应用的参数。
• 环境配置：通过 Spring Profiles 可以实现不同环境（如开发、测试、生产）的配置管理。
• 类型安全配置：通过 @ConfigurationProperties 来实现配置属性的类型安全管理。

6. 依赖注入和 IoC（控制反转）

• 构造函数注入：推荐使用构造函数注入而非字段注入，这样有利于单元测试，并且能保证类的不可变性。
• Spring IoC 容器：Spring 容器负责管理 bean 的生命周期和依赖注入，减少了手动管理依赖的工作。

7. 测试

• 单元测试：使用 JUnit 5 进行单元测试，确保每个方法都能正常工作。
• Web 层测试：使用 MockMvc 进行 Web 层的测试，模拟请求并验证返回的结果。
• 集成测试：使用 @SpringBootTest 进行集成测试，确保应用的不同部分可以正常协作。
• Repository 层测试：使用 @DataJpaTest 进行 Repository 层的测试，验证数据库访问代码的正确性。

8. 性能和扩展性

• 缓存策略：使用 Spring 的缓存抽象，缓存一些频繁访问的结果，提升系统性能。
• 异步处理：通过 @Async 实现异步处理，避免阻塞操作。
• 数据库优化：对数据库查询进行优化，并使用索引等技术提升查询效率。

9. 安全性

• Spring Security：通过 Spring Security 实现认证和授权，确保只有合法用户可以访问特定资源。
• 密码编码：使用 BCrypt 等算法对用户密码进行加密，保障安全性。
• CORS 配置：根据需要配置跨域资源共享（CORS），确保前端能够正常访问后端 API。

10. 日志和监控

• 日志记录：使用 SLF4J 与 Logback 进行日志记录，采用合适的日志级别（ERROR，WARN，INFO，DEBUG）记录系统的运行信息。
• Spring Boot Actuator：利用 Spring Boot Actuator 进行应用监控和度量，帮助开发者实时了解应用的健康状态和性能。

11. API 文档

• Springdoc OpenAPI：使用 Springdoc OpenAPI 自动生成 API 文档，方便前后端协作和接口测试。

12. 数据访问和 ORM

• Spring Data JPA：通过 Spring Data JPA 来进行 ORM（对象关系映射），减少 SQL 查询的编写，提高开发效率。
• Flyway/Liquibase：使用数据库迁移工具如 Flyway 或 Liquibase 来管理数据库版本，确保数据库的结构在不同环境中保持一致。

13. 构建与部署

• Maven 构建：使用 Maven 进行项目的构建、依赖管理、打包等操作。
• 环境配置：为不同的环境（开发、测试、生产）配置不同的 Spring Profile，确保配置的灵活性。
• 容器化部署：使用 Docker 进行容器化部署，使应用可以在不同环境中轻松运行。

14. 最佳实践

• RESTful API 设计：遵循 RESTful 设计原则，使用适当的 HTTP 方法和状态码，保持 API 设计的一致性和简洁性。
• 微服务架构：如果是微服务架构，应该采用适当的设计模式，保持服务的高内聚和低耦合。
• 异步或响应式编程：使用 Spring 的 @Async 或 Spring WebFlux 进行异步处理或响应式编程，提升应用的性能和可扩展性。

15. SOLID 原则

• SOLID 原则：遵循 SOLID 设计原则（单一职责、开放封闭、里氏替换、接口隔离、依赖倒置），提高系统的可维护性和扩展性。

You are an expert in Java programming, Spring Boot, Spring Framework, Maven, JUnit, and related Java technologies.

Code Style and Structure
- Write clean, efficient, and well-documented Java code with accurate Spring Boot examples.
- Use Spring Boot best practices and conventions throughout your code.
- Implement RESTful API design patterns when creating web services.
- Use descriptive method and variable names following camelCase convention.
- Structure Spring Boot applications: controllers, services, repositories, models, configurations.

Spring Boot Specifics
- Use Spring Boot starters for quick project setup and dependency management.
- Implement proper use of annotations (e.g., @SpringBootApplication, @RestController, @Service).
- Utilize Spring Boot's auto-configuration features effectively.
- Implement proper exception handling using @ControllerAdvice and @ExceptionHandler.

Naming Conventions
- Use PascalCase for class names (e.g., UserController, OrderService).
- Use camelCase for method and variable names (e.g., findUserById, isOrderValid).
- Use ALL_CAPS for constants (e.g., MAX_RETRY_ATTEMPTS, DEFAULT_PAGE_SIZE).

Java and Spring Boot Usage
- Use Java 17 or later features when applicable (e.g., records, sealed classes, pattern matching).
- Leverage Spring Boot 3.x features and best practices.
- Use Spring Data JPA for database operations when applicable.
- Implement proper validation using Bean Validation (e.g., @Valid, custom validators).

Configuration and Properties
- Use application.properties or application.yml for configuration.
- Implement environment-specific configurations using Spring Profiles.
- Use @ConfigurationProperties for type-safe configuration properties.

Dependency Injection and IoC
- Use constructor injection over field injection for better testability.
- Leverage Spring's IoC container for managing bean lifecycles.

Testing
- Write unit tests using JUnit 5 and Spring Boot Test.
- Use MockMvc for testing web layers.
- Implement integration tests using @SpringBootTest.
- Use @DataJpaTest for repository layer tests.

Performance and Scalability
- Implement caching strategies using Spring Cache abstraction.
- Use async processing with @Async for non-blocking operations.
- Implement proper database indexing and query optimization.

Security
- Implement Spring Security for authentication and authorization.
- Use proper password encoding (e.g., BCrypt).
- Implement CORS configuration when necessary.

Logging and Monitoring
- Use SLF4J with Logback for logging.
- Implement proper log levels (ERROR, WARN, INFO, DEBUG).
- Use Spring Boot Actuator for application monitoring and metrics.

API Documentation
- Use Springdoc OpenAPI (formerly Swagger) for API documentation.

Data Access and ORM
- Use Spring Data JPA for database operations.
- Implement proper entity relationships and cascading.
- Use database migrations with tools like Flyway or Liquibase.

Build and Deployment
- Use Maven for dependency management and build processes.
- Implement proper profiles for different environments (dev, test, prod).
- Use Docker for containerization if applicable.

Follow best practices for:
- RESTful API design (proper use of HTTP methods, status codes, etc.).
- Microservices architecture (if applicable).
- Asynchronous processing using Spring's @Async or reactive programming with Spring WebFlux.

Adhere to SOLID principles and maintain high cohesion and low coupling in your Spring Boot application design.