0 联系我
1.Java 开发技术交流 Q 群 https://jq.qq.com/?_wv=1027&k=5UB4P1T
2. 完整博客链接 http://www.shishusheng.com/
3. 个人知乎 http://www.zhihu.com/people/shi-shu-sheng-
4.gayhub https://github.com/Wasabi1234
1 简介
webMvcConfigurer 配置类其实是 Spring 内部的一种配置方式, 采用 JavaBean 的形式来代替传统的 xml 配置文件形式进行针对框架个性化定制
基于 java-based 方式的 spring mvc 配置, 需要创建一个配置类并实现 WebMvcConfigurer 接口
WebMvcConfigurerAdapter 抽象类是对 WebMvcConfigurer 接口的简单抽象(增加了一些默认实现), 但在在 SpringBoot2.0 及 Spring5.0 中 WebMvcConfigurerAdapter 已被废弃 .
官方推荐直接实现 WebMvcConfigurer 或者直接继承 WebMvcConfigurationSupport
方式一实现 WebMvcConfigurer 接口(推荐)
方式二继承 WebMvcConfigurationSupport 类
2 重点方法讲解
- /* 拦截器配置 */
- void addInterceptors(InterceptorRegistry var1);
- /* 视图跳转控制器 */
- void addViewControllers(ViewControllerRegistry registry);
- /**
- * 静态资源处理
- */
- void addResourceHandlers(ResourceHandlerRegistry registry);
- /* 默认静态资源处理器 */
- void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer);
- /**
- * 这里配置视图解析器
- */
- void configureViewResolvers(ViewResolverRegistry registry);
- /* 配置内容裁决的一些选项 */
- void configureContentNegotiation(ContentNegotiationConfigurer configurer);
- 2.1 addInterceptors(InterceptorRegistry registry)
专门注册一个 Interceptor, 如 HandlerInterceptorAdapter
addPathPatterns("/**")
对所有请求都拦截, 但是排除了 / toLogin 和 / login 请求的拦截
当 Spring Boot 版本升级为 2.x 时, 访问静态资源就会被 HandlerInterceptor 拦截, 网上有很多处理办法都是如下写法
.excludePathPatterns("/index.html","/","/user/login","/static/**");
可有人说在使用时一直不起作用, 查看请求的路径里并没有 / static / 如图:
于是改成
"/js/**","/CSS/**","/images/**"
这样页面内容就可以正常访问了, 他的项目结构如下:
2.2 页面跳转 - addViewControllers
以前写 SpringMVC 的时候, 如果需要访问一个页面, 必须要写 Controller 类, 然后再写一个方法跳转到页面, 感觉麻烦
其实重写 WebMvcConfigurer 中的 addViewControllers 方法即可同效
在这里重写 addViewControllers, 并不会覆盖
WebMvcAutoConfiguration
中的 addViewControllers(在此方法中, Spring Boot 将 "/" 映射至 index.HTML)
这也就意味着我们自己的配置和 Spring Boot 的自动配置同时有效, 这也是我们推荐添加自己的 MVC 配置的方式.
2.3 自定义资源映射 - addResourceHandlers
欲自定义静态资源映射目录时, 只需重写 addResourceHandlers.
注: 如果继承 WebMvcConfigurationSupport 类实现配置时必须要重写该方法
通过 addResourceHandler 添加映射路径
然后通过 addResourceLocations 来指定路径
我们访问自定义 my 文件夹中的 elephant.jpg 图片的地址为
http://localhost:8080/my/elephant.jpg
指定外部的目录也很简单, 直接
addResourceLocations
addResourceLocations 指的是文件放置的目录
addResoureHandler 指的是对外暴露的访问路径
2.4 configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)
会注册一个默认的 Handler
DefaultServletHttpRequestHandler, 这个 Handler 也是用来处理静态文件的, 它会尝试映射 /. 当 DispatcherServelt 映射 / 时(/ 和 / 是有区别的), 并且没有找到合适的 Handler 来处理请求时, 就会交给 DefaultServletHttpRequestHandler 来处理. 注意: 这里的静态资源是放置在 Web 根目录下, 而非 Web-INF 下.
可能这里的描述有点不好懂 (我自己也这么觉得), 所以简单举个例子, 例如: 在 webroot 目录下有一个图片: 1.PNG 我们知道 Servelt 规范中 Web 根目录(webroot) 下的文件可以直接访问的, 但是由于 DispatcherServlet 配置了映射路径是:/ , 它几乎把所有的请求都拦截了, 从而导致 1.PNG 访问不到, 这时注册一个 DefaultServletHttpRequestHandler 就可以解决这个问题. 其实可以理解为 DispatcherServlet 破坏了 Servlet 的一个特性(根目录下的文件可以直接访问),DefaultServletHttpRequestHandler 是帮助回归这个特性的.
5,configureViewResolvers(ViewResolverRegistry registry)
从方法名称我们就能看出这个方法是用来配置视图解析器的, 该方法的参数 ViewResolverRegistry 是一个注册器, 用来注册你想自定义的视图解析器等. ViewResolverRegistry 常用的几个方法:
1).enableContentNegotiation()
- /** 启用内容裁决视图解析器 */
- public void enableContentNegotiation(View... defaultViews) {
- initContentNegotiatingViewResolver(defaultViews);
- }
该方法会创建一个内容裁决解析器 ContentNegotiatingViewResolver , 该解析器不进行具体视图的解析, 而是管理你注册的所有视图解析器, 所有的视图会先经过它进行解析, 然后由它来决定具体使用哪个解析器进行解析. 具体的映射规则是根据请求的 media types 来决定的.
- 2). UrlBasedViewResolverRegistration()
- public UrlBasedViewResolverRegistration jsp(String prefix, String suffix) {
- InternalResourceViewResolver resolver = new InternalResourceViewResolver();
- resolver.setPrefix(prefix);
- resolver.setSuffix(suffix);
- this.viewResolvers.add(resolver);
- return new UrlBasedViewResolverRegistration(resolver);
- }
该方法会注册一个内部资源视图解析器 InternalResourceViewResolver 显然访问的所有 jsp 都是它进行解析的. 该方法参数用来指定路径的前缀和文件后缀, 如:
registry.jsp("/WEB-INF/jsp/", ".jsp");
对于以上配置, 假如返回的视图名称是 example, 它会返回 / Web-INF/jsp/example.jsp 给前端, 找不到则报 404.
- 3). beanName()
- public void beanName() {
- BeanNameViewResolver resolver = new BeanNameViewResolver();
- this.viewResolvers.add(resolver);
- }
该方法会注册一个 BeanNameViewResolver 视图解析器, 这个解析器是干嘛的呢? 它主要是将视图名称解析成对应的 bean. 什么意思呢? 假如返回的视图名称是 example, 它会到 spring 容器中找有没有一个叫 example 的 bean, 并且这个 bean 是 View.class 类型的? 如果有, 返回这个 bean.
- 4). viewResolver()
- public void viewResolver(ViewResolver viewResolver) {
- if (viewResolver instanceof ContentNegotiatingViewResolver) {
- throw new BeanInitializationException(
- "addViewResolver cannot be used to configure a ContentNegotiatingViewResolver. Please use the method enableContentNegotiation instead.");
- }
- this.viewResolvers.add(viewResolver);
- }
这个方法想必看名字就知道了, 它就是用来注册各种各样的视图解析器的, 包括自己定义的.
configureContentNegotiation(ContentNegotiationConfigurer configurer)
上面我们讲了 configureViewResolvers 方法, 假如在该方法中我们启用了内容裁决解析器, 那么 configureContentNegotiation(ContentNegotiationConfigurer configurer) 这个方法是专门用来配置内容裁决的一些参数的. 这个比较简单, 我们直接通过一个例子看:
- public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
- /* 是否通过请求 Url 的扩展名来决定 media type /
- configurer.favorPathExtension(true)
- / 不检查 Accept 请求头 /
- .ignoreAcceptHeader(true)
- .parameterName("mediaType")
- / 设置默认的 media yype /
- .defaultContentType(MediaType.TEXT_HTML)
- / 请求以. HTML 结尾的会被当成 MediaType.TEXT_HTML/
- .mediaType("html", MediaType.TEXT_HTML)
- / 请求以. JSON 结尾的会被当成 MediaType.APPLICATION_JSON*/
- .mediaType("json", MediaType.APPLICATION_JSON);
- }
到这里我们就可以举个例子来进一步熟悉下我们上面讲的知识了, 假如我们 MVC 的配置如下:
- @EnableWebMvc
- @Configuration
- public class MyWebMvcConfigurerAdapte extends WebMvcConfigurerAdapter {
- @Override
- public void configureViewResolvers(ViewResolverRegistry registry) {
- registry.jsp("/WEB-INF/jsp/", ".jsp");
- registry.enableContentNegotiation(new MappingJackson2JsonView());
- }
- @Override
- public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
- configurer.favorPathExtension(true)
- .ignoreAcceptHeader(true)
- .parameterName("mediaType")
- .defaultContentType(MediaType.TEXT_HTML)
- .mediaType("html", MediaType.TEXT_HTML)
- .mediaType("json", MediaType.APPLICATION_JSON);
- }
- }
controller 的代码如下:
- @Controller
- public class ExampleController {
- @RequestMapping("/test")
- public ModelAndView test() {
- Map<String, String> map = new HashMap();
- map.put("哈哈", "哈哈哈哈");
- map.put("呵呵", "呵呵呵呵");
- return new ModelAndView("test", map);
- }
- }
在 Web-INF/jsp 目录下创建一个 test.jsp 文件, 内容随意. 现在启动 tomcat, 在浏览器输入以下链接: http://localhost:8080/test.JSON , 浏览器内容返回如下:
- {
- "哈哈":"哈哈哈哈",
- "呵呵":"呵呵呵呵"
- }
在浏览器输入 http://localhost:8080/test 或者 http://localhost:8080/test.HTML , 内容返回如下:
this is test.jsp
显然, 两次使用了不同的视图解析器, 那么底层到底发生了什么? 在配置里我们注册了两个视图解析器: ContentNegotiatingViewResolver 和 InternalResourceViewResolver, 还有一个默认视图: MappingJackson2JsonView.controller 执行完毕之后返回一个 ModelAndView, 其中视图的名称为 example1.
1. 返回首先会交给 ContentNegotiatingViewResolver 进行视图解析处理, 而 ContentNegotiatingViewResolver 会先把视图名 example1 交给它持有的所有 ViewResolver 尝试进行解析(本实例中只有 InternalResourceViewResolver),
2. 根据请求的 mediaType, 再将 example1.mediaType(这里是 example1.JSON 和 example1.HTML)作为视图名让所有视图解析器解析一遍, 两步解析完毕之后会获得一堆候选的 List<View> 再加上默认的 MappingJackson2JsonView ,
3. 根据请求的 media type 从候选的 List<View> 中选择一个最佳的返回, 至此视图解析完毕.
现在就可以理解上例中为何请求链接加上. JSON 和不. JSON 结果会不一样. 当加上. JSON 时, 表示请求的 media type 为 MediaType.APPLICATION_JSON, 而 InternalResourceViewResolver 解析出来的视图的 ContentType 与其不符, 而与 MappingJackson2JsonView 的 ContentType 相符, 所以选择了 MappingJackson2JsonView 作为视图返回. 当不加. JSON 请求时, 默认的 media type 为 MediaType.TEXT_HTML, 所以就使用了 InternalResourceViewResolver 解析出来的视图作为返回值了. 我想看到这里你已经大致可以自定义视图了.
来源: http://www.jianshu.com/p/c5117d1cf366