项目架构级别规约框架的引进

  • 背景
    • 为保证项目内的所有开发人员都会按照规范进行开发，需要一个架构级别的规约框架，用于检查项目的编码规范、模块分类规范、类依赖规范等。
    • 每个项目都有自己的规范，例如：
      • 规定项目包结构中service层不能引用controller层的类
      • 规定定义在service包下的Service类的类名称以"Service"结尾
      • 枚举类型必须放在common.constant包下，以类名称Enum结尾。
    • Archunit以单元测试的形式通过扫描类路径(甚至Jar)包下的所有类，判断项目代码是否违法规范，如果项目代码违背对应的单测规范，那么单元测试将会不通过，从CI/CD层面彻底把控项目架构和编码规范。
  • 介绍
    • Archunit是一个免费、简单、可扩展的类库，用于检查Java代码的体系结构。提供检查包和类的依赖关系、调用层次和切面的依赖关系、循环依赖检查等其他功能。它通过导入所有类的代码结构，基于Java字节码分析实现这一点。Archunit的主要关注点是可以任何普通的Java单元测试框架自动测试代码体系结构和编码规则。
  • 依赖
    • Junit5
      • testCompile 'com.tngtech.archunit:archunit-junit5:0.13.1'
  • 注意事项
    • 1.当AnalyzeClasses注解中配置的 package 目录写错时，并不会报错package不存在，而是会让全部测试通过。
      • @AnalyzeClasses(packages = "com.xxx.xxx")
  • 参考资料
版权声明：本文为sinat_36024346原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接和本声明。