前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >给项目添加chechstyle

给项目添加chechstyle

作者头像
阿超
发布2023-04-06 09:54:29
5790
发布2023-04-06 09:54:29
举报
文章被收录于专栏:快乐阿超

收到个prhttps://gitee.com/dromara/stream-query/pulls/301

给项目添加了checkstyle,非常的nice

主要是配置了maven插件

代码语言:javascript
复制
<!-- 公共checkstyle标准配置,可以在子模块中覆盖,修改自定义选项 -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>3.1.0</version>
    <configuration>
        <configLocation>checkstyle/checkstyle.xml</configLocation>
        <includeTestSourceDirectory>false</includeTestSourceDirectory>
        <consoleOutput>true</consoleOutput>
        <encoding>UTF-8</encoding>
        <skip>false</skip>
        <violationSeverity>error</violationSeverity>
        <failsOnError>false</failsOnError>
    </configuration>
    <executions>
        <execution>
            <id>validate</id>
            <phase>validate</phase>
            <goals>
                <goal>checkstyle</goal>
            </goals>
        </execution>
    </executions>
</plugin>

以及配置文件checkstyle.xml

代码语言:javascript
复制
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
  "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
  "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<module name="Checker">

  <property name="charset" value="UTF-8"/>
  <property name="fileExtensions" value="java"/>

  <module name="Header">
    <property name="headerFile" value="checkstyle-header.txt"/>
    <property name="fileExtensions" value="java"/>
  </module>

  <!-- 文件长度不超过1500行 -->
<!--  <module name="FileLength">-->
<!--    <property name="max" value="1500"/>-->
<!--  </module>-->

  <!-- 每个java文件一个语法树 -->
  <module name="TreeWalker">
    <!-- import检查-->
    <!-- 避免使用* -->
<!--    <module name="AvoidStarImport">-->
<!--      &lt;!&ndash; 实例;import java.util.*;.&ndash;&gt;-->
<!--      <property name="allowClassImports" value="false"/>-->
<!--      &lt;!&ndash; 实例 ;import static org.junit.Assert.*;&ndash;&gt;-->
<!--      <property name="allowStaticMemberImports" value="true"/>-->
<!--    </module>-->
    <!-- 检查是否从非法的包中导入了类 -->
