Spring框架JdbcTemplate数据库事务管理完全注解方式

下面开始讲解“Spring框架JdbcTemplate数据库事务管理完全注解方式”的完整攻略。

什么是JdbcTemplate

JdbcTemplate是Spring JDBC 模块中的一个核心类，用于简化JDBC操作。它完全封装了JDBC API，提供了一组更简单、更少样板代码的JDBC操作方式。同时，JdbcTemplate也提供了事务处理的支持。

JDBC事务处理方式

在 JDBC API 中，事务是通过一系列的操作来实现的，如下所示：

Connection conn = null;
PreparedStatement ps = null;

try {
    // 获取连接，关闭默认自动提交事务
    conn = DriverManager.getConnection(url, username, password);
    conn.setAutoCommit(false);

    // 执行 SQL 语句
    ps = conn.prepareStatement(sql);
    // 执行更新语句
    int result = ps.executeUpdate();

    // 提交事务
    conn.commit();
} catch (Exception e) {
    // 出现异常，回滚事务
    conn.rollback();
} finally {
    // 关闭资源
    try {ps.close();} catch (Exception e) {}
    try {conn.close();} catch (Exception e) {}
}

这种方式虽然简单，但是也存在着一些问题：

1. 对代码耦合度较高，需要手动编写 try-catch-finally 代码块；
2. 每次操作都需要手动获取连接和关闭资源，代码量过大。

相对于原始的JDBC方式，Spring框架提供了更方便的JdbcTemplate操作方式。

JdbcTemplate的使用

配置数据源

在使用JdbcTemplate之前，需要先配置数据源。可以通过Spring的XML配置或注解配置实现。

这里，我们采用注解方式，配置数据源 DataSource。需要在配置类上使用 @Configuration 注解，并在其中添加一个使用 @Bean 注解的方法。

@Configuration
public class MyConfig {

    // 数据源配置
    @Bean
    public DataSource dataSource() {
        // 配置数据源
        return dataSource;
    }
}

配置JdbcTemplate

配置完数据源之后，可以通过写一个使用 @Bean 注解的方法来配置 JdbcTemplate：

@Configuration
public class MyConfig {

    // 数据源配置
    @Bean
    public DataSource dataSource() {
        // 配置数据源
        return dataSource;
    }

    // JdbcTemplate 的注入
    @Bean
    public JdbcTemplate jdbcTemplate(DataSource dataSource) {
        return new JdbcTemplate(dataSource);
    }
}

添加事务支持

接下来，需要添加事务支持。通过使用 @EnableTransactionManagement 注解，开启对事务的支持。同时，在实现类的方法上，使用 @Transactional 注解，表示该方法需要被事务控制。

@Configuration
@EnableTransactionManagement
public class MyConfig {

    // 数据源配置
    @Bean
    public DataSource dataSource() {
        // 配置数据源
        return dataSource;
    }

    // JdbcTemplate 的注入
    @Bean
    public JdbcTemplate jdbcTemplate(DataSource dataSource) {
        return new JdbcTemplate(dataSource);
    }
}

实现数据访问的类

写一个数据访问的实现类，实现 insert() 方法，将数据添加到用户表中。

@Repository
public class UserDaoImpl implements UserDao {

    // JdbcTemplate 注入
    @Autowired
    private JdbcTemplate jdbcTemplate;

    // 在实现类的方法上声明事务
    @Transactional
    public int insert(User user) {
        String sql = "INSERT INTO user(name, age) VALUES (?, ?)";

        // JdbcTemplate 操作
        return jdbcTemplate.update(sql, user.getName(), user.getAge());
    }
}

使用 @Autowired 注解，将 JdbcTemplate 自动注入到 UserDaoImpl 实现类的属性 jdbcTemplate 中。

同时，该方法上添加了 @Transactional 注解，表示该方法需要事务控制。该注解可以写在类上，表示该类所有的方法都需要事务控制。

实现一个测试Controller

@RestController
public class UserController {

    @Autowired
    private UserDao userDao;

    @RequestMapping(value = "/add")
    public int addUser() {
        User user = new User();
        user.setName("tom");
        user.setAge(18);
        return userDao.insert(user);
    }
}

使用 @Autowired 注解自动注入 UserDao，调用其 insert() 方法。

示例

假如有一个用户表，存储用户的基本信息。现在需要将一条新的用户记录添加到用户表中。珂以使用如下的代码实现：

@Configuration
@EnableTransactionManagement
public class MyConfig {

    // 数据源配置
    @Bean
    public DataSource dataSource() {
        // 配置数据源
        return dataSource;
    }

    // JdbcTemplate 的注入
    @Bean
    public JdbcTemplate jdbcTemplate(DataSource dataSource) {
        return new JdbcTemplate(dataSource);
    }
}

@Repository
public class UserDaoImpl implements UserDao {

    // JdbcTemplate 注入
    @Autowired
    private JdbcTemplate jdbcTemplate;

    // 在实现类的方法上声明事务
    @Transactional
    public int insert(User user) {
        String sql = "INSERT INTO user(name, age) VALUES (?, ?)";

        // JdbcTemplate 操作
        return jdbcTemplate.update(sql, user.getName(), user.getAge());
    }
}

@RestController
public class UserController {

    @Autowired
    private UserDao userDao;

    @RequestMapping(value = "/add")
    public int addUser() {
        User user = new User();
        user.setName("tom");
        user.setAge(18);
        return userDao.insert(user);
    }
}

在浏览器中访问 http://localhost:8080/add ，即可将一条新的记录插入到用户表中。

另一个更加具体的例子，详见官方文档 https://spring.io/guides/gs/managing-transactions/ 。

希望这份攻略能对你有所帮助。