0.准备
Spring Boot 不仅提供了相当简单使用的自动配置功能，而且开放了非常自由灵活的配置类。Spring MVC 为我们提供了 WebMvcConfigurationSupport 类和一个注解 @EnableWebMvc 以帮助我们减少配置 Bean 的声明。本文简单说明如何自定义 Web MVC 配置。
首先需要使用 @Configuration 将 WebMvcConfig 类标注为 Spring 配置类，示例代码如下:
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
//通过重写配置方法覆盖
}
并在启动类上添加 @EnableWebMvc，代码如下：
@SpringBootApplication
@MapperScan("cn.zwqh.springboot.dao")
@EnableWebMvc //启用 Spring MVC 配置
public class SpringBootSsmThymeleafApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootSsmThymeleafApplication.class, args);
}
}
1.静态资源配置
Spring Boot 中默认的静态资源配置，是把类路径下的/static、/public、/resources 和 /METAINF/resources 目录或者 ServletContext 的根目录中的静态文件直接映射为 /****。它使用来自 Spring MVC 的ResourceHttpRequestHandler，以便您可以通过添加自己的WebMvcConfigurer并覆盖addResourceHandlers方法来修改该行为。示例代码如下：
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/statics/**").addResourceLocations("classpath:/statics/");//静态资源路径 css,js,img等
registry.addResourceHandler("/templates/**").addResourceLocations("classpath:/templates/");//视图
registry.addResourceHandler("/mapper/**").addResourceLocations("classpath:/mapper/");//mapper.xml
super.addResourceHandlers(registry);
}
2.拦截器配置
通过重写 addInterceptors() 方法，使用 InterceptorRegistry 注册类来添加拦截器 HandlerInterceptor。示例代码如下：
@Autowired
private BeforMethodInteceptor beforMethodInteceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
//注册自定义拦截器，添加拦截路径和排除拦截路径
registry.addInterceptor(beforMethodInteceptor) //添加拦截器
.addPathPatterns("/**") //添加拦截路径
.excludePathPatterns(//添加排除拦截路径
"/index",
"/login",
"/doLogin",
"/logout",
"/register",
"/doRegister",
"/**/*.css",
"/**/*.png",
"/**/*.jpeg",
"/**/*.jpg",
"/**/*.ico",
"/**/*.js",
"/swagger-resources/**"
);
super.addInterceptors(registry);
}
3.跨域配置
通过重写 addCorsMappings 方法实现跨域配置的支持，使用 CorsRegistry 注册类添加路径映射。示例代码如下：
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")//配置允许跨域的路径
.allowedOrigins("*")//配置允许访问的跨域资源的请求域名
.allowedMethods("PUT,POST,GET,DELETE,OPTIONS")//配置允许访问该跨域资源服务器的请求方法，如：POST、GET、PUT、DELETE等
.allowedHeaders("*"); //配置允许请求header的访问，如 ：X-TOKEN
super.addCorsMappings(registry);
}
4.视图控制器配置
通过重写 addViewControllers 方法，使用 ViewControllerRegistry 注册类来实现视图控制器配置。示例代码如下：
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/").setViewName("/index");//默认视图跳转
registry.addViewController("/index").setViewName("/index");
registry.addViewController("/article").setViewName("/article");
registry.addViewController("/error/404").setViewName("/error/404");
registry.addViewController("/error/500").setViewName("/error/500");
registry.setOrder(Ordered.HIGHEST_PRECEDENCE);
super.addViewControllers(registry);
}
上面的代码等同于如下代码：
@RequestMapping(value = { "/", "/index" })
public String index() {
return "index";
}
@RequestMapping(value = "article")
public String article() {
return "article";
}
@RequestMapping(value = "/error/404")
public String error_404() {
return "/error/404";
}
@RequestMapping(value = "/error/500")
public String error_500() {
return "/error/500";
}
5.消息转换器配置
通过覆盖重写 configureMessageConverters 方法来配置消息转换器。示例代码如下：
自定义字符串转换器：
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
StringHttpMessageConverter converter = new StringHttpMessageConverter(Charset.forName("UTF-8"));
converters.add(converter);
}
自定义fastjson转换器：
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
super.configureMessageConverters(converters);
//1.需要定义一个convert转换消息的对象;
FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();
//2.添加fastJson的配置信息，比如：是否要格式化返回的json数据;
FastJsonConfig fastJsonConfig = new FastJsonConfig();
fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat);
//3处理中文乱码问题
List<MediaType> fastMediaTypes = new ArrayList<>();
fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
//4.在convert中添加配置信息.
fastJsonHttpMessageConverter.setSupportedMediaTypes(fastMediaTypes);
fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);
//5.将convert添加到converters当中.
converters.add(fastJsonHttpMessageConverter);
}
6.数据格式化器配置
通过重写 addFormatters 方法来添加数据格式化器。Spring MVC 接受 HTTP 请求会把参数自动绑定映射到 Controller 请求参数上。Spring 中没有默认配置将字符串转换为日期类型。这时可以通过添加一个 DateFormatter 类来实现自动转换。示例代码如下：
@Override
public void addFormatters(FormatterRegistry registry) {
super.addFormatters(registry);
registry.addFormatter(new DateFormatter("yyyy-MM-dd"));
}
7.视图解析器配置
通过覆盖重写 configureViewResolvers() 方法来配置视图解析器。代码示例如下：
@Override
public void configureViewResolvers(ViewResolverRegistry registry) {
InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
viewResolver.setPrefix("");
viewResolver.setSuffix(".html");
viewResolver.setCache(false);
viewResolver.setContentType("text/html;charset=UTF-8");
viewResolver.setOrder(0);
registry.viewResolver(viewResolver);
super.configureViewResolvers(registry);
}
示例代码
非特殊说明，本文版权归 朝雾轻寒 所有，转载请注明出处.
原文标题：Spring Boot 2.X(四)：Spring Boot 自定义 Web MVC 配置
网友评论