flea-db使用之封装JDBC接入

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS MySQL,集群版 2核4GB 100GB
推荐场景:
搭建个人博客
云数据库 RDS MySQL,高可用版 2核4GB 50GB
简介: 【4月更文挑战第6天】本篇 Huazie 介绍 Flea 框架下的 flea-db 模块中封装JDBC的逻辑

《开发框架-Flea》

6cbeb6207e844f35b08eab510b5da5e5.jpeg

引言

本篇将要演示 FleaJDBCHelper 的使用,该工具类封装了基本的JDBC增删改查的操作,只需简单几步即可实现数据库操作。

1. 准备工作

为了演示JDBC接入(参考 JPA接入 中的准备工作),需要如下准备:

  1. MySQL数据库 (客户端可以使用 navicat for mysql)
  2. 新建测试数据库 fleajpatest
  3. 新建测试表 student

2. 接入讲解

2.1 JDBC数据源配置

数据源配置独立出来,定义在 flea-config.xml 中,可添加多个JDBC数据库配置【即 config-items 节点】。

<?xml version="1.0" encoding="UTF-8"?>

<flea-config>

    <!-- 其他配置省略 -->
    <config-items key="mysql-fleajpatest" desc="JDBC数据库配置【key=数据库系统-数据库或数据库用户】">
        <config-item key="driver" desc="mysql数据库驱动名">com.mysql.jdbc.Driver</config-item>
        <config-item key="url" desc="mysql数据库连接地址">jdbc:mysql://localhost:3306/fleajpatest?useUnicode=true&amp;characterEncoding=UTF-8</config-item>
        <config-item key="user" desc="mysql数据库登录用户名">root</config-item>
        <config-item key="password" desc="mysql数据库登录密码">root</config-item>
    </config-items>

</flea-config>

2.2 定义Flea数据库单元

每个 FleaDBUnit 中, databasename 对应上述 config-items 中的 keydriverurluserpassword 分别对应上述 config-item 中的配置。

/**
 * <p> Flea 数据库单元 </p>
 *
 * @author huazie
 */
public class FleaDBUnit {
   
   

    private String database; // 数据库管理系统名
    private String name; // 数据库名 或 数据库用户名
    private String driver; // 数据库驱动名
    private String url; // 数据库连接地址
    private String user; // 数据库登录用户名
    private String password; // 数据库登录密码

    // 省略 set 和 get方法
}

2.3 定义Flea数据库操作类

FleaDBOperation 封装了JDBC的数据库操作对象,包括数据库连接对象 Connection、数据库预编译状态对象 PreparedStatement 和 数据库结果集对象 ResultSet。该类继承 Closeable,实现 close 方法,用于每次 JDBC 数据库操作后释放资源【这里用到了 try-with-resource 语法糖 】。

/**
 * <p> Flea数据库操作 </p>
 *
 * @author huazie
 */
public class FleaDBOperation implements Closeable {
   
   

    private Connection connection;

    private PreparedStatement preparedStatement;

    private ResultSet resultSet;

    @Override
    public void close() {
   
   
        FleaJDBCConfig.close(connection, preparedStatement, resultSet);
    }

    // 省略 set 和 get方法
}

2.4 定义Flea JDBC配置类

FleaJDBCConfig 中的 init(String mDatabase, String mName) 方法用于初始化本次操作的数据库管理系统【mDatabase】、数据库名或数据库用户 【mName】,两者对应数据库配置 config-items 中的 key

/**
 * <p> 读取数据库的配置信息,该信息存在于flea-config.xml中 </p>
 *
 * @author huazie
 */
public class FleaJDBCConfig {
   
   

    private static volatile FleaJDBCConfig config;

    private static final ConcurrentMap<String, FleaDBUnit> fleaDBUnits = new ConcurrentHashMap<>();

    private FleaJDBCConfig() {
   
   
    }

