知識庫 / Spring RSS 訂閱

4. Spring Framework 7

Spring Framework 7 帶來了大量長期期待的功能以及在測試、API 設計和核心基礎設施方面的周密改進。 這些變更使框架現代化，同時減少了日常開發中的冗餘代碼。

4.1 測試改進

Spring 在測試過程中使用上下文緩存，以在測試性能和隔離性之間取得平衡。您可以在本文中找到有關此以及由此產生的陷阱以及可能的解決方案的詳細信息。

Spring Framework 7 引入了測試上下文暫停功能。此前，長時間運行的集成測試即使在空閒時也會消耗資源。現在，Spring 可以暫停並恢復存儲在上下文緩存中的上下文，從而節省內存並加快大型測試套件的執行速度。這對於 JMS 監聽器容器或計劃任務尤其有用。

此外，一個新的 RestTestClient 使測試 REST 端點變得更容易，類似於 WebTestClient，但無需引入反應式基礎設施：

這使 REST 測試更接近 WebTestClient 的簡潔性，而無需要求依賴反應式依賴項。

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class HelloWorldApiIntegrationTest {

    RestTestClient client;

    @BeforeEach
    void setUp(WebApplicationContext context) {
        client = RestTestClient.bindToApplicationContext(context)
            .build();
    }

    @Test
    void shouldFetchHelloV1() {
        client.get()
            .uri("/api/v1/hello")
            .exchange()
            .expectStatus()
            .isOk()
            .expectHeader()
            .contentTypeCompatibleWith(MediaType.TEXT_PLAIN)
            .expectBody(String.class)
            .consumeWith(message -> assertThat(message.getResponseBody()).containsIgnoringCase("hello"));
    }

}

4.2 API 版本控制

最受請求的新功能之一是首選的 API 版本控制。

傳統上，我們不得不自己構建解決方案——通過 URL 路徑約定（/v1/），自定義標頭或媒體類型。現在，框架提供了原生支持。 我們可以指定 版本屬性，如示例所示：

@RestController
@RequestMapping("/hello")
public class HelloWorldController {

    @GetMapping(version = "1", produces = MediaType.TEXT_PLAIN_VALUE)
    public String sayHelloV1() {
        return "Hello World";
    }

    @GetMapping(version = "2", produces = MediaType.TEXT_PLAIN_VALUE)
    public String sayHelloV2() {
        return "Hi World";
    }
 
}

我們也可以在控制器級別指定版本：

@RestController
@RequestMapping(path = "/hello", version = "3")
public class HelloWorldV3Controller {

    @GetMapping(produces = MediaType.TEXT_PLAIN_VALUE)
    public String sayHello() {
        return "Hey World";
    }

}

然後，我們需要配置映射策略，它可以是以下之一：

• 路徑映射（例如：/api/v1/hello 與 /api/v2/hello）
• 基於查詢參數（例如：/hello?version=1 與 /hello?version=2）
• 基於請求頭（例如：X-API-Version: 1 與 X-API-Version: 2）
• 基於媒體類型頭（例如：Accept: application/json; version=1 與 Accept: application/json; version=2）

以下配置使用了路徑映射：

@Configuration
public class ApiConfig implements WebMvcConfigurer {

    @Override
    public void configureApiVersioning(ApiVersionConfigurer configurer) {
        configurer.usePathSegment(1);
    }

    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix("/api/v{version}", HandlerTypePredicate.forAnnotation(RestController.class));
    }

}

Spring 將自動解析版本號。這使得在不破壞現有客户端的情況下，更容易演化 API 變得更加簡單。

4.3. 使用 @HttpServiceClient 的更智能的 HTTP 客户端

另一個顯著的功能是聲明式的 HTTP 客户端支持。受到 Feign 的啓發，但更輕量級且完全集成。

在較舊的 Spring 版本中，我們需要為 HttpInterface 創建代理。雖然存在更智能的解決方案，但它們都是單獨構建的。例如，在 這個倉庫中，我們可以找到一個使用自定義 @HttpClient 註解和自定義 Bean Registrar 的示例（正如你在這篇文章中看到的，該 Bean Registrar 也在 Spring Framework 7 中得到了改進）。

