Java开发规范(编程风格).pdf

《Java开发规范(编程风格).pdf》由会员分享，可在线阅读，更多相关《Java开发规范(编程风格).pdf（37页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、Java 开发规范 Java 开发规范 Java Development Specification 版本 2.0 版本 2.0 当前版本 2.0alpha 制定日期 2004-07-18 文档编号 Java_Dev_Spec 文档作者 韩卿(l_walker)电子邮件 walkerskyinn.org Skyinn Group(http:/www.skyinn.org)Skyinn Group(http:/www.skyinn.org)文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 修订历史记录 修订历史记录 日期 日期 版

2、本 版本 说明 说明 作者 作者 2002-9-7 1.0 创建文件 韩卿 2002-9-8 1.0 修改、增加 韩卿 2002-9-9 1.0 完成 韩卿 2003-1-19 1.0 更新 韩卿 2003-05-28 1.1 修改并完成 韩卿 2004-7-3 2.0 修改版式 韩卿 2004-7-11 20 更新文档 韩卿 2004-7-18 2.0 alpha 更新并发布 韩卿 共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 2 页/共 2 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java

3、_Dev_Spec 日期 2004-7-18 目录 目录 第第 1 章章 绪论绪论.5 1.1 目的目的.5 1.2 范围范围.5 1.3 版权声明版权声明.5 1.4 参考资料参考资料.5 1.5 概述概述.5 第第 2 章章 代码组织与风格代码组织与风格.7 2.1 基本原则基本原则.7 2.2 缩进缩进.7 2.3 长度长度.7 2.4 行宽行宽.7 2.5 间隔间隔.7 2.6 对齐对齐.7 2.7 括号括号.8 第第 3 章章 注释注释.9 3.1 基本原则基本原则.9 3.2 JAVADOC.9 3.3 文件与包注释文件与包注释.9 3.4 类、接口注释类、接口注释.10 3.5

4、方法注释方法注释.10 3.6 其他注释其他注释.11 3.7 注释参考表注释参考表.11 第第 4 章章 命名命名.13 4.1 基本原则基本原则.13 4.2 文件、包文件、包.13 4.3 类、接口类、接口.13 4.4 字段字段.14 4.5 方法方法.14 4.6 异常异常.15 4.7 命名约定表命名约定表.15 第第 5 章章 声明声明.17 5.1 基本原则基本原则.17 5.2 包包.17 5.3 类、接口类、接口.17 5.4 方法方法.17 5.5 字段字段.18 5.6 示例示例.18 第第 6 章章 类与接口类与接口.20 6.1 基本原则基本原则.20 6.2 抽象

5、类与接口抽象类与接口.20 6.3 继承与组合继承与组合.20 共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 3 页/共 3 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 6.4 构造函数和静态工厂方法构造函数和静态工厂方法.20 6.5 TOSTRING(),EQUALS(),HASHCODE().20 6.6 SINGLETON CLASS.22 第第 7 章章 方法方法.23 7.1 基本原则基本原则.23 7.2 参数和返回值参数和返回值

6、.23 第第 8 章章 表达式与语句表达式与语句.24 8.1 基本原则基本原则.24 8.2 控制语句控制语句.24 8.3 循环语句循环语句.25 第第 9 章章 错误与异常错误与异常.26 9.1 基本原则基本原则.26 9.2 已检查异常与运行时异常已检查异常与运行时异常.26 9.3 异常的捕捉与处理异常的捕捉与处理.26 第第 10 章章 测试与测试与BUG跟踪跟踪.27 10.1 基本原则基本原则.27 10.2 测试驱动开发测试驱动开发.27 10.3 JUNIT单元测试单元测试.27 10.4 自动测试与持续集成自动测试与持续集成.27 10.5 BUG跟踪和缺陷处理跟踪和缺