    /**
     * <p> 读取数据库相关配置信息 </p>
     *
     * @return JDBC配置对象
     */
    public static FleaJDBCConfig getConfig() {
   
   

        if (ObjectUtils.isEmpty(config)) {
   
   
            synchronized (FleaJDBCConfig.class) {
   
   
                if (ObjectUtils.isEmpty(config)) {
   
   
                    config = new FleaJDBCConfig();
                }
            }
        }
        return config;
    }

    /**
     * <p> 使用之前先初始化 </p>
     *
     * @param mDatabase 数据库管理系统名称
     * @param mName     数据库名  或  数据库用户
     */
    public static void init(String mDatabase, String mName) {
   
   
        FleaFrameManager.getManager().setDBConfigKey(mDatabase, mName);
    }

    /**
     * <p> 建立数据库连接 </p>
     *
     * @return 数据库连接对象
     * @since 1.0.0
     */
    public Connection getConnection() {
   
   
        Connection conn = null;
        FleaDBUnit fleaDBUnit;

        String dbConfigKey = FleaFrameManager.getManager().getDBConfigKey();

        if (!fleaDBUnits.containsKey(dbConfigKey)) {
   
   
            synchronized (fleaDBUnits) {
   
   
                if (!fleaDBUnits.containsKey(dbConfigKey)) {
   
   
                    fleaDBUnits.put(dbConfigKey, getFleaDBUnit(dbConfigKey));
                }
            }
        }

        fleaDBUnit = fleaDBUnits.get(dbConfigKey);

        try {
   
   
            // 请正确初始化数据库管理系统和数据库(或数据库用户)
            ObjectUtils.checkEmpty(fleaDBUnit, DaoException.class, "ERROR-DB-DAO0000000013");
            Class.forName(fleaDBUnit.getDriver());
            conn = DriverManager.getConnection(fleaDBUnit.getUrl(), fleaDBUnit.getUser(), fleaDBUnit.getPassword());
        } catch (Exception e) {
   
   
            LOGGER.error("获取数据库连接异常 :{}", e.getMessage());
        }
        return conn;
    }

    /**
     * <p> 读取指定配置键的数据库相关配置信息 </p>
     *
     * @param dbConfigKey 数据库配置键
     * @return 数据库配置信息类对象
     */
    private FleaDBUnit getFleaDBUnit(String dbConfigKey) {
   
   
        FleaDBUnit fDBUnit = null;
        if (StringUtils.isNotBlank(dbConfigKey)) {
   
   
            fDBUnit = new FleaDBUnit();
            String[] dbConfigKeyArr = StringUtils.split(dbConfigKey, CommonConstants.SymbolConstants.HYPHEN);
            if (ArrayUtils.isNotEmpty(dbConfigKeyArr) && CommonConstants.NumeralConstants.INT_TWO == dbConfigKeyArr.length) {
   
   
                fDBUnit.setDatabase(dbConfigKeyArr[0]);
                fDBUnit.setName(dbConfigKeyArr[1]);
            }
            fDBUnit.setDriver(FleaConfigManager.getConfigItemValue(dbConfigKey, DBConfigConstants.DB_CONFIG_DRIVER));
            fDBUnit.setUrl(FleaConfigManager.getConfigItemValue(dbConfigKey, DBConfigConstants.DB_CONFIG_URL));
            fDBUnit.setUser(FleaConfigManager.getConfigItemValue(dbConfigKey, DBConfigConstants.DB_CONFIG_USER));
            fDBUnit.setPassword(FleaConfigManager.getConfigItemValue(dbConfigKey, DBConfigConstants.DB_CONFIG_PASSWORD));
        }

        return fDBUnit;
    }

    /**
     * <p> 释放连接Connection </p>
     *
     * @param conn 数据库连接对象
     */
    private static void closeConnection(Connection conn) {
   
   
        try {
   
   
            if (ObjectUtils.isNotEmpty(conn)) {
   
   
                conn.close();
            }
        } catch (SQLException e) {
   
   
        }
    }

    /**
     * <p> 释放statement </p>
     *
     * @param statement Statement对象
     */
    private static void closeStatement(Statement statement) {
   
   
        try {
   
   
            if (ObjectUtils.isNotEmpty(statement)) {
   
   
                statement.close();
            }
        } catch (SQLException e) {
   
   
        }
    }

