Java中Bean屬性命名規(guī)范有哪些

Java中Bean屬性命名規(guī)范有哪些，很多新手對(duì)此不是很清楚，為了幫助大家解決這個(gè)難題，下面小編將為大家詳細(xì)講解，有這方面需求的人可以來學(xué)習(xí)下，希望你能有所收獲。

問題由來：

最近在一個(gè)java bean類中定義了一個(gè)boolean類型的變量：

//boolean屬性：是否顯示  private boolean isShowCode ;         //使用Eclipse自動(dòng)生成getter/setter方法如下：  public boolean isShowCode() {     return isShowCode;  }  public void setShowCode(boolean isShowCode) {      this.isShowCode = isShowCode;  }

spring在給java bean 設(shè)置值的時(shí)候， 拋出異常：

Caused by: org.springframework.beans.NotWritablePropertyException:   Invalid property 'isShowCode' of bean class [com.codemouse.beans.Country]:   Bean property 'isShowCode' is not writable or has an invalid setter method.   Did you mean 'showCode'?  at org.springframework.beans.BeanWrapperImpl.setPropertyValue(BeanWrapperImpl.java:1064)

代碼運(yùn)行環(huán)境： jdk 1.6 + eclipse 3.2 + spring 3.1, 本文下面的代碼都在該環(huán)境下測(cè)試。

原因跟蹤分析：跟蹤Spring源碼， 可以看到下面這段代碼：

private CachedIntrospectionResults(Class beanClass,       boolean cacheFullMetadata) throws BeansException {      ... ...      this.beanInfo = new ExtendedBeanInfo(Introspector.getBeanInfo(beanClass));      ... ...  }

方法Introspector.getBeanInfo(beanClass)返回的時(shí)候，獲取到的java bean 信息中的isShowCode屬性的名稱已經(jīng)被改成了"showCode"。

到這里可以確定問題不是出在spring代碼中， 網(wǎng)上有不少帖子說是spring的處理規(guī)則導(dǎo)致了這個(gè)問題，這里是不是可以否定這種看法？

問題跟蹤到這，也即跟蹤到了java.beans包。嘗試?yán)^續(xù)跟蹤JDK源碼，可能由于我的JDK的jar包和源碼不匹配的原因， eclipse總是監(jiān)控不到中間變量。也就沒有再跟蹤進(jìn)去了?？梢灾赖氖?，javabean中 的isShowCode 屬性 和 對(duì)應(yīng)的getter/setter方法應(yīng)該是沒有遵循javabean規(guī)范。Eclipse自動(dòng)生成的getter/setter方法看來也是存在一些問題的。

Eclipse自動(dòng)生成boolean類型屬性的方法是不是有點(diǎn)奇怪呢？ 屬性 isShowCode 的getter訪問器是isShowCode()而不是getIsShowCode()， setter設(shè)值器是setShowCode()而不是setIsShowCode()。原來在java bean 規(guī)范關(guān)于中提到， boolean屬性<propertyName>的getter訪問器可以使用下面這種模式

public boolean is<PropertyName>(){...};

來代替

public boolean get<PropertyName>(){...};

Javabean 規(guī)范(下載鏈接：http://download.oracle.com/otndocs/jcp/7224-javabeans-1.01-fr-spec-oth-JSpec/ ) 在8.3 章節(jié)"Design Patterns for Properties" 中的描述：

Eclipse根據(jù)這種方式生成getter訪問器和setter設(shè)值器， 由于屬性名isShowCode的is沒有去掉， 以致java bean類違背了java bean 的命名規(guī)范。

JavaBean 的屬性名和getter/setter存取方法規(guī)則小結(jié)：

1. 對(duì)于常規(guī)屬性 <propertyName> ， 屬性名稱的***個(gè)單詞小寫且字母?jìng)€(gè)數(shù)大于1，第二個(gè)單詞首字母大寫 。對(duì)應(yīng)的getter/setter方法名為：get /set + <PropertyName>()， 即屬性名稱的***個(gè)單詞的首字母改成大寫， 前面再加上"get"或"set"前綴。

2. 對(duì)于布爾類型 <propertyName> ， 可以按常規(guī)屬性的規(guī)則編寫getter/setter方法外， getter方法可以使用 is + <PropertyName>()的形式來代替。

3. 對(duì)于非常規(guī)屬性<pName>， 屬性名稱的***個(gè)單詞小寫且字母?jìng)€(gè)數(shù)等于1，第二個(gè)單詞首字母大寫 。

3.1 ） 對(duì)應(yīng)的getter/setter方法名可以為：get/set + <PName>()， 即***個(gè)單詞的首字母為改為大寫，前面再加上"get"或"set"前綴。Eclipse3.2 按這種方式自動(dòng)生成getter/setter方法。代碼片段：

