Spring Boot中WebMvcConfig配置详解及示例

引言：

在Spring Boot项目中，我们经常需要对Web MVC进行配置，以满足项目的特定需求。例如，设置静态资源映射、自定义消息转换器或生成Swagger接口文档等。今天，我们将详细探讨如何在Spring Boot中通过WebMvcConfig类进行这些配置，并附上相应的示例代码。

一、WebMvcConfig类的作用 ：
WebMvcConfig是一个配置类，它继承了WebMvcConfigurationSupport，允许我们对Spring MVC进行更细粒度的控制。通过此类，我们可以重写父类的方法来自定义我们自己的配置。

二、配置静态资源映射 ：

在Spring Boot中，静态资源默认放置在src/main/resources/static目录下。但有时，我们可能需要自定义静态资源的映射路径。这时，我们可以通过重写addResourceHandlers方法来实现。

示例代码：

java 复制代码

@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/");
}

通过上述配置，我们可以根据不同的路径访问不同目录下的静态资源。

三、自定义消息转换器 ：

在Spring MVC中，消息转换器负责将HTTP请求和响应体中的数据转换为Java对象。如果需要自定义转换规则，我们可以通过重写extendMessageConverters方法并添加自定义的HttpMessageConverter来实现。

示例代码：

java 复制代码

@Override
protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
    // 创建消息转换器对象，这里使用了自定义的JacksonObjectMapper
    MappingJackson2HttpMessageConverter messageConverter = new MappingJackson2HttpMessageConverter();
    messageConverter.setObjectMapper(new JacksonObjectMapper()); // 假设JacksonObjectMapper是自定义的ObjectMapper实现类
    // 将自定义的消息转换器添加到转换器列表的最前面，这样它会优先被使用
    converters.add(0, messageConverter);
}

注意：在上述代码中，我们假设有一个名为JacksonObjectMapper的类，它是ObjectMapper的自定义实现。在实际项目中，你可能需要根据你的需求来定制这个类。

四、生成Swagger接口文档 ：

Swagger是一个强大的API文档生成工具。在Spring Boot项目中，我们可以通过集成Swagger来自动生成接口文档。这通常涉及到创建一个Docket Bean，并对其进行相应的配置。

示例代码：

java 复制代码

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2) // 指定文档类型为Swagger2
            .apiInfo(apiInfo()) // 设置API文档的基本信息
            .select() // 构建一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现
            .apis(RequestHandlerSelectors.basePackage("com.itheima.reggie.controller")) // 指定扫描的包路径
            .paths(PathSelectors.any()) // 所有路径都被扫描
            .build(); // 构建Docket实例
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder() // 创建ApiInfoBuilder实例,用来构建ApiInfo对象(API文档的基本信息)
            .title("瑞吉外卖") // 设置标题
            .version("1.0") // 设置版本号
            .description("瑞吉外卖接口文档") // 设置描述信息
            .build(); // 构建ApiInfo实例并返回
}

通过上述配置，Swagger将自动扫描指定包下的所有Controller类，并生成相应的API文档。同时，我们还可以设置API文档的基本信息，如标题、版本号和描述等。这样，前端开发人员就可以通过Swagger UI界面方便地查看和测试后端提供的API接口了。