日期：2014/5/9

文：阿蜜果

         为便于规范各位开发人员代码、提高代码质量，研发中心需要启动代码评审机制。为了加快代码评审的速度，减少不必要的时间，可以加入一些代码评审的静态检查工具，另外需要为研发中心配置统一的编码模板和代码格式化模板。
      java代码规范、格式化和checkstyle检查配置文档下载地址：代码规范、格式化和checkstyle检查配置文档.rar

java代码规范、格式化和checkstyle检查配置文档 -凯发k8网页登录

1.1 配置编码模板

  在eclipse或myeclipse中点击window -> preferences菜单，点击左侧的“java”->“code style”->“code templates”，界面如下图所示：  
   

         点击上图右侧的“import”按钮，在弹出的文件选择窗口选择公司自己的编码模板，例如eclipse_templates.xml文件（仅提供参考，可自行修改）。在“configure generated code and comments”区域有“comments”和“code”两个菜单，点开后可以看到各种类型的注释和编码模板定义：
     
       

         可以点击上面的各种类型查看该模板文件的定义。

例如文件注释定义：
   

文件注释定义中的文件作者取自所在系统登录用户，若不正确时，可点击“edit”按钮后进行修改。

选择编码模板文件完成后点击下方的“apply”按钮应用该模板文件，而后点击“ok”按钮完成设置。

1.2 使用编码模板

1.2.1 创建类时自动添加注释

         在创建类时，勾选如下页面的“generate comments”选项，将会使新创建的类具有文件注释和类注释：     
      

         生成的类的内容参考如下：

/**//*
 * xx公司源代码，凯发k8网页登录的版权归xx公司所有。
 * 
 * 项目名称 : xxxxxxx
 * 创建日期 : may 9, 2014
 * 修改历史 : 
 *     1. [may 9, 2014]创建文件 by xingxing,xie
 */
package cn.amigo.eip.common;
/** *//**
 * //todo 添加类/接口功能描述
 * @author xingxing,xie
 */
public class commenttest {
 
    /** *//**
     * //todo 添加方法功能描述
     * @param args
     */
    public static void main(string[] args) {
        // todo auto-generated method stub
    }
}

