黑马程序员技术交流社区

标题: java编码轨范2 [打印本页]

---

作者: liufeng2436_01    时间: 2016-4-27 12:31
标题: java编码轨范2
　5) 存取方法（类的设置与获取成员函数）

　　接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的写在一行上，如类的成员变量已经有注释，类变量的存取方法可以没有注释。

　　public int[] getPackets() { return this.packets; }
   public void setPackets(int[] packets) { this.packets = packets; }  
     ……

　　要求说明的是，对于集合，加入成员函数来插入和删除项；另其它的方法不要写在一行上。

　　6) 构造函数

　　接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。

　　public CounterSet(int size){ this.size = size;}

　　7) 克隆方法

　　如果这个类是可以被克隆的，那么下一步就是 clone 方法：

　　public Object clone() { try { …… }catch(CloneNotSupportedException e) { …… }}

　　8) 类方法 （类的普通成员函数）

　　下面开始写类的方法：

　　/**
   * Set the packet counters
   * param r1 - ……
   * param r2 - ……
   * ……
   */
  protected final void setArray(int[] r1, int[] r2, int[] r3, int[] r4) throws IllegalArgumentException{
   // Ensure the arrays are of equal size
   ……
  }

9) toString 方法

　　一般情况下，每一个类都应该定义 toString 方法：

　　public String toString() { ……}

　　10) main 方法

　　普通类，考虑置入一个main()方法，其中包含用于测试那个类的代码，如果包含了main() 方法, 那么它应该写在类的底部。

　　4. Java编码其它约定

　　n 文档化

　　必须用 javadoc 来为类生成文档。不仅因为它是标准，这也是被各种 java 编译器都认可的方法。使用 @author 标记是不被推荐的，因为代码不应该是被个人拥有的。

　　n 缩进

　　缩进应该是每行2个空格。 不要在源文件中保存Tab字符， 在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度。

　　如果你使用 UltrEdit 作为你的 Java 源代码编辑器的话，你可以通过如下操作来禁止保存Tab字符， 方法是通过 UltrEdit中先设定 Tab 使用的长度室2个空格，然后用 Format|Tabs to Spaces 菜单将 Tab 转换为空格。

　　n 页宽

　　页宽应该设置为80字符。 源代码一般不会超过这个宽度， 并导致无法完整显示， 但这一设置也可以灵活调整。 在任何情况下， 超长的语句应该在一个逗号或者一个操作符后折行。 一条语句折行后， 应该比原来的语句再缩进2个字符。

　　n {} 对

　　{} 中的语句应该单独作为一行。 例如， 下面的第1行是错误的， 第2行是正确的:

　　if (i>0) { i ++ }; // 错误, { 和 } 在同一行 if (i>0) { i ++ }; // 正确, 单独作为一行

　　n 括号

　　左括号和后一个字符之间不应该出现空格； 同样， 右括号和前一个字符之间也不应该出现空格。 下面的例子说明括号和空格的错误及正确使用:

CallProc(AParameter); // 正确

　　不要在语句中使用无意义的括号，括号只应该为达到某种目的而出现在源代码中。

　　n JSP文件命名

　　采用完整的英文描述说明JSP所完成的功能，尽可能包括一个生动的动词，第一个字母小写，如：viewMessage.jsp、editUser.jsp或者forumChooser.jsp等。

　　n Servlet类命名

　　一般对应于所服务的对象加后缀Service来命名，如：UserService，TradeService等。

　　5. 一些编程建议

　　n 使用 StringBuffer 对象

　　在处理 String 的时候要尽量使用 StringBuffer 类，StringBuffer 类是构成 String 类的基础。String 类将 StringBuffer 类封装了起来，（以花费更多时间为代价）为开发人员提供了一个安全的接口。当我们在构造字符串的时候，我们应该用 StringBuffer 来实现大部分的工作，当工作完成后将 StringBuffer 对象再转换为需要的 String 对象。比如：如果有一个字符串必须不断地在其后添加许多字符来完成构造，那么我们应该使用 StringBuffer 对象和它的 append() 方法。如果我们用 String 对象代替 StringBuffer 对象的话，会花费许多不必要的创建和释放对象的 CPU 时间。

　　n 避免太多的使用 synchronized 关键字

　　避免不必要的使用关键字 synchronized，应该在必要的时候再使用它，这是一个避免死锁的好方法。 必须使用时，也尽量控制范围，最好在块级控制。

　　n 避免使用 java.util.Vector 类

　　因为"Unlike the new collection implementations, Vector is synchronized."，所以使用java.util.Vector类在性能上会有所减低。

　　n 尽量使用接口而不是一个具体的类

　　比方如下需求，给定一个SQL语句，返回一个对象的列表，实现中用java.util.ArrayList实现，于是定义方法为：


　　public java.util.ArrayList getObjectItems(String sql)

　　上面的方法存在一个问题，当getObjectItems内改用Vector或LinkedList实现，外部类必须做相应更改。一个更好的方法是定义返回值为java.util.AbstractList更合适：

　　public java.util.AbstractList getObjectItems(String sql)

　　这样即使更改实现，外部类也不必做相应更改。

　　n 避免使用索引来调用数据库中间层组件返回的结果集

　　如：

　　for(int i=1; i<=dt.getRowCount(); i++){ String field1 = dt.getField(i, 0).toString(); ……}

　　而应用字段名来存取结果集：

　　for(int i=1; i<=dt.getRowCount(); i++){ String field1 = dt.getField(i, "field1").toString(); ……}

　　这样在数据库设计更改或查询的SQL语句发生变化时，不会影响到程序的执行。

---

欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/)

黑马程序员IT技术论坛 X3.2