自己寫ORM框架 DBUtils_DG Java（C#的寫在鏈接里）

ORM框架想必大家都比較熟知了，即對象關係映射（英語：Object Relation Mapping，簡稱ORM，或O/RM，或O/R mapping），是一種程式技術，用於實現面向對象編程語言里不同類型系統的數據之間的轉換。從效果上說，它其實是創建了一個可在編程語言里使用的“虛擬對象資料庫”。 當你開發一個應用程式的時候(不使用O/R MAPPING),你可能會寫不少數據訪問層的代碼，用來從資料庫保存，刪除，讀取對象信息，等等。

你在DAO中寫了很多的方法來讀取對象數據，改變狀態對象等等任務。而這些代碼寫起來總是重覆的。我們可不可以寫一個類來封裝這些重覆的勞動呢？

想必大家都有曾經想過寫DBUtils_DG吧，實際上，從DBUtils_DG一步步寫下來，封裝到足夠好之後，就會成為一個自己專屬的ORM框架了。

在這裡，小編寫了一個很基礎的類ORM的DBUtils_DG裡面僅僅對Select查詢語句進行了封裝，由於考慮到了反射機制的詬病（這裡不再討論，關於反射效率問題有大多數的討論，利與弊總是同時存在的，我們不糾結於這點）。對於常見的CRUD來說，CUD通常一個方法可以實現，並且Sql語句可以得到更大的封裝結合配置文件和反射機制進行操作。小編這裡採用的模式是MySql+DBUtils_DG+代碼生成器（需要代碼生成器的可以聯繫本人,不定期更新）來完成的代碼編寫工作，因此沒有對CUD進行大量的封裝，同時也提高了執行效率（你懂的）。

