java/J2EE编程规范(一)

前段时间跟同事了解到了java/J2EE的一些编程规范，看了点相关资料，把受用的记录了一下。本人对java编程经验不多，需要增加和改进的地方还请指教，我们共同学习 :)
[b]1.命名规范：[/b]
文件名的长度要少于15个字符
尽量少之用缩写，除非是URL那些大家已经熟知的缩写。
[b]class名后缀：[/b]
接口（interface）： XXXIfc
继承类（Implementation）: XXXImpl
DAO里的类: XXXDAO,如果是接口的话:XXXDAOImpl
Handler: XXXHndlr
data bean: XXXEntity 或 XXXData
[b]method名：[/b]
如果getXXX()/setXXX()方法中返回的值为true或false,便于理解，可以将方法名改为：isEntity(),hasMembers()......
[b] 变量名：[/b]
变量名需要反映他们的使用范围，不要在变量使用前才对它进行定义。有些变量，即便作用域不同，也尽量不要使用重名。
in/out/inOut名为标准的输入输出流（I/O Stream）名。
[b]参量名（Parameter） ：[/b]
Prefix names with 'a' or 'an' to distinguish them from local variables.
方法中的形参和实参名不要相同，例如，方法

  validate(email,password){
     this.email = email;
     this.password = pasword;
              ...
      } 

可以将形参名email改为anEmail，password改为aPassword以此和实参区分。修改后的代码为：

validate(email,password){
     this.email = anEmail;
     this.password = aPasword;
              ...
      }

[b]常量（constant）：[/b]
常量名字中字母都大写。ANSI中尽量少用恒量，容易出bug。（目前还没用过ANSI,这句话纯属字面理解，以后用到时再好好了解一下）。
顺便提一下，使用数字常量时，除了-1、0、1，数字常量(如12，45，9，5)尽量少用。

将实例存入session时的命名：
[color=olive]Use the SESSION_KEY attribute to save objects to the Session. Set the value of SESSION_KEY as the class name for the object.

Every Data Bean should have a public static string declared as key for saving and retrieving from the session. The key value should be the class name. [/color]
当一个类的实例可能要存入一个session时，建议这个类在定义时可以加入一个静态的SESSION_KEY变量，这个变量的值应该为类名。这个静态变量用于实例存入session时的取名。如下例：

public class ChangeFormEntity implements java.io.Serializable{
   public static final String SESSION_KEY = "ChangeFormEntity";
   ...
}
//if changeFormEntity is a object of ChangeFormEntity class
Session.setAttribute(ChangeFormEntity.SESSION_KEY,changeFormEntity);