搭建SpringBoot脚手架工程(2)：代码格式化/质量审核/提交检查

前言

接上篇文章搭建SpringBoot脚手架工程，SpringBoot简单脚手架工程springboot-simple-scaffold已经利用Spring官方提供的平台搭建完成，但是作为一个企业级的脚手架需要考虑的更多，如团队统一代码格式，代码质量审核，代码提交检查等，这篇文章让我继续来完善脚手架。

统一代码格式

代码格式管理比较常用的插件是checkstyle，但这个插件用起来需要一些额外配置，团队中的每个人都需要在自己的Idea中下载插件然后导入配置，这无疑增加了一些工作量。后来我发现有一款更好用的代码格式化插件spotless，可以以更简单的方式进行代码格式化，在本次脚手架工程中我决定使用spotless来进行统一的代码格式管理。

• 配置
  在build.gradle配置文件中新增spotless插件，并按需扩展spotless配置，各项配置的说明参考注释，这里值得一提的是格式化形式有多种可以选择，因为我个人不喜欢googleJavaFormat格式化的缩进形式，所以使用了palantirJavaFormat，其他如removeUnusedImports/importOrder/formatAnnotations等配置是一致的。

  plugins {
  	id "com.diffplug.spotless" version "6.12.0"
  }
  spotless {
  	java {
     	 	//googleJavaFormat()
      	palantirJavaFormat()//格式化形式
      	removeUnusedImports()//移除无用Import
      	importOrder()//导入顺序
      	formatAnnotations()//注解格式化
  	 }
  }
  

• 效果检验
  刻意在ScaffoldController中导入了无用的Import，然后故意将ScaffoldController的代码格式弄的非常混乱，如以下截图：
  
  然后执行./gradlew spotlessApply命令，提示成功后我们再查看ScaffoldController，发现代码格式变得正常，同时无用的import也被移除了，证明spotless代码格式化插件配置成功。
  
  

代码质量审查

代码静态审查工具有很多，如FindBugs，Sonar，PMD等，本脚手架工程采用的审查工具是PMD。PMD(Programming Mistake Detector)是一个静态代码分析器，它可以报告在应用程序代码中发现的问题。

• 配置

   plugins {
  	id 'pmd'
   }
   pmd {
  	consoleOutput = true //结果输出到控制台
  	toolVersion = "6.39.0" //工具版本
  	rulesMinimumPriority = 5 //规则优先级
  	ruleSets = ["category/java/bestpractices.xml"] //规则集合
   }
  

• 效果检验
  刻意在ScaffoldController中新增一个无用的私有方法testPmd()，如以下截图：
  
  执行./gradlew pmdMain，发现命令无法通过，提示避免无用私有方法，证明PMD代码检查插件配置成功。
  

代码提交检查

• 说明
  在企业级项目开发中一般都会要求本地代码提交到远程仓库前必须经过一些检查，避免污染远程仓库，这些检查一般会包括代码格式检查，代码质量审查，代码测试检查等，这就要求开发人员每次push前都得去执行一下相关命令，但难免会有忘记的时候，这种情况下可以配置git hooks来进行自动检查。
  git hooks是执行git相关命令时会预执行的脚本，在项目根目录.git/hooks下可以看到很多后缀是sample的脚本文件，这些文件后缀是sample的脚本文件默认不会生效，如果希望生效则需要去掉.sample并修改脚本内容，以pre-commit为例，当执行git commit命令时会预先执行pre-commit脚本中的内容，git push同理。* 配置
  在build.gradle中配置自定义task，将预先写好的pre-commit和pre-push脚本放置在项目根目录的./scripts/hooks文件夹下。

  tasks.register('installGitHooks', Copy) {
  	from './scripts/hooks/pre-commit', './scripts/hooks/pre-push'
  	into './.git/hooks'
  }
  

  
  pre-commit的作用就是commit前先执行spotlessJavaApply进行代码格式化
  pre-push的作用就是push前先执行pmdMain和test单元测试进行代码质量检查
• 检验
  首先执行./gradlew installGitHooks将hooks安装到./.git/hooks目录下，故意在ScaffoldController新增无用import然后执行git commit，这时会发现无用的import已经不存在，证明我们的hooks配置是生效了。
  
  
  我们再执行git push会发现无法push成功，这是因为最开始我为了测试PMD新增的无用私有方法没有去掉，而我们在pre-push中又会去执行pmdMain的校验。
  
  只需要去掉在ScaffoldController中新增的无用方法，再次进行git push，会发现push成功。
  

结语

到这里我们的SpringBoot脚手架工程已经初具雏形，具备统一代码格式，代码质量审核，代码提交检查的能力。但似乎还是有些不够，大家想想我们的脚手架还有什么不足吗？下篇文章告诉你答案。