1

轻松写出优雅的 Java 代码之 CheckStyle

西铭（李振华）

2010-12-30

2

目录

1

•你准备好了吗？

2

•Windows环境搭建。

3

•Linux环境搭建

4

•Windows开发环境上安装Eclipse Plugin

5

•第一个Map/Reduce Project

6

•Debug你的Map/Reduce程序

3

1. 你准备好了吗？ 操作系统

Windows Java SE Development Kit （ JDK ）

下载： http://java.sun.com/javase/downloads/widget/jdk6.jsp

需要下载 Windows 32bit 版本 Eclipse Galileo 版

下载： http://www.eclipse.org/downloads/ 需要下载 Eclipse IDE for Java Developers For Windows 32bit 版本

CheckStyle 5.3 官方版下载：

http://sourceforge.net/projects/checkstyle/files/http://checkstyle.sourceforge.net/config_javadoc.html

4

2.Windows Eclipse 开发环境搭建1. 下载并安装配置 JDK ，操作（略）2. 下载 Eclipse ，解压缩到本地磁盘目录下，启动 Eclipse ，准备安装

CheckStyle Plugin3. CheckStyle 安装 url http://eclipse-cs.sf.net/update

5

2.Windows Eclipse 开发环境搭建4. 安装好 CheckStyle 插件后，重启 Eclipse ，开始设置 CheckStyle5. 如图打开 Preferences 窗口，设置 CheckStyle ，默认情况有 2 个配置文件 Sun Checks 和 Sun Checks (Eclipse) ，这两个配置是按照 Sun Java 语言标准规范进行设定的，对于大多数程序开发人员来说非常严格， 我们可以根据官方配置自定义适合我们的配置6. 有了自己定义的配置之后，可以导入到 eclipse 中，并且 Set as Default. 可以使用我配置好的 taobao-checker-1.0.1.xml

6

2.Windows Eclipse 开发环境搭建7. 配置好 CheckStyle 之后，就可以在项目中使用了。 CheckStyle Builder 会帮助我们自动检测 Java 代码中不符合规范的部分，

并且会有详细的提示，在你修改好代码后，保存代码， CheckStyle Builder会自动重新 Check ，非常方便。

8. 也可以用右键菜单中的 Check 选项来重新检查整个项目和类

7

2.Windows Eclipse 开发环境搭建9. 修改 Eclipse Java Code Style Formatter 配置，由于 Eclipse 默认设置换行

后的缩进符号为 tab ，而 Java 规范不允许代码中有 tab ，因为 tab 在不同的操作系统下的长度占位不同，有的是 4 个空格，有的是 8 个空格，因此我们要修改这个配置为空格。

8

2.Windows Eclipse 开发环境搭建10. 打开 Eclipse Java Code Style Formatter 配置，点击 New 按钮，新增自

己定义的配置，在 Indentation 面板的 Tab policy 中选择 Spaces Only ，然后保存。

9

3. 编写优雅的 Java 代码现在开始，编写优雅的 java 代码将会变得非常轻松，让我们一起 Happy 吧！