如何使用 CheckStyle 工具提升代码质量

马丁玩编程
4,341 阅读4分钟

CheckStyle 是一种开发工具，可帮助程序员编写符合编码标准的 Java 代码。它使检查 Java 代码的过程自动化，从而使开发者免于完成这项无聊（但重要）的任务。这使得它非常适合想要强制执行编码标准的项目。

CheckStyle 可以检查源代码的许多方面。它可以发现类设计问题、方法设计问题。它还能够检查代码布局和格式问题。

正文开始之前，向大家推荐一款新开源的商城项目。基于 DDD 领域驱动模型，代码设计优雅，涵盖商城核心业务。内置分布式锁、分布式事务、分库分表、消息队列、数据搜索、服务监控等功能。

文章介绍：《发现一个商城开源项目，谷粒商城外又多了个选择》

官网地址：magestack.cn

定义扫描规则

CheckStyle 有着众多扫描规则，涵盖种类非常之多，容易让人眼花缭乱。这里提供一份开源项目 Hippo4j 正在使用的规则文件，如需个性化可参考官网进行修改。

创建自定义 checkstyle.xml 文件：

<!DOCTYPE module PUBLIC
        "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
    <module name="NewlineAtEndOfFile"/>
    <module name="RegexpSingleline">
        <property name="format" value="printStackTrace"/>
        <property name="message" value="Prohibit invoking printStackTrace in source code !"/>
    </module>
    <module name="TreeWalker">
        <module name="AvoidStarImport">
            <property name="excludes" value="java.io,java.net,java.lang.Math"/>
            <property name="allowClassImports" value="false"/>
            <property name="allowStaticMemberImports" value="true"/>
        </module>
        <module name="IllegalImport"/>
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>
        <module name="JavadocType">
            <property name="allowUnknownTags" value="true"/>
            <property name="allowMissingParamTags" value="true"/>
            <message key="javadoc.missing" value="Class Comments: Missing Javadoc Comments"/>
        </module>
        <!-- Do not scan method annotations for now -->
        <!--<module name="JavadocMethod">
            <property name="tokens" value="METHOD_DEF"/>
            <property name="allowMissingPropertyJavadoc" value="true"/>
            <message key="javadoc.missing" value="Method Comments: Missing Javadoc Comments"/>
        </module>-->
        <module name="LocalFinalVariableName"/>
        <module name="LocalVariableName"/>
        <module name="PackageName">
            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
        </module>
        <module name="StaticVariableName"/>
        <module name="TypeName"/>
        <module name="MemberName"/>
        <module name="MethodName"/>
        <module name="ParameterName "/>
        <module name="ConstantName"/>
        <module name="ArrayTypeStyle"/>
        <module name="UpperEll"/>
        <module name="LineLength">
            <property name="max" value="200"/>
        </module>
        <module name="MethodLength">
            <property name="tokens" value="METHOD_DEF"/>
            <property name="max" value="150"/>
        </module>
        <module name="ParameterNumber">
            <property name="max" value="5"/>
            <property name="ignoreOverriddenMethods" value="true"/>
            <property name="tokens" value="METHOD_DEF"/>
        </module>
        <module name="MethodParamPad"/>
        <module name="TypecastParenPad"/>
        <module name="NoWhitespaceAfter"/>
        <module name="NoWhitespaceBefore"/>
        <module name="OperatorWrap"/>
        <module name="ParenPad"/>
        <module name="WhitespaceAfter"/>
        <module name="WhitespaceAround"/>
        <module name="ModifierOrder"/>
        <module name="RedundantModifier"/>
        <module name="AvoidNestedBlocks"/>
        <module name="EmptyBlock"/>
        <module name="LeftCurly"/>
        <module name="NeedBraces"/>
        <module name="RightCurly"/>
        <module name="EmptyStatement"/>
        <module name="EqualsHashCode"/>
        <module name="IllegalInstantiation"/>
        <module name="InnerAssignment"/>
        <module name="MagicNumber">
            <property name="ignoreNumbers" value="0, 1, 2"/>
            <property name="ignoreAnnotation" value="true"/>
            <property name="ignoreHashCodeMethod" value="true"/>
            <property name="ignoreFieldDeclaration" value="true"/>
        </module>
        <module name="MissingSwitchDefault"/>
        <module name="SimplifyBooleanExpression"/>
        <module name="SimplifyBooleanReturn"/>
        <module name="FinalClass"/>
        <module name="InterfaceIsType"/>
        <module name="VisibilityModifier">
            <property name="packageAllowed" value="true"/>
            <property name="protectedAllowed" value="true"/>
        </module>
        <module name="StringLiteralEquality"/>
        <module name="NestedForDepth">
            <property name="max" value="3"/>
        </module>
        <module name="NestedIfDepth">
            <property name="max" value="4"/>
        </module>
        <module name="UncommentedMain">
            <property name="excludedClasses" value=".*Application$"/>
        </module>
        <module name="Regexp">
            <property name="format" value="System\.out\.println"/>
            <property name="illegalPattern" value="true"/>
        </module>
        <module name="ReturnCount">
            <property name="max" value="4"/>
        </module>
        <module name="NestedTryDepth ">
            <property name="max" value="4"/>
        </module>
        <module name="SuperFinalize"/>
        <module name="SuperClone"/>
    </module>
