在Java SE中使用Hibernate框架

bluecrystal 2006-02-16

展開全文

在Java SE中使用Hibernate框架

　　目前人們很容易發(fā)現(xiàn)Hibernate正迅速的成為流行的J2EE的O/R映射工具和數(shù)據(jù)集成框架（如果不是最流行的）。Hibernate為企業(yè)應(yīng)用開發(fā)者操作關(guān)系數(shù)據(jù)庫的提供了清晰明了而又強(qiáng)大的工具。然而如果你需要在外部訪問那些包裝在J2EE web應(yīng)用里的實體，情況又怎樣呢？你的開發(fā)跟應(yīng)用獨(dú)立分開，卻又相同的實體以訪問你的數(shù)據(jù)嗎？又或者你得編寫附加的web組件來管理對數(shù)據(jù)的內(nèi)部訪問嗎？

　　在很多情況下，這些問題都會出現(xiàn)。我的情況是我的公司需要將來自多個供應(yīng)商，有著多種文件格式的記錄導(dǎo)入到數(shù)據(jù)庫里。我想起我以前經(jīng)常使用的方法，那就是編寫Shell和SQL教本（甚至是存儲過程）來導(dǎo)入數(shù)據(jù)。但是由于我們的數(shù)據(jù)模型太過復(fù)雜，我決定在web應(yīng)用之外盡可能的利用現(xiàn)有的實體，Spring DAO以及服務(wù)并且開發(fā)一個自定義的J2SE命令行數(shù)據(jù)加載工具。

　　大問題：你該怎樣呢？

　　現(xiàn)在很多Hibernate的文檔和范例都是綁定在容器上。不管是web應(yīng)用還是內(nèi)部的大型應(yīng)用，總會使用到容器的。人們有很好的理由去使用它。容器是設(shè)計來提供對各種特性的支持，例如事務(wù)處理，線程以及安全?，F(xiàn)今，這些特性都是開發(fā)中等規(guī)模和企業(yè)應(yīng)用所必需的工具。然而當(dāng)你需要在容器之外訪問實體時，你該怎樣呢？你是使用現(xiàn)有的架構(gòu)和代碼呢，還是會從一個不同的角度來解決問題，比如說完全采用另一種開發(fā)語言？當(dāng)然，我們沒有正確答案。在本文的余下部分，我將說明我的方法：就是在Spring容器之外重用現(xiàn)有的實體/POJO。

　　起初，腳本語言，例如Perl，Python，Ruby甚至Tcl（是的，我以前也做過這個）看起來有很多優(yōu)勢。它們能省下很多時間，可以輕易得到初始結(jié)果，還能規(guī)避許多Hibernate潛在的復(fù)雜度。人們完全可能只用幾行代碼就可以連接數(shù)據(jù)庫，查詢結(jié)果，已經(jīng)打印輸出到終端屏幕或者日志文件。然而，取決于你的數(shù)據(jù)模型，事情也（總是）會變得相當(dāng)復(fù)雜。譬如說你有一個表 person, 其中有一個外鍵屬于表 address。當(dāng)我們添加數(shù)據(jù)的時候，表address沒有正確的插入數(shù)據(jù)，就會導(dǎo)致表person 也不能插入了。這是個很典型的事務(wù)處理方面的問題。也許有人會說在腳本語言中這個問題不難解決，就像在你的主程序里一樣?？墒菃栴}仍然存在，為什么要這樣做呢？業(yè)務(wù)邏輯不是已經(jīng)在你的應(yīng)用里面了嗎？為什么要在寫一遍代碼呢？而且這并不是唯一的情況，你必須重復(fù)你的工作和業(yè)務(wù)邏輯，這樣就會帶來出錯的可能。

　　然而，有些人會覺得這樣也行，他們使用自己覺得最適合的工具。也許你已經(jīng)因為程序之外的原因而有了某種獨(dú)立的架構(gòu)；也許你會在獨(dú)立的數(shù)據(jù)庫里加載和測試數(shù)據(jù)，然后在通過各種測試后再遷移到產(chǎn)品的數(shù)據(jù)庫里；又也許你把數(shù)據(jù)庫維護(hù)外包出去，你只需要把相關(guān)文件發(fā)給合作伙伴讓他們?nèi)ヌ幚砟切﹩栴}?？傊?，總會有很多理由不使用現(xiàn)有的Hibernate數(shù)據(jù)層。沒有誰對誰錯，只是如果你可以也愿意在你的應(yīng)用之外使用現(xiàn)有的代碼，請往下看。我會告訴你一些方法，這能解決你不少的煩惱噢。

　　配置

　　如果你覺得可以在容器之外使用現(xiàn)有的Hibernate對象的話，那你首先要做的事就是得自己手工管理所有的配置項，在本文余下部分我所采用的方法是使用一個基于命令行的JAVA程序。既然你已經(jīng)配置了Hibernate XML配置文件，你應(yīng)該知道需要提供的參數(shù)，例如JNDI DataSource名，實體映射文件，還有其他一些處理SQL日志的屬性。如果你想使用命令行程序的話，你就得解決如何解析XML文件和把它添加到配置項中的這些問題。雖然解析XML文件也不難，但這本身并不是我們的重點。因此，我建議使用propetries文件，properties文件比較直觀而且容易加載并從中讀取數(shù)據(jù)。下面是配置Hibernate所需要的最小屬性集（不包括任何實體映射）。