<!--    <module name="IllegalImport"/>-->
    <!-- 检查是否导入了多余的包 -->
    <module name="RedundantImport"/>
    <!-- 没用的import检查,比如:1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
    <module name="UnusedImports" />

    <!-- 注释检查 -->
    <!-- 检查方法和构造函数的javadoc -->
    <module name="JavadocType">
      <property name="tokens" value="INTERFACE_DEF"/>
      <property name="allowUnknownTags" value="true"/>
      <property name="allowedAnnotations" value="Generated"/>
      <message key="javadoc.missing" value="类注释:缺少Javadoc注释。"/>
    </module>
    <!-- 命名检查 -->
    <!-- 局部的final变量,包括catch中的参数的检查 -->
    <module name="LocalFinalVariableName" />
    <!-- 局部的非final型的变量,包括catch中的参数的检查 -->
    <module name="LocalVariableName" />
    <!-- 包名的检查(只允许小写字母),默认^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9_]*)*$ -->
    <module name="PackageName">
      <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
      <message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>
    </module>
    <!-- 仅仅是static型的变量(不包括static final型)的检查 -->
    <module name="StaticVariableName" />
    <!-- Class或Interface名检查,默认^[A-Z][a-zA-Z0-9]*$-->
    <module name="TypeName">
      <property name="severity" value="warning"/>
      <message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>
    </module>
    <!-- 非static型变量的检查 -->
    <module name="MemberName" />
    <!-- 方法名的检查 -->
    <module name="MethodName" />
    <!-- 方法的参数名 -->
    <module name="ParameterName " />
    <!-- 常量名的检查(只允许大写),默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ -->
    <module name="ConstantName" />

    <!-- 定义检查 -->
    <!-- 检查数组类型定义的样式 -->
    <module name="ArrayTypeStyle"/>
    <!-- 检查long型定义是否有大写的“L” -->
    <module name="UpperEll"/>

    <!-- 长度检查 -->
    <!-- 方法不超过50行 -->
    <module name="MethodLength">
      <property name="tokens" value="METHOD_DEF" />
      <property name="max" value="50" />
    </module>
    <!-- 方法的参数个数不超过8个。 并且不对构造方法进行检查-->
    <module name="ParameterNumber">
      <property name="max" value="8" />
      <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="ParenPad"/>
    <!-- 检查分隔符是否在空白之后 -->
    <module name="WhitespaceAfter"/>
    <!-- 检查分隔符周围是否有空白 -->
    <module name="WhitespaceAround"/>

    <!-- 修饰符检查 -->
    <!-- 检查修饰符的顺序是否遵照java语言规范,默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp -->
    <module name="ModifierOrder"/>
    <!-- 检查接口和annotation中是否有多余修饰符,如接口方法不必使用public -->
    <module name="RedundantModifier"/>

    <!-- 代码块检查 -->
    <!-- 检查是否有嵌套代码块 -->
    <module name="AvoidNestedBlocks"/>
    <!-- 检查是否有空代码块 -->
    <module name="EmptyBlock"/>
    <!-- 检查左大括号位置 -->
    <module name="LeftCurly"/>
    <!-- 检查右大括号位置 -->
    <module name="RightCurly"/>
    <!-- 检查代码块是否缺失{} -->
    <module name="NeedBraces"/>

    <!-- 代码检查 -->
    <!-- 检查空的代码段 -->
    <module name="EmptyStatement"/>
    <!-- 检查在重写了equals方法后是否重写了hashCode方法 -->
    <module name="EqualsHashCode"/>
    <!-- 检查是否使用工厂方法实例化 -->
    <module name="IllegalInstantiation"/>
    <!-- 检查是否有"魔术"数字 -->
    <!-- 检查switch语句是否有default -->
    <module name="MissingSwitchDefault"/>
    <!-- 检查是否有过度复杂的布尔表达式 -->
    <module name="SimplifyBooleanExpression"/>
    <!-- 检查是否有过于复杂的布尔返回代码段 -->
    <module name="SimplifyBooleanReturn"/>

    <!-- 类设计检查 -->
    <!-- 检查类是否为扩展设计l -->
    <!-- 检查接口是否仅定义类型 -->
<!--    <module name="InterfaceIsType"/>-->
    <!-- 检查类成员的可见度 检查类成员的可见性。只有static final 成员是public的
    除非在本检查的protectedAllowed和packagedAllowed属性中进行了设置-->
    <module name="VisibilityModifier">
      <property name="packageAllowed" value="true"/>
      <property name="protectedAllowed" value="true"/>
    </module>

    <!-- 语法 -->
    <!-- String的比较不能用!= 和 == -->
    <module name="StringLiteralEquality"/>
    <!-- 限制for循环最多嵌套2层 -->
    <module name="NestedForDepth">
      <property name="max" value="2"/>
    </module>
    <!-- if最多嵌套3层 -->
    <module name="NestedIfDepth">
      <property name="max" value="3"/>
    </module>
    <!-- 检查未被注释的main方法,排除以Application结尾命名的类 -->
    <module name="UncommentedMain">
      <property name="excludedClasses" value=".*Application$"/>
    </module>
    <!-- 禁止使用System.out.println -->
    <module name="Regexp">
      <property name="format" value="System\.out\.println"/>
      <property name="illegalPattern" value="true"/>
    </module>
    <!--try catch 异常处理数量 3-->
    <module name="NestedTryDepth ">
      <property name="max" value="3"/>
    </module>
    <!-- clone方法必须调用了super.clone() -->
    <module name="SuperClone" />
    <!-- finalize 必须调用了super.finalize() -->
    <module name="SuperFinalize" />
  </module>
</module>

还有LICENCE校验checkstyle-header.txt

代码语言:javascript
复制
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

之后就可以使用mvn checkstyle:checkstyle进行代码审查啦!

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2023-04-04,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
相关产品与服务
腾讯云代码分析
腾讯云代码分析(内部代号CodeDog)是集众多代码分析工具的云原生、分布式、高性能的代码综合分析跟踪管理平台,其主要功能是持续跟踪分析代码,观测项目代码质量,助力维护团队卓越代码文化。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档