AI 助理
文档备案控制台
开发者社区 数据库 文章 正文

commons-dbutils使用介绍

2016-03-30 6335
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：

commons-dbutils是Apache开源组织提供的用于操作数据库的工具包。今天为大家介绍一下该包的常用方法。
对于数据库的操作无外乎增删改查，而增删改本质上可以归为一类，操作方式相同，只是SQL语法不同而已，所以我将以修改和查询两类来介绍commons-dbutils的用法。

首先我们来创建一个测试类，使用JUnit进行测试。

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

import org.apache.commons.dbutils.DbUtils;
import org.apache.commons.dbutils.QueryRunner;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;


public class DBUtilsTest
{
   private Connection conn = null;

   @Before
   public void initConnection() throws SQLException, ClassNotFoundException
   {
      printCurrentMethodName();
      Class.forName("org.h2.Driver");
      conn = DriverManager.getConnection("jdbc:h2:h2.db", "test", "123");
   }

   @Before
   public void initDatabase() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      runner.update(
            conn,
            "CREATE TABLE IF NOT EXISTS USER_INFO (userId VARCHAR(20) PRIMARY KEY, userName VARCHAR(50))");
   }

   @After
   public void destory()
   {
      printCurrentMethodName();
      DbUtils.closeQuietly(conn);
   }

   /**
    * 打印当前运行方法名称
    */
   public void printCurrentMethodName()
   {
      System.out.println(Thread.currentThread().getStackTrace()[2]
            .getMethodName());
      System.out.println("==================================================");
   }
}

在这段测试代码中，我们是用h2作为数据库进行测试以及定义了一些连接、数据库的初始化及销毁的方法。
在commons-dbutils中操作数据库的常用类为：QueryRunner。
QueryRunner的常用方法如下：

返回值 方法名 说明
int[] batch(Connection conn, String sql, Object[][] params) 批量执行INSERT、UPDATE或DELETE
int[] batch(String sql, Object[][] params) 批量执行INSERT、UPDATE或DELETE
T insert(Connection conn, String sql, ResultSetHandler rsh) 执行一个插入查询语句
T insert(Connection conn, String sql, ResultSetHandler rsh, Object… params) 执行一个插入查询语句
T insert(String sql, ResultSetHandler rsh) 执行一个插入查询语句
T insert(String sql, ResultSetHandler rsh, Object… params) 执行一个插入查询语句
T insertBatch(Connection conn, String sql, ResultSetHandler rsh, Object[][] params) 批量执行插入语句
T insertBatch(String sql, ResultSetHandler rsh, Object[][] params) 批量执行插入语句
T query(Connection conn, String sql, ResultSetHandler rsh) 查询
T query(Connection conn, String sql, ResultSetHandler rsh, Object… params) 查询
T query(String sql, ResultSetHandler rsh) 查询
T query(String sql, ResultSetHandler rsh, Object… params) 查询
int update(Connection conn, String sql) 执行INSERT、UPDATE或DELETE
int update(Connection conn, String sql, Object… params) 执行INSERT、UPDATE或DELETE
int update(Connection conn, String sql, Object param) 执行INSERT、UPDATE或DELETE
int update(String sql) 执行INSERT、UPDATE或DELETE
int update(String sql, Object… params) 执行INSERT、UPDATE或DELETE
int update(String sql, Object param) 执行INSERT、UPDATE或DELETE

修改

我们先来看一下如何使用QueryRunner进行修改操作，在我们的测试代码中添加测试方法：

@Test
public void update() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   String suffix = Long.toHexString(System.currentTimeMillis());
   Integer result = runner.update(conn,
         "insert into USER_INFO(userId, userName) values(?, ?)", suffix,
         "name" + suffix);
   System.out.println("受影响记录条数：" + result);
}

修改的操作相比较而言还是很简单的，在这段测试代码中，我们向数据库中添加了一条记录，在QueryRunner中也是支持动态参数的，可以很方便的绑定参数。

查询

ScalarHandler

ScalarHandler会返回一个对象，用于读取结果集中第一行指定列的数据。这里我们以查询表中总记录数为例：

@Test
public void queryByScalarHandler() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   Number number = runner.query(conn, "select count(*) from USER_INFO",
         new ScalarHandler<Number>());
   System.out.println("总记录记录条数：" + number.intValue());
}

不知大家有没有发现，在ScalarHandler的泛型中，我使用的是Number，解释一下：之前我在使用该方法查询记录条数的时候，不同的数据库返回的数据类型可能不同，有的返回是Integer，而有的却是Long，为了代码的通用，所以在这里我使用了Number。

ArrayHandler

ArrayHandler会返回一个数组，用于将结果集第一行数据转换为数组。

