Spring基础分析07-Spring JdbcTemplate

大家好，今天和大家一起分享一下Spring的JdbcTemplate~

传统的JDBC API虽然提供了对数据库的基本访问能力，但其冗长的代码和繁琐的资源管理非常的不方便。为了解决这些问题，Spring框架引入了JdbcTemplate，通过一系列便捷的方法简化了与数据库的交互过程，同时保持了对SQL语句的直接控制。

Spring JdbcTemplate简介

JdbcTemplate是Spring框架中用于简化JDBC操作的一个类。它封装了JDBC API中的大部分样板代码，如创建连接、预编译SQL语句、执行查询或更新、处理结果集等，是我们可以专注于编写SQL逻辑，而不必担心底层细节。此外，JdbcTemplate还提供了自动资源管理和异常转换的功能，进一步提高了开发效率和代码质量。

核心功能

• 简化SQL执行：支持多种类型的SQL语句（如SELECT, INSERT, UPDATE, DELETE），并提供相应的方法来简化这些操作。
• 自动资源管理：负责打开和关闭数据库连接、准备语句、释放资源等任务，减少了内存泄漏的风险。
• 异常转换：将原始的SQLException转换为更具描述性的Spring DataAccessException层次结构下的异常类型，便于错误处理。
• 结果集映射：通过RowMapper接口，可以方便地将查询结果映射到Java对象上，简化了结果集的处理过程。
• 批量操作：支持批量插入、更新等操作，提高了性能。

JdbcTemplate的工作原理

JdbcTemplate内部采用了模板方法模式，它定义了一个标准的操作流程，而具体的实现则由子类或者回调函数提供。例如，在执行查询时，JdbcTemplate会按照以下步骤操作：

1. 获取DataSource：从Spring容器中获取数据源（DataSource）。
2. 创建Connection：使用DataSource创建数据库连接。
3. 预编译SQL：根据传入的SQL字符串和参数，预编译成PreparedStatement。
4. 执行SQL：调用PreparedStatement的execute方法执行SQL语句。
5. 处理结果集：如果是查询操作，则遍历ResultSet并将每一行数据映射到Java对象。
6. 清理资源：无论是否发生异常，都会确保所有使用的资源被正确关闭。

不仅简化了代码，而且保证了资源的安全释放。

配置JdbcTemplate

使用XML配置

在基于XML配置的应用程序中，可以通过<bean>标签来定义JdbcTemplate实例，并注入相应的DataSource。

<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
    <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
    <property name="url" value="jdbc:mysql://localhost:3306/mydb"/>
    <property name="username" value="root"/>
    <property name="password" value="password"/>
</bean>

<bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
    <property name="dataSource" ref="dataSource"/>
</bean>

使用注解配置

对于采用注解驱动的Spring Boot应用程序，只需要在主类或配置类上添加@Configuration注解，并通过@Bean方法注册JdbcTemplate即可。

@Configuration
public class AppConfig {

    @Bean
    public DataSource dataSource() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/mydb");
        dataSource.setUsername("root");
        dataSource.setPassword("password");
        return dataSource;
    }

    @Bean
    public JdbcTemplate jdbcTemplate(DataSource dataSource) {
        return new JdbcTemplate(dataSource);
    }
}

常用操作

查询操作

JdbcTemplate提供了多种查询方法，可以根据不同的需求选择最合适的方式。例如，queryForObject()用于返回单个对象，queryForList()用于返回列表，而query()则允许自定义结果集的映射规则。

举例查询所有用户

@Repository
public class UserDaoJdbc implements UserDao {

    private final JdbcTemplate jdbcTemplate;

    @Autowired
    public UserDaoJdbc(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }

    @Override
    public List<User> findAll() {
        String sql = "SELECT * FROM users";
        return jdbcTemplate.query(sql, (rs, rowNum) ->
            new User(rs.getLong("id"), rs.getString("username"))
        );
    }
}

在这个例子中，我们使用了JdbcTemplate的query()方法，并通过匿名内部类实现了RowMapper接口，以指定如何将每一行结果映射到User对象。

更新操作

除了查询之外，JdbcTemplate同样支持插入、更新和删除操作。这些操作通常涉及到SQL语句中的占位符参数，以便安全地传递动态值。

举例插入新用户

@Override
public void createUser(User user) {
    String sql = "INSERT INTO users (username) VALUES (?)";
    jdbcTemplate.update(sql, user.getUsername());
}

批量操作

当需要一次性执行多个相似的操作时，JdbcTemplate也提供了批量处理的支持。

举例批量插入用户

@Override
public void createUsers(List<User> users) {
    String sql = "INSERT INTO users (username) VALUES (?)";
    List<Object[]> batchArgs = users.stream()
        .map(user -> new Object[]{user.getUsername()})
        .collect(Collectors.toList());
    jdbcTemplate.batchUpdate(sql, batchArgs);
}

事务管理

JdbcTemplate本身并不直接处理事务，但它可以很好地与Spring的声明式事务管理配合使用。只需在服务层方法上加上@Transactional注解，就能确保一组相关操作要么全部成功，要么完全回滚。

@Service
@Transactional
public class UserServiceImpl implements UserService {

    private final UserDao userDao;

    @Autowired
    public UserServiceImpl(UserDao userDao) {
        this.userDao = userDao;
    }

