Loading...

Back to Details

spring-framework

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Spring Framework

Spring Framework

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 with accurate Spring Boot examples
Follow camelCase for methods and variables, PascalCase for classes
Structure applications with clear separation: controllers, services, repositories, models, and configurations

编写简洁、高效且文档完善的Java代码，并提供准确的Spring Boot示例
方法和变量遵循驼峰式命名（camelCase），类遵循帕斯卡命名（PascalCase）
应用结构清晰分离：控制器、服务、仓库、模型及配置类

Spring Boot Specifics

Spring Boot 专属规范

Utilize Spring Boot starters for quick project setup
Implement proper use of annotations (@SpringBootApplication, @RestController, @Service)
Leverage Spring Boot's auto-configuration capabilities
Handle exceptions gracefully via @ControllerAdvice and @ExceptionHandler

利用Spring Boot启动器快速搭建项目
正确使用注解（@SpringBootApplication、@RestController、@Service）
充分利用Spring Boot的自动配置能力
通过@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)

类名使用帕斯卡命名（PascalCase）（例如：UserController、OrderService）
方法和变量名使用驼峰式命名（camelCase）（例如：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 features and best practices
Use Spring Data JPA for database operations
Implement Bean Validation using Jakarta Validation annotations

适当时使用Java 17或更高版本的特性（例如：records、密封类、模式匹配）
遵循Spring Boot 3.x的特性与最佳实践
使用Spring Data JPA进行数据库操作
利用Jakarta Validation注解实现Bean校验

Dependency Injection

依赖注入

Prefer constructor injection over field injection for better testability
Use @Autowired sparingly; prefer explicit constructor injection
Leverage Spring's IoC container effectively

优先使用构造函数注入而非字段注入，以提升可测试性
谨慎使用@Autowired；优先选择显式构造函数注入
有效利用Spring的IoC容器

Testing

测试

Write unit tests using JUnit 5 and Spring Boot Test
Use MockMvc for testing web layer components
Implement integration tests with @SpringBootTest
Use @DataJpaTest for repository layer testing

使用JUnit 5和Spring Boot Test编写单元测试
使用MockMvc测试Web层组件
结合@SpringBootTest实现集成测试
使用@DataJpaTest测试仓库层

Performance and Scalability

性能与可扩展性

Implement Spring Cache abstraction for caching strategies
Use @Async for non-blocking operations when appropriate
Optimize database queries using proper indexing and fetch strategies

实现Spring Cache抽象以应用缓存策略
适当时使用@Async实现非阻塞操作
通过合理的索引和查询优化策略提升数据库查询性能

Security

安全

Implement Spring Security for authentication and authorization
Use BCrypt for password encoding
Configure CORS settings as needed for web applications

集成Spring Security实现身份认证与授权
使用BCrypt进行密码加密
根据Web应用需求配置CORS设置

Logging and Monitoring

日志与监控

Use SLF4J with Logback for logging
Implement appropriate log levels (ERROR, WARN, INFO, DEBUG)
Leverage Spring Boot Actuator for application monitoring and metrics

使用SLF4J结合Logback进行日志记录
配置合适的日志级别（ERROR、WARN、INFO、DEBUG）
利用Spring Boot Actuator实现应用监控与指标采集

API Documentation

API文档

Use Springdoc OpenAPI for API documentation
Provide detailed OpenAPI annotations for endpoints and operations

使用Springdoc OpenAPI生成API文档
为接口和操作提供详细的OpenAPI注解

Configuration Management

配置管理

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

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

Build and Deployment

构建与部署

Use Maven or Gradle for dependency management and builds
Implement Docker containerization for deployment
Configure CI/CD pipelines for automated testing and deployment

使用Maven或Gradle进行依赖管理与项目构建
实现Docker容器化部署
配置CI/CD流水线以实现自动化测试与部署

General Best Practices

通用最佳实践

Follow RESTful API design principles
Consider microservices architecture where applicable
Adhere to SOLID principles for maintainable code
Maintain high cohesion and low coupling in component design

遵循RESTful API设计原则
酌情考虑微服务架构
遵循SOLID原则以保证代码可维护性
在组件设计中保持高内聚、低耦合