idea,eclipse使用checkStyle约束代码规范,插件使用教程

1.如何使用checkStyle插件

idea

    (1).在使用的编程软件中搜索插件,CheckStyle 下载并安装到本地….idea下载CheckStyle-IDEA 安装并重启

    (2).下载checkStyle.xml文件到项目根目录下.

    (3).打开preperences-->Tools--->Checkstyle,新建congfiguration File 新添加配置文件指向项目根目录下的checkStyle.xml.

    

    (4),在文件内容页右键选中 “Check Current File”  即可为当前文件代码检验代码格式是符合规范.

    

左方功能栏区域分别可以选中当前模块,或是整个项目进行代码规范检查.

 

eclipse

    (1).搜索插件checkStyle 安装,或离线安装,并重启软件

    (2).下载

    (3),打开window-->preferences-->checkStyle

新建 “check configurations”—>选择”External Configuration File “ —>选择之前下载下来的代码规范文件,—>完成

(4).将新建的格式配置设置为默认—>set as default—>Apply and Close

(5)右键项目文件夹或是项目具体文件,选择 ”checkStyle” —>”check Code with CheckStyle” 对整个项目进行格式化代码约束检查.

 

 

2.使用自动化格式化工具,格式化现有代码

  idea

    (1).idea软件本身支持自动对代码进行既定格式的格式化功能,但是需要人为的去配置格式化规范文件

    (2).打开preperences-->Editor-->Code Style—>java

    

然后导入之前下载到项目根目录下的checkStyle文件作为新的Scheme ,并应用到项目

    (3).然后就是自动化项目现有代码,右键选中,项目文件.或是项目文件夹,或是整个项目的根文件夹,选中”Reformat Code “ 然后就会根据配置的已有规范去自动化格式化代码.

 

  eclipse

    (1)打开window-->preferences-->搜索”code Style “ 或是直接打开”java”—>code Style 选择Formatter.

    (2)选择”New” 新创建一个profile,并导入根目录文件夹内的eclipseStyle.xml文件,导入成功后设为默认,并应用.

    (3)选择项目列表的项目或是单一的文件夹,点击右键,选中”Source”—>”Format”,就可以对所选中的文件或是项目进行相应的自动格式化.

 

 

 

*注: 代码命名规范,参数个数,代码行数,有可能会影响程序逻辑运行代码块的不会自动化的修改格式,需要人为的调整.

       关于导包,有一些不规范的类,或是方法,尝试更换其他的实现.

 

 

3.使用maven CheckStyle 进行打包代码格式约束

        (1).将checkStyle.xml文件放入根目录下,与父pom.xml同级目录

        (2).在父pom文件内添加 plugin

        (3).在单module中直接放入pom文件中即可

            <plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-checkstyle-plugin</artifactId>

    <version>3.0.0</version>

    <executions>

        <execution>

            <id>validate</id>

            <phase>validate</phase>

            <configuration>

                <configLocation>checkStyle2.xml</configLocation>

                <encoding>UTF-8</encoding>

                <consoleOutput>true</consoleOutput>

                <failsOnError>true</failsOnError>

            </configuration>

            <goals>

                <goal>check</goal>

            </goals>

        </execution>

    </executions>

</plugin>

 

    这时候就可以使用: mvn compile checkstyle:checkstyle 来校验代码中不符合规范的代码块了.或是直接使用打包命令,代码块中有不符合规范的写法会导致打包失败的.