agilelabs-fx-docs main checks/framework-usage.md

框架使用检查

本页把“项目是否正确使用 AgileLabs Framework”拆成可执行检查项,帮助代码审查、项目巡检和改造评估。

检查目标

  • 判断项目是否复用了框架默认骨架,而不是重复手写同类能力。
  • 判断项目级扩展是否建立在框架约定之上。
  • 判断是否存在长期半框架化、半手工化的实现。

必查项

  • 宿主入口是否保持薄,注册和扩展是否落在明确接入点。
  • 统一异常链、统一返回封包、统一 Json 配置是否仍然生效。
  • WorkContext、审计字段和时间处理是否沿用框架默认骨架。
  • 项目级扩展是否通过公共注册层或项目标准层承接,而不是散落在控制器或仓储中。
  • 偏离默认规则的地方是否有明确文档说明和范围界定。

判定标准

  • 能通过统一入口描述系统的启动、序列化、异常处理和时间语义,判定为基本合规。
  • 若同一能力在多个层重复手写,并绕开框架默认接入点,判定为不合规。
  • 若项目有二次封装,但底层规则仍与框架规范一致,判定为可接受扩展。
  • 若旧模块暂未收敛,但已在文档中标明偏差和迁移路径,判定为已知偏差而非未知风险。

常见不合规信号

  • 控制器里大量手工 catch (Exception) 并拼 JSON。
  • 多个宿主各自维护不同 Json 配置、不同时间语义或不同错误结构。
  • Program.cs / Startup 里堆满业务细节和重复注册代码。
  • 审计字段、时间转换和上下文建立依赖人工约定而不是统一机制。

规则依据

示例项目对照