接下來我貼上我的代碼（裡面註釋採用中文註釋，比較完善有不懂的可以咨詢本人）:

  1 package liuyanban.Utils;
  2 
  3 import java.io.IOException;
  4 import java.io.InputStream;
  5 import java.lang.reflect.Field;
  6 import java.sql.CallableStatement;
  7 import java.sql.Connection;
  8 import java.sql.DriverManager;
  9 import java.sql.PreparedStatement;
 10 import java.sql.ResultSet;
 11 import java.sql.ResultSetMetaData;
 12 import java.sql.SQLException;
 13 import java.util.ArrayList;
 14 import java.util.List;
 15 import java.util.Properties;
 16 
 17 import org.json.JSONArray;
 18 import org.json.JSONObject;
 19 
 20 public abstract class DBUtils_DG {
 21     // 資料庫驅動類名稱
 22     private static String driver_class = null;              //"com.mysql.jdbc.Driver";
 23     // 連接字元串
 24     private static String driver_url = null;                //"jdbc:mysql://localhost:3306/db_liuyanban";
 25     // 用戶名
 26     private static String database_user = null;                //"root";
 27     // 密碼
 28     private static String database_password =null;            // "root";
 29     // 創建資料庫連接對象
 30     private static Connection connnection = null;
 31     // 創建結果集對象
 32     private static ResultSet resultSet = null;
 33     // 創建PreparedStatement對象
 34     private static PreparedStatement preparedStatement = null;
 35     // 創建CallableStatement對象
 36     private static CallableStatement callableStatement = null;
 37 
 38     static {
 39         try {
 40             Properties properties = new Properties();
 41             InputStream fis = DBUtils_DG.class.getClassLoader().getResourceAsStream("db.properties");// 載入資料庫配置文件到記憶體中放在同src下
 42             try {
 43                 properties.load(fis);// 獲取資料庫配置文件
 44                 driver_class = properties.getProperty("driver_class").toString();
 45                 driver_url =properties.getProperty("driver_url").toString();
 46                 database_user =properties.getProperty("database_user").toString();
 47                 database_password =properties.getProperty("database_password").toString();
 48             } catch (IOException e) {
 49                 e.printStackTrace();
 50             }
 51             Class.forName(driver_class);  // 載入資料庫驅動程式
 52         } catch (ClassNotFoundException e) {
 53             System.out.println("載入驅動錯誤");
 54             System.out.println(e.getMessage());
 55         }
 56     }
 57     /**
 58      * 所有執行方法的輔助器(共同參與的部分)
 59      * @param sql SQL語句
 60      * @param params 參數數組，若沒有參數則為null
 61      */
 62     private static void SqlPrepareCommand(String sql, Object... params)
 63     {
 64         try {
 65             // 獲得連接
 66             connnection = DriverManager.getConnection(driver_url, database_user, database_password);
 67             // 調用SQL
 68             preparedStatement = connnection.prepareStatement(sql);
 69             // 參數賦值
 70             if (params != null) {
 71                 for (int i = 0; i < params.length; i++) {
 72                     preparedStatement.setObject(i + 1, params[i]);
 73                 }
 74             }
 75         } catch (Exception e) {
 76             System.out.println(e.getMessage());
 77         }
 78     }
 79 
 80     /**
 81      * insert update delete SQL語句的執行的統一方法
 82      * @param sql SQL語句
 83      * @param params 參數數組，若沒有參數則為null
 84      * @return 受影響的行數
 85      */
 86     public static boolean executeUpdate(String sql, Object...params) {
 87         try {
 88             SqlPrepareCommand(sql, params);//調用通用的初始化方法來設置參數
 89             return preparedStatement.executeUpdate()>0?true:false;// 執行
 90         } catch (SQLException e) {
 91             System.out.println(e.getMessage());
 92             return false;
 93         } finally {
 94             // 釋放資源
 95             closeAll();
 96         }
 97     }
 98 
 99     /**
100      * SQL 查詢將查詢結果直接放入ResultSet中
101      * @param sql SQL語句
102      * @param params 參數數組，若沒有參數則為null
103      * @return 結果集
104      */
105     public static ResultSet executeQueryResultSet(String sql, Object... params) {
106         try {
107             SqlPrepareCommand(sql, params);                //調用通用的初始化方法來設置參數
108             return preparedStatement.executeQuery();     // 執行
109         } catch (SQLException e) {
110             System.out.println(e.getMessage());
111             return null;
112         }
113     }
114 
115     /**
116      * SQL 查詢將查詢結果：一行一列 (左上角的結果)
117      * @param sql SQL語句
118      * @param params 參數數組，若沒有參數則為null
119      * @return 結果集
120      */
121     public static Object executeQuerySingleData(String sql, Object... params) {
122         try {
123             resultSet=executeQueryResultSet(sql, params);
124             return  resultSet.next()?resultSet.getObject(1):null;
125         } catch (SQLException e) {
126             System.out.println(e.getMessage());
127             return null;
128         } finally {
129             closeAll();
130         }
131     }
132     /**
133      * SQL 查詢將查詢結果：一行 返回class類型的對象(第一行結果)
134      * @param sql SQL語句
135      * @param params 參數數組，若沒有參數則為null
136      * @return 結果集
137      */
138     public static <T> T executeQuerySingleLine(Class<T> clazz,String sql, Object... params) {
139         try {
140             resultSet=executeQueryResultSet(sql, params);                                //從資料庫獲得結果集
141             if(resultSet != null) {
142                 ResultSetMetaData rsmd = resultSet.getMetaData();                          // 獲得結果集的MetaData
143                 T t = clazz.newInstance();                                                 // 通過反射創建 T 實例
144                 while(resultSet.next()){
145                     for(int i=1;i<=rsmd.getColumnCount();i++){
146                         Field tField =clazz.getDeclaredField(rsmd.getColumnLabel(i));    //獲取到單行記錄對應的欄位
147                         tField.setAccessible(true);                                        //設置通過反射訪問該Field時取消訪問許可權檢查
148                         tField.set(t, resultSet.getObject(rsmd.getColumnLabel(i)));        //獲取到每一行結果對應欄位的值並賦值給類屬性
149                     }
150                 }
151                 return t;                                                                  //返回賦值後的T對象
152             } else return null;
153         } catch (Exception e) {
154             return null;
155         }
156     }
157 
158     /**
159      * 獲取結果集，並將結果放在List中生成List<T> (多行數據)
160      * @param clazz 類
161      * @param sql SQL語句
162      * @params List結果集
163      */
164     public static <T> List<T> executeQueryList(Class<T> clazz,String sql, Object... params) {
165         try {
166             resultSet=executeQueryResultSet(sql, params);                                //從資料庫獲得結果集
167             List<T> list = new ArrayList<T>();                                          //實例化一個泛型List<T>保存結果的List
168             try {
169                 ResultSetMetaData rsmd = resultSet.getMetaData();                         // 獲得結果集的MetaData
170                 while (resultSet.next()){
171                     T t = clazz.newInstance();                                             // 通過反射創建 clazz 實例
172                     for(int i=1;i<=rsmd.getColumnCount();i++){
173                         try {
174                             Field tField =clazz.getDeclaredField(rsmd.getColumnLabel(i));    //獲取到單行記錄對應的欄位
175                             tField.setAccessible(true);                                        //設置通過反射訪問該Field時取消訪問許可權檢查
176                             tField.set(t, resultSet.getObject(rsmd.getColumnLabel(i)));        //獲取到每一行結果對應欄位的值並賦值給類屬性
177                         } catch (Exception e) {
178                             continue;
179                         }
180                     }
181                     list.add(t);                                                        //將實例化賦值的對象存到List<T>中
182                 }
183             } catch (Exception e) {
184                 System.out.println(e.getMessage());
185                 return null;
186             }
187             return list;//返回填充對象的list
188         }  finally {
189             closeAll();//調用自定義的關閉所有資源方法關閉所有資源
190         }
191     }
192 
193     /**
194      * 存儲過程帶有一個輸出參數的方法
195      * @param sql 存儲過程語句
196      * @param params 參數數組
197      * @param outParamPos 輸出參數位置
198      * @param SqlType 輸出參數類型
199      */
200     public static Object executeQueryProcedure(String sql, Object[] params,int outParamPos, int SqlType) {
201         Object object = null;
202         try {
203             connnection = DriverManager.getConnection(driver_url, database_user, database_password);
204             // 調用存儲過程
205             callableStatement = connnection.prepareCall(sql);
206             // 給參數賦值
207             if(params != null) {
208                 for(int i = 0; i < params.length; i++) {
209                     callableStatement.setObject(i + 1, params[i]);
210                 }
211             }
212             // 註冊輸出參數
213             callableStatement.registerOutParameter(outParamPos, SqlType);
214             // 執行
215             callableStatement.execute();
216             // 得到輸出參數
217             object = callableStatement.getObject(outParamPos);
218 
219         } catch (SQLException e) {
220             System.out.println(e.getMessage());
221         } finally {
222             // 釋放資源
223             closeAll();
224         }
225         return object;
226     }
227     /**
228      * 將查詢到的單行數據轉換成JsonObject
229      * @param sql SQL語句
230      * @param params 參數數組，若沒有參數則為null
231      * @return JSONObject結果
232      */
233     public static JSONObject executeQuerySingleLineToJsonObject(String sql, Object... params)
234     {
235         try {
236             resultSet=executeQueryResultSet(sql, params);                                //從資料庫獲得結果集
237             JSONObject jsonObject=new JSONObject();
238             if(resultSet != null) {
239                 ResultSetMetaData rsmd = resultSet.getMetaData();                          // 獲得結果集的MetaData
240                 while(resultSet.next()){
241                     for(int i=1;i<=rsmd.getColumnCount();i++){
242                         jsonObject.put(rsmd.getColumnLabel(i), resultSet.getObject(rsmd.getColumnLabel(i)));
243                     }
244                 }
245                 return jsonObject;                                                                  //返回賦值後的T對象
246             } else return null;
247         } catch (Exception e) {
248             return null;
249         }
250     }
251     /**
252      * 將ResultSet數據轉換成JsonArray
253      * @param sql SQL語句
254      * @param params 參數數組，若沒有參數則為null
255      * @return JSONArray結果集
256      */
257     public static JSONArray executeQueryResultSetToJsonArray(String sql, Object... params)
258     {
259         try {
260             resultSet= executeQueryResultSet(sql, params);
261             JSONArray jsonArray=new JSONArray();
262             if(resultSet != null) {
263                 ResultSetMetaData rsmd = resultSet.getMetaData();// 獲得結果集的MetaData
264                 while(resultSet.next()){
265                     JSONObject jsonMember =new JSONObject();
266                     for(int i=1;i<=rsmd.getColumnCount();i++){
267                         jsonMember.put(rsmd.getColumnLabel(i), resultSet.getObject(rsmd.getColumnLabel(i)));
268                     }
269                     jsonArray.put(jsonMember);
270                 }
271                 return    jsonArray;//返回賦值後的T對象
272             } else return null;
273         } catch (Exception e) {
274             System.err.println(e.getMessage());
275             return null;
276         }
277     }
278     /**
279      * 關閉所有資源
280      */
281     private static void closeAll() {
282         // 關閉結果集對象
283         if (resultSet != null) {
284             try {
285                 resultSet.close();
286             } catch (SQLException e) {
287                 System.out.println(e.getMessage());
288             }
289         }
290         // 關閉PreparedStatement對象
291         if (preparedStatement != null) {
292             try {
293                 preparedStatement.close();
294             } catch (SQLException e) {
295                 System.out.println(e.getMessage());
296             }
297         }
298         // 關閉CallableStatement 對象
299         if (callableStatement != null) {
300             try {
301                 callableStatement.close();
302             } catch (SQLException e) {
303                 System.out.println(e.getMessage());
304             }
305         }
306         // 關閉Connection 對象
307         if (connnection != null) {
308             try {
309                 connnection.close();
310             } catch (SQLException e) {
311                 System.out.println(e.getMessage());
312             }
313         }
314     }
315 }

