1. 程式人生 > >Java Bean 屬性命名規範問題分析

Java Bean 屬性命名規範問題分析

問題由來:

最近在一個java bean類中定義了一個boolean型別的變數:

//boolean屬性:是否顯示
private boolean isShowCode ; 
	
//使用Eclipse自動生成getter/setter方法如下:
public boolean isShowCode() {
   return isShowCode;
}
public void setShowCode(boolean isShowCode) {
    this.isShowCode = isShowCode;
}
spring在給java bean 設定值的時候, 丟擲異常:
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)
程式碼執行環境: jdk 1.6 + eclipse 3.2 + spring 3.1, 本文下面的程式碼都在該環境下測試。
原因跟蹤分析:跟蹤Spring原始碼, 可以看到下面這段程式碼:
private CachedIntrospectionResults(Class beanClass, 
	boolean cacheFullMetadata) throws BeansException {
	... ...
	this.beanInfo = new ExtendedBeanInfo(Introspector.getBeanInfo(beanClass));
	... ...
}

方法Introspector.getBeanInfo(beanClass)返回的時候,獲取到的java bean 資訊中的isShowCode屬性的名稱已經被改成了"showCode"。

      到這裡可以確定問題不是出在spring程式碼中, 網上有不少帖子說是spring的處理規則導致了這個問題,這裡是不是可以否定這種看法?
      問題跟蹤到這,也即跟蹤到了java.beans包。嘗試繼續跟蹤JDK原始碼,可能由於我的JDK的jar包和原始碼不匹配的原因, eclipse總是監控不到中間變數。也就沒有再跟蹤進去了。可以知道的是,javabean中 的isShowCode 屬性 和 對應的getter/setter方法應該是沒有遵循javabean規範。Eclipse自動生成的getter/setter方法看來也是存在一些問題的。
      Eclipse自動生成boolean型別屬性的方法是不是有點奇怪呢? 屬性 isShowCode

的getter訪問器是isShowCode()而不是getIsShowCode(), setter設值器是setShowCode()而不是setIsShowCode()。原來在java bean 規範關於中提到, boolean屬性<propertyName>的getter訪問器可以使用下面這種模式
public boolean is<PropertyName>(){...};
來代替
public boolean get<PropertyName>(){...};

 Javabean 規範(下載連結:http://download.oracle.com/otndocs/jcp/7224-javabeans-1.01-fr-spec-oth-JSpec/ )  在8.3 章節"Design Patterns for Properties" 中的描述:

Eclipse根據這種方式生成getter訪問器和setter設值器, 由於屬性名isShowCode的is沒有去掉, 以致java bean類違背了java bean 的命名規範。

JavaBean 的屬性名和getter/setter存取方法規則小結

1. 對於常規屬性  <propertyName> , 屬性名稱的第一個單詞小寫且字母個數大於1,第二個單詞首字母大寫  。對應的getter/setter方法名為:get /set +  <PropertyName>(), 即屬性名稱的第一個單詞的首字母改成大寫, 前面再加上"get"或"set"字首。

2. 對於布林型別 <propertyName> , 可以按常規屬性的規則編寫getter/setter方法外, getter方法可以使用 is +  <PropertyName>()的形式來代替。

3. 對於非常規屬性<pName>, 屬性名稱的第一個單詞小寫且字母個數等於1,第二個單詞首字母大寫  。

  3.1 )  對應的getter/setter方法名可以為:get/set +  <PName>(), 即第一個單詞的首字母為改為大寫,前面再加上"get"或"set"字首。Eclipse3.2 按這種方式自動生成getter/setter方法。程式碼片段:
 
	<bean id="country" class="com.codemouse.beans.Country" lazy-init="true">
		<property name="pName">
			<value>中國</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 )對應的getter/setter方法名可以為:get/set+  <pName>(), 即屬性名稱不變,第一個單詞的首字母任然為小寫,前面再加上"get"或"set"字首。這種方式也可以正常執行。網上有帖子說Eclipse3.5按這種方式自動生成getter/setter方法。

程式碼片段:
    <bean id="country" class="com.codemouse.beans.Country" lazy-init="true">
		<property name="pName">
			<value>中國</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. 對於非常規屬性<PName>, 屬性名稱的前兩個字母都是大寫  。即連續兩個大寫字母開頭的屬性名。
         對應的getter/setter方法名為: get/set +  <PName>(), 即屬性名稱不變,前面再加上"get"或"set"字首。

spring3.1 配置檔案程式碼片段:
 
	<bean id="country" class="com.codemouse.beans.Country" lazy-init="true">
		<property name="PName">
			<value>中國</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. 對於非常規屬性<Property>或<PropertyName>, 屬性名稱第一個字母大寫 。網上有帖子說這是不符合JSR規範的,會報 "屬性找不到" 的錯誤。

(如帖子1: http://lzh166.iteye.com/blog/631838 ;
      帖子2: http://hi.baidu.com/w8y56f/blog/item/4fd037e845bbbe372cf5342a.html)。我在我的 環境下測試了下, 是不會報錯的,可以正常執行,雖然這種命名方式是令人難以忍受的:
	<bean id="country" class="com.codemouse.beans.Country" lazy-init="true">
		<property name="PropertyName">
			<value>中國</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;
	}
測試方法: 第一個@test方法用普通javabean呼叫方式測試; 第二個@test方法使用spring建立bean
    @Test
	public void testJavaBeanNamingRule0(){
		Country country = new Country();
		country.setPropertyName("中國");
		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());
	}
執行結果:都可以正常執行。
中國
123.45600128173828
log4j:WARN No appenders could be found for logger (org.springframework.core.env.StandardEnvironment).
log4j:WARN Please initialize the log4j system properly.
中國
12.345

總結:

1. javabean屬性命名儘量使用常規的駝峰式命名規則
2. 屬性名第一個單詞儘量避免使用一個字母:如eBook, eMail。
3. boolean屬性名避免使用 “is” 開頭的名稱
4. 隨著jdk, eclipse, spring 等軟體版本的不斷提高, 底版本的出現的問題可能在高版本中解決了, 低版本原來正常的程式碼可能在高版本環境下不再支援。