自己写ORM框架 DBUtils_DG Java（C#的写在链接里）

ORM框架想必大家都比较熟知了，即对象关系映射（英语：Object Relation Mapping，简称ORM，或O/RM，或O/R mapping），是一种程序技术，用于实现面向对象编程语言里不同类型系统的数据之间的转换。从效果上说，它其实是创建了一个可在编程语言里使用的“虚拟对象数据库”。 当你开发一个应用程序的时候(不使用O/R MAPPING),你可能会写不少数据访问层的代码，用来从数据库保存，删除，读取对象信息，等等。

现在流行的ORM框架有：

JAVA系列：APACHE OJB，CAYENNE，JAXOR，JPA，HIBERNATE，IBATIS/MYBATIS，JRELATIONALFRAMEWORK，SMYLE，TOPLINK等

其中 TOPLINK 是 ORACLE 的商业产品，其他均为开源项目。其中 HIBERNATE的轻量级 ORM 模型逐步确立了在 JAVA ORM 架构中领导地位，甚至取代复杂而又繁琐的 EJB 模型而成为事实上的 JAVA ORM 工业标准。

.NET系列：EF（ENTITY FRAMWORK），NHIBERNATE，Ibits，ENTITYSCODEGENERATE，LINQ TOSQL，GROVE，RUNGOO.ENTERPRISEORM，FIRECODE CREATOR，MYGENERATION，CODESMITH PRO，CODEAUTO等

微软VS中自带的有EF（ENTITY FRAMWORK）框架。

---

你在DAO中写了很多的方法来读取对象数据，改变状态对象等等任务。而这些代码写起来总是重复的。我们可不可以写一个类来封装这些重复的劳动呢？

想必大家都有曾经想过写DBUtils_DG吧，实际上，从DBUtils_DG一步步写下来，封装到足够好之后，就会成为一个自己专属的ORM框架了。

在这里，小编写了一个很基础的类ORM的DBUtils_DG里面仅仅对Select查询语句进行了封装，由于考虑到了反射机制的诟病（这里不再讨论，关于反射效率问题有大多数的讨论，利与弊总是同时存在的，我们不纠结于这点）。对于常见的CRUD来说，CUD通常一个方法可以实现，并且Sql语句可以得到更大的封装结合配置文件和反射机制进行操作。小编这里采用的模式是MySql+DBUtils_DG+代码生成器（需要代码生成器的可以联系本人,不定期更新）来完成的代码编写工作，因此没有对CUD进行大量的封装，同时也提高了执行效率（你懂的）。

接下来我贴上我的代码（里面注释采用中文注释，比较完善有不懂的可以咨询本人）:

package liuyanban.Utils;

import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Field;
import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

import org.json.JSONArray;
import org.json.JSONObject;

public abstract class DBUtils_DG {
    // 数据库驱动类名称
    private static String driver_class = null;              //"com.mysql.jdbc.Driver";
    // 连接字符串
    private static String driver_url = null;                //"jdbc:mysql://localhost:3306/db_liuyanban";
    // 用户名
    private static String database_user = null;                //"root";
    // 密码
    private static String database_password =null;            // "root";
    // 创建数据库连接对象
    private static Connection connnection = null;
    // 创建结果集对象
    private static ResultSet resultSet = null;
    // 创建PreparedStatement对象
    private static PreparedStatement preparedStatement = null;
    // 创建CallableStatement对象
    private static CallableStatement callableStatement = null;

