Java Architecture Guide

Java 业务项目架构指南

分层架构

四层单向调用，禁止反向或跨层依赖：

Controller → Facade → Service → Repository (Mapper)

各层职责

为什么引入 Facade 层

• 单一职责: Service 层专注自己领域，不承担编排逻辑
• 降低耦合: Service 不依赖其他 Service，可独立测试
• 事务清晰: 跨服务事务统一在 Facade 管理
• 便于定位: 业务编排集中在 Facade，排查问题路径清晰

层间调用铁律

规则 1: Controller 只注入 Facade

// CORRECT
@RestController
@RequiredArgsConstructor
public class PolicyController {
    private final PolicyFacade facade;  // ✅

    @PostMapping
    public ApiResponse<IdResp> create(@Valid @RequestBody PolicyCreateReq req) {
        return ApiResponse.ok(new IdResp(facade.create(req)));
    }
}

// WRONG
public class PolicyController {
    private final PolicyService service;  // ❌ 禁止直接注入 Service
}

规则 2: Service 禁止注入其他 Service

这是最常被违反的规则。跨域数据需求必须上推到 Facade 层。

// WRONG - Service 跨域调用
@Service
public class AlgoServiceServiceImpl {
    private final LlmServiceMapper llmServiceMapper;  // ❌ 注入其他域 Mapper
    private final VideoSourceService videoSourceService;  // ❌ 注入其他 Service
}

// CORRECT - Facade 编排
@Component
@RequiredArgsConstructor
public class AlgoServiceFacade {
    private final AlgoServiceService algoServiceService;  // ✅
    private final LlmServiceService llmServiceService;    // ✅ Facade 注入多个 Service
    
    public AlgoServiceDetail getDetail(Long id) {
        AlgoServiceDetail detail = algoServiceService.getDetail(id);
        if (detail.getLlmServiceId() != null) {
            LlmService llm = llmServiceService.getById(detail.getLlmServiceId());
            detail.setLlmServiceName(llm.getName());
        }
        return detail;
    }
}

规则 3: Mapper 保持空接口

查询逻辑在 Service 中使用 LambdaQueryWrapper 构建，保证类型安全。 禁止 在 Mapper 中新增方法或 Mapper XML 自定义 SQL，复杂条件仍在 Service 使用 Wrapper/apply 构建。

// CORRECT
@Mapper
public interface PolicyMapper extends BaseMapper<AlertPolicy> {
    // 空接口，不添加任何方法
}

// Service 中构建查询
LambdaQueryWrapper<AlertPolicy> wrapper = new LambdaQueryWrapper<>();
wrapper.eq(AlertPolicy::getEnabled, true)
       .orderByDesc(AlertPolicy::getCreateTime);
List<AlertPolicy> list = baseMapper.selectList(wrapper);

// WRONG
@Mapper
public interface PolicyMapper extends BaseMapper<AlertPolicy> {
    @Select("SELECT * FROM alert_policy WHERE enabled = 1")  // ❌
    List<AlertPolicy> findEnabled();
}

事务管理

事务边界

事务注解标准写法

@Transactional(rollbackFor = Exception.class)
public Long create(TaskCreateReq req) {
    // 业务逻辑
}

事务内禁止

• 远程调用（HTTP / RPC / 消息发送）
• 耗时操作（文件 IO、大量计算）
• @Async 方法调用

异常处理体系

异常层次

RuntimeException
  └── BusinessException (业务异常，含 ErrorCode)
        └── AuthConsoleException (外部系统异常)

各层异常职责

错误码分段管理

按业务模块分配错误码范围（如 2xxx 算法服务、3xxx 预警策略），避免冲突。

日志级别规范

命名规范

Java 命名

分层命名

数据库命名

API 路径

• 格式: /api/v{version}/{resources} (复数, kebab-case)
• 示例: /api/v1/llm-services, /api/v1/analysis-tasks

代码质量原则

必须遵守

• 公共 API 方法必须有 Javadoc
• 使用 LambdaQueryWrapper 保证类型安全，避免字符串列名
• 不使用物理外键约束，通过应用层保证数据一致性
• 所有表使用逻辑删除（deleted 字段）
• 写操作考虑乐观锁（version_num 字段）
• 删除前检查依赖关系，防止数据不一致

统一响应格式

所有 API 返回 ApiResponse<T>:

ApiResponse.ok()           // 无数据成功
ApiResponse.ok(data)       // 带数据成功
ApiResponse.error(code, msg)  // 错误

参数校验

• Request Body: @Valid @RequestBody XxxReq req
• Path Variable 校验: 类上加 @Validated，参数上加 @NotBlank
• 校验注解: @NotBlank, @NotNull, @NotEmpty (Jakarta Validation)

常见反模式

Converted and distributed by TomeVault — claim your Tome and manage your conversions.