# Learning-Summary

**Repository Path**: fuyan_u/Learning-Summary

## Basic Information

- **Project Name**: Learning-Summary
- **Description**: 汇总
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-25
- **Last Updated**: 2024-12-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## checkstyle代码校验

#### 1、准备好环境

- jdk与git环境配置
- 了解git hook，们要在git commit之前自动检查style，就需要利用git hook（钩子），查看文档：https://git-scm.com/book/zh/v2/%E8%87%AA%E5%AE%9A%E4%B9%89-Git-Git-%E9%92%A9%E5%AD%90
![](assets/60c417b55d974e63b9dea84a623e6d2e&showdoc=.jpg)
- checkstyle的jar包（https://github.com/checkstyle/checkstyle/releases ）
- style xml配置文件

```xml
<?xml version="1.0" encoding="UTF-8"?>
<!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"/>
    <!-- 重复代码的检查，超过20行就认为重复，UTF-8格式-->
    <module name="TreeWalker">
        <!-- javadoc的检查 -->
        <!-- 检查所有的interface和class -->
        <module name="JavadocType">
            <property name="allowUnknownTags" value="true"/>
        </module>
        <!--<module name="JavadocMethod">-->
        <!--<property name="scope" value="private" />-->
        <!--<property name="allowMissingPropertyJavadoc" value="true" />-->
        <!--<property name="allowMissingParamTags" value="true" />-->
        <!--<property name="logLoadErrors" value="true" />-->
        <!--<property name="suppressLoadErrors" value="true" />-->
        <!--</module>-->
        <!-- 命名方面的检查，它们都使用了Sun官方定的规则。 -->
        <!-- 局部的final变量，包括catch中的参数的检查 -->
        <module name="LocalFinalVariableName" />
        <!-- 局部的非final型的变量，包括catch中的参数的检查 -->
        <module name="LocalVariableName" />
        <!-- 包名的检查（只允许小写字母） -->
        <module name="PackageName">
            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
        </module>
        <!-- 仅仅是static型的变量（不包括static final型）的检查 -->
        <module name="StaticVariableName" />
        <!-- 类型(Class或Interface)名的检查 -->
        <module name="TypeName" />
        <!-- 非static型变量的检查 -->
        <module name="MemberName" />
        <!-- 方法名的检查 -->
        <module name="MethodName" />
        <!-- 方法的参数名 -->
        <module name="ParameterName " />
        <!-- 常量名的检查 -->
        <module name="ConstantName" />
        <!-- 对区域的检查 -->
        <!-- 不能出现空白区域 -->
        <module name="EmptyBlock" />
        <!-- 所有区域都要使用大括号。 -->
        <module name="NeedBraces" />
        <!-- 多余的括号 -->
        <module name="AvoidNestedBlocks">
            <property name="allowInSwitchCase" value="true" />
        </module>
        <!-- String的比较不能用!= 和 == -->
        <module name="StringLiteralEquality" />
        <!-- 同一行不能有多个声明 -->
        <module name="MultipleVariableDeclarations" />
        <!-- 不必要的圆括号 -->
        <module name="UnnecessaryParentheses" />
        <!-- 检查是否有未注释的main方法 -->
<!--        <module name="UncommentedMain" />-->
        <!-- 检查并确保所有的常量中的L都是大写的。因为小写的字母l跟数字1太象了 -->
        <module name="UpperEll" />
        <!-- 检查数组类型的定义是String[] args，而不是String args[] -->
        <module name="ArrayTypeStyle" />
        <module name="MagicNumber">
            <property name="tokens" value="NUM_DOUBLE, NUM_FLOAT"/>
            <property name="ignoreNumbers" value="0,1"/>
            <property name="ignoreAnnotation" value="true"/>
        </module>
        <!-- 检查switch语句是否有default -->
        <module name="MissingSwitchDefault"/>
        <!-- if最多嵌套3层 -->
        <module name="NestedIfDepth">
            <property name="max" value="3"/>
        </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>
        <!-- finalize 必须调用了super.finalize() -->
        <module name="SuperFinalize" />
        <!-- 检查类成员的可见度 检查类成员的可见性。只有static final 成员是public的
        除非在本检查的protectedAllowed和packagedAllowed属性中进行了设置-->
        <module name="VisibilityModifier">
            <property name="packageAllowed" value="true"/>
            <property name="protectedAllowed" value="true"/>
        </module>
        <!-- 检查在重写了equals方法后是否重写了hashCode方法 -->
        <module name="EqualsHashCode"/>
        <!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->
        <module name="ParameterNumber">
            <property name="max" value="4" />
            <property name="ignoreOverriddenMethods" value="true"/>
            <property name="tokens" value="METHOD_DEF" />
        </module>
        <!-- 检查是否从非法的包中导入了类 -->
        <module name="IllegalImport"/>
        <!-- 检查是否导入了多余的包 -->
        <module name="RedundantImport"/>
        <!-- 没用的import检查，比如：1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->
        <module name="UnusedImports" />
    </module>
</module>
```