7、陷处理.27 第第 11 章章 性能与安全性能与安全.28 11.1 基本原则基本原则.28 11.2 STRING与与STRINGBUGFFER.28 11.3 集合集合.28 11.4 对象对象.28 11.5 同步同步.28 11.6 FINAL.28 11.7 垃圾收集和资源释放垃圾收集和资源释放.29 第第 12 章章 其他其他.30 12.1 目录结构目录结构.30 12.2 CVS注释与标记注释与标记.31 12.3.31 第第 13 章章 附录附录.32 13.1 CVS标识符标识符.32 13.2 注释模板注释模板.32 13.3 常用缩写简表常用缩写简表.33 13.4 版

8、权声明模板版权声明模板.33 13.5 示例代码示例代码.34 共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 4 页/共 4 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 Java 开发规范 Java 开发规范 第1章 绪论 第1章 绪论 1.1 目的 1.1 目的 本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可

9、维护性和一致性等，增进团队间的交流，并保证软件产品的质量。1.2 范围 1.2 范围 本规范适用于“Skyinn Group”及其下所有软件项目、产品等的设计、开发以及维护、升级等。本规范使用于“Skyinn Group”的所有软件开发人员，在整个软件开发过程中必须遵循此规范。1.3 版权声明 1.3 版权声明 本文档为共享文档，不限转载，但请保持本文档的完整性。您可以修改本文档以符合您或组织、公司等之实际，但请在文档中保持对本文档的引用和说明。未经本人授权，任何个人、组织或单位不得将本文档用于书面发表、转载、摘录等，亦不得用于其他商业行为。本人及本组织不承担任何因使用、参考本文档等而导致的任

10、何可能责任或连带责任。1.4 参考资料 1.4 参考资料 Java 编程指南见 RUP（Rational Unified Process）中文版。Java 技术手册(Java in a Nutshell)Sun Java 语言编码规范(Java Code Conventions)Effictive Java Java Pitfalls Java Rules 1.5 概述 1.5 概述 对于代码，首要要求是它必须正确，能够按照设计预定功能去运行；第二是要求代码必须清晰易懂，使自己和其他的程序员能够很容易地理解代码所执行的功能等。然而，在实际开发中，每个程序员所写的代码却经常自成一套，很少统一，导

11、致理解困难，影响团队的开发效率及系统的质量等。因此，一份完整并被严格执行的开发规范是非常必须的，特别是对软件公司的开发团队而言。此规范参考自业界标准编程规范并结合本人多年编程经验、习惯等而制定，在本人工作过的公司中都曾参考本文档而形成内部开发规范并执行。现在将本文档共享之，希望能对各位有所帮助，并做引玉之砖，希望各位朋友将自己的经验等增补进去，对我们所热爱的软件业有所裨益。最根本的原则：最根本的原则：代码虽然是给机器运行的，但却是给人读的！运用常识。当找不到任何规则或指导方针，当规则明显不能适用，当所有的方法都失效的时 共享 Copyright(C)Skyinn Group,2002-2004

12、 http:/www.skyinn.org 第 5 页/共 5 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 侯：运用常识并核实这些基本原则。这条规则比其它所有规则都重要。常识是必不可少。当出现该情况时，应当及时收集并提交，以便对本规范进行修改。您可以在以下地址中找到本文档的最新版本：http:/www.skyinn.org/wiki/Wiki.jsp?page=JavaDevSpec 本文档尚未完善，我将不断更新之，如果您有任何问题、建议或意见等请联系我：walkerskyinn.org 共享 Copyright(C)

13、Skyinn Group,2002-2004 http:/www.skyinn.org 第 6 页/共 6 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 第2章 代码组织与风格 第2章 代码组织与风格 2.1 基本原则 2.1 基本原则 代码的组织和风格的基本原则是：便于自己的开发，易于与他人的交流。因个人习惯和编辑器等可以设置和形成自己的风格，但必须前后一致，并符合本规范的基本要求和原则。本章所涉及到的内容一般都可在 Java 集成编辑环境中进行相应设置，也可由 Ant 等调用checkstyle 等来进行自动规整。2