db.properties是外部的一個配置文件，裡面對資料庫的一些信息進行配置，具體配置信息如下：

1 driver_class=com.mysql.jdbc.Driver
2 driver_url=jdbc\:mysql\://localhost\:3306/db_liuyanban
3 database_user=root
4 database_password=root

內部的一些主要方法介紹：

executeUpdate 執行sql命令，返回受影響的行數，通過受影響的行數進而判斷是否執行成功！ 一般用作CUD操作

executeQuerySingleData 執行sql語句或存儲過程 返回單個數據 （如返回自增的ID）

public static ResultSet executeQueryResultSet(String sql, Object... params)執行sql語句或存儲過程 返回ResultSet

public static JSONObject executeQuerySingleLineToJsonObject(String sql, Object... params) 執行sql語句，查詢單行數據返回一個JSONObject（Object對象轉成的JSONObject）

public static JSONArray executeQueryResultSetToJsonArray(String sql, Object... params) 執行sql語句，查詢單行數據返回一個JSONArray（list對象轉成的JSONArray）

executeQueryProcedure 執行存儲過程

public static <T> List<T> executeQueryList(Class<T> clazz,String sql, Object... params)反射返回一個List T 類型的結果集 如List<User> 用於Reader操作

public static <T> T executeQuerySingleLine(Class<T> clazz,String sql, Object... params) 反射返回一個T類型的結果 如User 用於Reader操作

