一種基于源碼分析和代碼生成的ORM開發(fā)工具

瞿華

摘要：目前在開發(fā)信息系統(tǒng)時，數據持久化功能多采用ORM（對象——關系映射）框架，如Hiberate、MyBatis來進行。這類框架降低了數據持久化功能開發(fā)工作量，提升了軟件開發(fā)和維護的效率，但同時也降低了系統(tǒng)的運行速度、消耗了更多的內存等資源。針對現(xiàn)有ORM框架運行效率低的缺點，該文提出了一種在代碼開發(fā)階段使用源碼分析獲取ORM元信息，自動生成相關代碼的數據持久化功能開發(fā)方法，并以Intelli IDEA平臺插件的形式設計和開發(fā)了相應的工具——EasyPersist 。本文通過實驗程序，將自動生成的持久化代碼與使用Hibernate框架的代碼進行了對比實驗，證明了所提出的方法的有效性。

關鍵詞：數據持久化；ORM；源碼分析；代碼生成

中圖分類號：TP317 文獻標識碼：A 文章編號：1009-3044（2016）20-0083-04

1 背景

黑龍江省森林工業(yè)總局（龍江森工）是我國最大的國有林區(qū)和森林工業(yè)集團。龍江森工為了提升自身的管理水平，委托筆者所在的課題組開發(fā)和實施智慧林業(yè)信息管理平臺項目。筆者在項目的調研過程中了解到，基層職工多，包袱重，人均收入低，信息化投入有限，是影響國有林業(yè)企業(yè)基層信息管理系統(tǒng)普及的重要因素。因此，盡可能地提高信息系統(tǒng)的運行效率，降低系統(tǒng)對運行環(huán)境的要求，減少系統(tǒng)運維成本，對于在林業(yè)部門普及和推廣信息系統(tǒng)具有重要的意義。

為了應對問題領域的復雜性，較好地適應需求的變化，目前的信息系統(tǒng)大多采用面向對象方法進行開發(fā)，用實體對象[1]來組織和表示系統(tǒng)在運行過程中獲取和產生的各種信息。而與此同時，在信息的持久化存儲上，大多數信息系統(tǒng)還在采用傳統(tǒng)的關系式數據庫，即使用關系數據表來存儲信息。因此，在大多數信息系統(tǒng)中，都必須通過某種方式來實現(xiàn)從對象和關系式數據的轉換，即所謂的對象——關系映射（Object-Relational Mapping，簡稱ORM）功能[2-4]。

目前有多種ORM框架，如Hiberante[5]、iBatis[6]等，可以幫助開發(fā)者簡化ORM功能的開發(fā)。這些ORM框架都是在程序運行時，通過反射來動態(tài)訪問實體對象的屬性和方法[7， 8]，不需要對象實現(xiàn)特殊的接口或方法，具有較高的靈活性，易于部署和使用，因此得到了廣泛的應用。

但這些ORM框架也存在一些天然的缺陷，如：1）必須使用反射機制動態(tài)訪問實體對象，增加了系統(tǒng)運行時的開銷，降低了系統(tǒng)的運行效率；2）數據庫操作完全在程序運行時動態(tài)生成，開發(fā)人員難以控制和優(yōu)化[9-12]等。

針對傳統(tǒng)ORM框架運行效率較低的缺點，本文提出了一種新的在代碼開發(fā)階段，自動生成源代碼的ORM開發(fā)方法，并在Intellij IDEA平臺①上設計和實現(xiàn)了相應的ORM開發(fā)工具——EasyPersist②。使用該工具，可以自動生成實體類的ORM持久化代碼。生成的代碼可供開發(fā)人員利用繼承或嵌入等方式直接使用，也可以自由的進行修改和優(yōu)化。因此本方法在未犧牲開發(fā)效率的前提下，為開發(fā)人員提供了更大的靈活性。此外，由于沒有運行時的反射等開銷，最終程序的代碼運行效率也更高。該工具在實際項目《龍江森工集團智慧決策平臺》的開發(fā)中得到了應用，取得了較好的效果。

2 問題描述

2.1 ORM功能