14、.2 缩进 2.2 缩进 子功能块当在其父功能块后缩进。当功能块过多而导致缩进过深时当将子功能块提取出来做为子函数。代码中以 TAB（4 个字符）缩进，在编辑器中请将 TAB 设置为以空格替代，否则在不同编辑器 或设置下会导致 TAB 长度不等而影响整个程序代码的格式。例如：Table1缩进示例 public void methodName()if(some condition)for()/some sentences /end for /end if 2.3 长度 2.3 长度 为便于阅读和理解，单个函数的有效代码长度当尽量控制在 100 行以内（不包括注释行），当一个功能模块过大时往往造成

15、阅读困难，因此当使用子函数等将相应功能抽取出来，这也有利于提高代码的重用度。单个类也不宜过大，当出现此类情况时当将相应功能的代码重构到其他类中，通过组合等方式来调用，建议单个类的长度包括注释行不超过 1500 行。尽量避免使用大类和长方法。2.4 行宽 2.4 行宽 页宽应该设置为 80 字符。一般不要超过这个宽度,这会导致在某些机器中无法以一屏来完整显示,但这一设置也可以灵活调整。在任何情况下,超长的语句应该在一个逗号后或一个操作符前折行。一条语句折行后,应该比原来的语句再缩进一个 TAB 或 4 个空格，以便于阅读。2.5 间隔 2.5 间隔 类、方法及功能块间等应以空行相隔，以增加可读性

16、，但不得有无规则的大片空行。操作符两端应当各空一个字符以增加可读性。相应独立的功能模块之间可使用注释行间隔，并标明相应内容，具体参看附录的代码示例 2.6 对齐 2.6 对齐 关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。连续赋值时当对齐操作符。共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 7 页/共 7 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 当方法参数过多时当在每个参数后（逗号后）换行并对齐。当控制或循环中的条件比较长

17、时当换行（操作符前）、对齐并注释各条件。变量定义最好通过添加空格形成对齐，同一类型的变量应放在一起。如下例所示：Table2对齐示例/变量对齐-int count =100;int length =0;String strUserName=null;Integer porductCode=new Integer(2);/产品编码数组 /参数对齐-public Connection getConnection(String url,String userName,String password)throws SQLException,IOException /换行对齐-public final

18、static String SQL_SELECT_PRODUCT=“SELECT*“+“FROM TProduct WHERE Prod_ID=”+prodID;/条件对齐-if(Condition1 /当条件一&Condition2 /并且条件二|Condition3)/或者条件三 for(int i=0;i productCount.length;/循环终止条件 i+)2.7 括号 2.7 括号 中的语句应该单独作为一行，左括号当紧跟其语句后，右括号永远单独作为一行且与其匹配行对齐，并尽量在其后说明其匹配的功能模块。较长的方法以及类、接口等的右括号后应使用/end.等标识其结束。如:类的结

19、束符：/EOC ClassName，方法结束符：/end methodName()，功能块结束：/end if.userName is null?循环快结束：/end for.every user in userList 不要在程序中出现不必要的括号，但有时为了增加可读性和便于理解，当用括号限定相应项。左括号是否换行等随个人习惯而定，若换行则当与其前导语句首字符对齐。共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 8 页/共 8 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec

20、 日期 2004-7-18 第3章 注释 第3章 注释 3.1 基本原则 3.1 基本原则 3.1.1 注释应该增加代码的清晰度。代码注释的目的是要使代码更易于被其他开发人员等理解。3.1.2 如果你的程序不值得注释，那么它很可能也不值得运行。3.1.3 避免使用装饰性内容。3.1.4 保持注释的简洁。3.1.5 注释信息不仅要包括代码的功能，还应给出原因。3.1.6 不要为注释而注释。3.1.7 除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。3.2 JavaDoc 3.2 JavaDoc 对类、方法、变量等的注释需要符合 JavaDoc 规范，对每个类、方法都应详细说

21、明其功能、条件、参数等，并使用良好的 HTML 标记格式化注释，以使生成的 JavaDoc 易阅读和理解。类注释中当包含版本和作者信息，使用 CVS 标记自动跟踪版本变化和修改记录，具体内容参见CVS 使用手册及下面几节的相应内容等，CVS 标识符请参加附录中的CVS 标识符。3.3 文件与包注释 3.3 文件与包注释 在每个文件、包的头部都应该包含该文件的功能、作用、作者、版权以及创建、修改记录等。并在其中使用 CVS 标记自动跟踪版本变化及修改记录等信息。注意是/*/注释而不是/*/JavaDoc 注释。文件注释模板见附件注释模板中的文件注释部分。版权声明部分请参见附件版权声明并注意更新到

