Spring (18)什么是JdbcTemplate

55 阅读3分钟

JdbcTemplate 是 Spring 框架提供的一个主要的类,旨在简化传统 JDBC 的使用。它处理了诸如连接管理、异常处理等繁琐的低级任务,让开发者可以更专注于执行 SQL 语句和处理结果。JdbcTemplate 属于 Spring JDBC 模块(spring-jdbc),通过提供一系列的模板方法,它最大程度地减少了 JDBC 编码的样板代码。

核心功能

  • 简化连接管理:自动获取和释放数据库连接,避免了手动管理连接的复杂性。
  • 异常处理:将 SQLException 转换为 Spring 的数据访问异常,这是一种未检查(运行时)异常。
  • 简化 CRUD 操作:提供了一系列便捷的方法来执行查询、更新、插入和删除操作。
  • 结果集处理:通过回调接口简化了结果集的处理,例如将每行数据映射到对象。

深入源码

JdbcTemplate 的设计使用了模板方法模式。这种设计模式在操作中定义了算法的骨架,将算法的一些步骤延迟到子类中实现。在 JdbcTemplate 的情况下,并不是通过继承来实现延迟的步骤,而是通过回调和策略模式。

主要方法

以下是 JdbcTemplate 的一些关键方法及其简要说明:

  • query:执行 SQL 查询,并使用 RowMapperResultSet 的每一行映射到对象。
  • update:用于执行插入、更新、删除操作。
  • execute:可以用于执行任何 SQL 语句,对于执行存储过程或实现复杂的数据库操作特别有用。

实现示例

让我们通过实现一个简单的查询来看看 JdbcTemplate 的使用方法:

public class EmployeeDao {
    private JdbcTemplate jdbcTemplate;

    public EmployeeDao(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    public List<Employee> findAll() {
        String sql = "SELECT id, name, department FROM employees";
        return jdbcTemplate.query(sql, new RowMapper<Employee>() {
            @Override
            public Employee mapRow(ResultSet rs, int rowNum) throws SQLException {
                Employee employee = new Employee();
                employee.setId(rs.getInt("id"));
                employee.setName(rs.getString("name"));
                employee.setDepartment(rs.getString("department"));
                return employee;
            }
        });
    }
}

在这个例子中,jdbcTemplate.query 方法接收一个 SQL 语句和一个 RowMapper 实现。RowMapper 接口要求实现 mapRow 方法,该方法负责将 ResultSet 的当前行映射到用户定义的对象。

源码解析

让我们深入一点,看看 JdbcTemplate 中的 query 方法的典型实现:

public <T> List<T> query(String sql, RowMapper<T> rowMapper) throws DataAccessException {
    return query(sql, new Object[]{}, new int[]{}, rowMapper);
}

public <T> List<T> query(String sql, Object[] args, int[] argTypes, RowMapper<T> rowMapper) throws DataAccessException {
    return execute(new PreparedStatementCreator() {
        @Override
        public PreparedStatement createPreparedStatement(Connection con) throws SQLException {
            PreparedStatement ps = con.prepareStatement(sql);
            if (args != null) {
                for (int i = 0; i < args.length; i++) {
                    ps.setObject(i + 1, args[i], argTypes[i]);
                }
            }
            return ps;
        }
    }, new PreparedStatementCallback<List<T>>() {
        @Override
        public List<T> doInPreparedStatement(PreparedStatement ps) throws SQLException, DataAccessException {
            try (ResultSet rs = ps.executeQuery()) {
                List<T> results = new ArrayList<>();
                int rowNum = 0;
                while (rs.next()) {
                    results.add(rowMapper.mapRow(rs, rowNum++));
                }
                return results;
            }
        }
    });
}

这个简化的代码演示了几个关键点:

  • query 方法的重载版本接收 SQL 语句、参数数组、参数类型数组和一个 RowMapper
  • 使用 PreparedStatementCreator 来创建 PreparedStatement,这是一个典型的模板方法模式的应用。
  • 使用 PreparedStatementCallback 执行查询并处理 ResultSet,同样是模板方法模式的应用。
  • 最后,RowMapper 用于将每一行转换成用户定义的对象类型。

小结

JdbcTemplate 的设计和实现体现了 Spring 框架的核心原则之一:简化开发。通过封装 JDBC 的复杂性,并提供一套简洁的操作数据库的 API,JdbcTemplate 使得数据库操作变得更加直接和容易理解。同时,它的设计也体现了面向对象设计原则和设计模式的应用,例如模板方法模式和策略模式,这进一步提高了代码的可读性和可维护性。