跳至主要內容

Spring注解开发_整合Junit

2026/9/12大约 6 分钟框架学习Spring

Spring注解开发_整合Junit

本篇介绍 Spring 的两种简化配置方式：先用原始注解代替 XML 中的 Bean 配置，再用新注解完全取代 XML 配置文件；最后学习 Spring 整合 Junit，解决测试代码中重复获取容器的问题。

1. Spring注解开发

Spring 是轻代码重配置的框架，配置比较繁琐。随着项目的扩大，配置会变得非常臃肿，影响开发效率。为了解决这个问题，注解开发成为一种趋势：用注解代替 XML 配置文件可以简化配置，提高开发效率。

这同样体现了一种"约定大于配置"的思想。

1.1 Spring原始注解

目的：代替 Spring 的 <bean> 标签的配置。

注解说明
@Component使用在类上，用于实例化 Bean
@Controller使用在 Web 层类上，用于实例化 Bean（SpringMVC 中会讲到）
@Service使用在 Service 层类上，用于实例化 Bean
@Repository使用在 Dao 层类上，用于实例化 Bean
@Autowired使用在字段上，用于根据类型依赖注入
@Qualifier结合 @Autowired 一起使用，用于根据名称进行依赖注入
@Resource相当于 @Autowired + @Qualifier，按照名称进行注入
@Value注入普通属性
@Scope标注 Bean 的作用范围
@PostConstruct使用在方法上，标注该方法是 Bean 的初始化方法
@PreDestroy使用在方法上，标注该方法是 Bean 的销毁方法
@Transactional在需要进行事务控制的类或方法上开启事务

1.2 案例

在上一讲声明式事务的案例基础上修改，把 Service 与事务配置改为注解方式。

1.2.1 修改Spring配置文件

使用注解进行开发时：

  • 需要在 applicationContext.xml 中配置组件扫描，作用是指定哪个包及其子包下的 Bean 需要进行扫描，以便识别使用注解配置的类、字段和方法；
  • 配置文件中要开启事务的注解驱动 <tx:annotation-driven />，同时指定事务管理器；
  • 在使用原始注解的情况下，第三方的类（不是自己定义的类）只能在 XML 中使用 <bean> 标签配置，无法使用上述注解进行配置。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/tx
        http://www.springframework.org/schema/tx/spring-tx.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop.xsd">
    <!-- 配置包扫描 -->
    <context:component-scan base-package="com.qfedu" />

    <!-- 加载配置文件 -->
    <context:property-placeholder location="classpath:jdbc.properties" />

    <!-- 配置数据源 -->
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
        <property name="driverClassName" value="${jdbc.driver}" />
        <property name="url" value="${jdbc.url}" />
        <property name="username" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />
    </bean>

    <!-- 配置sqlSessionFactory，整合MyBatis -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 配置连接池 -->
        <property name="dataSource" ref="dataSource" />
        <!-- 配置别名 -->
        <property name="typeAliasesPackage" value="com.qfedu.entity" />
        <!-- 配置MyBatis的核心配置文件 -->
        <property name="configLocation" value="classpath:mybatis-config.xml" />
    </bean>

    <!-- 配置包扫描 - 扫描Mapper -->
    <bean id="mapperScannerConfigurer" class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.qfedu.mapper" />
    </bean>

    <!-- 配置事务管理器 -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource" />
    </bean>

    <!-- 事务的注解驱动 -->
    <tx:annotation-driven transaction-manager="transactionManager" />
</beans>

1.2.2 配置Service

使用 @Autowired 或者 @Autowired + @Qualifier 或者 @Resource 进行 Mapper 代理对象的注入，并在需要进行事务控制的方法上加 @Transactional：

@Service("accountService")
public class AccountServiceImpl implements AccountService {
    @Autowired
    private AccountMapper accountMapper;

    @Override
    @Transactional
    public void transfer(Integer srcId, Integer dstId, Integer money) throws Exception {
        Account src = accountMapper.findById(srcId);
        Account dst = accountMapper.findById(dstId);

        if (src == null) {
            throw new RuntimeException("转出用户不存在");
        }

        if (dst == null) {
            throw new RuntimeException("转入用户不存在");
        }

        if (src.getMoney() < money) {
            throw new RuntimeException("转出账户余额不足");
        }

        src.setMoney(src.getMoney() - money);
        dst.setMoney(dst.getMoney() + money);

        accountMapper.update(src);
        // int x = 1/0;  // 取消注释可验证异常时事务回滚
        accountMapper.update(dst);
    }
}

