快捷導(dǎo)航

Spring?Boot中WebMvcConfig配置詳解及示例代碼

更新時(shí)間：2024年03月29日 10:44:36 作者：hoypte

WebMvcConfig是一個(gè)配置類,它繼承了WebMvcConfigurationSupport,允許我們對SpringMVC進(jìn)行更細(xì)粒度的控制,這篇文章主要給大家介紹了關(guān)于Spring?Boot中WebMvcConfig配置詳解及示例的相關(guān)資料,需要的朋友可以參考下

引言：

在Spring Boot項(xiàng)目中，我們經(jīng)常需要對Web MVC進(jìn)行配置，以滿足項(xiàng)目的特定需求。例如，設(shè)置靜態(tài)資源映射、自定義消息轉(zhuǎn)換器或生成Swagger接口文檔等。今天，我們將詳細(xì)探討如何在Spring Boot中通過WebMvcConfig類進(jìn)行這些配置，并附上相應(yīng)的示例代碼。

一、WebMvcConfig類的作用：

WebMvcConfig是一個(gè)配置類，它繼承了WebMvcConfigurationSupport，允許我們對Spring MVC進(jìn)行更細(xì)粒度的控制。通過此類，我們可以重寫父類的方法來自定義我們自己的配置。

二、配置靜態(tài)資源映射：

在Spring Boot中，靜態(tài)資源默認(rèn)放置在src/main/resources/static目錄下。但有時(shí)，我們可能需要自定義靜態(tài)資源的映射路徑。這時(shí)，我們可以通過重寫addResourceHandlers方法來實(shí)現(xiàn)。

示例代碼：

@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    // 將/doc.html映射到classpath:/META-INF/resources/目錄下
    registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
    // 將/webjars/**映射到classpath:/META-INF/resources/webjars/目錄下
    registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    // 將/backend/**映射到classpath:/backend/目錄下
    registry.addResourceHandler("/backend/**").addResourceLocations("classpath:/backend/");
    // 將/front/**映射到classpath:/front/目錄下
    registry.addResourceHandler("/front/**").addResourceLocations("classpath:/front/");
}

通過上述配置，我們可以根據(jù)不同的路徑訪問不同目錄下的靜態(tài)資源。

三、自定義消息轉(zhuǎn)換器：

在Spring MVC中，消息轉(zhuǎn)換器負(fù)責(zé)將HTTP請求和響應(yīng)體中的數(shù)據(jù)轉(zhuǎn)換為Java對象。如果需要自定義轉(zhuǎn)換規(guī)則，我們可以通過重寫extendMessageConverters方法并添加自定義的HttpMessageConverter來實(shí)現(xiàn)。

示例代碼：

@Override
protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
    // 創(chuàng)建消息轉(zhuǎn)換器對象，這里使用了自定義的JacksonObjectMapper
    MappingJackson2HttpMessageConverter messageConverter = new MappingJackson2HttpMessageConverter();
    messageConverter.setObjectMapper(new JacksonObjectMapper()); // 假設(shè)JacksonObjectMapper是自定義的ObjectMapper實(shí)現(xiàn)類
    // 將自定義的消息轉(zhuǎn)換器添加到轉(zhuǎn)換器列表的最前面，這樣它會(huì)優(yōu)先被使用
    converters.add(0, messageConverter);
}

注意：在上述代碼中，我們假設(shè)有一個(gè)名為JacksonObjectMapper的類，它是ObjectMapper的自定義實(shí)現(xiàn)。在實(shí)際項(xiàng)目中，你可能需要根據(jù)你的需求來定制這個(gè)類。

四、生成Swagger接口文檔：

Swagger是一個(gè)強(qiáng)大的API文檔生成工具。在Spring Boot項(xiàng)目中，我們可以通過集成Swagger來自動(dòng)生成接口文檔。這通常涉及到創(chuàng)建一個(gè)Docket Bean，并對其進(jìn)行相應(yīng)的配置。

示例代碼：

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2) // 指定文檔類型為Swagger2
            .apiInfo(apiInfo()) // 設(shè)置API文檔的基本信息
            .select() // 構(gòu)建一個(gè)ApiSelectorBuilder實(shí)例,用來控制哪些接口暴露給Swagger來展現(xiàn)
            .apis(RequestHandlerSelectors.basePackage("com.itheima.reggie.controller")) // 指定掃描的包路徑
            .paths(PathSelectors.any()) // 所有路徑都被掃描
            .build(); // 構(gòu)建Docket實(shí)例
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder() // 創(chuàng)建ApiInfoBuilder實(shí)例,用來構(gòu)建ApiInfo對象(API文檔的基本信息)
            .title("瑞吉外賣") // 設(shè)置標(biāo)題
            .version("1.0") // 設(shè)置版本號(hào)
            .description("瑞吉外賣接口文檔") // 設(shè)置描述信息
            .build(); // 構(gòu)建ApiInfo實(shí)例并返回
}

通過上述配置，Swagger將自動(dòng)掃描指定包下的所有Controller類，并生成相應(yīng)的API文檔。同時(shí)，我們還可以設(shè)置API文檔的基本信息，如標(biāo)題、版本號(hào)和描述等。這樣，前端開發(fā)人員就可以通過Swagger UI界面方便地查看和測試后端提供的API接口了。