- pre-commit脚本

```bash
#!/bin/bash
#@author:jimo#
#@func:pre-commit#
## cp ./check-style/pre-commit ./.git/hooks/
# 一个打印函数，前后加空行
function print(){
    echo ""
    echo "===========$*============"
    echo ""
}
print 避免NPE是程序员的基本修养！
print 开始style checking
wd=`pwd`
print "当前工作目录：$wd"
check_jar_path="$wd/check-style/checkstyle-8.20-all.jar"
check_xml_path="$wd/check-style/iad-checkstyle.xml"
# echo $check_jar_path $check_xml_path
# 清空temp文件
rm -f temp
is_err=0
for file in `git status --porcelain | sed s/^...// | grep '\.java$'`;do
    path="$wd/$file"
    print "检查文件：$path"
    re=`java -jar $check_jar_path -c $check_xml_path $path >> temp`
    err=`cat temp | grep "ERROR"`
    if [[ $err = *"ERROR"* ]];then
        print $err
        is_err=1
    fi
done
print "检查完成，祝你好运"
rm -f temp
if [ $is_err -ne 0 ]
then
    print "请先符合style才能提交！"
    exit 1
fi
exit 0
```

#### 2、在项目根目录下增加check-style目录来存放文件

#### ![img](assets/1bc22997a3345219b9becd14821b3450&showdoc=.jpg)

#### 3、使用

因为.git这个目录是不随项目文件一起提交的，所以不能实现共享，所以需要做一些配置，有两种方案：

##### 第一种方案：

可以拷贝pre-commit到.git/hooks目录下，根目录下执行下面命令：

```
cp ./check-style/pre-commit ./.git/hooks/
```

##### 第二种方案：

在根目录下的pom.xml文件增加插件

```xml
 <plugin>
                <groupId>com.rudikershaw.gitbuildhook</groupId>
                <artifactId>git-build-hook-maven-plugin</artifactId>
                <version>3.0.0</version>
                <configuration>
                    <gitConfig>
                        <core.hooksPath>./check-style/</core.hooksPath>
                    </gitConfig>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>initialize</goal>
                            <goal>configure</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