　　清單1：

hibernate.dialect=net.sf.hibernate.dialect.PostgreSQLDialect
hibernate.connection.driver_class=org.postgresql.Driver
hibernate.connection.url=jdbc:postgresql://devserver/devdb
hibernate.connection.username=dbuserhibernate.connection.password=dbpassword
hibernate.query.substitutions yes ‘Y‘

　　正如你所看到的，上面的屬性值指定了數(shù)據(jù)庫方言，JDBC驅(qū)動，數(shù)據(jù)庫url，用戶名，用戶密碼，以及是否使用查找替換。只要定義以上幾項數(shù)值并保存在文件hibernate.properties里（要放置在你的類路徑里面哦），就能很輕松的加載，填充到Hibernate Configuation類里面。

　　清單2：

Properties props = new Properties();
try {
　props.load(props.getClass().getResourceAsStream("hibernate.properties"));
}catch(Exception e){
　System.out.println("Error loading hibernate properties.");
　e.printStackTrace();
　System.exit(0);
}
String driver = props.getProperty("hibernate.connection.driver_class");
String connUrl = props.getProperty("hibernate.connection.url");
String username = props.getProperty("hibernate.connection.username");
String password = props.getProperty("hibernate.connection.password");
// In my examples, I use Postgres, but Hibernate
// supports virtually every popular dbms out
there.Class.forName("org.postgresql.Driver");
Connection conn = DriverManager.getConnection(connUrl, username, password);
Configuration cfg = new Configuration();
cfg.setProperties( props );
SessionFactory sessions = cfg.buildSessionFactory();
Session session = sessions.openSession(conn);

　　這樣我們就得到了Hibernate Session類了。但我們也有必要解決如何利用現(xiàn)有的實體映射這個問題。在《Hibernate in Action》一書中，提到怎樣從實體映射XML文件中加載，如下所示：

　　清單3：

Configuration cfg = new Configuration();
cfg.addResource("hello/Message.hbm.xml");
cfg.setProperties( System.getProperties() );
SessionFactory sessions = cfg.buildSessionFactory();

　　這段代碼清晰的說明了從hello包里加載Message實體定義的過程。對于這個例子來說還好，但對那些有多個實體的應(yīng)用來說，就很單一而且容易出錯。不僅映射關(guān)系是硬編碼，還得手工管理每次添加一個新的實體就要更新實體加載的代碼。其實有跟簡單的方法去查找和加載映射關(guān)系以使其與最新的jar文件保持一致。

　　首先，在你的web服務(wù)器或者企業(yè)服務(wù)器里，映射文件需要放置在類路徑里，這樣Hibernate才能正常的運(yùn)行。這樣做是很有好處的，因為你所需要做的就是使用同樣的jar包和查找相應(yīng)的映射文件的名字。因為你可能會有多個jar文件在你的類路徑里，你需要指定哪個jar包包含了映射文件。以下就是一種查找映射關(guān)系的方法

　　清單4：

String cp = System.getProperty("java.class.path");
String jarFile = null;
List hbmList = null;String[] cparr = cp.split("\\:");
for(int j=0;j<cparr.length;j++){
　// The following assumes our entities
　// are wrapped up in a jar file
　// called ‘dbobjs.jar‘
　if(cparr[j].indexOf("dbobjs.jar") != -1)
　　jarFile=(cparr[j]);
}
if(jarFile != null){
　JarFile jar = new JarFile(new File(jarFile));
　Enumeration e = jar.entries();
　if(e.hasMoreElements())
　{
　　hbmList = new ArrayList();
　　while(e.hasMoreElements()){
　　　// Object comes back as JarFile$JarFileEntry
　　　JarEntry entry = (JarEntry)e.nextElement();
　　　if(entry.getName().indexOf(".hbm.xml") != -1)
　　　{
　　　　hbmList.add(entry.getName());
　　　}
　　}
　}else {
　　System.out.println("Error: The entity jar dbobjs.jar was not found in " + "classpath: " + cp);
　}
}

　　上面的代碼主要完成了以下幾件事情：獲取Java虛擬機(jī)初始化的classpath系統(tǒng)屬性；查找含有實體映射文件的jar包；解析映射文件的名字，然后添加到一個ArrayList對象中去。當(dāng)我們的ArrayList對象裝滿了實體映射的名字后，就可以將其傳遞到Hibernate Configuration 對象，如下所示：

　　清單5：

Configuration cfg = new Configuration();
Iterator iterator = hbmFileNames.iterator();
while(iterator.hasNext()){
　cfg.addResource((String)iterator.next());
}

　　只要我們在Hibernate Session 對象里配置好正確的映射關(guān)系，我們就可以將實體拿來使用了。