<bean id="country" class="com.codemouse.beans.Country" lazy-init="true">      <property name="pName">          <value>中國(guó)</value>      </property>      <property name="code">          <value>CN</value>      </property>      <property name="showCode">          <value>true</value>      </property>  </bean>

   private String pName;   public String getPName() {      return pName;  }  public void setPName(String name) {      pName = name;  }

3.2 ）對(duì)應(yīng)的getter/setter方法名也可以為：get/set+ <pName>()， 即屬性名稱不變，***個(gè)單詞的首字母任然為小寫，前面再加上"get"或"set"前綴。這種方式也可以正常運(yùn)行。網(wǎng)上有帖子說Eclipse3.5按這種方式自動(dòng)生成getter/setter方法。

代碼片段：

   <bean id="country" class="com.codemouse.beans.Country" lazy-init="true">      <property name="pName">          <value>中國(guó)</value>      </property>      <property name="code">          <value>CN</value>      </property>      <property name="showCode">          <value>true</value>      </property>  </bean>

   private String pName;   public String getpName() {      return pName;  }  public void setpName(String name) {      pName = name;  }

4. 對(duì)于非常規(guī)屬性<PName>， 屬性名稱的前兩個(gè)字母都是大寫 。即連續(xù)兩個(gè)大寫字母開頭的屬性名。

對(duì)應(yīng)的getter/setter方法名為： get/set + <PName>()， 即屬性名稱不變，前面再加上"get"或"set"前綴。

spring3.1 配置文件代碼片段：

<bean id="country" class="com.codemouse.beans.Country" lazy-init="true">      <property name="PName">          <value>中國(guó)</value>      </property>      <property name="code">          <value>CN</value>      </property>      <property name="showCode">          <value>true</value>      </property>  </bean>

private String PName;   public String getPName() {      return PName;  }  public void setPName(String name) {      PName = name;  }

5. 對(duì)于非常規(guī)屬性<Property>或<PropertyName>， 屬性名稱***個(gè)字母大寫 。網(wǎng)上有帖子說這是不符合JSR規(guī)范的，會(huì)報(bào) "屬性找不到" 的錯(cuò)誤。

(如帖子1: http://lzh266.iteye.com/blog/631838 ；

帖子2: http://hi.baidu.com/w8y56f/blog/item/4fd037e845bbbe372cf5342a.html)。我在我的 環(huán)境下測(cè)試了下， 是不會(huì)報(bào)錯(cuò)的，可以正常運(yùn)行，雖然這種命名方式是令人難以忍受的：

<bean id="country" class="com.codemouse.beans.Country" lazy-init="true">     <property name="PropertyName">         <value>中國(guó)</value>     </property>     <property name="code">         <value>CN</value>     </property>     <property name="showCode">         <value>true</value>     </property>     <property name="Xcoordinate">         <value>12.345</value>     </property> </bean>

private String PropertyName;  public String getPropertyName() {      return PropertyName;  }  public void setPropertyName(String propertyName) {      PropertyName = propertyName;  }   private Double Xcoordinate;  public Double getXcoordinate() {      return Xcoordinate;  }  public void setXcoordinate(Double xcoordinate) {      Xcoordinate = xcoordinate;  }

測(cè)試方法： ***個(gè)@test方法用普通javabean調(diào)用方式測(cè)試； 第二個(gè)@test方法使用spring創(chuàng)建bean

   @Test public void testJavaBeanNamingRule0(){      Country country = new Country();      country.setPropertyName("中國(guó)");      country.setXcoordinate(Double.valueOf(123.456f));      System.out.println(country.getPropertyName());      System.out.println(country.getXcoordinate());  }   @Test public void testJavaBeanNamingRule(){      ApplicationContext ctx = new ClassPathXmlApplicationContext("myBeans.xml");      Country country = (Country)ctx.getBean("country");      System.out.println(country.getPropertyName());      System.out.println(country.getXcoordinate());  }

運(yùn)行結(jié)果：都可以正常運(yùn)行。

中國(guó)  123.45600128173828 log4j:WARN No appenders could be found for logger (org.springframework.core.env.StandardEnvironment).  log4j:WARN Please initialize the log4j system properly.  中國(guó)  12.345

總結(jié)：

1. javabean屬性命名盡量使用常規(guī)的駝峰式命名規(guī)則

2. 屬性名***個(gè)單詞盡量避免使用一個(gè)字母：如eBook， eMail。

3. boolean屬性名避免使用 “is” 開頭的名稱

4. 隨著jdk， eclipse， spring 等軟件版本的不斷提高， 底版本的出現(xiàn)的問題可能在高版本中解決了， 低版本原來正常的代碼可能在高版本環(huán)境下不再支持。

看完上述內(nèi)容是否對(duì)您有幫助呢？如果還想對(duì)相關(guān)知識(shí)有進(jìn)一步的了解或閱讀更多相關(guān)文章，請(qǐng)關(guān)注億速云行業(yè)資訊頻道，感謝您對(duì)億速云的支持。