SVN添加钩子检查代码规范

穷儒公羊

已于 2024-02-04 16:56:40 修改

阅读量166

点赞数

分类专栏： DevOps 文章标签： svn 代码规范 devops

于 2023-06-27 18:00:43 首次发布

本文链接：https://blog.csdn.net/weixin_42789334/article/details/131421868

版权

DevOps 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

文章目录

前言
一、安装Python2.x
二、配置CheckStyle
安装svnchecker-0.3
- - 四、配置SVN SERVER
遇到问题
总结

前言

之前项目组代码有点乱，现在需要进行代码审查。虽然给出规范，但是由于之前随便惯了，避免开发人员继续随便提交不符合规范的代码，于是决定用 SVNChecker + CheckStyle 进行强制校验

一、安装Python2.x

需要先安装下Python2.x版本（是2.x版本，之前用了3.10，一路火花带闪电），可以从Python官网 下载。安装步骤就不多说了，无脑下一步即可

二、配置CheckStyle

1、从CheckStyle下载地址 中挑选你想要的版本，这里注意下载 checkstyle-x.xx-all.jar版本的，并且要与jdk对应。这里我用的是 checkstyle-8.17-all.jar 对应的是 jdk1.8。下载完放到自己想要的目录

2、 CheckStyle 需要配合 checks.xml 进行使用，可以用 CheckStyle 内嵌的 google_checks.xml、sun_checks.xml。也可以用国内的阿里规范。这里用的是阿里的规范，由于刚上代码校验，所以暂时定义相对宽松点，避免被打，大家可以根据实际情况进行相应的修改。checks.xml 配置如下：

<?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">

    <!-- 检查文件是否以一个空行结束 -->
   <!--  <module name="NewlineAtEndOfFile"/> -->

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

    <!-- 每个java文件一个语法树 -->
    <module name="TreeWalker">
        <!-- import检查-->
        <!-- 避免使用* -->
       <!--   <module name="AvoidStarImport">-->
         <!--     <property name="excludes" value="java.io,java.net,java.lang.Math"/>-->
            <!-- 实例；import java.util.*;.-->
       <!--       <property name="allowClassImports" value="false"/>-->
            <!-- 实例 ；import static org.junit.Assert.*;-->
         <!--     <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="allowUnknownTags" value="true"/>
            <message key="javadoc.missing" value="类注释：缺少Javadoc注释。"/>
        </module>
      <!--  <module name="JavadocMethod">
            <property name="tokens" value="METHOD_DEF" />-->
            <!--允许get set 方法没有注释-->
      <!--       <property name="allowMissingPropertyJavadoc" value="true"/>
            <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"/>

        <!-- 长度检查 -->
        <!-- 每行不超过120个字符 -->
        <module name="LineLength">
            <property name="max" value="120" />
        </module>
        <!-- 方法不超过500行 -->
        <module name="MethodLength">
            <property name="tokens" value="METHOD_DEF" />
            <property name="max" value="500" />
        </module>
        <!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->
        <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"/>-->

        <!-- 修饰符检查 -->
        <!-- 检查修饰符的顺序是否遵照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="NeedBraces"/>
        <!-- 检查右大括号位置 -->
        <module name="RightCurly"/>

        <!-- 代码检查 -->
        <!-- 检查空的代码段 -->
        <module name="EmptyStatement"/>
        <!-- 检查在重写了equals方法后是否重写了hashCode方法 -->
        <module name="EqualsHashCode"/>
        <!-- 检查局部变量或参数是否隐藏了类中的变量 -->
        <module name="HiddenField">
            <property name="tokens" value="VARIABLE_DEF"/>
        </module>
        <!-- 检查是否使用工厂方法实例化 -->
        <module name="IllegalInstantiation"/>
        <!-- 检查子表达式中是否有赋值操作 -->
        <module name="InnerAssignment"/>
        <!-- 检查是否有"魔术"数字 -->
        <module name="MagicNumber">
           <property name="ignoreNumbers" value="0, 1"/>
           <property name="ignoreAnnotation" value="true"/>
       </module>
        <!-- 检查switch语句是否有default -->
        <module name="MissingSwitchDefault"/>
        <!-- 检查是否有过度复杂的布尔表达式 -->
        <module name="SimplifyBooleanExpression"/>
        <!-- 检查是否有过于复杂的布尔返回代码段 -->
        <module name="SimplifyBooleanReturn"/>

        <!-- 类设计检查 -->
        <!-- 检查类是否为扩展设计l -->
        <!-- 检查只有private构造函数的类是否声明为final -->
       <!-- <module name="FinalClass"/>  -->
        <!-- 检查工具类是否有putblic的构造器 -->
       <!-- <module name="HideUtilityClassConstructor"/>  -->
        <!-- 检查接口是否仅定义类型 -->
        <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方法,排除以Appllication结尾命名的类 -->
        <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>
        <!-- return个数 3个-->
        <module name="ReturnCount">
            <property name="max" value="3"/>
        </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>

