朱晔和你聊Spring系列S1E4：灵活但不算好用的Spring MVC

阅读PDF版本

本文会以一些例子来展现Spring MVC的常见功能和一些扩展点，然后我们来讨论一下Spring MVC好用不好用。

使用SpringBoot快速开始

基于之前的parent模块，我们来创建一个新的模块：

    4.0.0

    me.josephzhu
    spring101-webmvc
    0.0.1-SNAPSHOT
    jar

    spring101-webmvc
    

    
        me.josephzhu
        spring101
        0.0.1-SNAPSHOT
    


    
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.boot
            spring-boot-starter-thymeleaf
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

使用web来启用Spring MVC，使用thymeleaf来启用thymeleaf模板引擎。Thymeleaf是一个强大的Java模板引擎，可以脱离于Web单独使用，本身就有非常多的可配置可扩展的点，这里不展开讨论，详见官网。
接下去我们创建主程序：

package me.josephzhu.spring101webmvc;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Spring101WebmvcApplication {

    public static void main(String[] args) {
        SpringApplication.run(Spring101WebmvcApplication.class, args);
    }
}
以及一个测试Controller：
package me.josephzhu.spring101webmvc;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.stream.Collectors;
import java.util.stream.IntStream;

@Controller
public class MyController {

    @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;
    }

}

这里使用到了一个自定义的类：

package me.josephzhu.spring101webmvc;

import lombok.AllArgsConstructor;
import lombok.Data;

@AllArgsConstructor
@Data
public class MyItem {
    private String name;
    private Integer price;
}

最后我们需要在resources目录下创建一个templates目录，在目录下再创建一个shop.html模板文件：

    
    


Hello Shop

    

        
...
        
...
    

我们看到有了SpringBoot，创建一个Spring MVC程序整个过程非常简单：
1 引入starter
2 创建@Controller，设置@RequestMapping
3 创建模板文件
没有任何配置工作，一切都是starter自动配置。

快速配置ViewController

几乎所有Spring MVC的扩展点都集成在了接口中，要进行扩展很简单，实现这个接口，加上@Configuration和@EnableWebMvc注解，实现需要的方法即可。
我们先用它来快速配置一些ViewController：

package me.josephzhu.spring101webmvc;

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;

import java.util.List;

@EnableWebMvc
@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    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：

    
    


Hello World

这种配置方式可以省一些代码量，但是我个人认为在这里做配置可读性一般。

定制路径匹配

我们还可以实现路径匹配策略的定制：

@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
    configurer.setUseTrailingSlashMatch(false);
}

比如这样就关闭了结尾为/的匹配（默认开启）。试着访问http://localhost:8080/shop/得到如下错误：

2018-10-02 18:58:16.581  WARN 20264 --- [nio-8080-exec-1] o.s.web.servlet.PageNotFound             : No mapping found for HTTP request with URI [/shop/] in DispatcherServlet with name 'dispatcherServlet'

这个方法可以针对路径匹配进行相当多的配置，具体请参见文档，这里只列出了其中的一个功能。

配置静态资源

在配置类加上下面的代码：

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/static/**")
            .addResourceLocations("classpath:/static/")
            .resourceChain(true)
            .addResolver(new GzipResourceResolver())
            .addResolver(new VersionResourceResolver()
                    .addFixedVersionStrategy("1.0.0", "/**"));
}

这就实现了静态资源路由到static目录，并且为静态资源启用了Gzip压缩和基于版本号的缓存。配置后我们在resources目录下创建一个static目录，然后随便创建一个a.html文件，试试访问这个文件，测试可以发现：http://localhost:8080/static/1.0.0/a.html和http://localhost:8080/static/a.html都可以访问到这个文件。

解析自定义的参数

HandlerMethodArgumentResolver接口这是一个非常非常重要常用的扩展点。通过这个接口，我们可以实现通用方法来装配HandlerMethod上的自定义参数，我们现在来定义一个MyDevice类型，然后我们希望框架可以在所有出现MyDevice参数的时候自动为我们从Header里获取相应的设备信息构成MyDevice对象（如果我们API的使用者是客户端应用程序，这是不是一个挺常见的需求）。

package me.josephzhu.spring101webmvc;

import lombok.Data;

@Data
public class MyDevice {
    private String type;
    private String version;
    private String screen;
}

然后是自定义的HandlerMethodArgumentResolver实现：

package me.josephzhu.spring101webmvc;

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 {
    @Override
    public boolean supportsParameter(MethodParameter methodParameter) {
        return methodParameter.getParameterType().equals(MyDevice.class);
    }

    @Override
    public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer, NativeWebRequest nativeWebRequest, 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类，加入下面的代码：

@Override
public void addArgumentResolvers(List resolvers) {
    resolvers.add(new DeviceHandlerMethodArgumentResolver());
}

然后，我们写一个例子来测试一下：

package me.josephzhu.spring101webmvc;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;

import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.IntStream;

@RestController
@Slf4j
@RequestMapping("api")
public class MyRestController {

    @RequestMapping(value = "items", method = RequestMethod.GET)
    public List getItems(MyDevice device) {
        log.debug("Device : " + device);
        List myItems = new ArrayList<>();
        myItems.add(new MyItem("aa", 10));
        myItems.add(new MyItem("bb", 20));
        return myItems;
    }

}

这里因为用了debug，所以需要在配置文件中打开debug日志级别：

logging.level.me.josephzhu.spring101webmvc=DEBUG

测试一下：

curl -X GET \
  http://localhost:8080/api/items \
  -H 'device.screen: 1280*800' \
  -H 'device.type: android' \
  -H 'device.version: 1.1'

可以在控制台看到这样的日志：

2018-10-02 19:10:56.667 DEBUG 20325 --- [nio-8080-exec-9] m.j.spring101webmvc.MyRestController     : Device : MyDevice(type=android, version=1.1, screen=1280*800)

可以证明我们方法中定义的MyDevice的确是从请求中获取到了正确的结果。大家可以发挥一下想象，ArgumentResolver不但可以做类似参数自动装配（从各个地方获取必要的数据）的工作，而且还可以做验证工作。大家可以仔细看一下resolveArgument方法的参数，是不是相当于要啥有啥了（当前参数定义、当前请求、Model容器以及绑定工厂）。

自定义ResponseBody后处理

在刚才的实现中，我们直接返回了List 数据，对于API来说，我们一般会定义一套API的结果对象，包含API的数据、成功与否结果、错误消息、签名等等内容，这样客户端可以做签名验证，然后是根据成功与否来决定是要解析数据还是直接提示错误，比如：

package me.josephzhu.spring101webmvc;

import lombok.AllArgsConstructor;
import lombok.Data;

@Data
@AllArgsConstructor
public class APIResponse {
    T data;
    boolean success;
    String message;
    String sign;
}

如果我们在每个API方法中去返回这样的APIResponse当然可以实现这个效果，还有一种通用的实现方式是使用ResponseBodyAdvice：

package me.josephzhu.spring101webmvc;

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 org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@ControllerAdvice
public class APIResponseBodyAdvice implements ResponseBodyAdvice