@Test
public void queryByArrayHandler() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   Object[] results = runner.query(conn, "select * from USER_INFO",
         new ArrayHandler());
   System.out.println(Arrays.asList(results));
}

ArrayListHandler

ArrayListHandler会返回一个集合，集合中的每一项对应结果集指定行中的数据转换后的数组。

@Test
public void queryByArrayListHandler() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   List<Object[]> results = runner.query(conn, "select * from USER_INFO",
         new ArrayListHandler());
   for (Object[] object : results)
   {
      System.out.println(Arrays.asList(object));
   }
}

KeyedHandler

KeyedHandler会返回一个Map，我们可以指定某一列的值作为该Map的键，Map中的值为对应行数据转换的键值对，键为列名。

@Test
public void queryByKeyedHandler() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   Map<String, Map<String, Object>> results = runner.query(conn,
         "select * from USER_INFO", new KeyedHandler<String>());
   System.out.println(results);
}

ColumnListHandler

ColumnListHandler会返回一个集合，集合中的数据为结果集中指定列的数据。

@Test
public void queryByColumnListHandler() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   List<String> results = runner.query(conn, "select * from USER_INFO",
         new ColumnListHandler<String>());
   System.out.println(results);
}

MapHandler

MapHandler会将结果集中第一行数据转换为键值对，键为列名。

@Test
public void queryByMapHandler() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   Map<String, Object> results = runner.query(conn,
         "select * from USER_INFO", new MapHandler());
   System.out.println(results);
}

MapListHandler

MapHandler会将结果集中的数据转换为一个集合，集合中的数据为对应行转换的键值对，键为列名

@Test
public void queryByMapListHandler() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   List<Map<String, Object>> results = runner.query(conn,
         "select * from USER_INFO", new MapListHandler());
   System.out.println(results);
}

BeanHandler

BeanHandler实现了将结果集第一行数据转换为Bean对象，在实际应用中非常方便。

在编写测试代码之前，我们先来编写一个对应的Bean类：

import java.text.MessageFormat;

public class UserInfo
{
   private String userId;
   private String userName;

   public String getUserId()
   {
      return userId;
   }

   public void setUserId(String userId)
   {
      this.userId = userId;
   }

   public String getUserName()
   {
      return userName;
   }

   public void setUserName(String userName)
   {
      this.userName = userName;
   }

   @Override
   public String toString()
   {
      return MessageFormat
            .format("[userId:{0},userName:{1}]", userId, userName);
   }
}

接下来，我们来编写测试代码：

@Test
public void queryByBeanHandler() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   UserInfo results = runner.query(conn, "select * from USER_INFO",
         new BeanHandler<UserInfo>(UserInfo.class));
   System.out.println(results);
}

BeanListHandler

BeanHandler只转换结果集的第一行，而BeanListHandler会将结果集的所有行进行转换，返回一个集合。

@Test
public void queryByBeanListHandler() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   List<UserInfo> results = runner.query(conn, "select * from USER_INFO",
         new BeanListHandler<UserInfo>(UserInfo.class));
   System.out.println(results);
}

BeanMapHandler

BeanMapHandler也会将结果集转换为Bean对象，不过返回的是已指定列的值作为键的键值对。

@Test
public void queryByBeanMapHandler() throws SQLException
{
   printCurrentMethodName();
   QueryRunner runner = new QueryRunner();
   Map<String, UserInfo> results = runner.query(conn,
         "select * from USER_INFO", new BeanMapHandler<String, UserInfo>(
               UserInfo.class));
   System.out.println(results);
}

完整测试代码

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

import org.apache.commons.dbutils.DbUtils;
import org.apache.commons.dbutils.QueryRunner;
import org.apache.commons.dbutils.handlers.ArrayHandler;
import org.apache.commons.dbutils.handlers.ArrayListHandler;
import org.apache.commons.dbutils.handlers.BeanHandler;
import org.apache.commons.dbutils.handlers.BeanListHandler;
import org.apache.commons.dbutils.handlers.BeanMapHandler;
import org.apache.commons.dbutils.handlers.ColumnListHandler;
import org.apache.commons.dbutils.handlers.KeyedHandler;
import org.apache.commons.dbutils.handlers.MapHandler;
import org.apache.commons.dbutils.handlers.MapListHandler;
import org.apache.commons.dbutils.handlers.ScalarHandler;
import org.junit.After;
import org.junit.Before;

public class DBUtilsTest
{
   private Connection conn = null;

   @Before
   public void initConnection() throws SQLException, ClassNotFoundException
   {
      printCurrentMethodName();
      Class.forName("org.h2.Driver");
      conn = DriverManager.getConnection("jdbc:h2:h2.db", "test", "123");
   }

