JDBC相关工具类的封装

之前看网易云课堂的时候有一个老师教过JDBC工具类的封装，那时候对泛型、反射不是很了解，最近刚好把泛型、反射复习了一下，打算重新自己写一下，提升一下印象

一、JDBC连接工具类（MySQL为例）

1、在项目根目录创建一个properties的配置文件db.properties，里面定义了四行数据，分别对应着JDBC连接所需要的几个参数（注：Properties底层为一个Hashtable，配置文件中“=”之前的代表Map中的键，之后的代表相应键所对应的值）

driverClassName=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/jdbc_db?rewriteBatchedStatements=true
username=root
password=123456

2、JDBC连接工具类

/**
 * JDBC工具类
 * @Author: fangju
 * @Date: 2019/6/15 
 */
public class JDBCUtil {
    private static String driver;
    private static String url;
    private static String username;
    private static String password;

    //静态代码块，在程序编译的时候执行
    static {
        try {
            //创建Properties对象
            Properties p = new Properties();
            //获取文件输入流
            InputStream in = new FileInputStream("db.properties");
            //加载输入流
            p.load(in);
            //获取数据库连接驱动名字
            driver = p.getProperty("driverClassName",null);
            //获取数据库连接地址
            url = p.getProperty("url",null);
            //获取数据库连接用户名
            username = p.getProperty("username",null);
            //获取数据库连接密码
            password = p.getProperty("password",null);
            if(driver != null && url != null
                    && username != null && password != null){
                //加载驱动
                Class.forName(driver);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 获取连接对象
     * @return Connection连接对象
     */
    public static Connection getConn(){
        Connection conn = null;
        try {
            conn = DriverManager.getConnection(url,username,password);
        } catch (SQLException e) {
            e.printStackTrace();
        }
        return conn;
    }

    /**
     * 关闭连接（Connection连接对象必须在最后关闭）
     * @param conn Connection连接对象
     * @param st 编译执行对象
     * @param rs 结果集
     */
    public static void close(Connection conn, Statement st, ResultSet rs){
        try {
            if(rs != null){
                rs.close();
            }
            if(st != null){
                st.close();
            }
            if(conn != null){
                conn.close();
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

二、增删改查工具类

1、为什么要这样进行封装

（1）每次进行数据库操作的时候，首先需要获取数据库连接对象(Connection)，然后获取预编译执行语句(PrepareStatement)，查询的时候还需要获取结果集(ResultSet)，这一连串的操作基本上只有sql语句的差异，所以对于这部分可以进行封装一下
（2）我们平常对数据库操作的方法常用的有execute()、executeUpdate()、executeQuery()，几个方法的差异具体如下

方法名	作用
execute	可以增删改查
executeUpdate	可以增删改，但是不能查询
executeQuery	只可以查询

所以我们的工具类里面的方法可以定义为两种，一种是用来增删改操作，一种是用来查询操作

2、CRUD工具封装

一般情况下我们定义JavaBean的类名与表名相同，字段名与表中列名相同，这样在结果集中取值就方便很多。

CRUD工具类

/**
 * 增删改查工具类
 * @Author: fangju
 * @Date: 2019/6/15
 */
public class CRUDTemplate {
    /**
     * 增删改操作
     * @param sql 传入的SQL语句
     * @param params 可变参数
     * @return 操作结果
     */
    public static int executeUpdate(String sql,Object... params){
        Connection conn = null;
        PreparedStatement psmt = null;
        int result = 0;
        try {
            //获取数据库连接对象
            conn = JDBCUtil.getConn();
            //获取预编译语句对象
            psmt = conn.prepareStatement(sql);
            //给预编译语句赋值
            for (int i = 0; i < params.length; i++) {
                psmt.setObject(i+1,params[i]);
            }
            //执行SQL语句获取执行结果
            result = psmt.executeUpdate();
        } catch (SQLException e) {
            e.printStackTrace();
        } finally {
            //关闭数据库连接
            JDBCUtil.close(conn,psmt,null);
        }
        return result;
    }

    /**
     * 查询操作
     * @param sql SQL语句
     * @param handler 判断查询一个还是多个
     * @param params 可变参数
     * @param  具体操作的实体类
     * @return 返回IResultSetHandler接口中的泛型
     */
    public static <T> T executeQuery(String sql, IResultSetHandler<T> handler,Object... params){
        Connection conn = null;
        PreparedStatement psmt = null;
        ResultSet rs = null;
        try {
            //获取数据库连接对象
            conn = JDBCUtil.getConn();
            //获取预编译语句对象
            psmt = conn.prepareStatement(sql);
            //给预编译语句赋值
            for (int i = 0; i < params.length; i++) {
                psmt.setObject(i+1,params[i]);
            }
            //执行SQL语句获取结果集
            rs = psmt.executeQuery();
            //处理结果集
            return handler.handle(rs);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            //关闭数据库连接
            JDBCUtil.close(conn,psmt,rs);
        }
        return null;
    }
}

对于查询，可能返回一个JavaBean对象，也可能返回一个JavaBean的集合，所以我们可以定义一个接口，这个接口专门来处理结果集，接口方法返回的为泛型参数，具体返回什么由用户自己定义。

/**
 * 把JDBC返回的结果集封装成特定类型
 * @Author: fangju
 * @Date: 2019/6/15
 */
public interface IResultSetHandler<T> {
    T handle(ResultSet rs) throws Exception;
}

IResultSetHandler具体的实现类

/**
 * 返回一个JavaBean
 * @Author: fangju
 * @Date: 2019/6/15
 */
public class BeanHandler<T> implements IResultSetHandler<T> {
    private Class<T> clazz;

    public BeanHandler(Class<T> clazz){
        this.clazz = clazz;
    }

    @Override
    public T handle(ResultSet rs) throws Exception{
        //结果集默认指向为第一个数据的前一个
        if (rs.next()){
            //根据传入的字节码创建传入的指定对象
            T obj = clazz.newInstance();
            //获取指定字节码信息
            BeanInfo beanInfo = Introspector.getBeanInfo(clazz,Object.class);
            //获取所有属性描述器
            PropertyDescriptor[] pds = beanInfo.getPropertyDescriptors();
            for (PropertyDescriptor pd:pds){
                //获取结果集中对应字段名的值
                Object o = rs.getObject(pd.getName());
                //执行当前方法并传入参数
                pd.getWriteMethod().invoke(obj,o);
            }
            return obj;
        }
        return null;
    }
}

/**
 * 返回一个JavaBean的集合
 * @Author: fangju
 * @Date: 2019/6/15 17:31
 */
public class BeanListHandler<T> implements IResultSetHandler<List<T>> {
    private Class<T> clazz;

    public BeanListHandler(Class<T> clazz){
        this.clazz = clazz;
    }

    @Override
    public List<T> handle(ResultSet rs) throws Exception {
        //获取指定字节码信息
        BeanInfo beanInfo = Introspector.getBeanInfo(clazz,Object.class);
        //获取所有属性描述器
        PropertyDescriptor[] pds = beanInfo.getPropertyDescriptors();
        List<T> list = new ArrayList<>();
        while (rs.next()){
            T obj = clazz.newInstance();
            for (PropertyDescriptor pd:pds){
                //获取结果集中对应字段名的值
                Object o = rs.getObject(pd.getName());
                //执行当前方法并传入参数
                pd.getWriteMethod().invoke(obj,o);
            }
            list.add(obj);
        }
        return list;
    }
}

3、测试

以学生类为例

/**
 * @Author: fangju
 * @Date: 2019/6/15 
 */
public class Student {
    private Integer id;
    private String name;
    private Integer age;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age='" + age + '\'' +
                '}';
    }
}