    /**
     * <p> 释放ResultSet结果集 </p>
     *
     * @param rs 结果集对象
     */
    private static void closeResultSet(ResultSet rs) {
   
   
        try {
   
   
            if (ObjectUtils.isNotEmpty(rs)) {
   
   
                rs.close();
            }
        } catch (SQLException e) {
   
   
        }
    }

    /**
     * <p> 释放资源 </p>
     *
     * @param conn      数据库连接对象
     * @param statement 数据库状态对象
     * @param rs        数据库结果集对象
     */
    public static void close(Connection conn, Statement statement, ResultSet rs) {
   
   
        closeResultSet(rs);
        closeStatement(statement);
        closeConnection(conn);
    }

    // 省略一些close方法
}

上述 init 方法中,使用了 FleaFrameManager.getManager().setDBConfigKey,这里是将 JDBC连接的数据库配置添加到了线程对象中 ThreadLocal 中,代码如下:

    // 当前线程采用JDBC连的数据库前缀配置
    private static ThreadLocal<String> sDBLocal = new ThreadLocal<>(); 

    /**
     * <p> 获取当前线程中使用JDBC连接的数据库配置键 </p>
     *
     * @return 当前线程中使用JDBC连接的数据库配置键
     */
    public String getDBConfigKey() {
   
   
        return sDBLocal.get();
    }

    /**
     * <p> 设置当前线程中使用JDBC连接的数据库配置键 </p>
     *
     * @param dbSysName 数据库系统名
     * @param dbName    数据库名
     */
    public void setDBConfigKey(String dbSysName, String dbName) {
   
   
        if (StringUtils.isNotBlank(dbSysName) && StringUtils.isNotBlank(dbName)) {
   
   
            sDBLocal.set(dbSysName.toLowerCase() + CommonConstants.SymbolConstants.HYPHEN + dbName.toLowerCase());
        }
    }

2.4 定义 Flea JDBC工具类

在使用 FleaJDBCHelper 之前,一定要先调用一下 init

image.png

3. 接入自测

请查看单元测试类 StudentJDBCTest

3.1 JDBC新增数据

    @Test
    public void testStudentInsert() throws Exception {
   
   
        // 初始化数据库配置,用于获取具体操作数据源
        FleaJDBCConfig.init(DBSystemEnum.MySQL.getName(), "fleajpatest");

        String sql = "insert into student(stu_name, stu_age, stu_sex, stu_state) values(?, ?, ?, ?)";

        List<Object> paramList = new ArrayList<Object>();
        paramList.add("huazie");
        paramList.add(25);
        paramList.add(1);
        paramList.add(1);

        int ret = FleaJDBCHelper.insert(sql, paramList);

        LOGGER.debug("RESULT = {}", ret);
    }

执行结果:

image.png

3.2 JDBC查询数据

这里的查询语句,可以是复杂SQL,返回结果 List>

    @Test
    public void testStudentQuery() throws Exception {
   
   
        FleaJDBCConfig.init(DBSystemEnum.MySQL.getName(), "fleajpatest");

        String sql = "select * from student where stu_state = ?";

        List<Object> paramList = new ArrayList<Object>();
        paramList.add(1);

        LOGGER.debug("RESULT LIST = {}", FleaJDBCHelper.query(sql, paramList));
    }

执行结果:

image.png

    @Test
    public void testStudentSingleQuery() throws Exception {
   
   
        FleaJDBCConfig.init(DBSystemEnum.MySQL.getName(), "fleajpatest");

        String sql = "select count(*) from student where stu_state = ?";

        List<Object> paramList = new ArrayList<Object>();
        paramList.add(1);

        LOGGER.debug("COUNT = {}", FleaJDBCHelper.querySingle(sql, paramList));
    }

执行结果:

image.png