    static {
        try {
            Properties properties = new Properties();
            InputStream fis = DBUtils_DG.class.getClassLoader().getResourceAsStream("db.properties");// 加载数据库配置文件到内存中放在同src下
            try {
                properties.load(fis);// 获取数据库配置文件
                driver_class = properties.getProperty("driver_class").toString();
                driver_url =properties.getProperty("driver_url").toString();
                database_user =properties.getProperty("database_user").toString();
                database_password =properties.getProperty("database_password").toString();
            } catch (IOException e) {
                e.printStackTrace();
            }
            Class.forName(driver_class);  // 加载数据库驱动程序
        } catch (ClassNotFoundException e) {
            System.out.println("加载驱动错误");
            System.out.println(e.getMessage());
        }
    }
    /**
     * 所有执行方法的辅助器(共同参与的部分)
     * @param sql SQL语句
     * @param params 参数数组，若没有参数则为null
     */
    private static void SqlPrepareCommand(String sql, Object... params)
    {
        try {
            // 获得连接
            connnection = DriverManager.getConnection(driver_url, database_user, database_password);
            // 调用SQL
            preparedStatement = connnection.prepareStatement(sql);
            // 参数赋值
            if (params != null) {
                for (int i = 0; i < params.length; i++) {
                    preparedStatement.setObject(i + 1, params[i]);
                }
            }
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }
    }

    /**
     * insert update delete SQL语句的执行的统一方法
     * @param sql SQL语句
     * @param params 参数数组，若没有参数则为null
     * @return 受影响的行数
     */
    public static boolean executeUpdate(String sql, Object...params) {
        try {
            SqlPrepareCommand(sql, params);//调用通用的初始化方法来设置参数
            return preparedStatement.executeUpdate()>0?true:false;// 执行
        } catch (SQLException e) {
            System.out.println(e.getMessage());
            return false;
        } finally {
            // 释放资源
            closeAll();
        }
    }

    /**
     * SQL 查询将查询结果直接放入ResultSet中
     * @param sql SQL语句
     * @param params 参数数组，若没有参数则为null
     * @return 结果集
     */
    public static ResultSet executeQueryResultSet(String sql, Object... params) {
        try {
            SqlPrepareCommand(sql, params);                //调用通用的初始化方法来设置参数
            return preparedStatement.executeQuery();     // 执行
        } catch (SQLException e) {
            System.out.println(e.getMessage());
            return null;
        }
    }

    /**
     * SQL 查询将查询结果：一行一列 (左上角的结果)
     * @param sql SQL语句
     * @param params 参数数组，若没有参数则为null
     * @return 结果集
     */
    public static Object executeQuerySingleData(String sql, Object... params) {
        try {
            resultSet=executeQueryResultSet(sql, params);
            return  resultSet.next()?resultSet.getObject(1):null;
        } catch (SQLException e) {
            System.out.println(e.getMessage());
            return null;
        } finally {
            closeAll();
        }
    }
    /**
     * SQL 查询将查询结果：一行 返回class类型的对象(第一行结果)
     * @param sql SQL语句
     * @param params 参数数组，若没有参数则为null
     * @return 结果集
     */
    public static <T> T executeQuerySingleLine(Class<T> clazz,String sql, Object... params) {
        try {
            resultSet=executeQueryResultSet(sql, params);                                //从数据库获得结果集
            if(resultSet != null) {
                ResultSetMetaData rsmd = resultSet.getMetaData();                          // 获得结果集的MetaData
                T t = clazz.newInstance();                                                 // 通过反射创建 T 实例
                while(resultSet.next()){
                    for(int i=1;i<=rsmd.getColumnCount();i++){
                        Field tField =clazz.getDeclaredField(rsmd.getColumnLabel(i));    //获取到单行记录对应的字段
                        tField.setAccessible(true);                                        //设置通过反射访问该Field时取消访问权限检查
                        tField.set(t, resultSet.getObject(rsmd.getColumnLabel(i)));        //获取到每一行结果对应字段的值并赋值给类属性
                    }
                }
                return t;                                                                  //返回赋值后的T对象
            } else return null;
        } catch (Exception e) {
            return null;
        }
    }