22、最新版本。Table3 文件注释示例：/*=*$Id:User.java,v 1.1 2002/09/07 14:36:23 l_walker Exp$*Created:2003-3-23 20:18:53 by l_walker *=*ProjectName *Description *=*Copyright Information.*=*/每个包当有包注释，在源码及 JavaDoc 相应包路径下建立 package.html 以描述包的功能、作用等。共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 9 页/共 9 页

23、文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 3.4 类、接口注释 3.4 类、接口注释 在类、接口定义之前当对其进行注释，包括类、接口的目的、作用、功能、继承于何种父类，实现的接口、实现的算法、使用方法、示例程序等，在作者和版本域中使用 CVS 标记自动跟踪版本变化等，具体参看附件注释模板中相关部分。Table4 类注释示例/*字符串实用类。*定义字符串操作时所需要用到的方法，如转换中文、HTML 标记处理等。*author$Author:l_walker$*version$Revision:1.2$Date:2003/0

24、5/15 02:10:27$*/public class StringUtil 3.5 方法注释 3.5 方法注释 依据标准 JavaDoc 规范对方法进行注释，以明确该方法功能、作用、各参数含义以及返回值等。复杂的算法用/*/在方法内注解出。参数注释时当注明其取值范围等 返回值当注释出失败、错误、异常时的返回情况。异常当注释出什么情况、什么时候、什么条件下会引发什么样的异常 Table5 方法注释示例/*执行查询。*该方法调用 Statement 的 executeQuery(sql)方法并返回 ResultSet*结果集。*param sql 标准的 SQL 语句 *return Resu

25、ltSet 结果集，若查询失败则返回 null *throws SQLException 当查询数据库时可能引发此异常 */public ResultSet executeQuery(String sql)throws SQLException /Statement 和 SQL 语句都不能为空 if(null!=stmt&!StringUtil.isEmpty(sql)/返回查询执行结果 return stmt.executeQuery(sql);return null;/end executeQuery()共享 Copyright(C)Skyinn Group,2002-2004 http:

26、/www.skyinn.org 第 10 页/共 10 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 3.6 其他注释 3.6 其他注释 应对重要的变量加以注释，以说明其含义等。应对不易理解的分支条件表达式加注释。不易理解的循环，应说明出口条件。过长的方法实现，应将其语句按实现的功能分段加以概括性说明。对于异常处理当注明正常情况及异常情况或者条件，并说明当异常发生时程序当如何处理。3.7 注释参考表 3.7 注释参考表 Table6 注释参考表 项目 项目 注释内容 注释内容 参数 参数类型 参数用来做什么 约束或前提条

27、件 示例 字段/属性 字段描述 注释所有使用的不变量 示例 并行事件 可见性决策 类 类的目的 已知的问题 类的开发/维护历史、版本 注释出采用的不变量 并行策略 编译单元（文件）每一个类/类内定义的接口，含简单的说明 文件名和/或标识信息 修改/维护记录 版权信息 获取成员函数 若可能，说明为什么使用滞后初始化 接口 目的 它应如何被使用以及如何不被使用 局部变量 用处/目的 成员函数注释 成员函数做什么以及它为什么做这个 哪些参数必须传递给一个成员函数 成员函数返回什么 已知的问题 任何由某个成员函数抛出的异常 可见性决策 成员函数是如何改变对象的 包含任何修改代码的历史 如何在适当情况下

28、调用成员函数的例子 适用的前提条件和 后置条件 成员函数内部注释 控制结构 代码做了些什么以及为什么这样做 局部变量 共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 11 页/共 11 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 难或复杂的代码 处理顺序 包 包的功能和用途 共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 12 页/共 12 页 文档名称 Java开发规范

29、版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 第4章 命名 第4章 命名 4.1 基本原则 4.1 基本原则 规范的命名能使程序更易阅读，从而更易于理解。它们也可以提供一些标识功能方面的信息，有助于更好的理解代码和应用。4.1.1 使用可以准确说明变量/字段/类/接口/包等的完整的英文描述符。例如，采用类似 firstName，listAllUsers 或 CorporateCustomer 这样的名字，严禁使用汉语拼音及不相关单词命名，虽然 Java 支持 Unicode 命名，但本规范规定对包、类、接口、方法、变量、字段等不得使用汉字等进行命名。4

30、.1.2 采用该领域的术语。如果用户称他们的“客户”(clients)为“顾客”(customers)，那么就采用术语 Customer 来命名这个类，而不用 Client。4.1.3 采用大小写混合，提高名字的可读性。一般应该采用小写字母，但是类和接口的名字的首字母，以及任何中间单词的首字母应该大写。包名全部小写。4.1.4 尽量少用缩写，但如果一定要使用，当使用公共缩写和习惯缩写等，如实现（implement）可缩写成 impl，经理（manager）可缩写成 mgr 等，具体参看附录之常用缩写简表，严禁滥用缩写。4.1.5 避免使用长名字（最好不超过 25 个字母）。4.1.6 避免使用

31、相似或者仅在大小写上有区别的名字。4.1.7 避免使用数字，但可用 2 代替 to，用 4 代替 for 等，如：go2Jsp。4.2 文件、包 4.2 文件、包 4.2.1 文件名当与其类严格相同，所有单词首字母大写。4.2.2 包名一般以项目或模块名命名，少用缩写和长名，一律小写。4.2.3 基本包：org.skyinn，所有包、文件都从属于此包。4.2.4 包名按如下规则组成：基本包.项目名.模块名.子模块名.如：org.skyinn.quasar org.skyinn.skyhome.dao.hibernate 4.2.5 不得将类直接定义在基本包下，所有项目中的类、接口等都当定义在各

32、自的项目和模块包中。4.3 类、接口 4.3 类、接口 所有单词首字母大写。使用能确切反应该类、接口含义、功能等的词。一般采用名词。接口可带 I 前缀或 able、ible、er 等后缀。共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 13 页/共 13 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 4.4 字段 4.4 字段 4.4.1 常量 采用完整的英文大写单词，在词与词之间用下划线连接，如：DEFAULT_VALUE 4.4.2 变量和参数

33、 对不易清楚识别出该变量类型的变量应使用类型缩写作其前缀，如字符串使用strXXX,boolean 使用 isXXX，hasXXX 等等。除第一各个单词外其余单词首字母大写。对私有实例变量可使用_前缀，但在其存取方法中则应该将其前缀去掉。4.4.3 组件/部件 应采用完整的英文描述符命名组件（接口部件），遵循匈牙利命名法则 如：btnOK，lblName。4.4.4 集合 一个集合，例如数组和矢量，应采用复数命名来表示队列中存放的对象类型。命名应采用完整的英文描述符，名字中所有非开头的单词的第一个字母应大写，适当使用集合缩写前缀。如：Vector vProducts=new Vector();

34、/产品向量 Array aryUsers=new Array();/用户列表 4.4.5 神秘的数 我们在程序里经常会用到一些量，它是有特定的含义的。例如，现在我们写一个薪金统计程序，公司员工有 50 人，我们在程序里就会用 50 这个数去进行各种各样的运算。在这里，50 就是神秘的数。当别的程序员在程序里看到 50 这个数，将很难知道它的含义，造成理解上的困难。在程序里出现神秘的数会降低程序的可读性、可维护性和可扩展性，故规定不得出现此类神秘的数。避免的方法是把神秘的数定义为一个常量。注意这个常量的命名应该能表达该数的意义，并且应该全部大写，以与对应于变量的标识符区别开来。例如上面 50 这

35、个数，我们可以定义为一个名为 NUM_OF_EMPLOYEES 的常量来代替。这样，别的程序员在读程序的时候就可以容易理解了。4.4.6 其他 命名时应使用复数来表示它们代表多值。如：orderItems。4.5 方法 4.5 方法 方法的命名应采用完整的英文描述符，大小写混合使用：所有中间单词的第一个字母大写。方法名称的第一个单词常常采用一个有强烈动作色彩的动词。取值类使用 get 前缀，设值类使用 set 前缀，判断类使用 is(has)前缀。例：getName()setSarry()isLogon()方法参数建议顺序：(被操作者，操作内容，操作标志，其他)例：public void re

36、place(String sourceStr,/源字串 String oldStr,/被替换字串 String newStr)/替换为字串 共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 14 页/共 14 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 4.6 异常 4.6 异常 异常类名由表示该异常类型的单词和 Exception 组成，如 ActionException。异常实例一般使用 e、ex 等，在多个异常时使用该异常名或简写加 E，Ex

37、 等组成，如：SQLEx ActionEx 4.7 命名约定表 4.7 命名约定表 Table7 命名约定表 操作项 操作项 命名约定 命名约定 示例 示例 参数 使用传递值/对象的完整的英文描述符。userID 字段/属性 字段采用完整的英文描述，第一个字母小写，任何中间单词的首字母大写。firstName 布尔型的获取成员函数 所有的布尔型获取函数必须用单词 is（has）做前缀。isString()hasMoney()类 采用完整的英文描述符，所有单词的第一个字母大写。Customer 编译单元文件 使用类或接口的名字，或者如果文件中除了主类之外还有多个类时，加上前缀 java 来说明它

38、是一个源码文件。Customer.java 部件/组件 使用完整的英文描述来说明组件的用途，将组件类型使用匈牙利命名法则作其前缀。btnOK,cboTypeList 构造函数 使用类名 Customer()析构函数 Java 没有析构函数，但一个对象在垃圾收集时，调用成员函数 finalize()。finalize()异常类名 由表示该异常类型等的单词和Exception 组成 SQLException ActionException 异常实例名 通常采用字母 e、ex 表示异常。多个异常时使用异常名或其简写加E、Ex 等构成 e SQLEx 静态常量字段（常量）全部采用大写字母，单词之间用下

39、划线分隔。采用静态常量获取成员函数。DEFAULT_NAME 获取成员函数 被访问字段名的前面加上前缀 get。getUserName()接口 采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。使用 I 前缀，其后使用 able,.IRunnable IPrompter 共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 15 页/共 15 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 ible 或者 er 等后缀，但这不是必需的。局部变量

40、采用完整的英文描述符，第一个字母小写，但不要隐藏已有字段。例如，如果有一个字段叫 firstName，不要让一个局部变量叫 firstName。strName,totalMoney 循环计数器 通常采用字母 i，j，k 或者 counter，index i,j,k,count,index 包 采用完整的英文描述符，所有单词都小写，多个单词以下划线相连。所有包都属于 org.skyinn org.skyinn.quasar org.skyinn.skyhome.dao 成员函数 采用完整的英文描述说明成员函数功能，第一个单词尽可能采用一个生动的动词，除第一个单词外，每个单词第一个字母小写。ope

41、nFile()addUser()设置成员函数 被访问字段名的前面加上前缀 set。setName()setPower()共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 16 页/共 16 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 第5章 声明 第5章 声明 5.1 基本原则 5.1 基本原则 声明的基本原则是遵守 Java 语言规范，并遵从习惯用法。5.2 包 5.2 包 在导入包时当完全限制代码所使用的类的名字,尽量少用通配符的方式，但导入一

42、些通用包，或用到一个包下大部分类时，则可是使用通配符方式，如：import org.skyinn.quasar.services.Service;import java.util.*;同一包中的类导入时当声明在一起，可由编辑器自动完成此功能。重要的包当添加注释。5.3 类、接口 5.3 类、接口 类、接口定义语法规范：可见性(abstract|final)Class|Interface class_name (extends|implements)父类或接口名 如：public class LoginAction extends BaseAction implemnets ActionList

43、ener 5.4 方法 5.4 方法 良好的程序设计应该尽可能减小类与类之间耦合，所遵循的经验法则是：尽量限制成员函数的可见性。如果成员函数没必要公有(public)，就定义为保护(protected)；没必要保护(protected)，就定义为私有(private)。方法定义语法规范：可见性(abstract|final)synchronized返回值类型 method_name(参数列表)(throws)异常列表 /功能模块 如：public List listAllUsers()throws DAOException 若有 toString(),equals(),hashCode(),c

44、olone()等重载自 Object 的方法，应将其放在类的最后。声明顺序：构造方法 静态公共方法 静态私有方法 受保护方法 共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 17 页/共 17 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 私有方法 继承自 Object 的方法 5.5 字段 5.5 字段 字段定义语法规范：(public|private|protected)(final|volatile)statictransient data_

45、type field_name =expression;若没有足够理由，不要把实例或类变量声明为公有。公共和保护的可见性应当尽量避免，所有的字段都建议置为私有，由获取和设置成员函数（Getter、Setter）访问。不允许“隐藏”字段，即给局部变量所取的名字，不可与另一个更大范围内定义的字段的名字相同（或相似）。例如，如果把一个字段叫做 firstName，就不要再生成一个局部变量叫做 firstName，或者任何易混肴的名字，如 fistName。数组声明时当将跟再类型后，而不时字段名后，如：Integer ai =new Integer(2);/一个整数对象数组，用于.Integer aj

46、=new Integer(3);/不要用这种数组声明方式 一行代码只声明一个变量，仅将一个变量用于一件事。声明顺序：常量 类变量 实例变量 公有字段 受保护字段 私有字段 可以将私有变量声明在类或接口的最后。注意受保护变量、私有变量、“包”变量间的区别。5.6 示例 5.6 示例 Table8 /常量-public final static double PI=3.141592653589793;/-类变量 protected static String key=“Love”;/-实例变量/共有字段-public String userName=“Tom”;/受保护字段-protected f

47、loat price=0.0;/友元字段-Vector vPorducts=null;/私有字段-private int count;共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 18 页/共 18 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 /构造方法-public Constructor()/公共方法-public String getUserName()/友元方法-void createProduct()/受保护方法-protected

48、void convert()/私有方法-private void init()/重载 Object 方法-public String toString()/main 方法-public static void main(String args)共享 Copyright(C)Skyinn Group,2002-2004 http:/www.skyinn.org 第 19 页/共 19 页 文档名称 Java开发规范 版本 2.0alpha 文档编号 Java_Dev_Spec 日期 2004-7-18 第6章 类与接口 第6章 类与接口 6.1 基本原则 6.1 基本原则 类的划分粒度，不可太大

49、，造成过于庞大的单个类，也不可太细，从而使类的继承太深。一般而言，一个类只做一件事；另一个原则是根据每个类的职责进行划分，比如用 User 来存放用户信息，而用 UserDAO 来对用户信息进行数据访问操作（比如存取数据库），用 UserBroker 来封装用户信息的业务操作等等。多使用设计模式，随时重构。多个类中使用相同方法时将其方法提到一个接口中或使用抽象类，尽量提高重用度。将不希望再被继承的类声明成 final，例如某些实用类，但不要滥用 final，否则会对系统的可扩展性造成影响。将不希望被实例化的类的缺省构造方法声明成 private。6.2 抽象类与接口 6.2 抽象类与接口 一般

50、而言：接口定义行为，而抽象类定义属性和公有行为，注意两者间的取舍，在设计中，可由接口定义公用的行为，由一个抽象类来实现其部分或全部方法，以给子类提供统一的行为定义，可参考 Java 集合等实现。多使用接口，尽量做到面向接口的设计，以提高系统的可扩展性。6.3 继承与组合 6.3 继承与组合 尽量使用组合来代替继承，一则可以使类的层次不至于过深，而且会使类与类，包与包之间的耦合度更小，更具可扩展性。6.4 构造函数和静态工厂方法 6.4 构造函数和静态工厂方法 当需要使用多个构造函数创建类时，建议使用静态工厂方法替代这些构造方法(参考Effictive Java Item1)，例如：public