深入理解WebMvcConfigurer

小蓝 • 2024-12-09 10:59 • 编程

一、什么是WebMvcConfigurer？

WebMvcConfigurer是Spring Boot提供的一个配置接口，用于配置Spring MVC的相关配置。它可以让开发者通过实现接口的方式来扩展Spring MVC的功能，包括添加拦截器、视图解析器、消息转换器等等。WebMvcConfigurer是Spring MVC配置的核心接口之一，十分重要。

二、如何实现WebMvcConfigurer？

为了实现WebMvcConfigurer接口，我们需要编写一个Java类，让其同时实现该接口。WebMvcConfigurer提供了一些默认的实现方法，我们只需要实现我们需要的方法即可，例如：

@Configuration
public class MvcConfigurer implements WebMvcConfigurer {
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AuthenticationInterceptor());
    }
    
    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        registry.jsp("/WEB-INF/views/", ".jsp");
    }
    
    // 还可以实现其他方法...
}

上述代码实现了addInterceptors()和configureViewResolvers()两个方法，分别用于添加自定义拦截器和配置视图解析器。当Spring Boot应用启动时，该类将被Spring自动识别并加载。

三、常用的WebMvcConfigurer方法

除了上述两种方法，WebMvcConfigurer还提供了许多其他方法，下面我们来逐一介绍。

1. 配置拦截器（addInterceptors()）

addInterceptors()方法用于添加自定义拦截器，需要传入InterceptorRegistry对象，示例如下：

@Configuration
public class MvcConfigurer implements WebMvcConfigurer {
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AuthenticationInterceptor())
            .addPathPatterns("/**")
            .excludePathPatterns("/login");
    }
}

上述代码添加了一个名为AuthenticationInterceptor的拦截器，并指定其拦截所有请求，除了/login请求。

2. 配置视图解析器（configureViewResolvers()）

configureViewResolvers()方法用于配置视图解析器，需要传入ViewResolverRegistry对象，示例如下：

@Configuration
public class MvcConfigurer implements WebMvcConfigurer {
    
    @Override
    public void configureViewResolvers(ViewResolverRegistry registry) {
        registry.jsp("/WEB-INF/views/", ".jsp")
            .viewNames("myView")
            .defaultViewName("index");
    }
}

上述代码配置了一个JSP视图解析器，将视图文件放置于/WEB-INF/views/目录下，使用.jsp作为后缀名。同时指定了自定义视图名称myView和默认视图名称index。

3. 配置静态资源（addResourceHandlers()）

addResourceHandlers()方法用于配置静态资源路径，通常用于展示图片、样式表、JavaScript等文件。示例如下：

@Configuration
public class MvcConfigurer implements WebMvcConfigurer {
    
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**")
            .addResourceLocations("classpath:/static/");
    }
}

上述代码配置了静态资源目录/static/，并将其映射到classpath:/static/路径下。我们可以在HTML代码中使用/static/路径来访问该目录下的资源。

4. 配置消息转换器（extendMessageConverters()）

extendMessageConverters()方法用于扩展Spring MVC的消息转换器，可以添加自定义的消息转换器，支持JSON、XML等格式。示例如下：

@Configuration
public class MvcConfigurer implements WebMvcConfigurer {
    
    @Override
    public void extendMessageConverters(List<HttpMessageConverter> converters) {
        converters.add(new FastJsonHttpMessageConverter());
    }
}

上述代码添加了一个FastJsonHttpMessageConverter消息转换器，用于将Java对象转换为JSON格式。

四、总结

WebMvcConfigurer是Spring Boot中用于配置Spring MVC的核心接口之一，它允许开发者通过实现接口的方式来扩展Spring MVC的功能。WebMvcConfigurer提供了许多常用的配置方法，包括添加拦截器、配置视图解析器、配置静态资源、添加消息转换器等等。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/219505.html