Spring Boot 2.X(四):Spring Boot 自定義 Web MVC 配置
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 配置
原文地址: https://www.zwqh.t