在使用面向對象方法開發(fā)的系統(tǒng)中，實體對象（Entity）是數據的基本組織和存儲單位，數據多以實體對象屬性的形式存在。當系統(tǒng)需要將實體對象中的數據持久化保存到數據庫中時，必須將實體對象的屬性值轉化成對應的數據記錄的字段參數；同樣的，當系統(tǒng)需要從數據庫中載入數據時，也必須將數據庫返回的查詢結果中的字段數據轉化為對應的實體對象屬性，如表1所示。這就是所謂的ORM功能。

由于ORM本質上是對數據庫訪問接口的機械調用和數據格式之間的轉換，因此可以用某種自動化工具來對其進行封裝，從而簡化系統(tǒng)的開發(fā)。根據這一思想，產生了ORM框架。使用ORM框架開發(fā)的系統(tǒng)，無須編寫數據庫訪問和數據映射轉換代碼，只需要將轉換信息（ORM元信息）提供給ORM框架，然后調用相關的API即可。除此之外，很多ORM框架還提供了實體間關系映射的處理、緩存等高級功能。

但這些框架都需要在系統(tǒng)運行時，動態(tài)生成SQL查詢語句，并通過反射等方式動態(tài)創(chuàng)建和訪問實體對象，因此需要額外消耗一定的內存和CPU等資源，與手工編寫的ORM相比，運行效率較低；此外，由于SQL語句在運行時動態(tài)生成，難以對其進行手動優(yōu)化，因此這類框架也普遍存在著復雜查詢效率低的問題。

2.2 ORM元數據與注解

ORM主要是實體對象（屬性）和關系數據（字段）之間的轉換，不管哪種ORM工具，都需要知道實體和數據表、屬性和字段等之間的對應關系，才能完成轉換。這些對應信息就構成了所謂的ORM元信息（meta information）。目前，主要有三種方法來提供ORM元信息，即約定[13]、XML映射文件和注解[14， 15]。

約定方式是指程序開發(fā)者按照預先約定好的規(guī)則來命名相關的程序和數據庫元素，如要求實體類和數據表的名稱必須相同等。這種方法工作量較小，但靈活性和兼容性差，主要用在各種快速開發(fā)框架中；XML映射文件方式是指以XML格式的配置文件提供相關的ORM元信息，使用較為靈活，但配置信息和程序代碼分離也帶來了一些開發(fā)維護上的問題；注解方式是通過特殊的語法，將元數據直接以注解（Annotation）的形式嵌入在程序源代碼和編譯后的可執(zhí)行代碼中，開發(fā)、維護和使用較為便利，目前也得到了廣泛的應用。本文也采用這種方法來提供實體類的ORM元信息。表2是采用JPA 2.1標準注解提供ORM元信息的實體類示例：

3 工作原理

目前各種ORM框架，如Java社區(qū)常用的Hibernate，MyBatis等，其基本工作原理類似，如圖1所示：

1）系統(tǒng)啟動時，首先通過讀取XML文件、解析代碼中的注解信息等方式載入ORM元信息；2）當系統(tǒng)需要進行數據持久化時，調用ORM框架提供的API接口方法；3）ORM框架一方面通過反射機制訪問實體對象中的相應屬性或方法，從而實現(xiàn)對象中信息的讀取或更新；另一方面根據元信息動態(tài)生成SQL語句，訪問關系式數據庫進行數據存取。

為了解決ORM框架在運行時工作帶來的運行效率低下的問題，本文提出的EasyPersist工具，其工作原理與傳統(tǒng)的ORM有較大的區(qū)別，如圖2所示：

1）EasyPersist工作在代碼開發(fā)階段。開發(fā)人員完成了實體類和ORM元信息的開發(fā)后，手動執(zhí)行EasyPersist工具；

2）EasyPersist工具讀入實體類的源代碼，分析其注解信息，從而得到ORM元信息，建立ORM映射模型；

3）EasyPersist根據ORM映射模型，生成實體類對應的數據持久化源代碼（以數據持久化類的形式）；

4）開發(fā)人員在程序中使用自動生成的源代碼。