    /**
     * 获取结果集，并将结果放在List中生成List<T> (多行数据)
     * @param clazz 类
     * @param sql SQL语句
     * @params List结果集
     */
    public static <T> List<T> executeQueryList(Class<T> clazz,String sql, Object... params) {
        try {
            resultSet=executeQueryResultSet(sql, params);                                //从数据库获得结果集
            List<T> list = new ArrayList<T>();                                          //实例化一个泛型List<T>保存结果的List
            try {
                ResultSetMetaData rsmd = resultSet.getMetaData();                         // 获得结果集的MetaData
                while (resultSet.next()){
                    T t = clazz.newInstance();                                             // 通过反射创建 clazz 实例
                    for(int i=1;i<=rsmd.getColumnCount();i++){
                        try {
                            Field tField =clazz.getDeclaredField(rsmd.getColumnLabel(i));    //获取到单行记录对应的字段
                            tField.setAccessible(true);                                        //设置通过反射访问该Field时取消访问权限检查
                            tField.set(t, resultSet.getObject(rsmd.getColumnLabel(i)));        //获取到每一行结果对应字段的值并赋值给类属性
                        } catch (Exception e) {
                            continue;
                        }
                    }
                    list.add(t);                                                        //将实例化赋值的对象存到List<T>中
                }
            } catch (Exception e) {
                System.out.println(e.getMessage());
                return null;
            }
            return list;//返回填充对象的list
        }  finally {
            closeAll();//调用自定义的关闭所有资源方法关闭所有资源
        }
    }

    /**
     * 存储过程带有一个输出参数的方法
     * @param sql 存储过程语句
     * @param params 参数数组
     * @param outParamPos 输出参数位置
     * @param SqlType 输出参数类型
     */
    public static Object executeQueryProcedure(String sql, Object[] params,int outParamPos, int SqlType) {
        Object object = null;
        try {
            connnection = DriverManager.getConnection(driver_url, database_user, database_password);
            // 调用存储过程
            callableStatement = connnection.prepareCall(sql);
            // 给参数赋值
            if(params != null) {
                for(int i = 0; i < params.length; i++) {
                    callableStatement.setObject(i + 1, params[i]);
                }
            }
            // 注册输出参数
            callableStatement.registerOutParameter(outParamPos, SqlType);
            // 执行
            callableStatement.execute();
            // 得到输出参数
            object = callableStatement.getObject(outParamPos);

        } catch (SQLException e) {
            System.out.println(e.getMessage());
        } finally {
            // 释放资源
            closeAll();
        }
        return object;
    }
    /**
     * 将查询到的单行数据转换成JsonObject
     * @param sql SQL语句
     * @param params 参数数组，若没有参数则为null
     * @return JSONObject结果
     */
    public static JSONObject executeQuerySingleLineToJsonObject(String sql, Object... params)
    {
        try {
            resultSet=executeQueryResultSet(sql, params);                                //从数据库获得结果集
            JSONObject jsonObject=new JSONObject();
            if(resultSet != null) {
                ResultSetMetaData rsmd = resultSet.getMetaData();                          // 获得结果集的MetaData
                while(resultSet.next()){
                    for(int i=1;i<=rsmd.getColumnCount();i++){
                        jsonObject.put(rsmd.getColumnLabel(i), resultSet.getObject(rsmd.getColumnLabel(i)));
                    }
                }
                return jsonObject;                                                                  //返回赋值后的T对象
            } else return null;
        } catch (Exception e) {
            return null;
        }
    }
    /**
     * 将ResultSet数据转换成JsonArray
     * @param sql SQL语句
     * @param params 参数数组，若没有参数则为null
     * @return JSONArray结果集
     */
    public static JSONArray executeQueryResultSetToJsonArray(String sql, Object... params)
    {
        try {
            resultSet= executeQueryResultSet(sql, params);
            JSONArray jsonArray=new JSONArray();
            if(resultSet != null) {
                ResultSetMetaData rsmd = resultSet.getMetaData();// 获得结果集的MetaData
                while(resultSet.next()){
                    JSONObject jsonMember =new JSONObject();
                    for(int i=1;i<=rsmd.getColumnCount();i++){
                        jsonMember.put(rsmd.getColumnLabel(i), resultSet.getObject(rsmd.getColumnLabel(i)));
                    }
                    jsonArray.put(jsonMember);
                }
                return    jsonArray;//返回赋值后的T对象
            } else return null;
        } catch (Exception e) {
            System.err.println(e.getMessage());
            return null;
        }
    }
    /**
     * 关闭所有资源
     */
    private static void closeAll() {
        // 关闭结果集对象
        if (resultSet != null) {
            try {
                resultSet.close();
            } catch (SQLException e) {
                System.out.println(e.getMessage());
            }
        }
        // 关闭PreparedStatement对象
        if (preparedStatement != null) {
            try {
                preparedStatement.close();
            } catch (SQLException e) {
                System.out.println(e.getMessage());
            }
        }
        // 关闭CallableStatement 对象
        if (callableStatement != null) {
            try {
                callableStatement.close();
            } catch (SQLException e) {
                System.out.println(e.getMessage());
            }
        }
        // 关闭Connection 对象
        if (connnection != null) {
            try {
                connnection.close();
            } catch (SQLException e) {
                System.out.println(e.getMessage());
            }
        }
    }
}

