Java 使用 Google 代码风格

2016/01/01 Java

Eclipse 中配置使用 Google 代码风格。

下载

下载代码格式xml配置文件 eclipse-java-google-style.xml

配置

Eclipse 里倒入配置文件

导入方法:Eclipse->window->preferences->Java->Code Style->Formatter->Import 选择eclipse-java-google-style.xml文件。

点击apply,ok就行了。这样就可以选中代码进行格式化(默认快捷键是Ctrl+Shift+F),用以保持代码风格一致。 默认的缩进是2格,一般习惯都是四格的缩进,可以在edit里面修改一下:

Maven 插件配置(可选)

如果是maven项目可以配置maven-checkstyle-plugin插件 在pom.xml中添加如下插件(与build节点同级):

<reporting>
     	<plugins>
     		 <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-checkstyle-plugin</artifactId>
             <version>2.15</version>
             <configuration>
                  <configLocation>eclipse-java-google-style.xml</configLocation>
             </configuration>
         </plugin>
         <plugin>  
              <groupId>org.apache.maven.plugins</groupId>  
              <artifactId>maven-jxr-plugin</artifactId>  
              <version>2.3</version>  
          </plugin>  
     	</plugins>
     </reporting>

其中可以修改使用的检查规则文件路径,插件默认提供了四个规则文件可以直接使用,,它们分别是:

* config/sun_checks.xml - Sun Microsystems Definition (default).  
* config/maven_checks.xml - Maven Development Definitions.  
* config/turbine_checks.xml - Turbine Development Definitions.  
* config/avalon_checks.xml - Avalon Development Definitions.  

这里使用自定义的规则,将下载的 eclipse-java-google-style.xml 放到 src/main/resources 目录下

这个插件支持的命令如下:

mvn checkstyle:help           查看checkstyle-plugin的帮助:   
mvn checkstyle:check          检查工程是否满足checkstyle的检查,如果没有满足,检查会失败,可以通过target/site/checkstyle.html查看。  
mvn checkstyle:checkstyle     检查工程是否满足checkstyle的检查,如果没有满足,检查不会失败,可以通过target/site/checkstyle.html查看。  
mvn checkstyle:checkstyle-aggregate     检查工程是否满足checkstyle的检查,如果没有满足,检查不会失败,可以通过target/site/checkstyle.html查看。  

在运行完“mvn checkstyle:checkstyle”命令后,可以运行”mvn jxr:jxr”来使checkstyle的结果可以直接跳转到代码行位置。

Search

    Table of Contents