3.3 JDBC更新数据

    @Test
    public void testStudentUpdate() throws Exception {
   
   
        FleaJDBCConfig.init(DBSystemEnum.MySQL.getName(), "fleajpatest");

        String sql = "update student set stu_state = ? where stu_name = ?";

        List<Object> paramList = new ArrayList<Object>();
        paramList.add(2);
        paramList.add("huazie");

        int ret = FleaJDBCHelper.update(sql, paramList);

        LOGGER.debug("RESULT = {}", ret);
    }

执行结果:

image.png

3.4 JDBC删除数据

    @Test
    public void testStudentDelete() throws Exception {
   
   
        FleaJDBCConfig.init(DBSystemEnum.MySQL.getName(), "fleajpatest");

        String sql = "delete from student where stu_name = ? and stu_state = ? ";

        List<Object> paramList = new ArrayList<Object>();
        paramList.add("huazie");
        paramList.add(2);

        int ret = FleaJDBCHelper.delete(sql, paramList);

        LOGGER.debug("RESULT = {}", ret);
    }

执行结果:

image.png

相关实践学习
如何在云端创建MySQL数据库
开始实验后,系统会自动创建一台自建MySQL的 源数据库 ECS 实例和一台 目标数据库 RDS。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助 &nbsp; &nbsp; 相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
目录
相关文章
|
3月前
|
Java 数据库连接
JDBC跨平台封装工具类
JDBC跨平台封装工具类
|
Java 数据库连接 数据库
JDBC学习(三):封装工具类JDBCUtils类
为了以后方便进行数据库连接、数据库关闭、还有后面的连接池的操作等功能,现在将功能封装到JDBCUtils类当中,作为自己的一个工具箱。
365 0
|
2月前
|
SQL Java 数据库连接
老程序员分享:JDBC工具类封装、封装DAO方法与数据库表实体类封装的使用案列详情
老程序员分享:JDBC工具类封装、封装DAO方法与数据库表实体类封装的使用案列详情
|
3月前
|
SQL Java 数据库连接
JDBC如何封装成Mybaits持久层框架只需4
本文主要讲解JDBC怎么演变到Mybatis的渐变过程,重点讲解了为什么要将JDBC封装成Mybaits这样一个持久层框架。再而论述Mybatis作为一个数据持久层框架本身有待改进之处。
26 0
|
Java 数据库连接
Java 中封装JDBC连接到JDBCUtils工具类的详解
Java 中封装JDBC连接到JDBCUtils工具类的详解
64 0
|
3月前
|
SQL Java 数据库连接
JDBC技术【分页查询、数据库连接池、应用程序分层、封装通用的BaseDao】(四)-全面详解(学习总结---从入门到深化)(下)
JDBC技术【分页查询、数据库连接池、应用程序分层、封装通用的BaseDao】(四)-全面详解(学习总结---从入门到深化)
497 1
|
3月前
|
SQL druid Java
JDBC技术【分页查询、数据库连接池、应用程序分层、封装通用的BaseDao】(四)-全面详解(学习总结---从入门到深化)
JDBC技术【分页查询、数据库连接池、应用程序分层、封装通用的BaseDao】(四)-全面详解(学习总结---从入门到深化)
46 0
|
3月前
|
SQL Java 数据库连接
JDBC技术【分页查询、数据库连接池、应用程序分层、封装通用的BaseDao】(四)-全面详解(学习总结---从入门到深化)(中)
JDBC技术【分页查询、数据库连接池、应用程序分层、封装通用的BaseDao】(四)-全面详解(学习总结---从入门到深化)
44 0
|
3月前
|
SQL 存储 Java
JDBC技术【封装JDBC工具类、Statement的使用、PreparedStatement的使用(重点)、ResultSet的使用】(二)-全面详解(学习总结---从入门到深化)
JDBC技术【封装JDBC工具类、Statement的使用、PreparedStatement的使用(重点)、ResultSet的使用】(二)-全面详解(学习总结---从入门到深化)
146 0
|
druid 前端开发 Java
Spring boot整合<Mybatis【对JDBC的封装】>,Druid连接池
目录 文件目录层次和等级: 第二依赖: 第三配置文件: 第四创建文件:
127 0
Spring boot整合<Mybatis【对JDBC的封装】>,Druid连接池