由于EasyPersist自動化生成相關的源代碼，因此其開發(fā)的效率與使用ORM框架相比，是相同的；同時，由于生成的源代碼中未對數據庫操作和數據庫轉換操作進行額外的封裝，因此它的執(zhí)行效率與手工編寫的代碼相當，比傳統(tǒng)的ORM框架要更加高效。

4 EasyPersist工具設計與實現(xiàn)

4.1 EasyPersist的整體結構

EasyPersist的整體結構如圖3所示，主要包括四大子模塊，即：

1）XML配置文件解析模塊（Config Parser），負責解析XML配置文件，獲取實體類所在包和持久化代碼輸出目錄等相關配置信息；

2）實體關系模型倉庫（Mapping Repository），用于儲存各實體類對應的ORM元信息；

3）源代碼分析模塊（Package Scaner），用于分析實體類的源代碼，獲取實體類對應的ORM的元信息，并存儲到實體關系模型倉庫中；

4）代碼生成模塊（Persistor Generator），從實體關系模型倉庫中讀取各實體的ORM元信息，生成最終的持久化代碼。

4.2 源代碼分析算法

源代碼分析模塊是EasyPersist的核心模塊之一，其作用是對程序源代碼進行分析，找出實體類以及對應的ORM元信息。其核心算法如表3所示：

4.3 代碼生成算法

代碼生成是EasyPersist的另一個核心模塊，其作用是根據已有的ORM元信息，生成對應實體的持久化代碼。其核心算法見表4。

4.4 條件查詢與分頁

除了基本的CRUD操作外，在信息系統(tǒng)中還經常需要查找屬性符合特定條件的實體，即進行條件查詢操作。由于每一個實體類都可能會有多個屬性，將各屬性的所有可能組合都一一列舉出來分別生成一個對應的查詢方法，會導致生成的代碼過分龐大。因此，需要通過某種方式，在ORM元信息中指明可能的條件查詢方式。

實際上，在關系數據庫的查詢中，往往采用建立索引的方式來對條件查詢進行優(yōu)化。因此，可以在實體類代碼中嵌入JPA2.1標準中的@Index和@UniqueContstraint等注解，以提供數據庫中的索引信息，如表5所示。

EasyPersist在源代碼分析時讀取這些元信息，然后在代碼生成根據元信息推斷出信息系統(tǒng)可能的條件查詢方式，并生成相應的條件查詢代碼。

根據索引和被索引字段類型的不同，其可能的條件查詢方式和返回結果也不同：

1）對于唯一型索引，其可以有兩種查詢方式：a.要求被索引字段（屬性）的值與查詢關鍵字相等，此時查詢結果應是唯一的；b.要求被索引字段（屬性）的值位于查詢關鍵字限定的某個范圍內，此時查詢結果是一組實體對象。因此，對于此種索引，可以針對兩種情況分別生成兩個查詢方法。

2）對于非唯一型索引，不管是要求與查詢關鍵字相等還是要求位于某一范圍內，其查詢結果都可能是一組實體對象。因此。這種索引只需要生成一個查詢方法。

此外，針對信息系統(tǒng)中常見的分頁要求，EasyPersist一方面在返回一組對象的查詢方法中增加了相關的參數，另一方面為每個索引生成一個對應的計數方法。

最終得到的條件查詢方法生成算法如表6所示。

5 試驗

筆者在Core i5，16G內存，Windows 7 64位， JDK 1.8.0_60 64位環(huán)境下，對使用Hibernate框架編寫和用EasyPersist生成的持久化代碼進行了對比測試。具體測試內容如下：

1）實驗一，將1000個實體對象依次保存到空的數據表中，記錄所用總時間和內存；

2）實驗二，從數據表中讀取全部的1000條記錄，重復1000次，記錄所用總時間和內存；

3）實驗三，從數據表中讀取所有符合特定查詢條件的記錄（有索引），重復1000次，記錄所用總時間和內存。

三項實驗分別進行了1000次，結果如表7-9所示

從實驗結果可見，與Hibernate框架相比，使用EasyPersist生成的持久化代碼，其運行時間更短，使用的內存資源也更少；特別是進行數據的讀取查詢處理時，在內存資源的使用上有近百倍的差別。因此，EasyPersist具有明顯的優(yōu)越性。

