使用HIBERNATE的SQL查詢並將結果集自動轉換成POJO

在某些場合下，我們可能想使用HIBERNATE的框架提供的SQL查詢接口，但是，由於實體沒有做映射，HIBERNATE不能把結果集轉換成你想要的List<POJO>，本文討論如何在這種情況下讓HIBERNATE直接返回你想的結果。下面是簡單的查詢封裝方法 

public List<?> findObjectBySql(String queryString,Class<?> pojoClass){
                  //使用SQL構造查詢對象，此SQL是可以被JDBC接受的SQL，如SELECT * FROM XXX_TABLE
        Query query = this.getSession().createSQLQuery(queryString);
                  //設置結果集轉換器，這是本文重點所在
        query.setResultTransformer(new EscColumnToBean(pojoClass));
                  //返回查詢結果
        return query.list();

    上面這個方法很簡單，如果查的是USER表，並且pojoClass參數傳入的就是USER.class的話，那么返回結果集的就是List<User>。當然在我的應用中還有查詢條件封裝，分頁和自動查詢總行數等邏輯，不想把主題分散，所以給省略了。 
     下面是結果集轉換器的完整代碼 

package com.lgdlgd.hibernate;

import java.lang.reflect.Field;
import java.util.List;

import org.hibernate.HibernateException;
import org.hibernate.property.ChainedPropertyAccessor;
import org.hibernate.property.PropertyAccessor;
import org.hibernate.property.PropertyAccessorFactory;
import org.hibernate.property.Setter;
import org.hibernate.transform.ResultTransformer;

import com.esc.common.baseclass.BaseModel;

/**
 * 自定義的數據庫字庫轉換成POJO
 */
public class EscColumnToBean implements ResultTransformer {
    private static final long serialVersionUID = 1L;
    private final Class<? extends BaseModel> resultClass;
    private Setter[] setters;
    private PropertyAccessor propertyAccessor;

    public EscColumnToBean(Class<? extends BaseModel> resultClass) {
        if(resultClass==null) throw new IllegalArgumentException("resultClass cannot be null");
        this.resultClass = resultClass;
        propertyAccessor = new ChainedPropertyAccessor(new PropertyAccessor[] { PropertyAccessorFactory.getPropertyAccessor(resultClass,null), PropertyAccessorFactory.getPropertyAccessor("field")});
    }

    //結果轉換時，HIBERNATE調用此方法
    public Object transformTuple(Object[] tuple, String[] aliases) {
        Object result;

        try {
            if(setters==null) {//首先初始化，取得目標POJO類的所有SETTER方法
                setters = new Setter[aliases.length];
                for (int i = 0; i < aliases.length; i++) {
                    String alias = aliases[i];
                    if(alias != null) {
                        //我的邏輯主要是在getSetterByColumnName方法里面，其它都是HIBERNATE的另一個類中COPY的
                        //這里填充所需要的SETTER方法
                        setters[i] = getSetterByColumnName(alias);
                    }
                }
            }
            result = resultClass.newInstance();

            //這里使用SETTER方法填充POJO對象
            for (int i = 0; i < aliases.length; i++) {
                if(setters[i]!=null) {
                    setters[i].set(result, tuple[i], null);
                }
            }
        } catch (InstantiationException e) {
            throw new HibernateException("Could not instantiate resultclass: " + resultClass.getName());
        } catch (IllegalAccessException e) {
            throw new HibernateException("Could not instantiate resultclass: " + resultClass.getName());
        }

        return result;
    }

    //根據數據庫字段名在POJO查找JAVA屬性名，參數就是數據庫字段名，如：USER_ID
    private Setter getSetterByColumnName(String alias) {
        //取得POJO所有屬性名
        Field[] fields = resultClass.getDeclaredFields();
        if(fields==null || fields.length==0){
            throw new RuntimeException("實體"+resultClass.getName()+"不含任何屬性");
        }
        //把字段名中所有的下杠去除
        String proName = alias.replaceAll("_", "").toLowerCase();
        for (Field field : fields) {
            if(field.getName().toLowerCase().equals(proName)){//去除下杠的字段名如果和屬性名對得上，就取這個SETTER方法
                return propertyAccessor.getSetter(resultClass, field.getName());
            }
        }
        throw new RuntimeException("找不到數據庫字段 ："+ alias + " 對應的POJO屬性或其getter方法，比如數據庫字段為USER_ID或USERID，那么JAVA屬性應為userId");
    }

    @SuppressWarnings("unchecked")
    public List transformList(List collection) {
        return collection;
    }

}

我這個轉換器工作的前提是數據庫的字段名除了可以含有下杠外，不能再含有其它 POJO對應屬性中沒有的字符，如USER_ID 對應POJO的userId。 
擴展點： 
1、可以自定義數據庫與POJO屬性的對應關系，在查詢方法中構造轉換器時，通過參數把轉換關系傳入進來，這樣就可實現自由轉換了，但請注意這種轉換關系只有非常通用才有價值（上面的轉換規則就是：字段名去除下杠 = JAVA屬性名），反之如果每個實體都有自己特有的轉換關系，那就還不如編寫一個HIBERNATE的映射文件了。 
2、本類沒有考慮關聯，即自定義的對象屬性，但這些都不難實現，有興趣的朋友可結合我的第一篇文章來實現。 

注意：HIBERNATE3.25以前（后面的沒看），對SQL查詢的CHAR類型字段處理不好，只返回一位，且是JAVA的CHAR類型，要修改CharacterType類的代碼以返回該類型字段的全值 

后記：有朋友說到，HIBERNATE本身也支持這種封裝，直接使用HIBERNATE原有的封裝： 

Query query = this.getSession().createSQLQuery(queryString).addEntity(pojoClass);

這樣后面就不需要設置結果轉換器了，但是這樣做的前提是實體必須要有映射