hibernate 注解@Formula解析和使用简介

一.hibernate 注解@Formula即hibernate提取属性也叫做计算属性，该属性值是一个值读属性，是通过使用sql语句获取得到的，常用的是统计数据。

例如：我有一个employee实体类,该类有主键Id或name，月薪水(monthlySalary)等属性(字段)，你现在有一个想法想要获取该employee的年薪,计算方式是月薪*12个月=年薪。

package net.ozar.exp.entity;
 
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.Table;
 
@Entity
@Table(name="EMPLOYEE")
public class Employee implements java.io.Serializable {
 
    private static final long serialVersionUID = -7311873726885796936L;
 
    @Id
    @Column(name="ID")
    private Integer id;
 
    @Column(name="FIRST_NAME", length=31)
    private String firstName;
 
    @Column(name="LAST_NAME", length=31)
    private String lastName;
 
    @Column(name="MONTHLY_SALARY")
    private float monthlySalary;
 
    public Employee() {
    }
 
    // getters and setters
     // ...
 
    public float getMonthlySalary() {
        return monthlySalary;
    }
 
    public void setMonthlySalary(float monthlySalary) {
        this.monthlySalary = monthlySalary;
    }
 
     /* This artificial property - as I call it - is a kind of a calculated property, but not with Hibernate derived property support - not just yet */
    public float getYearlySalary() {
        return this.monthlySalary * 12;
    }
 
}

上面这个是没有加入hibernate @Formula支持的用法 ，现在我们加入这个注解实现：

package net.ozar.exp.entity;
 
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.Table;
 
import org.hibernate.annotations.Formula;
 
@Entity
@Table(name="EMPLOYEE")
public class Employee implements java.io.Serializable {
 
    private static final long serialVersionUID = -7311873726885796936L;
 
    @Id
    @Column(name="ID")
    private Integer id;
 
    @Column(name="FIRST_NAME", length=31)
    private String firstName;
 
    @Column(name="LAST_NAME", length=31)
    private String lastName;
 
    @Column(name="MONTHLY_SALARY")
    private float monthlySalary;
 
    <span style="color:#ff0000;">@Formula</span>("MONTHLY_SALARY*12")
    private float yearlySalary;
 
    public Employee() {
    }
 
    public Integer getId() {
        return id;
    }
 
    public void setId(Integer id) {
        this.id = id;
    }
 
    public String getFirstName() {
        return firstName;
    }
 
    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }
 
    public String getLastName() {
        return lastName;
    }
 
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
 
    public float getMonthlySalary() {
        return monthlySalary;
    }
 
    public void setMonthlySalary(float monthlySalary) {
        this.monthlySalary = monthlySalary;
    }
 
    public float getYearlySalary() {
        return yearlySalary;
    }
 
}

注意到上面这个案例的@Formla的值是关联到“MONTHLY_SALARY”而yearlySalry属性是没有存储如数据库的。

一些更为复杂用法如下所示，注意：最後面的customer_id=id中后面的id的值也就当前对象的id值

@Formula("(select min(l.creation_date) from Logs l where l.customer_id = id)")
private Date firstLoginDate;

二. Hibernate Formula作用就是说白了就是用一个查询语句动态的生成一个类的属性。

比如java eye登陆之后 收件箱显示有几封未读邮件的数字，就是一条select count(*)...构成的虚拟列，而不是存储在数据库里的一个字段。

用比较标准的说法就是：有时候，你想让数据库，而非JVM，来替你完成一些计算，也可能想创建某种虚拟列，你可以使用sql片段，而不是将属性映射(物理)列。这种属性是只读的(属性值由公式求得).Formula甚至可以包含sql子查询，Formula真的这么强大吗？确实，它很好很强大，节省了不少代码！

使用Formula的细节：

package aa;      
     
import static javax.persistence.GenerationType.IDENTITY;      
     
import javax.persistence.Entity;      
import javax.persistence.GeneratedValue;      
import javax.persistence.Id;      
import javax.persistence.Table;      
     
import org.hibernate.annotations.Formula;      
     
/**     
 * 注解必须是在属性上的，如果有任何一个注解在方法上，那么@Formula将失效     
 * @author 昆明蜂鸟软件     
 * @version 0.1.0 2008-7-15 下午06:09:38     
 */     
@Entity     
@Table(name = "user", catalog = "test")      
public class User {      
          
    @Id     
    @GeneratedValue(strategy = IDENTITY)      
    private int id;      
     
    @Formula("(select COUNT(*) from user)")      
    private int count;      
     
    public int getId() {      
        return id;      
    }      
     
    public void setId(int id) {      
        this.id = id;      
    }      
     
    public int getCount() {      
        return count;      
    }      
     
    public void setCount(int count) {      
        this.count = count;      
    }      

} 

数据库表:Sql代码

    CREATE TABLE  `test`.`user` (      
      `id` int(10) unsigned NOT NULL auto_increment,      
      PRIMARY KEY  USING BTREE (`id`)      
    ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;  

细节1.使用@Formula 你的注解必须是在属性上，如果有一个注解在方法上，那么@Formula将失效。

这个我是做过实验的，比如把以上的java文件改为：

package aa;  
import static javax.persistence.GenerationType.IDENTITY;  
import javax.persistence.Entity;  
import javax.persistence.GeneratedValue;  
import javax.persistence.Id;  
import javax.persistence.Table;  
import org.hibernate.annotations.Formula;  
/**  
* 注解必须是在属性上的，如果有任何一个注解在方法上，那么@Formula将失效  
* @author 昆明蜂鸟软件  
* @version 0.1.0 2008-7-15 下午06:09:38  
*/  
@Entity  
@Table(name = "user", catalog = "test")  
public class User {  
private int id;  
@Formula("(select COUNT(*) from user)")  
private int count;  
<span style="color:#3333FF;">@Id  
@GeneratedValue(strategy = IDENTITY)  
public int getId() {  
return id;  
}  </span>
public void setId(int id) {  
this.id = id;  
}  
public int getCount() {  
return count;  
}  
public void setCount(int count) {  
this.count = count;  
}  
}  

这样@Formula就不可以运行！！！我前边就是被Hibernate官方的文档给搞晕了。

细节2.既然@Formula 是一个虚拟列，那么数据库中不需要建这一列，同样可以，如果有个列存在，hibernate也会将   其忽略。

以上示例中的user就没有count列。

细节3.sql语句必须写在()中，这个以前也有人说过。

细节4.如果有where子查询，那么表需要用别名，比如 select COUNT(*) from user where id=1 是错的

而select COUNT(*) from user u where u.id=1是正确的

细节5.只要是你在数据库的sql控制台执行过的语句，并且使用了表别名，那么@Formula都应该是支持的。

确实@Formula是一个很常用且好用的东西！