現在，我們有了內置的解決方案，即使用 @HttpServiceClient 註解。 讓我們來看一個例子：

@HttpServiceClient("christmasJoy")
public interface ChristmasJoyClient {

    @GetExchange("/greetings?random")
    String getRandomGreeting();

}

然後，我們需要激活類路徑掃描並配置客户端分配的服務組：

@Configuration
@Import(HttpClientConfig.HelloWorldClientHttpServiceRegistrar.class)
public class HttpClientConfig {

    static class HelloWorldClientHttpServiceRegistrar extends AbstractClientHttpServiceRegistrar {

        @Override
        protected void registerHttpServices(GroupRegistry registry, AnnotationMetadata metadata) {
            findAndRegisterHttpServiceClients(registry, List.of("com.baeldung.spring.mvc"));
        }
    }

    @Bean
    RestClientHttpServiceGroupConfigurer christmasJoyServiceGroupConfigurer() String baseUrl) {
        return groups -> {
            groups.filterByName("christmasJoy")
                .forEachClient((group, clientBuilder) -> {
                    clientBuilder.baseUrl("https://christmasjoy.dev/api");
                });
        };
    }

}

<em>ChristmasJoyClient</em> 隨後可以像往常一樣注入到其他 Spring 組件中：

@RestController
@RequestMapping(path = "/hello", version = "4")
@RequiredArgsConstructor
public class HelloWorldV4Controller {

    private final ChristmasJoyClient christmasJoy;

    @GetMapping(produces = MediaType.TEXT_PLAIN_VALUE)
    public String sayHello() {
        return this.christmasJoy.getRandomGreeting();
    }

}

4.4. 彈性回退註解

Spring Retry 長期以來一直是生態系統的一部分，但一直感覺像是一個“附加組件”。在 Spring Framework 7 中，彈性回退已內置於框架中。我們可以使用 Spring 註解 對 Spring 組件的方法進行註解，從而直接添加回退邏輯或併發限制：

@HttpServiceClient("christmasJoy")
public interface ChristmasJoyClient {

    @GetExchange("/greetings?random")
    @Retryable(maxAttempts = 3, delay = 100, multiplier = 2, maxDelay = 1000)
    @ConcurrencyLimit(3)
    String getRandomGreeting();

}

這些註釋默認情況下會被忽略，除非我們在其中之一添加了 @EnableResilientMethods。

這極大地簡化了在不借助如 Resilience4j 等額外庫的情況下添加彈性模式，儘管它們仍然可以很好地集成。

這使得在運行時驗證彈性策略變得更加容易，從而確保我們的註釋實際上正在被應用。

4.5. 多個 TaskDecorator Bean

@Component
@Slf4j
public class HelloWorldEventLogger {

    @Async
    @EventListener
    void logHelloWorldEvent(HelloWorldEvent event) {
        log.info("Hello World Event: {}", event.message());
    }

}

@Configuration
@Slf4j
public class TaskDecoratorConfiguration {

    @Bean
    @Order(2)
    TaskDecorator loggingTaskConfigurator() {
        return runnable -> () -> {
            log.info("Running Task: {}", runnable);
            try {
                runnable.run();
            } finally {
                log.info("Finished Task: {}", runnable);
            }
        };
    }

    @Bean
    @Order(1)
    TaskDecorator measuringTaskConfigurator() {
        return runnable -> () -> {
            final var ts1 = System.currentTimeMillis();
            try {
                runnable.run();
            } finally {
                final var ts2 = System.currentTimeMillis();
                log.info("Finished within {}ms (Task: {})", ts2 - ts1, runnable);
            }
        };
    }

}

Running Task: com.baeldung.spring.mvc.TaskDecoratorConfiguration$$Lambda/0x00000ff0014325f8@57e8609
Hello World Event: "Happy Christmas"
Finished within 0ms (Task: java.util.concurrent.FutureTask@bb978d6[Completed normally])
Finished Task: com.baeldung.spring.mvc.TaskDecoratorConfiguration$$Lambda/0x00000ff0014325f8@57e8609

@Configuration
public class ApiConfig implements WebMvcConfigurer {

    @Override
    public void configureApiVersioning(@NonNull ApiVersionConfigurer configurer) {
        configurer.usePathSegment(1);
    }

}