1.3 Spring新注解（XML配置改为Java配置）

使用上面的方式还不能完全代替 XML 配置文件，还需要使用注解替代的配置如下：

  • 非自定义的 Bean 的配置：<bean>；
  • 加载 properties 文件的配置：<context:property-placeholder>；
  • 组件扫描的配置：<context:component-scan>；
  • 引入其他文件：<import>。

Spring 后续版本新增注解如下：

注解说明
@Configuration用于指定当前类是一个 Spring 配置类，当创建容器时会从该类上加载注解
@ComponentScan用于指定 Spring 在初始化容器时要扫描的包，作用和 XML 配置中的 <context:component-scan base-package="com.qfedu" /> 一样
@Bean使用在方法上，将该方法的返回值存储到 Spring 容器中，通常用于管理第三方类（不是自己定义的类）的 Bean
@PropertySource用于加载 .properties 文件中的配置
@Import用于导入其他配置类
@MapperScan扫描特定包下的 Mapper
@EnableTransactionManagement配置事务的注解驱动

1.3.1 Jdbc配置类

// 声明这是一个配置类
@Configuration
// 引入外部配置文件
@PropertySource("classpath:jdbc.properties")
// 扫描特定包下的mapper
@MapperScan(basePackages = "com.qfedu.mapper")
// 配置事务的注解驱动
@EnableTransactionManagement
public class JdbcConfig {
    @Value("${jdbc.driver}")
    private String driverClassName;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;

    // 创建数据源
    @Bean("dataSource")
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);

        return dataSource;
    }

    // 配置事务平台管理器
    @Bean("transactionManager")
    public DataSourceTransactionManager transactionManager(@Qualifier("dataSource") DataSource dataSource) {
        return new DataSourceTransactionManager(dataSource);
    }

    // 创建并配置SqlSessionFactoryBean
    @Bean("sqlSessionFactoryBean")
    public SqlSessionFactoryBean sqlSessionFactoryBean(@Qualifier("dataSource") DataSource dataSource) {
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource);
        // 配置别名
        factoryBean.setTypeAliasesPackage("com.qfedu.entity");
        // 加载MyBatis的核心配置文件
        factoryBean.setConfigLocation(new PathMatchingResourcePatternResolver().getResource("classpath:mybatis-config.xml"));

        return factoryBean;
    }
}

1.3.2 主配置类

// 引入其他的配置类
@Import(JdbcConfig.class)
// 配置包扫描
@ComponentScan("com.qfedu")
public class MainConfig {

}

提示

上面的内容也可以写在一个配置类中，这里是为了演示引入其他配置类，拆成了两个。使用这套配置，在以后的开发中我们就可以完全抛弃 XML 配置了，这也是当前的主流——Spring Boot 中就是这样做的。

2. Spring整合Junit

2.1 原始Junit测试Spring存在的问题

在测试类中，每个测试方法都有以下两行代码：

ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
AccountService accountService = context.getBean(AccountService.class);

这两行代码的作用是获取 Spring IOC 容器。如果不写的话，直接会提示空指针异常，这对测试非常不友好——每个测试方法都要重复获取容器。

2.2 希望达到的效果

  • 只告诉测试类 Spring 的配置文件（或配置类）；
  • 需要的 Bean 直接通过 @Autowired 注入。

2.3 步骤

  1. 导入相关 Jar 包：junit 的 Jar 包和 spring-test 的 Jar 包；
  2. 使用 @RunWith 替换原来的运行器；
  3. 使用 @ContextConfiguration 或 @SpringJUnitConfig 指定配置文件或配置类；
  4. 使用 @Autowired 注入需要测试的对象；
  5. 创建测试方法测试。
// 指定运行器
@RunWith(SpringJUnit4ClassRunner.class)
// 指定Spring的配置文件或配置类
//@SpringJUnitConfig(locations = "classpath:applicationContext.xml")
@SpringJUnitConfig(classes = MainConfig.class)
public class MyTest1 {
    @Autowired
    private AccountService accountService;

    @Test
    public void test1() throws Exception {
        accountService.transfer(1, 2, 100);
    }
}

提示

整合 Junit 之后，测试类中不再出现任何创建容器的样板代码：运行器由 Spring 提供，容器由配置类（或配置文件）构建，测试对象直接注入即可，测试代码只剩业务验证逻辑。