1.2.2 对已有类添加注释

         对已有的类、方法添加注释的方法：

   1） 选择类的类名、方法名所在的行后，使用“alt shift j”快捷键；

   2） 在所在类或方法上输入“/**”后按enter键。

2.1 配置代码格式化模板

在eclipse或myeclipse中点击window -> preferences菜单，点击左侧的“java”->“code style”->“formatter”，界面如下图所示：   
      

点击上图的“import”按钮，弹出格式化模板文件选择框，选择代码格式化文件，例如eclipse_formatter-profile.xml文件（仅提供参考，可自行定义）。点击下方的“apply”按钮应用该模板文件，而后点击“ok”按钮完成设置。

在格式化文件中定义了很多java格式化规范，例如：

上行用于设置格式化时在一行达到150个字符（包括空格）时需要换行。

又如：

上行表示格式化时使用4个空格代替tab键。

有兴趣的人可以查看《eip_eclipse_formatter-profile.xml》文件的内容。

2.2 配置使用4个空格代替tab键

tab键在不同的ide、编辑器（例如editplus、ultraedit等）中使用的空格数不同，因此为了统一，开发人员统一使用4个空格代替tab键（checkstyle会配置做相应检查）。

在eclipse或myeclipse中点击window -> preferences菜单，点击左侧的“general”->“editors”->“text editors”，界面如下图所示： 
    

         在上图中勾选“insert spaces for tabs”（使用空格代替tab键），并设置“displayed tab width”为4（即使用4个空格代替tab键）。

2.3 去掉对代码注释的格式化

         在使用“2.4 使用模板进行格式化”进行代码格式化时，会将代码注释也进行格式化，引起格式错乱，为避免其对注释进行格式化，采用的方法为：点击“java”->“code style”-> “formatter”菜单，在右侧选中模板后点击“edit”按钮，在弹出的界面中选择“comments”的tab，如下图所示：
     

         在上图中对红色区域的复选框取消勾选。

2.4 使用模板进行格式化

         若要对某个文件进行格式化，可使用如下几种方法：

1） 打开文件后，在代码区域采用“ctrl shift f”快捷键；

2） 打开文件后，在代码区域点击右键选择“source”->“format”功能。

    【说明】建议采用“ctrl shift f”快捷键。

3.1 安装eclipse的checkstyle插件

可以从sourceforge网站下载插件，网址如下：

         该页面有3.3.1 ～ 5.7.0版本的checkstyle插件，因为5.0以上版本的checkstyle插件在笔者的myeclipse 6.5版本上无法使用，所以下载的4.4.2版本，高版本的myeclipse可尝试新版本的checkstyle试试是否能成功使用。

安装checkstyle插件的方法主要有如下三种：

一、在eclipse下使用link方式链接插件

在某个目录（eg. d:\program files (x86)\externalplugins）创建checkstyle\eclipse子目录，将之前下载的插件下的features和plugins两个文件下拷贝到该目录下（eg: d:\program files (x86)\externalplugins\checkstyle\eclipse）。

接着在eclipse的links目录下新建checkstyle.xml文件，在该文件中添加一行写上需要链接的插件地址，例如：path=d:/program files (x86)/externalplugins/checkstyle。

【说明】此种方式便于管理外部eclipse插件。

二、下载checkstyle插件文件夹后拷贝到eclipse的和features和plugins目录

此种方式将下载的checkstyle插件的features目录下的内容拷贝到eclipse下的features目录，将将下载的checkstyle插件的plugins目录下的内容拷贝到eclipse下的plugins目录。

三、使用 “software updates”->“find and install”指定网址安装插件。

点击eclipse或myeclipse的“help”->“software updates”->“find and install”，在弹出的窗口中选择“search for new features to install”单选框，接着在“update sites to visit”窗口点击“new remote site”按钮，在该窗口输入插件名称和插件下载地址后点击“ok”按钮完成下载。

3.2 设置checkstyle配置文件

         checkstyle插件安装完成后，需要配置研发中心的checkstyle配置文件，配置文件参考《eclipse_checkstyle.xml》文件，该文件定义了研发中心需要用到的一些检查规则。检查项都加了注释，具体内容请参见附录。

         点击“window”->“preferences”菜单，在弹出窗口左侧点击“checkstyle”，可看到右侧默认选中的是“sun checks”检查规则，因为该规则要求比较严格，而且不适合本研发中心，所以需要自定义检查文件。

         点击“new”按钮后，弹出“check configuration properties”窗口，如下图所示：
         

         在上图中选择“type”为“external configuration file”（外部配置文件），在“location”行点击“browse”按钮浏览选择checkstyle的配置文件，例如eclipse_checkstyle.xml文件（仅供参考，可自行定义），并输入“name”行的值，例如“eclipse_checkstyle”，点击“ok”按钮完成导入操作。回到checkstyle凯发k8网页登录主页面选择刚才添加的文件，点击“set as default”将其设置为默认checkstyle检查文件。

3.3 使用checkstyle

         选择某个项目，点击右键选择“checkstyle”，会出现如下菜单：

   1） configure project(s) from blueprint：指定工程加入checkstyle检查；

   2） activate checkstyle：激活checkstyle；

   3） deactivate checkstyle：取消激活checkstyle；

   4） check code with checkstyle：使用checkstyle检查代码；

   5） clear checkstyle violations：去掉checkstyle的检查提示。

  选择“check code with checkstyle”对所选中的项目进行检查，检查后对有问题的类会使用警告或错误标识。参考提示信息如下：   
     

         左侧会显示小圆圈，将鼠标移动到上面时将给出提示信息。

         使用checkstyle后，注释、变量命名规范性、类中变量、构造函数、方法的顺序的检查、行的长度、文件的长度、方法的长度等都不需要手工进行检查，只需要在代码评审时使用checkstyle检查即可。因此，让代码评审人员将侧重点放在checkstyle检查不出来的一些代码的优化问题。

3.4 checkstyle常见提示速查

         checkstyle常见错误和警告提示见下表所示：

4.1 eclipse_checkstyle.xml文件内容

         checkstyle配置文件eclipse_checkstyle如下所示：

xml version="1.0"?>
doctype module public
          "-//puppy crawl//dtd check configuration 1.2//en"
          "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">

<module name="checker">
         <property name="severity" value="warning"/>
    <module name="strictduplicatecode">
        <property name="charset" value="utf-8" />   
    module>   

    <module name="treewalker">   
           
           
        <module name="javadoctype" />   

           
           
        <module name="localfinalvariablename" />   
           
        <module name="localvariablename" />   
           
        <module name="packagename">   
            <property name="format" value="^[a-z] (\.[a-z][a-z0-9]*)*$" />   
        module>   
           
        <module name="staticvariablename" />   
           
        <module name="typename" />   
           
        <module name="membername" />   
           
        <module name="methodname" />   
           
        <module name="parametername " />   
           
        <module name="constantname" />
           
        <module name="unusedimports" />   

           
           
        <module name="filelength">   
            <property name="max" value="1500" />   
        module>   
           
        <module name="linelength">   
            <property name="max" value="150" />   
        module>   
           
        <module name="methodlength">   
            <property name="tokens" value="method_def" />   
            <property name="max" value="150" />   
        module>   
           
        <module name="parameternumber">   
            <property name="max" value="5" />   
            <property name="tokens" value="method_def" />   
        module>   

           
           
        <module name="methodparampad" />   
           
        <module name="typecastparenpad" />

           
           
        <module name="modifierorder" />   
           
        <module name="redundantmodifier" />   

           
           
        <module name="emptyblock" />   
           
        <module name="needbraces" />
           
        <module name="avoidnestedblocks">   
            <property name="allowinswitchcase" value="true" />   
        module>   

           
           
        <module name="emptystatement" /> 
           
        <module name="magicnumber">   
            <property name="tokens" value="num_double, num_int" />   
        module>
           
        <module name="redundantthrows" /> 
           
        <module name="stringliteralequality" />   
           
        <module name="nestedifdepth">   
            <property name="max" value="3" />   
        module>   
           
        <module name="nestedtrydepth">   
            <property name="max" value="2" />   
        module>   
           
        <module name="superclone" />   
           
        <module name="superfinalize" />   
           
        <module name="illegalcatch">   
            <property name="illegalclassnames" value="java.lang.exception" />  
        module>   
           
        <module name="packagedeclaration" />   
           
        <module name="returncount">   
            <property name="max" value="3" />   
            <property name="format" value="^$" />   
        module>   
           
        <module name="declarationorder" /> 
           
        <module name="multiplevariabledeclarations" />   
           
        <module name="unnecessaryparentheses" />    

           
           
        <module name="genericillegalregexp">   
            <property name="format" value="system\.out\.println" />   
            <property name="ignorecomments" value="true" />
        module>
           
        <module name="upperell" />   
           
        <module name="arraytypestyle" />
           
        <module name="indentation" />   
    module> 
module>