如何使用 JUnit 测试没有 @SpringBootApplication 的 Java Spring Boot 应用程序?

Pra*_*mar 11 java junit spring spring-boot junit5

我创建了一个 Spring Boot Java 库,其中包含一组执行某些功能的实用程序。然后可以在需要其实用程序的多个应用程序中使用该库。该库被设计为 Spring Boot 应用程序,以允许将这些实用程序注入到应用程序上下文中。

现在我希望对其中一个实用程序执行 JUnit 测试,以确保它正常工作。但是,由于该应用程序基本上是实用程序的集合,而不是独立的应用程序,因此它没有主类或用 注释的主方法@SpringBootApplication。现在,当我运行 JUnit 测试时,会出现错误。

java.lang.IllegalStateException: Unable to find a @SpringBootConfiguration, you need to use @ContextConfiguration or @SpringBootTest(classes=...)
Run Code Online (Sandbox Code Playgroud)

是否可以测试这个 Java 库,或者我们应该只在将使用这个库的应用程序中编写测试用例?

Mar*_*nik 11

我觉得你说的有些矛盾:

  1. 创建了一个库...被设计为 Spring Boot 应用程序。
  2. 库可以在需要其实用程序的多个应用程序中使用。

如果您实现“1”,则有一个带有 spring boot maven/gradle 插件的模块,配置为创建应用程序的 JAR(该应用程序是一个库)。

但是,如果您有模块 X 希望使用您的库,则不可能在此模块中添加对您的库的依赖项,Spring Boot JAR 工件不是 Java 意义上的 JAR...所以这在以下情况下不起作用IDE 和 maven (我的意思是从技术上讲你会遇到编译错误)。

然后你写一些完全有意义的东西:你说库本身没有主类/@SpringBootApplication带注释的类。由此我得出的结论是,它不是一个 Spring Boot 应用程序,而是一个 Spring Boot 启动模块。

在这种情况下,您不应该使用@SpringBootTest注释,因为它模仿启动 Spring Boot 应用程序的方式(查找主类,根据包结构扫描包,加载配置等)。你不需要这一切。好吧,也许从技术上讲,您仍然可以创建一个带有注释的主类@SpringBootApplication并将其放入src/test/java/.../相关的包中,但这实际上没有意义。

所以基本上你有两个选择:

  1. 您可以在没有 spring 的情况下测试实用程序,就好像该实用程序只是一个 Java 类一样,使用 Mockito 模拟依赖关系,然后就可以开始了。由于这些测试速度很快,因此它是您的最佳选择。

  2. 您可以通过加载带有应用程序创建的所有必需 bean 的 spring 上下文来运行集成测试。


@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = {MyLibraryConfiguration.class})
public class SampleLibraryTest {

    @Autowired 
    private SomeBeanFromTheLibrary theBean;

    @Test
    public void testFoo() {
      ....
    }
}
Run Code Online (Sandbox Code Playgroud)

现在,虽然您可以使用组件扫描(在这种情况下,您需要稍微不同的注释),但在示例中,我假设您正在使用 java 配置,在那里注册库的所有 bean 并创建一个spring.factories使用此 Java 的 bean用于创建自动配置的配置文件(您在模块 X 中添加对库的依赖项,它会自动加载库中定义的 bean)。

@ExtendsWith@RunWith对于 junit 4)与 Spring Boot 无关,它的行为就像一个“普通”spring,您可以自动装配 bean,创建模拟 bean,有配置缓存等。

  • 谢谢您的详细解释。在我的示例中,我实际上使用的是组件扫描。您能否解释一下哪些注释会因此而改变? (2认同)