网站统计cnzz,18款禁用软件app网站入口,wordpress 后台样式,宁波专业的网站建设团队最近的Java后端项目想实现代码的规范检查#xff0c;调研了一圈#xff0c;终于找到了简单的方式实现#xff1a;以下是常见的几种方案#xff1a; 1、在客户端做 git hook#xff0c;主要是用 pre-commit 这个钩子。前端项目中常见的 husky 就是基于此实现的。但缺点也很…最近的Java后端项目想实现代码的规范检查调研了一圈终于找到了简单的方式实现以下是常见的几种方案 1、在客户端做 git hook主要是用 pre-commit 这个钩子。前端项目中常见的 husky 就是基于此实现的。但缺点也很明显就是在本地把这个钩子删了、或者 git commit --no-verify 就绕开了。不过小团队、大家约定好的话这种方案是最方便的。 2、在服务端做 git hook主要是用 pre-receive 这个钩子。 3、不限制 push、但通过其他方式限制。比如可以通过 CI 限制例如在 forking-workflow 模式中设置在 Merge 时自动执行一个 Actions 来执行 Lint对于不合格的 Merge Request 直接关闭掉不允许合并以变相到达不合格代码进入主干的目的。 其中 1、2 两点跟 GitLab 无关需要的都是写 Shell 脚本而已。第 3 种可以在 GitLab 用图形化方式设置。 小团队的第一种用的比较多大团队这一步骤大多是跟 CI/CD 工作流紧密结合的。 我们用的方式是第一种在客户端校验加上checkStyle 工具包checkStyle可以直接在IDEA插件中搜索。 下载Checkstyle jar包 官网地址,GitHulb,目前最近版本为checkstyle-8.12-all.jar
下载对应的规范约束xml文件目前主要是有三种Alibaba_check.xml、sun_checks.xml 和google_checks.xml
我们用的完整的规范如下
?xml version1.0?
!DOCTYPE module PUBLIC-//Puppy Crawl//DTD Check Configuration 1.3//ENhttp://www.puppycrawl.com/dtds/configuration_1_3.dtd
!--文件描述阿里巴巴代码规范完整版--
!--创建日期20230203--
!--创建人QC班长--
module nameChecker!-- 检查文件是否以一个空行结束 --module nameNewlineAtEndOfFile/!-- 长度检查 --!-- 每行不超过120个字符 --module nameLineLengthproperty namemax value120 //module!-- 文件长度不超过1500行 --module nameFileLengthproperty namemax value1500//module!-- 每个java文件一个语法树 --module nameTreeWalker!-- import检查--!-- 避免使用* --
!-- module nameAvoidStarImport--
!-- property nameexcludes valuejava.io,java.net,java.lang.Math/--
!-- lt;!ndash; 实例import java.util.*;.ndash;gt;--
!-- property nameallowClassImports valuefalse/--
!-- lt;!ndash; 实例 import static org.junit.Assert.*;ndash;gt;--
!-- property nameallowStaticMemberImports valuetrue/--
!-- /module--!-- 检查是否从非法的包中导入了类 --module nameIllegalImport/!-- 检查是否导入了多余的包 --module nameRedundantImport/!-- 没用的import检查比如1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 --module nameUnusedImports /!-- 注释检查 --!-- 检查方法和构造函数的javadoc --module nameJavadocTypeproperty nameallowUnknownTags valuetrue/message keyjavadoc.missing value类注释缺少Javadoc注释。//module!-- 命名检查 --!-- 局部的final变量包括catch中的参数的检查 --module nameLocalFinalVariableName /!-- 局部的非final型的变量包括catch中的参数的检查 --module nameLocalVariableName /!-- 包名的检查只允许小写字母默认^[a-z](\.[a-zA-Z_][a-zA-Z_0-9_]*)*$ --module namePackageNameproperty nameformat value^[a-z](\.[a-z][a-z0-9]*)*$ /message keyname.invalidPattern value包名 {0} 要符合 {1}格式.//module!-- 仅仅是static型的变量不包括static final型的检查 --module nameStaticVariableName /!-- Class或Interface名检查默认^[A-Z][a-zA-Z0-9]*$--module nameTypeNameproperty nameseverity valuewarning/message keyname.invalidPattern value名称 {0} 要符合 {1}格式.//module!-- 非static型变量的检查 --module nameMemberName /!-- 方法名的检查 --module nameMethodName /!-- 方法的参数名 --module nameParameterName /!-- 常量名的检查只允许大写默认^[A-Z][A-Z0-9]*(_[A-Z0-9])*$ --module nameConstantName /!-- 定义检查 --!-- 检查数组类型定义的样式 --module nameArrayTypeStyle/!-- 检查long型定义是否有大写的“L” --module nameUpperEll/!-- 方法不超过50行 --module nameMethodLengthproperty nametokens valueMETHOD_DEF /property namemax value50 //module!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查--module nameParameterNumberproperty namemax value5 /property nameignoreOverriddenMethods valuetrue/property nametokens valueMETHOD_DEF //module!-- 空格检查--!-- 方法名后跟左圆括号( --module nameMethodParamPad /!-- 在类型转换时不允许左圆括号右边有空格也不允许与右圆括号左边有空格 --module nameTypecastParenPad /!-- 检查在某个特定关键字之后应保留空格 --module nameNoWhitespaceAfter/!-- 检查在某个特定关键字之前应保留空格 --module nameNoWhitespaceBefore/!-- 操作符换行策略检查 --module nameOperatorWrap/!-- 圆括号空白 --module nameParenPad/!-- 检查分隔符是否在空白之后 --module nameWhitespaceAfter/!-- 检查分隔符周围是否有空白 --module nameWhitespaceAround/!-- 修饰符检查 --!-- 检查修饰符的顺序是否遵照java语言规范默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp --module nameModifierOrder/!-- 检查接口和annotation中是否有多余修饰符如接口方法不必使用public --module nameRedundantModifier/!-- 代码块检查 --!-- 检查是否有嵌套代码块 --module nameAvoidNestedBlocks/!-- 检查是否有空代码块 --module nameEmptyBlock/!-- 检查左大括号位置 --module nameLeftCurly/!-- 检查代码块是否缺失{} --module nameNeedBraces/!-- 检查右大括号位置 --module nameRightCurly/!-- 代码检查 --!-- 检查空的代码段 --module nameEmptyStatement/!-- 检查在重写了equals方法后是否重写了hashCode方法 --module nameEqualsHashCode/!-- 检查局部变量或参数是否隐藏了类中的变量 --module nameHiddenFieldproperty nametokens valueVARIABLE_DEF//module!-- 检查是否使用工厂方法实例化 --module nameIllegalInstantiation/!-- 检查子表达式中是否有赋值操作 --module nameInnerAssignment/!-- 检查是否有魔术数字 --module nameMagicNumberproperty nameignoreNumbers value0, 1/property nameignoreAnnotation valuetrue//module!-- 检查switch语句是否有default --module nameMissingSwitchDefault/!-- 检查是否有过度复杂的布尔表达式 --module nameSimplifyBooleanExpression/!-- 检查是否有过于复杂的布尔返回代码段 --module nameSimplifyBooleanReturn/!-- 类设计检查 --!-- 检查类是否为扩展设计l --!-- 检查只有private构造函数的类是否声明为final --module nameFinalClass/!-- 检查工具类是否有putblic的构造器 --module nameHideUtilityClassConstructor/!-- 检查接口是否仅定义类型 --module nameInterfaceIsType/!-- 检查类成员的可见度 检查类成员的可见性。只有static final 成员是public的除非在本检查的protectedAllowed和packagedAllowed属性中进行了设置--module nameVisibilityModifierproperty namepackageAllowed valuetrue/property nameprotectedAllowed valuetrue//module!-- 语法 --!-- String的比较不能用! 和 --module nameStringLiteralEquality/!-- 限制for循环最多嵌套2层 --module nameNestedForDepthproperty namemax value2//module!-- if最多嵌套3层 --module nameNestedIfDepthproperty namemax value3//module!-- 检查未被注释的main方法,排除以Appllication结尾命名的类 --module nameUncommentedMainproperty nameexcludedClasses value.*Application$//module!-- 禁止使用System.out.println --module nameRegexpproperty nameformat valueSystem\.out\.println/property nameillegalPattern valuetrue//module!-- return个数 3个--module nameReturnCountproperty namemax value3//module!--try catch 异常处理数量 3--module nameNestedTryDepth property namemax value3//module!-- clone方法必须调用了super.clone() --module nameSuperClone /!-- finalize 必须调用了super.finalize() --module nameSuperFinalize //module
/moduleIDEA中的配置
代码规范检测工具配置 打开file -- settings,找到Plugins ,输入 checkStyle-IDEA,点击install 安装 考虑到CheckStyle提供的校验规则很严格这里我们用自定义的校验规则[alibaba-checks.xml] 打开file -- settings,找到Tools ,可以看到安装好的 checkstyle,Configuration File--点击➕添加项目中的配置文件选择checks/alibaba-checks.xml文件输入名称点击下一步完成。 这样子就好了不符合规范的代码会直接标红显示 参考文献 1、java代码提交到git服务器如何能自动检查代码规范 - SegmentFault 思否
2、git下使用checkstyle构建代码风格检查_唯一昵称真难的博客-CSDN博客_checkstylegit
3、符合阿里巴巴代码规范的checkstyle检测文件_KimZing的博客-CSDN博客
4、pre-commit
5、使用 pre-commit 实现代码检查_清欢守护者的博客-CSDN博客
