From 294c46f835eb2aa4c581c01036c57d73bef68816 Mon Sep 17 00:00:00 2001
From: lishouyu <18332763730@163.com>
Date: Wed, 27 Sep 2017 16:12:57 +0800
Subject: [PATCH] =?UTF-8?q?=E5=A2=9E=E5=8A=A0=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 CheckStyle.xml                                | 245 ++++++++++++++++++
 .../fast/common/config/package-info.java      |   3 +
 2 files changed, 248 insertions(+)
 create mode 100644 CheckStyle.xml

diff --git a/CheckStyle.xml b/CheckStyle.xml
new file mode 100644
index 0000000..c4cdfb9
--- /dev/null
+++ b/CheckStyle.xml
@@ -0,0 +1,245 @@
+<?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">
+    <!--
+        If you set the basedir property below, then all reported file
+        names will be relative to the specified directory. See
+        http://checkstyle.sourceforge.net/5.x/config.html#Checker
+
+        <property name="basedir" value="${basedir}"/>
+    -->
+
+    <!-- 检查每个包中是否有java注释文件，默认有package-info.java -->
+    <!-- <module name="JavadocPackage"/> -->
+
+    <!-- 检查文件是否以一个空行结束 -->
+    <module name="NewlineAtEndOfFile"/>
+
+    <!-- 检查property文件中是否有相同的key -->
+    <module name="Translation"/>
+
+    <!-- 文件长度不超过1500行 --> 
+    <module name="FileLength">
+        <property name="max" value="1500"/>
+     </module>
+    
+    <!-- 检查文件中是否含有'\t' -->
+    <module name="FileTabCharacter"/>
+
+    <!-- Miscellaneous other checks. -->
+    <module name="RegexpSingleline">
+       <property name="format" value="\s+$"/>
+       <property name="minimum" value="0"/>
+       <property name="maximum" value="0"/>
+       <property name="message" value="Line has trailing spaces."/>
+    </module>
+
+
+    
+
+    <!-- 每个java文件一个语法树 -->
+    <module name="TreeWalker">
+        <!-- 注释检查 -->
+        <!-- 检查方法和构造函数的javadoc -->
+        <module name="JavadocMethod">
+            <property name="tokens" value="METHOD_DEF" />
+            
+        </module>
+        <!-- 检查类和接口的javadoc。默认不检查author和version tags -->
+        <module name="JavadocType"/>
+        <!-- 检查变量的javadoc -->
+        <module name="JavadocVariable"/>
+        <!-- 检查javadoc的格式 -->
+        <module name="JavadocStyle">
+           <property name="checkFirstSentence" value="false"/>
+        </module>
+        <!-- 检查TODO:注释 -->
+        <module name="TodoComment"/>
+
+        <!-- 命名检查 --> 
+        <!-- 局部的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"/>
+        <!-- 检查方法名、构造函数、catch块的参数是否是final的 -->
+        <!-- <module name="FinalParameters"/> -->
+        <!-- 检查long型定义是否有大写的“L” -->
+        <module name="UpperEll"/>
+        
+
+        <!-- Checks for Headers                                -->
+        <!-- See http://checkstyle.sf.net/config_header.html   -->
+        <!-- <module name="Header">                            -->
+            <!-- The follow property value demonstrates the ability     -->
+            <!-- to have access to ANT properties. In this case it uses -->
+            <!-- the ${basedir} property to allow Checkstyle to be run  -->
+            <!-- from any directory within a project. See property      -->
+            <!-- expansion,                                             -->
+            <!-- http://checkstyle.sf.net/config.html#properties        -->
+            <!-- <property                                              -->
+            <!--     name="headerFile"                                  -->
+            <!--     value="${basedir}/java.header"/>                   -->
+        <!-- </module> -->
+
+        <!-- Following interprets the header file as regular expressions. -->
+        <!-- <module name="RegexpHeader"/>                                -->
+
+
+        <!-- import检查-->
+        <!-- 避免使用* -->
+        <module name="AvoidStarImport"/>
+        <!-- 检查是否从非法的包中导入了类 -->
+        <module name="IllegalImport"/>
+        <!-- 检查是否导入了多余的包 -->
+        <module name="RedundantImport"/>
+        <!-- 没用的import检查，比如：1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->   
+        <module name="UnusedImports" />
+
+        <!-- 长度检查 --> 
+        <!-- 每行不超过150个字符 -->
+        <module name="LineLength">
+            <property name="max" value="150" />   
+        </module> 
+        <!-- 方法不超过150行 -->   
+        <module name="MethodLength">   
+            <property name="tokens" value="METHOD_DEF" />   
+            <property name="max" value="150" />   
+        </module>
+        <!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->   
+        <module name="ParameterNumber">   
+            <property name="max" value="10" />   
+            <property name="ignoreOverriddenMethods" value="true"/>
+            <property name="tokens" value="METHOD_DEF" />   
+        </module> 
+
+        <!-- 空格检查-->  
+        <!-- 方法名后跟左圆括号"(" -->   
+        <module name="MethodParamPad" />   
+        <!-- 在类型转换时，不允许左圆括号右边有空格，也不允许与右圆括号左边有空格 -->   
+        <module name="TypecastParenPad" />
+        <!-- Iterator -->
+        <!-- <module name="EmptyForIteratorPad"/> -->
+        <!-- 检查尖括号 -->
+        <!-- <module name="GenericWhitespace"/> -->
+        <!-- 检查在某个特定关键字之后应保留空格 -->
+        <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="AvoidInlineConditionals"/> -->
+        <!-- 检查空的代码段 -->
+        <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 -->
+        <!-- <module name="DesignForExtension"/> -->
+        <!-- 检查只有private构造函数的类是否声明为final -->
+        <module name="FinalClass"/>
+        <!-- 检查工具类是否有putblic的构造器 -->
+        <module name="HideUtilityClassConstructor"/>
+        <!-- 检查接口是否仅定义类型 -->
+        <module name="InterfaceIsType"/>
+        <!-- 检查类成员的可见度 -->
+        <module name="VisibilityModifier"/>
+        
+
+        <!-- 其他检查 -->
+        <!-- 文件中使用了System.out.print等
+        <module name="GenericIllegalRegexp">
+            <property name="format" value="System\.out\.print"/>
+        </module>
+        <module name="GenericIllegalRegexp">
+            <property name="format" value="System\.exit"/>
+        </module>
+        <module name="GenericIllegalRegexp">
+            <property name="format" value="printStackTrace"/>
+        </module>-->
+        
+
+        <!-- 代码质量 -->
+        <!-- 圈复杂度
+        <module name="CyclomaticComplexity">
+              <property name="max" value="2"/>
+        </module> -->
+    </module>
+
+</module>
\ No newline at end of file
diff --git a/common/src/main/java/com/micro/fast/common/config/package-info.java b/common/src/main/java/com/micro/fast/common/config/package-info.java
index 742daed..bc163f4 100644
--- a/common/src/main/java/com/micro/fast/common/config/package-info.java
+++ b/common/src/main/java/com/micro/fast/common/config/package-info.java
@@ -1 +1,4 @@
+/**
+ * ssm配置包
+ */
 package com.micro.fast.common.config;
\ No newline at end of file