JavaBean的命名规则

  • Post author:
  • Post category:java



Sun


推荐的命名规范


1


,类名要首字母大写,后面的单词首字母大写


2


,方法名的第一个单词小写,后面的单词首字母大写


3


,变量名的第一个单词小写,后面的单词首字母大写


为了使


JavaBean


的属性名和存取方法都符合规范,


Sun





JSR


文档中规定了属性名和存取方法名的映射规则:





属性名对应的存取方法为


ge


t/set


加上首字母大写的属性名,如属性


userName


的存取方法为


setUserName/getUserName


。这样属性名和存取方法都符合命名规范。这个规则强制的,如果不符合规则就会出现异常。


但是这里有一个例外规则,


Sun


考虑在偶然的情况下会有全大写的属性名,所以又定了一条规则:


②如果属性名的第二个字母是大写,则它的存取方法是


set/get


加上属性原名。

上面两个属性与存取方法的映射规则如下:





属性名对应的存取方法为


ge


t/set


加上首字母大写的属性名,如属性


userName


的存取方法为


setUserName/getUserName




②如果属性名的第二个字母是大写,则它的存取方法是


set/get


加上属性原名。


应用这两个规则时有两个特殊情况需要注意


,属性名的第一个单词只有一个字母,如


s


Name


,按照第


2


条映射规则,它的存取方法为


setsName/getsName


。这样存取方法名就与方法名的命名规范有一定的出入,按规范应该是


setSName/getSName


。所以最好不要让属性名的第一个单词只有一个字母。另一个特殊情况是起了一个不符合规范的属性名


Sname


,首字母大写后面的小写,这种情况既没有映射规则,也是不允许出现的。下面用一个表格说明映射规则。


属性名/类型

getter 方法

setter 方法
xcoordinate/Double public Double getXcoordinate() public void setXcoordinate(Double newValue)
xCoordinate/Double public Double getxCoordinate() public void setxCoordinate(Double newValue)
XCoordinate/Double public Double getXCoordinate() public void setXCoordinate(Double newValue)
Xcoordinate/Double 不允许 不允许
student/Boolean public Boolean getStudent() public void setStudent(Boolean newValue)
student/boolean public boolean getStudent()

public boolean isStudent()
public void setStudent(boolean newValue)

一般JavaBean属性以小写字母开头,驼峰命名格式,相应的 getter/setter 方法是 get/set 接上首字母大写的属性名。例如:属性名为userName,其对应的getter/setter 方法是 getUserName/setUserName。

但是,还有一些特殊情况:

1、如果属性名的第二个字母大写,那么该属性名直接用作 getter/setter 方法中 get/set 的后部分,就是说大小写不变。例如属性名为uName,方法是getuName/setuName。

2、如果前两个字母是大写(一般的专有名词和缩略词都会大写),也是属性名直接用作 getter/setter 方法中 get/set 的后部分。例如属性名为URL,方法是getURL/setURL。

3、如果首字母大写,也是属性名直接用作 getter/setter 方法中 get/set 的后部分。例如属性名为Name,方法是getName/setName,这种是最糟糕的情况,会找不到属性出错,因为默认的属性名是name。

所以在JavaBean命名时应该注意符合以上命名规范


Java Bean


规范下载地址:




http://java.sun.com/javase/technologies/desktop/javabeans/docs/spec.html