    @Override
    public void createUser(User user) {
        userDao.createUser(user);
        // 如果下面的代码抛出异常，整个事务将会回滚
        throw new RuntimeException("Simulated error");
    }
}

实际代码举例：

例如我们构建一个完整的用户管理模块，包括创建、读取、更新和删除用户信息。

// 创建用户
@Override
public void createUser(User user) {
    String sql = "INSERT INTO users (username) VALUES (?)";
    jdbcTemplate.update(sql, user.getUsername());
}


// 获取所有用户
@Override
public List<User> findAll() {
    String sql = "SELECT * FROM users";
    return jdbcTemplate.query(sql, (rs, rowNum) ->
        new User(rs.getLong("id"), rs.getString("username"))
    );
}

// 更新用户信息
@Override
public void updateUser(User user) {
    String sql = "UPDATE users SET username=? WHERE id=?";
    jdbcTemplate.update(sql, user.getUsername(), user.getId());
}

// 删除用户
@Override
public void deleteUser(Long id) {
    String sql = "DELETE FROM users WHERE id=?";
    jdbcTemplate.update(sql, id);
}

复杂查询

对于一些复杂的查询需求比如多表联结、分组统计等，JdbcTemplate也能轻松处理，关键在于构造合适的SQL语句，并正确地映射结果集。

统计每个用户的订单数量

public Map<Long, Integer> getUserOrderCounts() {
    String sql = "SELECT u.id, COUNT(o.id) AS order_count FROM users u LEFT JOIN orders o ON u.id = o.user_id GROUP BY u.id";
    return jdbcTemplate.query(sql, (rs, rowNum) ->
        Maps.immutableEntry(rs.getLong("id"), rs.getInt("order_count"))
    ).stream().collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
}

动态SQL构建

有时候我们需要根据不同的条件动态生成SQL语句。JdbcTemplate支持使用命名参数来代替问号占位符，这样可以使SQL更加易读和灵活。

public List<User> findUsersByCriteria(String username, Boolean active) {
    Map<String, Object> params = new HashMap<>();
    StringBuilder sql = new StringBuilder("SELECT * FROM users WHERE 1=1");

    if (username != null && !username.isEmpty()) {
        sql.append(" AND username LIKE :username");
        params.put("username", "%" + username + "%");
    }

    if (active != null) {
        sql.append(" AND active = :active");
        params.put("active", active);
    }

    return namedParameterJdbcTemplate.query(sql.toString(), params, (rs, rowNum) ->
        new User(rs.getLong("id"), rs.getString("username"), rs.getBoolean("active"))
    );
}

我们使用了NamedParameterJdbcTemplate，它是JdbcTemplate的一个变种专门用于处理带有命名参数的SQL语句。

结合AOP进行日志记录

为了更好地跟踪数据库操作，可以在JdbcTemplate的相关方法上调用前或调用后插入日志记录逻辑，可以通过AOP切面来实现。

@Aspect
@Component
public class LoggingAspect {

    private static final Logger logger = LoggerFactory.getLogger(LoggingAspect.class);

    @Around("execution(* org.springframework.jdbc.core.JdbcTemplate.*(..))")
    public Object logJdbcTemplateCalls(ProceedingJoinPoint joinPoint) throws Throwable {
        long start = System.currentTimeMillis();
        Object proceed = joinPoint.proceed(); // 执行目标方法
        long executionTime = System.currentTimeMillis() - start;

        logger.info("Method {} executed in {} ms with arguments {}", joinPoint.getSignature(), executionTime, Arrays.toString(joinPoint.getArgs()));
        return proceed;
    }
}

使用RowMapper处理结果集

对于简单的查询，直接在query()方法中定义RowMapper已经足够。但对于复杂的业务对象，可能需要单独创建一个RowMapper实现类，以便更好地组织代码。

class UserRowMapper implements RowMapper<User> {

    @Override
    public User mapRow(ResultSet rs, int rowNum) throws SQLException {
        return new User(
            rs.getLong("id"),
            rs.getString("username"),
            rs.getBoolean("active")
        );
    }
}

// 在查询时使用
return jdbcTemplate.query(sql, new UserRowMapper());

分页查询

分页查询是一种常见的需求，尤其是在处理大量数据时。JdbcTemplate本身并没有内置的分页支持，但我们可以通过SQL语句来实现这一点。

public List<User> getUsersWithPagination(int page, int size) {
    String sql = "SELECT * FROM users LIMIT ? OFFSET ?";
    return jdbcTemplate.query(sql, new Object[]{size, (page - 1) * size}, new UserRowMapper());
}

最佳实践与注意事项

• 避免硬编码SQL：尽量使用参数化查询或命名参数，防止SQL注入攻击。
• 合理利用缓存：对于频繁查询的数据，考虑使用缓存机制减少数据库压力。
• 优化性能：针对大批量数据操作，评估是否需要使用批量处理或其他优化手段。
• 测试充分：编写单元测试和集成测试，确保数据库操作的正确性和稳定性。
• 文档记录：维护良好的代码注释和外部文档，帮助团队成员理解和维护代码。

JdbcTemplate作为Spring框架中的一员，极大地简化了Java应用程序与数据库之间的交互过程。不仅提供了丰富的API来执行各种类型的SQL操作，而且还解决了传统JDBC编程中的许多痛点问题。无论是简单的CRUD操作还是复杂的查询和事务管理，JdbcTemplate都能提供简洁而高效的解决方案，欢迎大家一起沟通~