Flutter/Dart类ArchUnit架构测试:Clean架构下的包访问合规校验
Flutter生态下类ArchUnit的架构校验工具与落地实践
一、可直接匹配Clean Architecture需求的类ArchUnit工具
- 最贴近ArchUnit原生使用体验的是
arch_unit_dart,作为Java ArchUnit的Dart生态移植版本,支持用代码声明分层访问规则,完全不需要写自定义的扫描逻辑,API风格和你之前使用ArchUnit的习惯基本对齐 - 社区主流的前置校验方案是
custom_lint,可以把架构规则写成自定义lint规则,在开发编码阶段就实时提示跨层引用问题,不用等跑完整测试才能发现违规 - 轻量校验可以用
dependency_validator,直接做包级、目录级的依赖方向检查,适合项目初期规则还比较简单的场景
二、实际项目中的落地流程
大部分团队不会只用单一方案,通常是两层校验结合:
- 规则定义和Clean Architecture的分层强绑定,通常约定三层的边界:
domain层:纯业务逻辑、实体、用例抽象,不依赖任何UI、网络、数据库相关的实现data层:实现domain层定义的抽象接口,对接网络、本地存储等外部能力presentation层:承载UI、状态管理逻辑,只依赖domain层的抽象定义,不直接引用data层的实现类
- 用
arch_unit_dart写标准化的架构测试用例,常见写法参考:核心规则的代码实现
class CleanArchitectureRules extends ArchUnitTest { @override void configure(ArchUnitConfiguration config) { // 校验domain层不能反向依赖任何外层或外部实现 config.layer("domain", path: "lib/domain/**") .shouldNotDependOnLayers(["data", "presentation"]) .shouldNotImportPackages(["dio", "sqflite", "flutter_bloc"]); // 校验presentation层不能直接引用data层实现 config.layer("presentation", path: "lib/presentation/**") .shouldNotDependOnLayer("data"); } } - 把这类架构测试和单元测试、Widget测试一起集成到CI流水线里,只要提交的代码违反规则,合并请求直接拦截,从流程上堵住违规代码合入的可能
- 搭配
custom_lint把同样的规则前置到IDE层,开发时只要写错跨层import,编辑器立刻飘红提示,大幅降低返工成本
三、无专用工具时的替代方案
如果不想引入额外的架构测试依赖,很多团队也用过经过验证的轻量方案:
- 用
build_runner写简单的扫描脚本,遍历项目所有Dart文件的import语句,硬编码校验跨层引用的违规情况,本质是自己实现ArchUnit最核心的引用扫描逻辑,几百行代码就能覆盖基础规则 - 依赖注入容器校验:如果项目用了
get_it、injectable这类DI框架,专门写测试用例检查presentation层注入的所有依赖,确认全部是domain层定义的抽象类型,没有直接注入data层的实现类 - 包级拆分隔离:项目规模足够大的话,直接把domain层拆成独立的本地Pub包,data、presentation层作为这个包的下游依赖,从Pub的依赖机制层面就切断domain反向依赖上层的可能,从根源上避免违规
四、落地时的通用注意事项
- 规则不要一开始就定得过于僵化,比如强行要求domain层完全不能引入Flutter的基础核心类型,很容易造成团队开发阻力,可根据实际业务调整边界,优先把“禁止跨层直接依赖”这类核心规则落地
- 不要只依赖IDE端的lint提示,一定要把自动化校验流程接入CI,避免开发者临时关闭lint插件漏过违规
- 架构规则要和团队全员对齐,明确每一条规则的设计目的,不要让规则成为开发过程中的额外负担,减少大家刻意绕开规则的情况
内容的提问来源于stack exchange,提问作者TOho
相关产品推荐
相关产品推荐

