如何在生产中使用 CDI 测试类时注入模拟

2022-09-03 01:11:52

我正在Java SE环境中使用WELD-SE进行依赖注入。因此,类的依赖项如下所示:

public class ProductionCodeClass {
    @Inject
    private DependencyClass dependency;
}

在为这个类编写单元测试时,我正在创建一个模拟,由于我不想为我运行的每个测试启动一个完整的CDI环境,所以我手动“注入”模拟:DependencyClass

import static TestSupport.setField;
import static org.mockito.Mockito.*;

public class ProductionCodeClassTest {
    @Before
    public void setUp() {
        mockedDependency = mock(DependencyClass.class);
        testedInstance = new ProductionCodeClass();
        setField(testedInstance, "dependency", mockedDependency);
    }
}

静态导入的方法,我用我在测试中使用的工具在一个类中编写了自己:setField()

public class TestSupport {
    public static void setField(
                                final Object instance,
                                final String field,
                                final Object value) {
        try {
            for (Class classIterator = instance.getClass();
                 classIterator != null;
                 classIterator = classIterator.getSuperclass()) {
                try {
                    final Field declaredField =
                                classIterator.getDeclaredField(field);
                    declaredField.setAccessible(true);
                    declaredField.set(instance, value);
                    return;
                } catch (final NoSuchFieldException nsfe) {
                    // ignored, we'll try the parent
                }
            }

            throw new NoSuchFieldException(
                      String.format(
                          "Field '%s' not found in %s",
                          field,
                          instance));
        } catch (final RuntimeException re) {
            throw re;
        } catch (final Exception ex) {
            throw new RuntimeException(ex);
        }
    }
}

我不喜欢这个解决方案的原因是,在任何新项目中,我都需要这个帮手一遍又一遍。我已经将其打包为Maven项目,我可以将其作为测试依赖项添加到我的项目中。

但是,在我错过的其他一些公共库中,难道没有现成的东西吗?对我这样做的方式有什么评论吗?


答案 1

Mockito开箱即用地支持这一点:

public class ProductionCodeClassTest {

    @Mock
    private DependencyClass dependency;

    @InjectMocks
    private ProductionCodeClass testedInstance;

    @Before
    public void setUp() {
        testedInstance = new ProductionCodeClass();
        MockitoAnnotations.initMocks(this);
    }

}

@InjectMocks注释将触发在测试类中模拟的类或接口的注入,在这种情况下:DependencyClass

Mockito尝试按类型注入(在类型相同的情况下使用名称)。当注入失败时,Mockito不会抛出任何东西 - 你必须手动满足依赖关系。

在这里,我也使用注释而不是调用.您仍然可以使用 ,但我更喜欢使用注释。@Mockmock()mock()

作为旁注,有可用的反射工具,它们支持您在 中实现的功能。其中一个例子是ReflectiveTestUtilsTestSupport


也许更好的是使用构造函数注入

public class ProductionCodeClass {

    private final DependencyClass dependency;

    @Inject
    public ProductionCodeClass(DependencyClass dependency) {
        this.dependency = dependency;
    }
}

这里的主要优点是,很明显该类依赖于哪些类,并且在不提供所有依赖项的情况下无法轻松构造它。此外,它还允许注入的类是最终的。

通过这样做,是没有必要的。相反,只需通过将 mock 作为参数提供给构造函数来创建类:@InjectMocks

public class ProductionCodeClassTest {

    @Mock
    private DependencyClass dependency;

    private ProductionCodeClass testedInstance;

    @Before
    public void setUp() {
        MockitoAnnotations.initMocks(this);
        testedInstance = new ProductionCodeClass(dependency);
    }

}

答案 2

当 mockitos 内置函数不够时,替代方案:尝试 needle4j.org

它是一个注入/模拟框架,允许注入模拟和具体实例,还支持生命周期模拟的后期构造。

 public class ProductionCodeClassTest {

    @Rule
    public final NeedleRule needle = new NeedleRule();

    // will create productionCodeClass and inject mocks by default
    @ObjectUnderTest(postConstruct=true)
    private ProductionCodeClass testedInstance;

    // this will automatically be a mock
    @Inject
    private AServiceProductionCodeClassDependsOn serviceMock;

    // this will be injected into ObjectUnderTest 
    @InjectIntoMany
    private ThisIsAnotherDependencyOfProdcutionCodeClass realObject = new ThisIsAnotherDependencyOfProdcutionCodeClass ();

    @Test
    public void test_stuff() {
         ....
    }

}

推荐