Microsoft Word - 朱晔和你聊Spring系列S1E4：灵活但不算好用的SpringMVC.docx

Size: px

Start display at page:

Download "Microsoft Word - 朱晔和你聊Spring系列S1E4：灵活但不算好用的SpringMVC.docx"

苗楼谈
5 years ago
Views:

1 朱晔和你聊 Spring 系列 S1E3: 灵活但不算好用的 Spring MVC 本文会以一些例子来展现 Spring MVC 的常见功能和一些扩展点, 然后我们来讨论一下 Spring MVC 好用不好用使用 SpringBoot 快速开始基于之前的 parent 模块, 我们来创建一个新的模块 : <?xml version="1.0" encoding="utf-8"?> <project xmlns:xsi=" xmlns=" xsi:schemalocation=" <modelversion>4.0.0</modelversion> <groupid>me.josephzhu</groupid> <artifactid>spring101-webmvc</artifactid> <version>0.0.1-snapshot</version> <packaging>jar</packaging> <name>spring101-webmvc</name> <description></description> <parent> <groupid>me.josephzhu</groupid> <artifactid>spring101</artifactid> <version>0.0.1-snapshot</version> </parent> <dependencies> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-web</artifactid> </dependency> <dependency> <groupid>org.springframework.boot</groupid>

