Spring Boot中WebMvcConfig配置详解及示例代码_Java

引言：

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

一、webmvcconfig类的作用：

webmvcconfig是一个配置类，它继承了webmvcconfigurationsupport，允许我们对spring mvc进行更细粒度的控制。通过此类，我们可以重写父类的方法来自定义我们自己的配置。

二、配置静态资源映射：

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

示例代码：

@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来实现。

示例代码：

@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，并对其进行相应的配置。

示例代码：

@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接口了。