Java基础开发规范


规范检查

本地开发开启两种规范检查,一种为sonarQube的规范检查,一种为基于sun和google的checkStyle规范检查。

同时在CI的SonarQube代码检查中也生效了这两种规范检查,控制代码质量。

  1. 本地开启sonarQube规范检查:

    在Idea中安装sonarLint插件:

    Java基础开发规范 - 图1

    Java基础开发规范 - 图2

    指定本地修改的文件或者全项目检查:

    Java基础开发规范 - 图3

    查看不符合检查的地方:

    Java基础开发规范 - 图4

  2. 本地开启checkStyle规范检查,注意更新插件,否则部分规则不适用于旧版本会报错:

    在Idea中安装CheckStyle-IDEA插件,步骤与上面安装插件一样

    生效checkStyle中checkStyle的规范config:choerodon_checks.xml Java基础开发规范 - 图5

附:

sonarQube规范检查规则链接:SonarRules

googleCheck规范检查规则链接:googleCheck

alibaba p3c代码规范:aliP3c

idea设置

  1. 修改import分组、排序规则

    Java基础开发规范 - 图6

  2. 换行设置

    Java基础开发规范 - 图7

  3. tab设置

    Java基础开发规范 - 图8