普通而抽象的思想是人类铸成大错的根源。——卢俊
收到个pr
:https://gitee.com/dromara/stream-query/pulls/301
给项目添加了checkstyle
,非常的nice
主要是配置了maven
插件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 <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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 <?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 > <module name ="TreeWalker" > <module name ="RedundantImport" /> <module name ="UnusedImports" /> <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 > <module name ="LocalFinalVariableName" /> <module name ="LocalVariableName" /> <module name ="PackageName" > <property name ="format" value ="^[a-z]+(\.[a-z][a-z0-9]*)*$" /> <message key ="name.invalidPattern" value ="包名 ''{0}'' 要符合 ''{1}''格式." /> </module > <module name ="StaticVariableName" /> <module name ="TypeName" > <property name ="severity" value ="warning" /> <message key ="name.invalidPattern" value ="名称 ''{0}'' 要符合 ''{1}''格式." /> </module > <module name ="MemberName" /> <module name ="MethodName" /> <module name ="ParameterName " /> <module name ="ConstantName" /> <module name ="ArrayTypeStyle" /> <module name ="UpperEll" /> <module name ="MethodLength" > <property name ="tokens" value ="METHOD_DEF" /> <property name ="max" value ="50" /> </module > <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" /> <module name ="ModifierOrder" /> <module name ="RedundantModifier" /> <module name ="AvoidNestedBlocks" /> <module name ="EmptyBlock" /> <module name ="LeftCurly" /> <module name ="RightCurly" /> <module name ="NeedBraces" /> <module name ="EmptyStatement" /> <module name ="EqualsHashCode" /> <module name ="IllegalInstantiation" /> <module name ="MissingSwitchDefault" /> <module name ="SimplifyBooleanExpression" /> <module name ="SimplifyBooleanReturn" /> <module name ="VisibilityModifier" > <property name ="packageAllowed" value ="true" /> <property name ="protectedAllowed" value ="true" /> </module > <module name ="StringLiteralEquality" /> <module name ="NestedForDepth" > <property name ="max" value ="2" /> </module > <module name ="NestedIfDepth" > <property name ="max" value ="3" /> </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 ="NestedTryDepth " > <property name ="max" value ="3" /> </module > <module name ="SuperClone" /> <module name ="SuperFinalize" /> </module > </module >
还有LICENCE
校验checkstyle-header.txt
:
之后就可以使用mvn checkstyle:checkstyle
进行代码审查啦!