JPA 2 静态Metamodel与Hibernate Metamodel Generator

其实本文并不是要讲解Hibernate Metamodel Generator的使用方法，因为大家可以从其参考文献(http://docs.jboss.org/hibernate/jpamodelgen/1.0/reference/en-US/html/)中获取这些知识。我只是想说说最近我体会到的Metamodel带给开发人员的好处，顺带提一提Hibernate Metamodel Generator带给我们的便利。

 

        java开发人员在开发web程序时可能经常会遇到这样的开发场景：在后台代码中读取前台发送的request中的参数值用于构建一个javabean，例如，下面是一个Person实体类的代码：

 

[java] view plain copy

1. public class Person implements Serializable {  
2.     @Id  
3.     @GeneratedValue(strategy = GenerationType.AUTO)  
4.     private Long id;  
5.       
6.     @Embedded  
7.     private PersonName personName;  
8.     @Temporal(javax.persistence.TemporalType.DATE)  
9.     private Date birthday;  
10.     private char gender;  
11.     public Long getId() {  
12.         return id;  
13.     }  
14.     public Date getBirthday() {  
15.         return birthday;  
16.     }  
17.     public void setBirthday(Date birthday) {  
18.         this.birthday = birthday;  
19.     }  
20.     public char getGender() {  
21.         return gender;  
22.     }  
23.     public void setGender(char gender) {  
24.         this.gender = gender;  
25.     }  
26.     public String getName() {  
27.         return personName.toString();  
28.     }  
29.     public String getFirstName() {  
30.         return personName.getFirstName();  
31.     }  
32.     public void setFirstName(String firstName) {  
33.         personName.setFirstName(firstName);  
34.     }  
35.     public String getLastName() {  
36.         return personName.getLastName();  
37.     }  
38.     public void setLastName(String lastName) {  
39.         personName.setLastName(lastName);  
40.     }  
41. }  

 

        下面的代码就是从request中读取参数值来构建一个Person对象：

 

[java] view plain copy

1. Person person = new Person();  
2. person.setFirstName(request.getParameter("firstName"));  
3. person.setLastName(request.getParameter("lastName"));  
4. ...  

 

        上面的代码有几个问题：1、并不是健壮的代码，原因是在代码中使用太多的字符串常量，难免会出现拼写错误，而这种错误并不容易被发现，特别是与javabean的类型和属性对应的字符串会在程序中的各个层出现，增加了犯拼写错误的风险；2、代码的可读性较差，原因是仅凭属性名，我们无法判断该属性对应的类；3、难以维护，当javabean的属性更改时，为了保持代码的一致性，相对应的字符串常量也应更改，这给开发人员造成了负担。

 

        我现在推荐两种方式来解决该问题，一种是在javabean中加入这些bean的元数据（Meta data）信息，以Person类为例，加入元数据（Meta data）信息后代码如下：

 

[java] view plain copy

1. public class Person implements Serializable {  
2.       
3.     public static final String ENTITY_NAME = "Person";  
4.     public static final String ID = "id";  
5.     public static final String PERSON_NAME = "personName";  
6.     public static final String BIRTHDAY = "birthday";  
7.     public static final String GENDER = "gender";  
8.     public static final String NAME = "name";  
9.     public static final String FIRSTNAME = "firstName";  
10.     public static final String LASTNAME = "lastName";  
11. ...  

 

        即关于Person的模型信息都通过公共的静态常量字段表示，这样，上诉获取request中的参数值的方法就可以改为：

 

[java] view plain copy

1. Person person = new Person(); person.setFirstName(request.getParameter(Person.FIRSTNAME)); person.setLastName(request.getParameter(Person.LASTNAME));  
2. ...  

 

        这种方法的优点是简单，缺点在于增加开发人员的工作量。开发人员在每编写一个实体类时都必须要增加描述该实体类的元信息。所以该方法适用于规模较小的系统。该方法另一个不足就是并没有给出完整的元数据信息，而只是给出了类名和属性名，没有给出属性的类型等其他信息。

 

        另一种方法就是JPA 2规范提出的静态Metamodel，关于规范在这部分的说明，大家请见(http://docs.jboss.org/hibernate/stable/entitymanager/reference/en/html/metamodel.html)。hibernate提供了一个工具包Hibernate Metamodel Generator来帮助开发人员生成反映实体类的静态Metamodel，对于该包的详细说明与使用方法，请参见本文开头给出的链接。对与上文的Person类，Hibernate Metamodel Generator自动生成的静态Metamodel的代码如下：

 

[java] view plain copy

1. import java.util.Date;  
2. import javax.persistence.metamodel.SingularAttribute;  
3. import javax.persistence.metamodel.StaticMetamodel;  
4. @StaticMetamodel(Person.class)  
5. public abstract class Person_ extends com.kingdee.felix.contact.domain.BasicModel_ {  
6.     public static volatile SingularAttribute<Person, Long> id;  
7.     public static volatile SingularAttribute<Person, Date> birthday;  
8.     public static volatile SingularAttribute<Person, Character> gender;  
9.     public static volatile SingularAttribute<Person, PersonName> personName;  
10. }  

 

        类Person_就是反映实体类Person的静态元模型，并且Person_的各静态字段分别对应Person的各属性，而且这些静态字段能提供包括属性名在内的各种信息。关于静态Metamodel的使用方式，请参见j2ee6的api文档(http://java.sun.com/javaee/6/docs/api/overview-summary.html)

 

 

         本文只是提出了实体类的元数据的用途，以及两种获取元数据的方法，并未对这两种方法作深入的示例与分析，希望有经验的java开发人员能从本文中获取一些使用元数据的技巧。