Spring5.1新特性—接口驱动开发Controller

本文介绍Spring MVC新特性，使用java接口定义web请求。

1. 概述

通常在SpringMVC中定义Controller，在其方法上使用不同的注解用于描述请求URL入口地址，HTTP请求方法，路径变量等。举例，我们在普通方法上增加@PostMapping("/save/{id}")，指定请求地址和路径变量：

@PostMapping("/save/{id}")
@ResponseBody
public Book save(@RequestBody Book book, @PathVariable int id) {
    // implementation
}

当只有一个controller处理该请求肯定没问题。但如果有多个controller，且有相同的方法签名，情况会如何呢？
举例，因迁移或其他类似原因造成我们可能有两个不同版本的controller，它们有相同方法签名，这时会有大量重复注解伴随方法定义。显然这违背DRY (don’t repeat yourself)原则。

如果纯粹是java类出现这种场景，简单定义接口使得不同类有不同实现即可。但是Controller方法的主要责任不是方法签名，而是方法的注解。

Spring 5.1 引入新的特性：

Controller接口上参数注解也会被检查，可以通过Controller接口完成映射约定。

下面我们看看如何使用这个特性。

2. Controller接口

2.1 示例说明

为了描述新特性，我们使用简单Rest应用管理书籍，仅包括一个controller，它定义返回书籍及修改书籍方法。

2.2 接口

下面定义普通接口，其中不仅定义方法签名，同时也定义web请求：

@RequestMapping("/default")
public interface BookOperations {

    @GetMapping("/")
    List<Book> getAll();

    @GetMapping("/{id}")
    Optional<Book> getById(@PathVariable int id);

    @PostMapping("/save/{id}")
    public void save(@RequestBody Book book, @PathVariable int id);
}

下面定义类实现接口，同时增加类级别注解和方法级别注解：

@RestController
@RequestMapping("/book")
public class BookController implements BookOperations {

    @Override
    public List<Book> getAll() {...}

    @Override
    public Optional<Book> getById(int id) {...}

    @Override
    public void save(Book book, int id) {...}

}

我们在controller上仍然增加了类级别注解@RestController 或 @Controller 。通过这种方法controller继承所有映射web请求的注解。

下面测试是否可用。运行程序通过下面请求调用getAll方法：

curl http://localhost:8081/book/

即使controller实现了接口，我们仍然可以通过注解微调web请求注解。就如对接口一样，可以是类级别或方法级别。实际上我们定义controller已经使用这种方式：

@RequestMapping("/book")
public class BookController implements BookOperations {...}

如果我们向controller添加web请求注解，它们优先于接口的注解。换句话说，Spring以类似于Java处理继承的方式解释控制器接口。因此，我们在接口中定义所有通用web请求属性，同时在controller进行必要的微调。

2.3 注意事项

当多个controller实现一个接口时，可能会遇到多个web请求被多个方法处理的场景，这时Spring会抛出异常：

Caused by: java.lang.IllegalStateException: Ambiguous mapping.

因此通过@RequestMapping注解定义controller时，要避免混淆映射的风险。

3. 总结

本文学习了Spring 5.1的新特性。使Spring MVC的Controller实现接口，这不仅时Java标准的继承方式，也可以继承接口中定义的web请求相关功能。