# gradle 进行代码检查

gradle code analysis

java 使用 Checkstyle

主要检查代码缩进，等等问题

Checkstyle 文档

1. 安装依赖build.gradle

plugins {
  id 'checkstyle'
}

这里直接使用的插件，所以会自动安装依赖包。

2. 添加配置文件

安装下列结构新建配置文件

<root>
└── config
    └── checkstyle           // (1)
        └── checkstyle.xml   // (2)
        └── suppressions.xml

3. 写入配置
   文档
   简单点，打开google,sun 两种配置文件
   随便选一个复制就行。

到这里简单的配置已经完成了。
运行gradle check，就会在build/reports/checkstyle/下生成报告。

看到 xml 的报告。是不是很不爽？可以在build.gradle配置下。

tasks.withType(Checkstyle) {
    reports {
        xml.enabled false
        html.enabled true
        html.stylesheet resources.text.fromFile('config/xsl/checkstyle-custom.xsl')
    }
}

运行下来发现好多警告，怎么办？
checkstyle-idea/
为idea安装这个插件，这样就可以帮你实时报告了。
接着我们设置idea的自动格式化代码风格。
打开preferences/Edit/codestyle:

image.png

注意选择idea code style xml
idea-java-google-style.xml
导入上面的文件，然后就可以愉快的编写代码了。

java 使用 spotbugs

主要找一些代码bugs，比如import顺序有误，使用getset方法，get返回了对象可能会修改对象等。

因为 findbugs 已经 n 年没有更新了，gradle 也将会移除 findbugs。所以直接用推荐的 spotbugs。

1. 安装依赖build.gradle

plugins {
  id "com.github.spotbugs" version "1.7.1"
}

2. 配置项选用默认。所以不作处理

   spotbugs 的配置和 FindBugsExtension 配置一样

3. 配置 report,这个不配置默认生成 xml

tasks.withType(com.github.spotbugs.SpotBugsTask) {
    reports {
        xml.enabled false
        html.enabled true
    }
}