Spring - 事务 - 声明使用

Spring - 事务 - 声明使用

1. pom.xml

    <dependencies>
        <!-- 引入Spring框架的核心上下文依赖，提供依赖注入和其他核心功能 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>6.1.10</version>
        </dependency>
        <!-- 引入Spring的JDBC模块，用于数据库访问和操作 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>6.1.11</version>
        </dependency>
        <!-- 引入MySQL的JDBC驱动，用于建立Java应用程序与MySQL数据库的连接 -->
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <version>9.0.0</version>
        </dependency>
    </dependencies>

2. application.properties

# 数据源配置
# 指定数据库连接的URL，这里连接的是MySQL数据库
spring.datasource.url=jdbc:mysql://10.10.0.5:3306/spring

# 数据库连接的用户名
spring.datasource.username=root

# 数据库连接的密码
spring.datasource.password=Password

# 指定数据库驱动类名，这里是MySQL的驱动类
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

3. SpringConfig.java

/**
 * 配置类，用于设置应用程序的bean及其相关属性。
 *
 * @Configuration 标记此类为配置类，用于声明Spring Bean的定义。
 * @ComponentScan 使用指定的包名，自动扫描并注册组件。
 * @Import 将DataSourceConfig类导入到当前配置中，以使用其中的配置信息。
 * @PropertySource 引入classpath下的application.properties文件作为属性源。
 */
@Configuration
@ComponentScan("com.springwork")
@Import(DataSourceConfig.class)
@PropertySource("classpath:application.properties")
public class SpringConfig {
}

4. DataSourceConfig.java

• @EnableTransactionManagement 启用事务管理

// 启用事务管理
@EnableTransactionManagement
public class DataSourceConfig {

    // 从配置文件中读取数据库驱动类名
    @Value("${spring.datasource.driver-class-name}")
    private String driverClassName;

    // 从配置文件中读取数据库URL
    @Value("${spring.datasource.url}")
    private String url;

    // 从配置文件中读取数据库用户名
    @Value("${spring.datasource.username}")
    private String username;

    // 从配置文件中读取数据库密码
    @Value("${spring.datasource.password}")
    private String password;

    /**
     * 配置数据源 bean。
     * 使用DriverManagerDataSource来直接连接数据库，不涉及复杂的连接池配置。
     * @return 返回配置好的数据源对象
     */
    @Bean
    public DataSource dataSource() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }

    /**
     * 配置JdbcTemplate bean。
     * JdbcTemplate提供了一种简化数据库操作的方式。
     * @param dataSource 数据源，用于初始化JdbcTemplate
     * @return 返回配置好的JdbcTemplate对象
     */
    @Bean
    JdbcTemplate jdbcTemplate(DataSource dataSource) {
        return new JdbcTemplate(dataSource);
    }

    /**
     * 配置事务管理器 bean。
     * 使用DataSourceTransactionManager作为事务管理器，它基于数据源进行事务管理。
     * @param dataSource 数据源，用于初始化事务管理器
     * @return 返回配置好的事务管理器对象
     */
    @Bean
    public TransactionManager transactionManager(DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }
}

5. UserEntity.java

/**
 * 用户实体类，用于表示用户的ID和名称。
 * 使用@Component注解，将该类注册为Spring Bean。
 */
@Component
public class UserEntity {
    private int id;
    private String name;

    /**
     * 获取用户的ID。
     *
     * @return 用户的ID。
     */
    public int getId() {
        return id;
    }

    /**
     * 设置用户的ID。
     *
     * @param id 用户的ID。
     */
    public void setId(int id) {
        this.id = id;
    }

    /**
     * 获取用户的名称。
     *
     * @return 用户的名称。
     */
    public String getName() {
        return name;
    }

    /**
     * 设置用户的名称。
     *
     * @param name 用户的名称。
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * 覆盖toString方法，以提供用户实体的字符串表示。
     * 该字符串包含用户的ID和名称。
     *
     * @return 用户实体的字符串表示。
     */
    @Override
    public String toString() {
        return "UserEntity{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }
}

6. UserDao.java

@Repository
public class UserDao {
    // 自动注入JdbcTemplate，用于数据库操作
    @Autowired
    JdbcTemplate jdbcTemplate;

    /**
     * 添加用户到数据库。
     * 使用JdbcTemplate的update方法执行SQL插入操作。
     * 参数和返回值说明：无参数，不返回具体结果，仅执行插入操作。
     */
    public void addUser() {
        String sql = "INSERT INTO user (id, name) VALUES (?, ?)";
        jdbcTemplate.update(sql, 1, "test");
        System.out.println("Added user");
    }

    /**
     * 从数据库删除用户。
     * 使用指定的ID删除用户记录。
     * 参数和返回值说明：无参数，不返回具体结果，仅执行删除操作。
     */
    public void deleteUser() {
        String sql = "DELETE FROM user WHERE id = ?";
        jdbcTemplate.update(sql, 1);
        System.out.println("Deleted user");
    }

    /**
     * 从数据库获取用户信息。
     * 执行SQL查询并将结果作为List返回。
     * 参数和返回值说明：无参数，返回用户信息的List。
     */
    public void getUser() {
        String sql = "SELECT * FROM user";
        jdbcTemplate.queryForList(sql);
        System.out.println("Got user");
    }

    /**
     * 更新数据库中的用户信息。
     * 根据指定的ID更新用户的名字。
     * 参数和返回值说明：无参数，不返回具体结果，仅执行更新操作。
     */
    public void updateUser() {
        String sql = "UPDATE user SET name = ? WHERE id = ?";
        jdbcTemplate.update(sql, "test2", 1);
        System.out.println("Updated user");
    }
}

7. UserService.java

• @Transactional 标记为事务，可作用在类，方法上，建议作用在业务类方法上。

/**
 * 用户服务类，提供用户相关的增删改查操作。
 */
@Service
public class UserService {
    /**
     * 自动注入用户数据访问对象，用于执行数据库操作。
     */
    @Autowired
    UserDao userDao;

    /**
     * 添加用户。
     * 此方法标记为事务性，确保数据库操作的原子性。
     */
    @Transactional
    public void addUser() {
        userDao.addUser();
        // 故意引发除零错误以演示事务回滚
        int i = 1 / 0;
        System.out.println("addUser");
    }

    /**
     * 删除用户。
     */
    public void deleteUser() {
        userDao.deleteUser();
        System.out.println("deleteUser");
    }

    /**
     * 获取用户信息。
     */
    public void getUser() {
        userDao.getUser();
        System.out.println("getUser");
    }

    /**
     * 更新用户信息。
     */
    public void updateUser() {
        userDao.updateUser();
        System.out.println("updateUser");
    }
}

8. Main.java

/**
 * 主类，程序的入口点。
 * 使用Spring框架的注解配置方式来初始化应用程序上下文。
 */
public class Main {
    /**
     * 程序入口方法。
     * @param args 命令行参数，本程序中未使用。
     */
    public static void main(String[] args) {
        // 初始化Spring的注解配置上下文
        ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        // 从上下文中获取UserService的实例
        UserService userService = context.getBean(UserService.class);
        // 调用UserService的addUser方法，演示依赖注入的使用。
        userService.addUser();
    }
}