6 結束語

本文針對以Hibernate為代表的 ORM框架的運行時速度較慢，資源占用較高等缺點，提出了一種在代碼開發(fā)時通過源碼分析提取ORM元信息，從而自動生成數據持久化源代碼的ORM開發(fā)方法，并開發(fā)出了相應的EasyPersist工具。實驗證明，使用該工具生成的數據持久化代碼，與使用傳統(tǒng)ORM框架開發(fā)的數據持久化代碼相比，開發(fā)和維護效率相當，而在運行速度和內存占用上都有較明顯的改善，從而可以減少系統(tǒng)對運行環(huán)境的要求，更加有利于信息系統(tǒng)在基層林業(yè)部門的普及和推廣。

注釋：

① http：//www.jetbrains.com/idea.

② https：//github.com/royqh1979/EasyPersist.

參考文獻：

[1] Masliankoa P P， Maistrenkoa A S. A system of entities for enterprise business models[J]. Cybernetics and Systems Analysis， 2012， 48（1）： 99-107.

[2] Wang Y， Xu，Y. Research of solutions of object-relational mapping in JAVA platform[C]//2011 International Conference on Control， Automation and Systems Engineering， Singapore， Singapore， 2011.

[3] Zyl P V， Kourie D G.The influence of optimisations on the performance of an object relational mapping tool[C]//Proceedings of the 2009 Annual Research Conference of the South African Institute of Computer Scientists and Information Technologists， Vanderbijlpark， Emfuleni， South Africa. ACM， 2009.

[4] 李杰. 基于ORM的輕量級數據持久化技術研究及應用[J]. 計算機科學， 2010， 37（9）： 190-193， 208.

[5] O'Neil E. Object/Relational mapping 2008： Hibernate and the entity data model （EDM）[C]//2008 ACM SIGMOD International Conference on Management of Data， Vancouver， BC， Canada. 2008.

[6] 程文波， 盧涵宇. 一種新的數據持久層設計方法與實現(xiàn)[J]. 微電子學與計算機， 2011（7）： 28-30.

[7] Gotz S， Kuhn T. Models@run.time for object-relational mapping supporting schema evolution[C]//10th International Workshop on Models@run.time， MRT 2015 - co-located with the 18th International Conference on Model Driven Engineering Languages and Systems， MoDELS 2015， September 29， 2015， Ottawa， ON， Canada. CEUR-WS， 2015.

[8] Kurtev I. Application of reflection in a model transformation language[J]. Software & Systems Modeling， 2009， 9（3）： 311-333.

[9] Cvetkovi S， Jankovi D. A Comparative Study of the Features and Performance of ORM Tools in a .NET Environment[C]// Dearle A， Zicari R V. Objects and Databases： Third International Conference， ICOODB 2010， Frankfurt/Main， Germany， September 28-30， 2010. Proceedings. Berlin， Heidelberg： Springer Berlin Heidelberg， 2010：147-158.

[10] Gruca A， Podsiadlo P. Performance Analysis of .NET Based Object-Relational Mapping Frameworks[C]//Beyond Databases， Architectures and Structures - 10th International Conference， BDAS 2014， Proceedings. Springer Verlag， 2014.

[11] Yousaf H. Performance Evaluation of Java Based Object Relational[J]. Mehran University Research Journal of Engineering & Technology， 2013， 32（2）： 160-166.

[12] Chen T H， Shang W. Detecting performance anti-patterns for applications developed using object-relational mapping[C]//Proceedings of the 36th International Conference on Software Engineering， Hyderabad， India. ACM， 2014.

[13] 黃強， 張曉梅. 一個基于類型元數據的輕量級ORM框架設計[J]. 計算機工程， 2007（22）： 54-56，59.

[14] 何成萬， 張立軍. 基于元數據和反射的面向方面軟件演化方法[J]. 電子學報， 2011（8）： 1771-1777.

[15] Prakash S， Saini J. Features of Annotations and their Applications[J]. International Journal of Computer Applications， 2011， 16（8）： 14-21.