如何在测试类外部使用 @LocalServerPort 修复 Spring Boot 中的自动装配问题

解决方案1：使用@DynamicPropertySource解决端口注入

这种方法使用Spring Boot的@DynamicPropertySource在测试期间动态设置本地服务器端口。

@Component
public class BaseControllerWrapper {
    protected int port;
}

@Component
public class SpecificControllerWrapper extends BaseControllerWrapper {
    public void callEndpoint() {
        System.out.println("Calling endpoint on port: " + port);
    }
}

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PermissionsTest {
    @Autowired
    private SpecificControllerWrapper specificControllerWrapper;

    @DynamicPropertySource
    static void dynamicProperties(DynamicPropertyRegistry registry) {
        registry.add("server.port", () -> 8080);
    }

    @Test
    public void testSomething() {
        specificControllerWrapper.port = 8080; // Dynamically set
        specificControllerWrapper.callEndpoint();
    }
}

解决方案 2：使用 ApplicationContextAware 进行端口注入

该解决方案利用 ApplicationContext 动态获取环境属性。

@Component
public class BaseControllerWrapper {
    protected int port;
}

@Component
public class SpecificControllerWrapper extends BaseControllerWrapper {
    public void callEndpoint() {
        System.out.println("Calling endpoint on port: " + port);
    }
}

@Component
public class PortInjector implements ApplicationContextAware {
    @Autowired
    private SpecificControllerWrapper wrapper;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        Environment env = applicationContext.getEnvironment();
        wrapper.port = Integer.parseInt(env.getProperty("local.server.port", "8080"));
    }
}

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PermissionsTest {
    @Autowired
    private SpecificControllerWrapper specificControllerWrapper;

    @Test
    public void testSomething() {
        specificControllerWrapper.callEndpoint();
    }
}

解决方案 3：为端口管理配置自定义 Bean

此方法设置一个自定义 bean 来处理端口注入和解析。

@Configuration
public class PortConfig {
    @Bean
    public BaseControllerWrapper baseControllerWrapper(@Value("${local.server.port}") int port) {
        BaseControllerWrapper wrapper = new BaseControllerWrapper();
        wrapper.port = port;
        return wrapper;
    }
}

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class PermissionsTest {
    @Autowired
    private SpecificControllerWrapper specificControllerWrapper;

    @Test
    public void testSomething() {
        specificControllerWrapper.callEndpoint();
    }
}

Spring Boot 测试中有关 @LocalServerPort 的常见问题

1. 怎么样 @LocalServerPort 工作？
2. 它在 Spring Boot 测试期间注入分配给嵌入式服务器的随机端口。
3. 我可以使用吗 @LocalServerPort 测试课之外？
4. 不直接，但您可以使用类似的解决方案 @DynamicPropertySource 或者 ApplicationContext。
5. 什么是 @DynamicPropertySource？
6. 它是 Spring Boot 的一项功能，允许您在测试期间动态注册属性。
7. 为什么 Spring 会抛出占位符解析错误？
8. 发生这种情况是因为占位符 ${local.server.port} 在测试上下文之外未得到解决。
9. 我可以使用共享包装器测试多个控制器吗？
10. 是的，动态端口解析方法可以让您有效地为多个控制器重用单个包装器。 😊

解决端口注入的挑战

使用 @本地服务器端口 有效地进行 Spring Boot 测试需要对测试上下文行为有深入的了解。动态属性配置或基于环境的注入等解决方案简化了这些问题的处理。这确保您可以重用控制器包装器等组件，而不会影响测试稳定性。

采用动态端口注册等最佳实践，不仅可以解决错误，还可以增强测试模块化。通过这些方法，开发人员可以为复杂的 REST API 测试创建强大且可重用的测试设置。干净、无错误的设置为可靠、高效的测试执行铺平了道路。 😊