   @Before
   public void initDatabase() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      runner.update(
            conn,
            "CREATE TABLE IF NOT EXISTS USER_INFO (userId VARCHAR(20) PRIMARY KEY, userName VARCHAR(50))");
   }

   public void update() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      String suffix = Long.toHexString(System.currentTimeMillis());
      Integer result = runner.update(conn,
            "insert into USER_INFO(userId, userName) values(?, ?)", suffix,
            "name" + suffix);
      System.out.println("受影响记录条数：" + result);
   }

   public void queryByScalarHandler() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      Number number = runner.query(conn, "select count(*) from USER_INFO",
            new ScalarHandler<Number>());
      System.out.println("总记录记录条数：" + number.intValue());
   }

   public void queryByArrayHandler() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      Object[] results = runner.query(conn, "select * from USER_INFO",
            new ArrayHandler());
      System.out.println(Arrays.asList(results));
   }

   public void queryByArrayListHandler() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      List<Object[]> results = runner.query(conn, "select * from USER_INFO",
            new ArrayListHandler());
      for (Object[] object : results)
      {
         System.out.println(Arrays.asList(object));
      }
   }

   public void queryByKeyedHandler() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      Map<String, Map<String, Object>> results = runner.query(conn,
            "select * from USER_INFO", new KeyedHandler<String>());
      System.out.println(results);
   }

   public void queryByColumnListHandler() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      List<String> results = runner.query(conn, "select * from USER_INFO",
            new ColumnListHandler<String>());
      System.out.println(results);
   }

   public void queryByMapHandler() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      Map<String, Object> results = runner.query(conn,
            "select * from USER_INFO", new MapHandler());
      System.out.println(results);
   }

   public void queryByMapListHandler() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      List<Map<String, Object>> results = runner.query(conn,
            "select * from USER_INFO", new MapListHandler());
      System.out.println(results);
   }

   public void queryByBeanHandler() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      UserInfo results = runner.query(conn, "select * from USER_INFO",
            new BeanHandler<UserInfo>(UserInfo.class));
      System.out.println(results);
   }

   public void queryByBeanListHandler() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      List<UserInfo> results = runner.query(conn, "select * from USER_INFO",
            new BeanListHandler<UserInfo>(UserInfo.class));
      System.out.println(results);
   }

   public void queryByBeanMapHandler() throws SQLException
   {
      printCurrentMethodName();
      QueryRunner runner = new QueryRunner();
      Map<String, UserInfo> results = runner.query(conn,
            "select * from USER_INFO", new BeanMapHandler<String, UserInfo>(
                  UserInfo.class));
      System.out.println(results);
   }

   @After
   public void destory()
   {
      printCurrentMethodName();
      DbUtils.closeQuietly(conn);
   }

   /**
    * 打印当前运行方法名称
    */
   public void printCurrentMethodName()
   {
      System.out.println(Thread.currentThread().getStackTrace()[2]
            .getMethodName());
      System.out.println("==================================================");
   }
}
文章标签：
SQL
数据库
Java
Apache
数据库连接
蒋固金
目录
相关文章
云技术达人
|
11月前
|
消息中间件 人工智能 Apache
Apache RocketMQ × AI：面向 Multi-Agent 的事件驱动架构
本文介绍阿里云周礼在2025全球机器学习大会分享的《Apache RocketMQ x AI》演讲，探讨如何利用RocketMQ新特性构建异步Multi-Agent系统，实现Agent能力发现、任务闭环与动态编排，推动Agentic AI高效协同。
云技术达人
424 5
Raymond运维
|
SQL Ubuntu 关系型数据库
PostgreSQL介绍和PostgreSQL包安装
PostgreSQL 是一个功能强大、可扩展的开源关系型数据库系统，以其可靠性、数据完整性和高性能著称。它支持复杂查询、事务、多版本并发控制及丰富的数据类型，适用于各种应用场景。本文介绍 PostgreSQL 的核心特性，并详细说明在多种 Linux 发行版上的安装与配置方法，帮助用户快速部署和使用该数据库系统。
Raymond运维
1380 0
Echo_Wish
|
机器学习/深度学习 人工智能 运维
使用AI进行系统调优：给系统装上“智能大脑”
使用AI进行系统调优：给系统装上“智能大脑”
Echo_Wish
846 10
潮文精选
|
12月前
|
机器学习/深度学习 人工智能 自然语言处理
学AI应该关注哪些博主或达人？这10位2025年最值得收藏的创作者请收好
2025年，AI重塑商业与社会，学习AI成必备技能。本文精选10位最具影响力的AI领域创作者，涵盖技术、商业、创业、战略等维度，助你精准找到学习路径，掌握时代先机。
潮文精选
1954 0
bruce_xiaowei
|
监控 安全 Linux
Linux系统提权之计划任务（Cron Jobs）提权
在Linux系统中，计划任务（Cron Jobs）常用于定时执行脚本或命令。若配置不当，攻击者可利用其提权至root权限。常见漏洞包括可写的Cron脚本、目录、通配符注入及PATH变量劫持。攻击者通过修改脚本、创建恶意任务或注入命令实现提权。系统管理员应遵循最小权限原则、使用绝对路径、避免通配符、设置安全PATH并定期审计，以防范此类攻击。
bruce_xiaowei
1574 1
游客dk6iqnpz2vtei
|
监控 测试技术 数据库
详解Hyper-V虚拟机CPU分配方法
在Hyper-V环境中，合理分配虚拟机的CPU资源至关重要。vCPU是物理CPU的虚拟化表示，管理员可通过指定处理器数量、核心数、设置兼容性和亲和性、启用动态分配等方法优化性能。使用性能监视工具监控并调整CPU资源，避免过度分配，确保虚拟机稳定运行。定期评估和优化资源分配策略，以适应业务变化，保持最佳性能。
游客dk6iqnpz2vtei
2411 6
aliyun4381607004
|
并行计算 PyTorch 算法框架/工具
阿里云PAI-部署Qwen2-VL-72B
阿里云PAI-部署Qwen2-VL-72B踩坑实录
aliyun4381607004
6338 1
技术小达人
|
Prometheus Kubernetes 监控
OpenAI故障复盘丨如何保障大规模K8s集群稳定性
OpenAI故障复盘丨如何保障大规模K8s集群稳定性
技术小达人
703 0
OpenAI故障复盘丨如何保障大规模K8s集群稳定性
蓝易云
|
存储 关系型数据库 MySQL
Mysql行格式DYNAMIC和COMPACT区别
总之，选择哪种行格式取决于具体的应用场景，如数据类型分布、读写比例、存储与性能需求等。在处理大量文本或二进制数据且对存储空间敏感的应用中，DYNAMIC格式可能是更好的选择；而对于混合型数据且对读取性能有一定要求的场景，COMPACT格式可能更合适。在设计数据库时，评估这些因素并进行适当测试，可以帮助确定最适合的行格式。
蓝易云
1328 0
风水道人
|
Java 应用服务中间件
Springboot启动的时候初始化的线程池默认配置tomcat
Springboot启动的时候初始化的线程池默认配置tomcat
风水道人
747 1