3、 CheckStyle 可以单独使用，如果有已提交的代码，可以直接运行 checkstyle-8.17-all.jar 进行校验，命令如下：

java -jar checkstyle-8.17-all.jar -c=checkstyle.xml SwaggerConfig.java

比如 SwaggerConfig 缺少类注释，使用 checkstyle-8.17-all.jar 检测一下，如下：

在这里插入图片描述

安装svnchecker-0.3

1、安装完Python环境后，就可以安装 svnchecker-0.3。svnchecker-0.3有直装版本，不过可能由于之前我配的环境变量是Python3.10，一直没装成功，所以改用zip来操作了，找到zip包直接下载之后直接解压即可

2、配置 svncheckerconfig.ini，svncheckerconfig.ini 需要放在对应SVN仓库的hooks目录下，也可以放在svnchecker的安装目录之下，前者只针对单个仓库，后者则对应全局

[Default]

#This property tells Subversionchecker about all checks
#(UnitTests, AccessRights, XMLValidator etc) it should execute.
#Separated with comma (",")
Main.PreCommitChecks=Checkstyle

#Path of java executable to run Checkstyle command
Checkstyle.Java=java
#Checkstyle.CheckFiles=.java
#Classpath for executing Checkstyle rules
Checkstyle.Classpath=D:/SVN/svnchecker-0.3/checkstyle-8.17-all.jar

#Configuration file for Checkstyle to run its rules.
Checkstyle.ConfigFile=D:/SVN/svnchecker-0.3/checkstyle.xml

#In case of failures, where should Subversionchecker redirect the errors
Checkstyle.FailureHandlers=Console

四、配置SVN SERVER

1、选择对应的仓库，右键选择Properties…

在这里插入图片描述

2、点击Hooks，选择Pre-commit hook

在这里插入图片描述

3、配置Pre-commit脚本，如下：

set python="D:\Python\Python27\python.exe"
set svnchecker="D:\SVN\svnchecker-0.3"
set svnlook="D:\SVN\VisualSVN Server\bin\svnlook.exe"

setlocal
set REPOS=%1
set TXN=%2
rem checkstyle hooks
%python% %svnchecker%\Main.py PreCommit %REPOS% %TXN% || exit 1

rem Make sure that the log message containssome text.
rem %svnlook% log -t "%TXN%""%REPOS%" | findstr "....." > null

if %errorlevel% gtr 0 goto err
exit 0

:err
rem echo 字符串长度不能小于5，不允许提交 1>&2
echo "%REPOS%" -t "%TXN%"1>&2
exit 2

遇到问题

1、这里整合时候遇到点问题，一个是 Checkstyle.CheckFiles 配置不起作用，这个是配置检查那种文件，在实际的工作环境中，并不是只有java文件，还有其他文档，软件等。这些就没必要进行校验了，所以这个配置必须得生效的。于是在Main.py中添加两行代码，如下：

在这里插入图片描述
代码如下：

check = config.getArray("Checkstyle.CheckFiles", [".*\.java"])
ignore = config.getArray("Checkstyle.IgnoreFiles", [])
files = transaction.getFiles(check, ignore).keys()

2、另外一个问题是SVN仓库路径中带有空格问题，由于命令行会把空格当成分割符，所以路径带空格会出现问题，于是把路径添加双引号，修改 Transaction#__executeSVN 如下：

在这里插入图片描述

代码如下：

command = "svnlook --%s %s %s \"%s\" %s" % (self.type, self.txnName, command, self.reposPath, arg)

3、最后一个问题就是中文乱码问题，删除 checkstyle-8.17-all.jar 中的 messages_zh.properties 文件，该文件位于 com/puppycrawl/tools/checkstyle 包下。修改 Checkstyle#run 如下：

在这里插入图片描述

代码如下：

msg += e.output.decode("utf-8").encode("gbk") + "\n"

总结

大致流程：SVN提交前调用 Pre-commit hook 脚本 =》调用svnchecker =》svn调用 checkstyle.jar 进行代码校验

穷儒公羊

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
打赏
0
评论
SVN添加钩子检查代码规范

之前项目组代码有点乱，现在需要进行代码审查。虽然给出规范，但是由于之前随便惯了，避免开发人员继续随便提交不符合规范的代码，于是决定用 SVNChecker + CheckStyle 进行强制校验需要先安装下Python2.x版本（是2.x版本，之前用了3.10，一路火花带闪电），可以从Python官网下载。安装步骤就不多说了，无脑下一步即可 1、从CheckStyle下载地址中挑选你想要的版本，这里注意下载 checkstyle-x.xx-all.jar版本的，并且要与jdk对应。这里我
复制链接

扫一扫