java

📜 Java 开发规则

版本: v4.3.0 | 最后更新: 2026-01-22 | 作者: Cursor AI Rules

🎯 适用场景

• Spring Boot 微服务开发
• 企业级 Java 应用
• Android 应用开发
• 大数据处理应用

🏗️ 架构原则

面向对象设计

• SOLID 原则: 单一职责、开闭原则、里氏替换、接口隔离、依赖倒置
• 设计模式: 在适当场景使用 GoF 设计模式
• 组合优于继承: 优先使用组合而不是继承

分层架构

• 表现层: Controller/REST API
• 业务层: Service/业务逻辑
• 数据访问层: Repository/DAO
• 领域层: Domain Model/业务实体

📝 编码规范

命名约定

// ✅ 推荐 - 类和接口
public class UserService {
    private UserRepository userRepository;
}

public interface PaymentProcessor {
    void process(PaymentRequest request);
}

// ✅ 推荐 - 方法和变量
public UserProfile getUserProfile(String userId) {
    Optional<User> user = userRepository.findById(userId);
    return user.map(this::convertToProfile).orElse(null);
}

private UserProfile convertToProfile(User user) {
    // 转换逻辑
}

// ❌ 避免
public class userservice {  // 类名应 PascalCase
    private UserRepository userrepository;  // 变量名应 camelCase
}

public UserProfile GetUserProfile(String userid) {  // 方法名应 camelCase
    // ...
}

包结构组织

com.company.project
├── api/           # REST API 接口
├── config/        # 配置类
├── domain/        # 领域模型
│   ├── entity/    # JPA 实体
│   ├── repository/# 数据访问接口
│   └── service/   # 业务服务
├── infrastructure/# 基础设施层
│   ├── persistence/# 数据持久化
│   ├── messaging/ # 消息处理
│   └── external/  # 外部服务集成
├── application/   # 应用服务层
└── common/        # 公共组件
    ├── exception/ # 异常处理
    ├── util/      # 工具类
    └── validation/# 验证器

🔧 最佳实践

异常处理

// ✅ 推荐 - 自定义异常和统一处理
@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BusinessException.class)
    public ResponseEntity<ErrorResponse> handleBusinessException(BusinessException ex) {
        return ResponseEntity.badRequest()
                .body(new ErrorResponse(ex.getMessage()));
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleGenericException(Exception ex) {
        log.error("Unexpected error", ex);
        return ResponseEntity.internalServerError()
                .body(new ErrorResponse("Internal server error"));
    }
}

// 自定义业务异常
public class BusinessException extends RuntimeException {
    public BusinessException(String message) {
        super(message);
    }
}