2 <artifactid>spring-boot-starter-thymeleaf</artifactid> </dependency> </dependencies> <build> <plugins> <plugin> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-maven-plugin</artifactid> </plugin> </plugins> </build> </project> 使用 web 来启用 Spring MVC, 使用 thymeleaf 来启用 thymeleaf 模板引擎 Thymeleaf 是一个强大的 Java 模板引擎, 可以脱离于 Web 单独使用, 本身就有非常多的可配置可扩展的点, 这里不展开讨论, 详见官网接下去我们创建主程序 : import org.springframework.boot.springapplication; import public class Spring101WebmvcApplication { public static void main(string[] args) { SpringApplication.run(Spring101WebmvcApplication.class, args); 以及一个测试 Controller: import org.springframework.stereotype.controller; import org.springframework.web.bind.annotation.getmapping; import org.springframework.web.servlet.modelandview; import java.util.stream.collectors; import public class MyController {

3 @GetMapping("shop") public ModelAndView shop() { ModelAndView modelandview = new ModelAndView(); modelandview.setviewname("shop"); modelandview.addobject("items", IntStream.range(1, 5).mapToObj(i -> new MyItem("item" + i, i * 100)).collect(Collectors.toList())); return modelandview; 这里使用到了一个自定义的类 : import lombok.allargsconstructor; public class MyItem { private String name; private Integer price; 最后我们需要在 resources 目录下创建一个 templates 目录, 在目录下再创建一个 shop.html 模板文件 : <!DOCTYPE html SYSTEM " <html lang="en"> <head> <meta charset="utf-8"> <title>hello Shop</title> </head> <body> Hello Shop <table> <tr th:each="item : ${items"> <td th:text="${item.name">...</td> <td th:text="${item.price">...</td> </tr> </table> </body> </html> 我们看到有了 SpringBoot, 创建一个 Spring MVC 程序整个过程非常简单 :

4 1 引入 starter 2 3 创建模板文件没有任何配置工作, 一切都是 starter 自动配置快速配置 ViewController 几乎所有 Spring MVC 的扩展点都集成在了接口中, 要进行扩展很简单, 实现这个接口, 注解, 实现需要的方法即可我们先用它来快速配置一些 ViewController: import org.springframework.context.annotation.configuration; import org.springframework.format.formatterregistry; import org.springframework.http.httpstatus; import org.springframework.web.method.support.handlermethodargumentresolver; import org.springframework.web.servlet.config.annotation.*; import org.springframework.web.servlet.resource.gzipresourceresolver; import org.springframework.web.servlet.resource.versionresourceresolver; public class WebConfig implements WebMvcConfigurer { public void addviewcontrollers(viewcontrollerregistry registry) { registry.addviewcontroller("/hello").setviewname("helloworld"); registry.addredirectviewcontroller("/", "/hello"); registry.addstatuscontroller("/user", HttpStatus.BAD_REQUEST); 代码中多贴了一些后面会用到的 import 在这里可以忽略这里我们配置了三套策略 : 1 访问 / 会跳转到 /hello 2 访问 /hello 会访问 helloworld 这个 view 3 访问 /user 会给出 400 的错误代码这里我们在 templats 目录再添加一个空白的 helloworld.html:

5 <!DOCTYPE html SYSTEM " <html lang="en"> <head> <meta charset="utf-8"> <title>hello World</title> </head> <body> Hello World </body> </html> 这种配置方式可以省一些代码量, 但是我个人认为在这里做配置可读性一般定制路径匹配我们还可以实现路径匹配策略的定制 : public void configurepathmatch(pathmatchconfigurer configurer) { configurer.setusetrailingslashmatch(false); 比如这样就关闭了结尾为 / 的匹配 ( 默认开启 ) 试着访问得到如下错误 : :58: WARN [nio-8080-exec-1] o.s.web.servlet.pagenotfound : No mapping found for HTTP request with URI [/shop/] in DispatcherServlet with name 'dispatcherservlet' 这个方法可以针对路径匹配进行相当多的配置, 具体请参见文档, 这里只列出了其中的一个功能配置静态资源在配置类加上下面的代码 : public void addresourcehandlers(resourcehandlerregistry registry) { registry.addresourcehandler("/static/**").addresourcelocations("classpath:/static/").resourcechain(true).addresolver(new GzipResourceResolver()).addResolver(new VersionResourceResolver().addFixedVersionStrategy("1.0.0", "/**"));

6 这就实现了静态资源路由到 static 目录, 并且为静态资源启用了 Gzip 压缩和基于版本号的缓存配置后我们在 resources 目录下创建一个 static 目录, 然后随便创建一个 a.html 文件, 试试访问这个文件, 测试可以发现 : 和都可以访问到这个文件解析自定义的参数 HandlerMethodArgumentResolver 接口这是一个非常非常重要常用的扩展点通过这个接口, 我们可以实现通用方法来装配 HandlerMethod 上的自定义参数, 我们现在来定义一个 MyDevice 类型, 然后我们希望框架可以在所有出现 MyDevice 参数的时候自动为我们从 Header 里获取相应的设备信息构成 MyDevice 对象 ( 如果我们 API 的使用者是客户端应用程序, 这是不是一个挺常见的需求 ) import public class MyDevice { private String type; private String version; private String screen; 然后是自定义的 HandlerMethodArgumentResolver 实现 : import org.springframework.core.methodparameter; import org.springframework.web.bind.support.webdatabinderfactory; import org.springframework.web.context.request.nativewebrequest; import org.springframework.web.method.support.handlermethodargumentresolver; import org.springframework.web.method.support.modelandviewcontainer; public class DeviceHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver { public boolean supportsparameter(methodparameter methodparameter) { return methodparameter.getparametertype().equals(mydevice.class); public Object resolveargument(methodparameter methodparameter, ModelAndViewContainer modelandviewcontainer, NativeWebRequest nativewebrequest,

7 WebDataBinderFactory webdatabinderfactory) throws Exception { MyDevice mydevice = new MyDevice(); mydevice.settype(nativewebrequest.getheader("device.type")); mydevice.setversion(nativewebrequest.getheader("device.version")); mydevice.setscreen(nativewebrequest.getheader("device.screen")); return mydevice; 实现分两部分, 第一部分告诉框架, 我们这个 ArgumentResolver 支持解析怎么样的参数这里我们的实现是根据参数类型, 还有很多时候可以通过检查是否参数上有额外的自定义注解来实现 ( 后面也会有例子 ) 第二部分就是真正的实现了, 实现非常简单, 从请求头里获取相应的信息构成我们的 MyDevice 对象要让这个 Resolver 被 MVC 框架识别到, 我们需要继续扩展刚才的 WebConfig 类, 加入下面的代码 : public void addargumentresolvers(list<handlermethodargumentresolver> resolvers) { resolvers.add(new DeviceHandlerMethodArgumentResolver()); 然后, 我们写一个例子来测试一下 : import lombok.extern.slf4j.slf4j; import org.springframework.web.bind.annotation.*; import java.util.arraylist; import java.util.list; import java.util.stream.collectors; @RequestMapping("api") public class MyRestController = "items", method = RequestMethod.GET) public List<MyItem> getitems(mydevice device) { log.debug("device : " + device); List<MyItem> myitems = new ArrayList<>(); myitems.add(new MyItem("aa", 10)); myitems.add(new MyItem("bb", 20)); return myitems;

8 这里因为用了 debug, 所以需要在配置文件中打开 debug 日志级别 : logging.level.me.josephzhu.spring101webmvc=debug 测试一下 : curl -X GET \ \ -H 'device.screen: 1280*800' \ -H 'device.type: android' \ -H 'device.version: 1.1' 可以在控制台看到这样的日志 : :10: DEBUG [nio-8080-exec-9] m.j.spring101webmvc.myrestcontroller : Device : MyDevice(type=android, version=1.1, screen=1280*800) 可以证明我们方法中定义的 MyDevice 的确是从请求中获取到了正确的结果大家可以发挥一下想象,ArgumentResolver 不但可以做类似参数自动装配 ( 从各个地方获取必要的数据 ) 的工作, 而且还可以做验证工作大家可以仔细看一下 resolveargument 方法的参数, 是不是相当于要啥有啥了 ( 当前参数定义当前请求 Model 容器以及绑定工厂 ) 自定义 ResponseBody 后处理在刚才的实现中, 我们直接返回了 List<MyItem> 数据, 对于 API 来说, 我们一般会定义一套 API 的结果对象, 包含 API 的数据成功与否结果错误消息签名等等内容, 这样客户端可以做签名验证, 然后是根据成功与否来决定是要解析数据还是直接提示错误, 比如 : import lombok.allargsconstructor; public class APIResponse<T> { T data;

9 boolean success; String message; String sign; 如果我们在每个 API 方法中去返回这样的 APIResponse 当然可以实现这个效果, 还有一种通用的实现方式是使用 ResponseBodyAdvice: import org.springframework.core.methodparameter; import org.springframework.http.mediatype; import org.springframework.http.converter.httpmessageconverter; import org.springframework.http.server.serverhttprequest; import org.springframework.http.server.serverhttpresponse; import org.springframework.web.bind.annotation.controlleradvice; import public class APIResponseBodyAdvice implements ResponseBodyAdvice<Object> { public boolean supports(methodparameter returntype, Class<? extends HttpMessageConverter<?>> convertertype) { return!returntype.getparametertype().equals(apiresponse.class); public Object beforebodywrite(object body, MethodParameter returntype, MediaType selectedcontenttype, Class<? extends HttpMessageConverter<?>> selectedconvertertype, ServerHttpRequest request, ServerHttpResponse response) { String sign = ""; Sign signannotation = returntype.getmethod().getannotation(sign.class); if (signannotation!= null) sign = "abcd"; return new APIResponse(body, true, "", sign); 注解来启用这个 Advice 在实现上也是两部分, 第一部分告诉框架我们这个 Advice 支持的是非 APIResponse 类型 ( 如果返回的对象已经是 APIResponse 了, 我们当然就不需要再包装一次了 ) 第二部分是实现, 这里的实现很简单, 我们先检查一下方法上是否有 Sign 这个注解, 如果有的话进行签名 ( 这里的逻辑是写死的签名 ), 然后把得到的 body 塞入 APIResponse 后返回这里补上 Sign 注解的实现 :

10 import java.lang.annotation.elementtype; import java.lang.annotation.retention; import java.lang.annotation.retentionpolicy; Sign { 这是一个空注解, 没啥可以说的, 下面我们来测试一下这个 = "item/{id", method = RequestMethod.GET) public MyItem getitem(@pathvariable("id") String id) { Integer i = null; try { i = Integer.parseInt(id); catch (NumberFormatException ex) { if (i == null i < 1) throw new IllegalArgumentException(" 不合法的商品 ID"); return new MyItem("item" + id, 10); 访问后得到如下图的结果 : 是不是很方便呢? 这个 API 包装的过程可以由框架进行, 无需每次手动来做

11 自定义异常处理如果我们访问会看到错误白页, 针对错误处理, 我们希望 : 1 可以使用统一的 APIResponse 方式进行错误返回 2 可以记录错误信息以便查看实现这个功能非常简单, 实现 : import lombok.extern.slf4j.slf4j; import org.springframework.web.bind.annotation.controlleradvice; import org.springframework.web.bind.annotation.exceptionhandler; import org.springframework.web.bind.annotation.responsebody; import org.springframework.web.bind.annotation.restcontroller; import org.springframework.web.method.handlermethod; import = public class public APIResponse handle(httpservletrequest req, HandlerMethod method, Exception ex) { log.error(string.format(" 访问 %s -> %s 出错了!", req.getrequesturi(), method.tostring()), ex); return new APIResponse(null, false, ex.getmessage(), ""); 注意几点 : 1 的 annotations 来关联我们需要拦截的 Controller 类型 2 handle 方法支持相当多的参数, 可谓是要啥有啥, 这里贴下官方文档说明的截图 ( 在这里我们使用了 ServletRequest 来获取请求地址, 使用了 HandlerMethod 来获取当前执行的方法 ):

12 访问地址可以看到如下输出 : ( 注意, 处理签名的 ResponseBodyAdvice 并不会针对这个返回进行处理, 因为之前实现的时候我们就判断了返回内容不是 APIResponse 才去处理, 在自己正式的实现中你可以实现的更合理, 让签名的处理逻辑同时适用出现异常的情况 ) 日志中也出现了错误信息 : :48: ERROR [nio-8080-exec-6] m.j.s.myrestexceptionhandler : 访问 /api/item/sd -> public me.josephzhu.spring101webmvc.myitem me.josephzhu.spring101webmvc.myrestcontroller.getitem(java.lang.string) 出错了! java.lang.illegalargumentexception: 不合法的商品 ID at me.josephzhu.spring101webmvc.myrestcontroller.getitem(myrestcontroller.java:34) ~[classes/:na]

13 at sun.reflect.nativemethodaccessorimpl.invoke0(native Method) ~[na:1.8.0_161] at sun.reflect.nativemethodaccessorimpl.invoke(nativemethodaccessorimpl.java:62) ~[na:1.8.0_161] at sun.reflect.delegatingmethodaccessorimpl.invoke(delegatingmethodaccessorimpl.java:43) ~[na:1.8.0_161] at java.lang.reflect.method.invoke(method.java:498) ~[na:1.8.0_161] at org.springframework.web.method.support.invocablehandlermethod.doinvoke(invocablehandlermethod.java:209) ~[spring-web release.jar:5.0.9.release] 自动处理参数类型转换比如有这么一个需求, 我们希望可以接受自定义的枚举作为参数, 而且枚举的名字不一定需要和请求的参数完全大小写匹配, 这个时候我们需要实现自己的转换器 : import org.springframework.core.convert.converter.converter; import org.springframework.core.convert.converter.converterfactory; import java.util.arrays; public class MyConverterFactory implements ConverterFactory<String, Enum> { public <T extends Enum> Converter<String, T> getconverter(class<t> targettype) { return new String2EnumConverter(targetType); class String2EnumConverter<T extends Enum<T>> implements Converter<String, T> { private Class<T> enumtype; private String2EnumConverter(Class<T> enumtype) { this.enumtype = enumtype; public T convert(string source) { return Arrays.stream(enumType.getEnumConstants()).filter(e -> e.name().equalsignorecase(source)).findany().orelse(null);

14 这里实现了一个从字符串到自定义枚举的转换, 在搜索枚举名字的时候我们忽略了大小写接下去我们通过 WebConfig 来注册这个转换器工厂 : public void addformatters(formatterregistry registry) { registry.addconverterfactory(new MyConverterFactory()); 来写一段代码测试一下 public List<MyItem> search(@requestparam("type") ItemTypeEnum itemtypeenum) { return IntStream.range(1, 5).mapToObj(i -> new MyItem(itemTypeEnum.name() + i, i * 100)).collect(Collectors.toList()); 这是一个 Get 请求的 API, 接受一个 type 参数, 参数是一个自定义枚举 : public enum ItemTypeEnum { BOOK, TOY, TOOL 很明显枚举的名字都是大写的, 我们来访问一下地址测试一下程序是否可以正确匹配 :

15 TOy 的搜索参数匹配到了 TOY 枚举, 结果符合我们的预期自定义拦截器最后, 我们来看看 Spring MVC 最通用的扩展点, 也就是拦截器

这个图清晰展现了拦截器几个重要方法事件节点在这个例子中, 我们利用 prehandle 和 posthandle 两个方法实现可以统计请求执行耗时的拦截器 : import lombok.extern.slf4j.slf4j; import org.springframework.web.servlet.modelandview; import org.springframework.web.servlet.handler.

16 这个图清晰展现了拦截器几个重要方法事件节点在这个例子中, 我们利用 prehandle 和 posthandle 两个方法实现可以统计请求执行耗时的拦截器 : import lombok.extern.slf4j.slf4j; import org.springframework.web.servlet.modelandview; import org.springframework.web.servlet.handler.handlerinterceptoradapter; import javax.servlet.http.httpservletrequest; import public class ExecutionTimeHandlerInterceptor extends HandlerInterceptorAdapter { private static final String START_TIME_ATTR_NAME = "starttime"; private static final String EXECUTION_TIME_ATTR_NAME = "executiontime"; public boolean prehandle(httpservletrequest request, HttpServletResponse response, Object handler) throws Exception { long starttime = System.currentTimeMillis(); request.setattribute(start_time_attr_name, starttime); return true; public void aftercompletion(httpservletrequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

17 public void posthandle(httpservletrequest request, HttpServletResponse response, Object handler, ModelAndView modelandview) throws Exception { long starttime = (Long) request.getattribute(start_time_attr_name); long endtime = System.currentTimeMillis(); long executiontime = endtime - starttime; String time = "[" + handler + "] executetime : " + executiontime + "ms"; if (modelandview!= null) { modelandview.addobject(execution_time_attr_name, time); log.debug(time); 在实现的时候, 我们不仅仅把执行时间输出到了日志, 而且还通过修改 ModelAndView 对象把这个信息加入到了视图模型内, 这样页面也可以展现这个时间要启用拦截器, 我们还需要配置 WebConfig: public void addinterceptors(interceptorregistry registry) { registry.addinterceptor(new ExecutionTimeHandlerInterceptor()); 接下去我们运行刚才那个例子, 可以看到如下的日志输出 : :58: DEBUG [nio-8080-exec-9] m.j.s.executiontimehandlerinterceptor : [public java.util.list<me.josephzhu.spring101webmvc.myitem> me.josephzhu.spring101webmvc.myrestcontroller.search(me.josephzhu.spring101webmvc.itemtypeenum)] executetime : 22ms 页面上也可以引用到我们添加进去的对象 : <!DOCTYPE html SYSTEM " <html lang="en"> <head> <meta charset="utf-8"> <title>hello World</title> </head> <body> Hello World <div th:text="${executiontime"></div>

18 </body> </html> 拦截器是非常通用的一个扩展, 可以全局实现权限控制缓存动态修改结果等等功能总结和讨论 Spring MVC 本文我们通过一个一个例子展现了 Spring MVC 的一些重要扩展点 : 1 使用拦截器做执行时间统计 2 自定义 ResponseBodyAdvice 来处理 API 的包装 3 自定义 ExceptionHandler 来统计错误处理 4 自定义 ConverterFactory 来解析转换枚举 5 自定义 ArgumentResolver 来组装设备信息参数 6 快速实现静态资源路径匹配以及 ViewController 的配置其实 Spring MVC 还有很多扩展点, 比如模型参数绑定和校验允许我们实现动态的 RequestMapping 甚至是 DispatcherServlet 进行扩展, 你可以继续自行研究最后, 我想说说我对 Spring MVC 的看法, 总体上我觉得 Spring MVC 实现很灵活, 扩展点很多, 几乎每一个组件都是松耦合, 允许我们自己定义和替换但是我觉得它的实现有点过于松散 ASP.NET MVC 的实现我就挺喜欢, 相比 Spring MVC,ASP.NET MVC 的两个 ActionFilter 和 ActionResult 的实现是亮点 : 1 ActionFilter 机制 Controller 里面的每一个方法称作 Action, 我们可以在每一个 Action 上加上各种注解来启用 ActionFilter,ActionFilter 可以针对 Action 执行前后出异常等等情况做回调处理 ASP.NET MVC 的 ActionFilter 的 Filer 级别是方法, 粒度上比拦截器精细很多, 而且配置更直观 Spring MVC 虽然除了拦截器还有 ArgumentResolver 以及 ReturnValueHandler 可以分别进行参数处理和返回值处理, 但是这两套扩展体系也是基于框架层面的, 如果要和方法打通还需要自定义注解来实现总觉得 Spring MVC 的这三套扩展点相互配合功能上虽然完整, 但是有种支离破碎的感觉, 如果我们真的要实现很多功能的, 话可能会在这里有相当多的 if-else, 没有 ActionFilter 来得直观 2 方法的返回值可以是 ModelAndView, 的自定义类型, 这两种输出类型的分法可以满足我们的需求, 但是总感觉很别扭在 ASP.NET MVC 中的方法返回抽象为了 ActionResult, 可以是 ViewResult JsonResult FileContentResult RedirectResult FilePathResult JavaScriptResult 等等, 正如其名, 看到返回值我们就可以看到方法实际的输出表现, 非常直观容易理解 ASP.NET MVC 并没有大量依赖 IOC 和 AOP 来实现, 而是由框架的整体结构实现了插件机制, 本质上这和 Spring 的风格就不同, 加上 Spring MVC 从简化 Servlet 开始演化, 两者理念上的区别也决定了设计上的区别, 因此 Spring MVC 这样设计我也能理解

"+handlermethod.getbean().getclass().getname()); public void aftercompletion(httpservletrequest req, HttpServletResponse resp, Object handler, Excepti

+handlermethod.getbean().getclass().getname()); public void aftercompletion(httpservletrequest req, HttpServletResponse resp, Object handler, Excepti SpringBoot 的配置一拦截器的配置 1 定义一个表单用户名 : 密码 :