```

根目录下执行下面命令：

```
mvn compile
或者
mvn install
或者
mvn package
```

### 二、gitalab远端代码检验，在git push时校验代码

- 一般在仓库的/var/opt/gitlab/git-data/repositories/<group>/<project>.git目录下创建目录：custom_hooks，但是因为我们gitlab配置了Use hashed storage，只能在gitlab上查询项目对应的hash值，以MES后端代码为例，仓库地址：/var/opt/gitlab/git-data/repositories/[@hashed](https://github.com/hashed)/45/23/4523540f1504cd17100c4835e85b7eefd49911580f8efff0599a8f283be6b9e3.git

![img](assets/e7d0c8d7670c5365512df4da59e35398&showdoc=.jpg)

![image-20241225154637628](assets/image-20241225154637628.png)

在custom_hooks目录下新增可执行文件：pre-receive （脚本可以是任何ruby、python、shell可执行脚本，没有后缀名，新建后记得授权：chmod +x pre-receive）输入内容如下：

```bash
#!/usr/bin/python
#coding=utf-8
import os
import sys
import subprocess
import tempfile
import shutil
__author__ = "zhangqa"
class Trigger(object):
 def __init__(self):
     '''
     初始化文件列表信息，提交者信息，提交时间,当前操作的分支
     '''
     self.pushAuthor = ""
     self.pushTime = ""
     self.fileList = []
     self.ref = ""
 def __getGitInfo(self):
     '''
     '''
     self.oldObject, self.newObject, self.ref = sys.stdin.readline().strip().split(' ')
 def __getPushInfo(self):
     '''
     git show命令获取push作者，时间，以及文件列表
     文件的路径为相对于版本库根目录的一个相对路径
     '''
     print(self.newObject)
     print(self.oldObject)
     if self.newObject.startswith("000000000"):
      exit(0)
     if self.oldObject.startswith("000000000"):
      exit(0)
     rev = subprocess.Popen('git rev-list '+self.newObject,shell=True,stdout=subprocess.PIPE)
     revList = rev.stdout.readlines()
     revList = [x.strip() for x in revList]
     #查找从上次提交self.oldObject之后还有多少次提交，即本次push提交的object列表
     indexOld = revList.index(self.oldObject)
     pushList = revList[:indexOld]
     pushList.reverse()
     #tempdir = tempfile.mkdtemp('git_hook')
     tempdir = ('/tmp')
     # 循环获取每次提交的文件列表
     for pObject in pushList:
         p = subprocess.Popen('git show '+pObject,shell=True,stdout=subprocess.PIPE)
         pipe = p.stdout.readlines()
         pipe = [x.strip() for x in pipe]
         for index, item in enumerate(pipe):
             if item.startswith("diff"):
                 #验证是否java文件
                 file = item.strip("diff").strip()
                 if not file.lower().endswith('.java'):
                     continue
                 filename = file.split('/')[-1]
                 #git get Tree
                 #content_hash = pipe[index+1].strip("index").strip()[10:16]
                 if pipe[index+1].startswith("similarity"):
                  s = pipe[index+4]
                  i = s.index("..")+2
                 elif pipe[index+1].startswith("index"):
                  s = pipe[index+1]
                  i = s.index("..")+2
                 elif pipe[index + 1].startswith("new"):
                  s = pipe[index + 2]
                  i = s.index("..") + 2
                 else:
                  continue
                 print(s)
                 content_hash = s[i:i+6]
                 print(content_hash)
                 content_p = subprocess.Popen('git cat-file -p '+content_hash,shell=True,stdout=subprocess.PIPE)
                 cpipe = content_p.stdout.readlines()
                 #print(cpipe)
                 with open(os.path.join(tempdir, filename), 'w+') as fp:
                  fp.writelines(cpipe)
                  fp.close()
                 self.handler_checkstyle(tempdir+'/'+filename)
                 # checkstyle
                 #self.handler_checkstyle(tempdir+"/")
  # 处理java文件
 def handler_checkstyle(self, file):
  try:
     print(file)
     cmd = r'java -jar /data/gitlab.checkstyle/lib/checkstyle-8.20-all.jar -c /data/gitlab.checkstyle/style/checkstyle.xml '+file
     print(cmd)
     result = self.execCmd(cmd)
     print(result)
     a = 'ERROR'
     if a in result:
      #print(result)
      exit(1)
  except Exception, e:
      print('error message:' + e.message)
      exit(1)
  finally:
      os.system('rm {}'.format(file))
 def execCmd(self, cmd):  
     r = os.popen(cmd)  
     text = r.read()  
     r.close()  
     return text
 def getGitPushInfo(self):
     self.__getGitInfo()
     self.__getPushInfo()
if __name__ == "__main__":
 #print("argv: ", sys.argv)
 t = Trigger()
 t.getGitPushInfo()
 exit(0)
```

- 使用的jar包的位置：/data/gitlab.checkstyle/lib/checkstyle-8.20-all.jar
- 使用的xml的位置：/data/gitlab.checkstyle/style/checkstyle.xml（内容和上面的style规则一致就行）