</module>

如何使用

CheckStyle 在日常生活中有两种常用的使用方式，分别是通过代码编辑器 IDEA 和 Maven 配合使用。

1. IDEA 插件

首先打开 IDEA 菜单栏的 Settings 配置中的 Plugins，搜索 CheckStyle-IDEA 并安装：

安装后，查看 Enable 是否开启，如果没有开启，将该框打勾并重启 IDEA。

安装重启 IDEA 之后，Settings 下搜索 Inspections，再查询 CheckStyle，如果能查询到内容，说明安装成功：

在 Settings 中搜索 CheckStyle，按下图导入上一步骤新建的 checkstyle.xml 文件：

通过下述代码扫描 CheckStyle 代码规则，看是否需要需要变更：

/**
 * 记录 C 用户用户变更日志
 *
 * @param customerOperationLogEvent
 */
public void recordCustomerUserOperationLog(OperationLogEvent customerOperationLogEvent) {
    String keys = UUID.randomUUID().toString();
    Message<?> message = MessageBuilder
            .withPayload(new MessageWrapper(keys, customerOperationLogEvent))
            .setHeader(MessageConst.PROPERTY_KEYS, keys)
            .setHeader(MessageConst.PROPERTY_TAGS, RocketMQConstants.CUSTOMER_USER_OPERATION_LOG_TAG)
            .build();
    long startTime = System.currentTimeMillis();
    boolean sendResult = false;
    try {
        sendResult = output.send(message, 2000L);
    } finally {
        log.info("C 端用户保存用户日志，发送状态: {}, Keys: {}, 执行时间: {} ms, 消息内容: {}", sendResult, keys, System.currentTimeMillis() - startTime, JSON.toJSONString(customerOperationLogEvent));
    }
}

通过控制台，可以看到该代码段有以下不规范的操作，双击提示，可以一步一步去解决规范的问题：

2. Maven 插件

在项目根目录新建一个 dev-support 文件夹，将代码规约配置文件放到此路径下，当然你也可以根据自己的需求去自行定义。

在 Maven 中一个名为 maven-checkstyle-plugin 的插件，用于执行 CheckStyle 任务。下面是一个简单的配置。在 Maven 工程中的 pom.xml 文件，添加内容如下：

<plugins>
    <plugin>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>3.1.0</version>
        <configuration>
            <configLocation>${maven.multiModuleProjectDirectory}/dev-support/checkstyle.xml</configLocation>
            <includeTestSourceDirectory>true</includeTestSourceDirectory>
            <excludes>**/autogen/**/*</excludes>
        </configuration>
        <executions>
            <execution>
                <id>validate</id>
                <goals>
                    <goal>check</goal>
                </goals>
                <phase>validate</phase>
            </execution>
        </executions>
    </plugin>
</plugins>

修改 pom.xml 之后，就可运行 CheckStyle 检查：

mvn checkstyle:check

IDEA 和 Maven 插件可结合使用。

开源地址

CheckStyle Site

CheckStyle GitHub

文末总结

CheckStyle 是一种开源的代码质量工具，它可以帮助开发人员在代码编写过程中检查代码的规范性和风格，确保代码的可读性、可维护性和可扩展性。CheckStyle 可以检查 Java 代码中的各种问题，包括代码格式、命名规范、注释等，同时也可以扩展到其他编程语言。

在 CheckStyle 中，通过定义一系列的检查规则来检查代码，每条规则对应着一种代码风格或规范要求。在编译代码的过程中，CheckStyle 会对代码进行分析，并对每个文件和代码段进行检查，如果发现不符合规范的代码，会给出警告或者错误提示。

除了 CheckStyle 自带的规则之外，还可以通过编写自定义规则来扩展 CheckStyle 的功能，满足特定的代码规范要求。此外，CheckStyle 还支持集成到常见的开发工具中，如 Eclipse、IntelliJ IDEA 等，以方便开发人员在实际开发中使用。

通过使用 CheckStyle 工具，开发人员可以提高代码的质量和可维护性，降低代码出错的概率，以及减少不同开发人员在代码风格和规范上的差异，从而提升团队协作和项目的整体效率。

本文正在参加「金石计划」

avatar
文章
阅读
粉丝