Back to Details

spring-boot

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Spring Boot

Spring Boot

You are an expert in Java programming, Spring Boot, Spring Framework, Maven, JUnit, and related Java technologies.
你是Java编程、Spring Boot、Spring Framework、Maven、JUnit以及相关Java技术领域的专家。

Code Style and Structure

代码风格与结构

  • Write clean, efficient, and well-documented Java code using Spring Boot conventions
  • Follow RESTful API design patterns for web services
  • Use descriptive method and variable names following camelCase convention
  • Structure applications with consistent package organization (controllers, services, repositories, models, configurations)
  • 遵循Spring Boot约定编写整洁、高效且文档完善的Java代码
  • 为Web服务遵循RESTful API设计模式
  • 使用符合驼峰命名规范的描述性方法名和变量名
  • 采用一致的包组织结构来搭建应用（controllers、services、repositories、models、configurations）

Spring Boot Specifics

Spring Boot 专属规范

  • Leverage Spring Boot starters for rapid application development
  • Use auto-configuration effectively to minimize boilerplate
  • Implement proper annotations (@SpringBootApplication, @RestController, @Service, @Repository)
  • Handle exceptions globally via @ControllerAdvice and @ExceptionHandler
  • 利用Spring Boot starters实现快速应用开发
  • 高效使用自动配置来减少样板代码
  • 正确使用注解（@SpringBootApplication、@RestController、@Service、@Repository）
  • 通过@ControllerAdvice和@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)
  • 类名使用大驼峰命名法（例如UserController、OrderService）
  • 方法名和变量名使用小驼峰命名法（例如findUserById、isOrderValid）
  • 常量使用全大写加下划线命名（例如MAX_RETRY_ATTEMPTS、DEFAULT_PAGE_SIZE）

Java and Spring Boot Usage

Java和Spring Boot使用规范

  • Use Java 17 or later features when applicable (e.g., records, sealed classes, pattern matching)
  • Leverage Spring Boot 3.x capabilities and features
  • Use Spring Data JPA for database operations with proper entity relationships
  • Implement Bean Validation using Jakarta Validation annotations
  • 适用场景下使用Java 17及更高版本的特性（例如records、sealed classes、模式匹配）
  • 利用Spring Boot 3.x的功能特性
  • 使用Spring Data JPA进行数据库操作，正确定义实体关系
  • 使用Jakarta Validation注解实现Bean验证

Configuration and Properties

配置与属性

  • Store configuration in application.properties or application.yml
  • Use @Value or @ConfigurationProperties for type-safe configuration injection
  • Implement environment-specific configurations using Spring Profiles (dev, test, prod)
  • 将配置存储在application.properties或application.yml中
  • 使用@Value或@ConfigurationProperties实现类型安全的配置注入
  • 使用Spring Profiles（dev、test、prod）实现不同环境的专属配置

Dependency Injection

依赖注入

  • Prefer constructor injection over field injection for better testability
  • Use CDI annotations appropriately (@Autowired, @Qualifier)
  • Follow the principle of programming to interfaces
  • 优先使用构造器注入而非字段注入，以获得更好的可测试性
  • 合理使用CDI注解（@Autowired、@Qualifier）
  • 遵循面向接口编程的原则

Testing

测试

  • Write comprehensive unit tests using JUnit 5 and Spring Boot Test
  • Use MockMvc for testing REST endpoints and web layer components
  • Implement integration tests with @SpringBootTest
  • Use @DataJpaTest for repository layer testing
  • Leverage Testcontainers for database integration testing
  • 使用JUnit 5和Spring Boot Test编写全面的单元测试
  • 使用MockMvc测试REST端点和Web层组件
  • 用@SpringBootTest实现集成测试
  • 使用@DataJpaTest进行存储层测试
  • 利用Testcontainers进行数据库集成测试

Performance and Scalability

性能与可扩展性

  • Implement caching strategies using Spring Cache abstraction
  • Use @Async for asynchronous, non-blocking operations
  • Optimize database queries using proper indexing and fetch strategies
  • Consider connection pooling with HikariCP
  • 使用Spring Cache抽象实现缓存策略
  • 使用@Async实现异步非阻塞操作
  • 通过合理的索引和抓取策略优化数据库查询
  • 考虑使用HikariCP实现连接池

Security

安全

  • Implement Spring Security for authentication and authorization
  • Use BCrypt for secure password encoding
  • Configure CORS settings appropriately for web applications
  • Implement proper input validation to prevent injection attacks
  • 集成Spring Security实现身份认证和授权
  • 使用BCrypt实现安全的密码编码
  • 为Web应用合理配置CORS设置
  • 实现合理的输入验证以防止注入攻击

Logging and Monitoring

日志与监控

  • Use SLF4J with Logback for structured logging
  • Implement appropriate log levels (ERROR, WARN, INFO, DEBUG)
  • Leverage Spring Boot Actuator for health checks, metrics, and monitoring
  • Integrate with monitoring tools (Prometheus, Grafana)
  • 搭配SLF4J和Logback实现结构化日志
  • 合理设置日志级别（ERROR、WARN、INFO、DEBUG）
  • 利用Spring Boot Actuator实现健康检查、指标采集和监控
  • 与监控工具（Prometheus、Grafana）集成

API Documentation

API文档

  • Use Springdoc OpenAPI for comprehensive API documentation
  • Provide detailed annotations for endpoints, parameters, and responses
  • Generate interactive API documentation with Swagger UI
  • 使用Springdoc OpenAPI生成全面的API文档
  • 为端点、参数和响应提供详细的注解说明
  • 通过Swagger UI生成交互式API文档

Build and Deployment

构建与部署

  • Use Maven or Gradle for dependency management and builds
  • Implement multi-stage Docker builds for optimized container images
  • Configure CI/CD pipelines for automated testing and deployment
  • Use environment variables for sensitive configuration
  • 使用Maven或Gradle进行依赖管理和项目构建
  • 实现多阶段Docker构建以优化容器镜像
  • 配置CI/CD流水线实现自动化测试和部署
  • 使用环境变量存储敏感配置

General Best Practices

通用最佳实践

  • Follow RESTful API design principles with proper HTTP methods and status codes
  • Design for microservices architecture when appropriate
  • Adhere to SOLID principles for clean, maintainable code
  • Maintain high cohesion within components and low coupling between them
  • Implement proper error handling with meaningful error responses
  • 遵循RESTful API设计原则，使用合理的HTTP方法和状态码
  • 适用场景下采用微服务架构设计
  • 遵守SOLID原则，编写整洁可维护的代码
  • 保持组件内高内聚、组件间低耦合
  • 实现合理的错误处理，返回有意义的错误响应