接下來我們介紹一下使用方法 ：

這裡採用的使用地方是我自己以前寫過的一個留言板的Dao層，這裡面有對我的DBUtils_DG的使用，具體見代碼：

 1 package liuyanban.dao;
 2 
 3 import liuyanban.Utils.DBUtils_DG;
 4 import liuyanban.entity.User;
 5 import sun.org.mozilla.javascript.internal.EcmaError;
 6 
 7 import java.util.List;
 8 
 9 /**
10  * Created by Administrator on 2016/8/22.
11  */
12 public class UserDaoImpl implements IUserDao {
13     //增刪改
14     public boolean addUser(User user) {
15         if (this.isExistUesr(user.getLoginId())) return false;//當登錄名已存在時不能進行註冊
16         String sql="insert into tb_user (loginId,Pwd,Name,jurisdiction,Image) values (?,?,?,?,?)";
17         Object[]objects={user.getLoginId(),user.getPwd(),user.getName(),user.getJurisdiction(),user.getImage()};
18         return DBUtils_DG.executeUpdate(sql,objects);
19     }
20 
21     public boolean updataUser(User user) {
22         String sql="update tb_user set loginId=?,Pwd=?,Name=?,jurisdiction=?,Image=? where userId=?";
23         Object[]objects={user.getLoginId(),user.getPwd(),user.getName(),user.getJurisdiction(),user.getImage(),user.getUserId()};
24         return DBUtils_DG.executeUpdate(sql,objects);
25     }
26     public boolean deleteUser(User user) {
27         String sql="delete from tb_user where userId=?";
28         return DBUtils_DG.executeUpdate(sql,user.getUserId());
29     }
30     //查詢
31     //獲得所有User
32     public List<User> getUserAll() {
33         String sql="select userId,loginId,`Name`,Jurisdiction,Image  from tb_user";
34         return DBUtils_DG.executeQueryList(User.class,sql);
35     }
36     //通過Id 獲得User對象
37     public User getUserByUserId(int userId) {
38         String sql="select userId,loginId,`Name`,Jurisdiction,Image from tb_user where userId=? limit 1";
39         return DBUtils_DG.executeQuerySingleLine(User.class,sql,userId);
40     }
41 
42     public boolean isExistUesr(String loginId) {
43         String sql="select loginId from tb_user where loginId=? limit 1";
44         try{
45             return DBUtils_DG.executeQuerySingleData(sql,loginId).toString().length()>0?true:false;
46         }
47         catch (Exception ee)
48         {
49             return false;
50         }
51     }
52 
53     //通過loginId 獲得User對象
54     public User getUserByloginId(String loginId)
55     {
56         String sql="select * from tb_user where loginId=? limit 1";
57         return DBUtils_DG.executeQuerySingleLine(User.class,sql,loginId);
58     }
59 }

寫到這裡，相信大家都已經對ORM框架的實現機制有一定的瞭解，並且能完美的實現一個DBUtils來進行對自己數據訪問代碼的封裝！如果喜歡，大家可以進一步對DAO層的代碼進行封裝放到一個類裡面，更加方便自己對資料庫的訪問，可以更加簡便地訪問資料庫，有朝一日寫出一個屬於自己的ORM框架！

有關於C#的SqlHelper介紹詳情請參考：http://www.cnblogs.com/qixiaoyizhan/p/5818298.html

2016-08-29 16:44:12

本文為七小站主原創作品，轉載請註明出處：http://www.cnblogs.com/qixiaoyizhan/