热门文章

最新文章

  • 1
    还在付费爱奇艺VIP？神级程序员教你用Python任意下！
  • 2
    关于区块链，你绝不能忽视的4个安全问题和5招应对方法！
  • 3
    远程桌面发生身份验证错误，要求的函数不受支持
  • 4
    【大数据开发套件调度配置实践】——不同周期任务依赖配置
  • 5
    vLLM 核心技术 PagedAttention 原理详解
  • 6
    【WEB安全】Apache Shiro 反序列化漏洞（中）
  • 7
    深度残差收缩网络(5)：实验验证
  • 8
    《云计算：概念、技术与架构》一1.2　本书未涵盖的内容
  • 9
    gentoo Hardened/Toolchain
  • 10
    DatagramSocket类简单实现文件下载
  • 1
    基于 YOLO11 的多语种交通标志与信号灯识别系统
    36
  • 2
    基于 YOLO11 的狗的 6 种行为识别系统：从模型到 Streamlit 全流程实战
    29
  • 3
    Stable Diffusion文生图：本地 AI 绘画事实标准入门
    52
  • 4
    集装箱损伤检测数据集 | 7700张YOLO智慧港口数据集
    29
  • 5
    空中目标检测数据集 | 8900张YOLO低空安防数据集
    34
  • 6
    STM32学习——传感器
    26
  • 7
    阿里云GPU服务器gn8is实例：L20显卡规格、收费价格与性能测评
    41
  • 8
    阿里云199元服务器怎么没有了？在这呢云服务器ECS通用算力型u1实例
    30
  • 9
    阿里云99元服务器一年在哪购买？续费多少钱？配置是什么？
    35
  • 10
    阿里云服务器架构指南：X86计算、Arm计算、GPU、弹性裸金属服务器、高性能计算深度解析
    27

    • 相关电子书

    更多
  • 低代码开发师（初级）实战教程
  • 冬季实战营第三期：MySQL数据库进阶实战
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    一条命令迁移，帮你实现 OpenClaw 与 Hermes Agent 记忆互通！