Spring Boot 单元测试时两个问题的解决（参数化测试，Mock用户信息）

Spring Boot Junit4单元测试时两个问题的解决（参数化测试，Mock用户信息结构不兼容

最近在做Spring Boot的开发，发现单元测试有两个问题，第一个问题是参数化测试——测试用例数据和测试逻辑分离。第二个问题是Junit自带的@WithMockUser 无法满足系统测试——mock的用户信息结构和实现系统的用户信息结构不一致导致测试失败。

基于这两个问题我做了以下的扩展

参数化测试

之前做Junit4单元测试时把测试用例数据和测试代码都耦合到了一起，导致测试代码看起来很乱难以维护，所以就想用参数化测试来解决测试代码和单元测试用例数据分离问题。

• 调研Junit4自带的参数化测试发现存在两个问题

1、自带的参数化测试和Spring整合的不好Spring自动注入等强大的功能不能使用（虽然可以通过额外的代码来弥补但是个人感觉不太好）

2、第一个问题虽然可以解决但是这个问题就比较麻烦了，测试时@Transactional不再生效也就是对数据库的修改不能回滚

通过研究Parameterized 的以下代码：

 /**
     *这个是Parameterized类的一段代码实现
     * Only called reflectively. Do not use programmatically.
     */
    public Parameterized(Class<?> klass) throws Throwable {
   
        super(klass, NO_RUNNERS);
        ParametersRunnerFactory runnerFactory = getParametersRunnerFactory(
                klass);
        Parameters parameters = getParametersMethod().getAnnotation(
                Parameters.class);
        runners = Collections.unmodifiableList(createRunnersForParameters(
                allParameters(), parameters.name(), runnerFactory));
    }

    private ParametersRunnerFactory getParametersRunnerFactory(Class<?> klass)
            throws InstantiationException, IllegalAccessException {
   
        //这里通过注解 UseParametersRunnerFactory来配置自定义的RunnerFactory
        UseParametersRunnerFactory annotation = klass
                .getAnnotation(UseParametersRunnerFactory.class);
        if (annotation == null) {
   
            //这里取的是默认值 BlockJUnit4ClassRunnerWithParametersFactory
            return DEFAULT_FACTORY;
        } else {
   
            Class<? extends ParametersRunnerFactory> factoryClass = annotation
                    .value();
            return factoryClass.newInstance();
        }
    }

那么BlockJUnit4ClassRunnerWithParametersFactory中都做了什么呢？

public class BlockJUnit4ClassRunnerWithParametersFactory implements
        ParametersRunnerFactory {
   //实现了接口ParametersRunnerFactory
    public Runner createRunnerForTestWithParameters(TestWithParameters test)
            throws InitializationError {
   
        //返回了BlockJUnit4ClassRunnerWithParameters实例
        return new BlockJUnit4ClassRunnerWithParameters(test);
    }
}

可以发现Parameterized 默认使用的是BlockJUnit4ClassRunnerWithParametersFactory来创建runner 并且默认用不用 的是 BlockJUnit4ClassRunnerWithParameters，而BlockJUnit4ClassRunnerWithParameters和SpringJUnit4ClassRunner都是BlockJUnit4ClassRunner子类，并且Parameterized 是可以配置自定义RunnerFactory。

了解到这里之后那么问题变得简单多了，我们只需要自己定义一个RunnerFactory 来实现基于SpringRunner的参数化测试就可以了

定义自己的RunnerFactory

/**
 * 自定义支持Spring的参数化Runner工厂
 * @author Alen
 * @date 2021-01-12 17:49
 * @since 2021-01-12 17:49
 */
public class SpringRunnerWithParametersFactory implements ParametersRunnerFactory {
   
    @Override
    public Runner createRunnerForTestWithParameters(TestWithParameters test) throws InitializationError {
   
        
        return new SpringParametersRunner(test);
    }
}

如上代码，我们自己定义的RunnerFactory也是非常简单的只创建了SpringParametersRunner，下面看一下SpringParametersRunner的实现：

public class SpringParametersRunner extends SpringJUnit4ClassRunner {
    //首先继承自SpringJUnit4ClassRunner

    private final Object[] parameters;//保存传入的参数

    private final String name;//保存测试用例名

    public SpringParametersRunner(TestWithParameters test) throws InitializationError {
   
        super(test.getTestClass().getJavaClass());
        this.parameters = test.getParameters().toArray();
        this.name = test.getName();
    }
    //这里的createTest实际是将SpringJUnit4ClassRunner 和 BlockJUnit4ClassRunnerWithParameters的该方法给合并在一起了
    @Override
    public Object createTest() throws Exception {
   
        Object object = null;
        if (fieldsAreAnnotated()) {
   
            object = createTestUsingFieldInjection();
        } else {
   
            object = createTestUsingConstructorInjection();
        }