db.properties是外部的一个配置文件，里面对数据库的一些信息进行配置，具体配置信息如下：

driver_class=com.mysql.jdbc.Driver
driver_url=jdbc\:mysql\://localhost\:3306/db_liuyanban
database_user=root
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的使用，具体见代码：

package liuyanban.dao;

import liuyanban.Utils.DBUtils_DG;
import liuyanban.entity.User;
import sun.org.mozilla.javascript.internal.EcmaError;

import java.util.List;

/**
 * Created by Administrator on 2016/8/22.
 */
public class UserDaoImpl implements IUserDao {
    //增删改
    public boolean addUser(User user) {
        if (this.isExistUesr(user.getLoginId())) return false;//当登录名已存在时不能进行注册
        String sql="insert into tb_user (loginId,Pwd,Name,jurisdiction,Image) values (?,?,?,?,?)";
        Object[]objects={user.getLoginId(),user.getPwd(),user.getName(),user.getJurisdiction(),user.getImage()};
        return DBUtils_DG.executeUpdate(sql,objects);
    }

    public boolean updataUser(User user) {
        String sql="update tb_user set loginId=?,Pwd=?,Name=?,jurisdiction=?,Image=? where userId=?";
        Object[]objects={user.getLoginId(),user.getPwd(),user.getName(),user.getJurisdiction(),user.getImage(),user.getUserId()};
        return DBUtils_DG.executeUpdate(sql,objects);
    }
    public boolean deleteUser(User user) {
        String sql="delete from tb_user where userId=?";
        return DBUtils_DG.executeUpdate(sql,user.getUserId());
    }
    //查询
    //获得所有User
    public List<User> getUserAll() {
        String sql="select userId,loginId,`Name`,Jurisdiction,Image  from tb_user";
        return DBUtils_DG.executeQueryList(User.class,sql);
    }
    //通过Id 获得User对象
    public User getUserByUserId(int userId) {
        String sql="select userId,loginId,`Name`,Jurisdiction,Image from tb_user where userId=? limit 1";
        return DBUtils_DG.executeQuerySingleLine(User.class,sql,userId);
    }

    public boolean isExistUesr(String loginId) {
        String sql="select loginId from tb_user where loginId=? limit 1";
        try{
            return DBUtils_DG.executeQuerySingleData(sql,loginId).toString().length()>0?true:false;
        }
        catch (Exception ee)
        {
            return false;
        }
    }

    //通过loginId 获得User对象
    public User getUserByloginId(String loginId)
    {
        String sql="select * from tb_user where loginId=? limit 1";
        return DBUtils_DG.executeQuerySingleLine(User.class,sql,loginId);
    }
}

---

写到这里，相信大家都已经对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/