Spring MVC函数式接口Router Function你用过吗？-51CTO.COM

环境：Springboot2.4.12

概述

Spring Web MVC包括WebMvc.fn，这是一种轻量级函数式编程模型，其中函数用于路由和处理请求，参数及返回值设计为不可变。它是基于注释的编程模型的替代方案，但在其他方面还是运行在同一DispatcherServlet上。

在WebMvc.fn中，HTTP请求由HandlerFunction处理：该函数接受ServerRequest并返回ServerResponse。请求和响应对象都有不可变，提供对HTTP请求和响应的JDK 8友好访问。HandlerFunction相当于基于注释的编程模型中@RequestMapping方法的主体。

传入的请求通过RouterFunction路由到处理程序函数：一个接受ServerRequest并返回可选HandlerFunction（即可选的<HandlerFunction>）的函数。当路由器函数匹配时，返回处理函数；否则为空可选。RouterFunction相当于@RequestMapping注释，但主要区别在于路由器函数不仅提供数据，还提供行为。

示例：

@Configuration
public class PersonHandlerConfiguration {
  
  @Bean
  public RouterFunction<ServerResponse> person() {
    return route().GET("/person", accept(MediaType.APPLICATION_JSON), request -> {
      return ServerResponse.status(HttpStatus.OK).body("Hello World") ;
    }).build() ;
  }
  
}

我们需要在一个@Configuration配置类中将RouterFunction暴露为Bean对象即可。

GET方法的3个参数：

第一个：请求的接口地址。

第二个：谓词也就是限定哪些调用能够匹配上，这个类似注解接口@RequestMapping参数中的consumer，params等属性一样。

第三个：HandlerFunction，这就是处理器对象了，实际的业务方法的处理对比@RequestMapping的方法体了。

HandlerFunction对象

ServerRequest和ServerResponse是不可变的接口，提供对HTTP请求和响应的JDK8友好访问，包括头、正文、方法和状态代码。

ServerRequest

ServerRequest提供对HTTP方法、URI、头和查询参数的访问，而对主体的访问是通过主体方法提供的。如下示例：

@Bean
public RouterFunction<ServerResponse> student() {
  return route().GET("/student/{id}", accept(MediaType.APPLICATION_JSON), request -> {
    return ServerResponse.ok().body("name = " + request.param("name").get() + ", id = " + request.pathVariable("id")) ;
  })
  .POST("/student", accept(MediaType.APPLICATION_JSON), request -> {
    return ServerResponse.ok().body(request.body(Student.class)) ;
  })
  .build() ;
}

GET接口获取查询参数和路径上的参数。

POST接口获取body主体内容。

ServerResponse

ServerResponse提供对HTTP响应的访问，因为它是不可变的，所以可以使用构建方法来创建它。可以使用生成器设置响应状态、添加响应标题或提供正文。

在上面的示例中已经看到了如何使用，这里就不再给出示例了。

Handler Classes处理器类

将处理器类单独定义到一个文件中进行相应的处理，这就与传统的@RestController注解类似了将很多的接口方法都定义在一个Controller类中。

示例：

@Configuration
public class PersonHandlerConfiguration {
  
  @Resource
  private PersonHandler ph ;
  
  @Bean
  public RouterFunction<ServerResponse> person() {
  return route()
      .GET("/person/{id}", accept(MediaType.APPLICATION_JSON), ph::queryPerson)
      .POST("/person", accept(MediaType.APPLICATION_JSON), ph::save)
      .build() ;
  }
}

处理器类（在该类中可以注入DAO类进行相关的数据库操作）

@Component
public class PersonHandler {
  
  public ServerResponse save(ServerRequest request) throws Exception {
    return ok().body(request.body(Person.class)) ;
  }
  
  public ServerResponse queryPerson(ServerRequest request) throws Exception {
    return ok().body(new Person(Integer.valueOf(request.pathVariable("id")), "中国")) ;
  }
  
}

Validation验证

可以使用Spring的验证工具将验证应用于请求主体。例如，给定一个人的自定义Spring验证器实现。示例：

@Component
public class PersonHandler {
  
  @Resource
  private Validator validator ;
  
  public ServerResponse save(ServerRequest request) throws Exception {
    Person person = request.body(Person.class) ;
    Errors errors = validate(person) ;
    if (errors == null) {
      return ok().body(person) ;
    }
    return ok().body(errors.toString()) ;
  }


  private Errors validate(Person person) {
    Errors errors = new BeanPropertyBindingResult(person, "person");
    validator.validate(person, errors);
    if (errors.hasErrors()) {
      return errors ; 
    }
    return null ;
  }
  
}

需要引入依赖：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

关于参数验证《Springboot项目中你的参数都在如何验证？这个starter你知道吗？》

RouterFunction

路由器功能用于将请求路由到相应的HandlerFunction。通常，你不会自己编写路由器函数，而是使用RouterFunctions类上的方法来创建路由器函数。RouterFunctions.route()（无参数）为你提供了创建路由器函数的流畅生成器，而RouterFunctions.route(RequestPredicate，HandlerFunction)则提供了创建路由器的直接方法。

通常，建议使用route() 构建，因为它为典型映射场景提供了方便的捷径，而不需要难以发现的静态导入。例如，router function builder提供方法GET(String，HandlerFunction)为GET请求创建映射；和POST(字符串、HandlerFunction)用于POST。

除了基于HTTP方法的映射之外，route builder还提供了一种在映射到请求时引入额外谓词的方法。对于每个HTTP方法，都有一个重载变量，该变量将RequestPredicate作为参数，通过它可以表示额外的约束。

在上面的示例中已经看到了在做相应GET，POST方法时传的第二个参数。

谓词Predicate

我们可以编写自己的RequestPredicate，但是RequestPredicates类提供了基于请求路径、HTTP方法、内容类型等的常用实现。如下示例通过Accept来限定了能够接收的数据类型。

import static org.springframework.web.servlet.function.RequestPredicates.accept;
@Bean
public RouterFunction<ServerResponse> hello() {
  return route().GET("/hello", accept(MediaType.APPLICATION_JSON), request -> {
    return ServerResponse.status(HttpStatus.OK).body("Hello World") ;
  }).build() ;
}

还可以通过and 或者 or 来添加多个谓词

accept(...).and() || or()

嵌套路由

在传统的Controller定义时，可以在类上加@RequestMapping("/person")注解的方式来统一请求接口的前缀。在函数式接口中我们可以通过如下的方式设定：

@Bean
public RouterFunction<ServerResponse> nestPerson() {
  return route()
          .path("/persons", builder -> builder 
          .GET("/{id}", accept(MediaType.APPLICATION_JSON), ph::queryPerson)
          .POST("/save", ph::save))
          .build();
}

通过path定义了路由的前缀。也可以通过如下方式：

@Bean
public RouterFunction<ServerResponse> nestPerson2() {
  return route()
      .path("/persons2", b1 -> b1
        .nest(accept(MediaType.APPLICATION_JSON), b2 -> b2
          .GET("/{id}", accept(MediaType.APPLICATION_JSON), ph::queryPerson))
        .POST("/save", ph::save))
      .build();
}

HandlerMapping

这种函数式接口既然底层还是使用的DispatcherServlet ，那么它就会有对应的HandlerMapping和Adapter

RouterFunctionMapping：检测Spring配置中的一个或多个RouterFunction<？>bean，对它们进行排序，通过RouterFunction.andOther组合它们，并将请求路由到生成的组合RouterFunction。

HandlerFunctionAdapter：让DispatcherHandler调用映射到请求的HandlerFunction的简单适配器。

过滤器

可以使用路由函数生成器上的before、after或filter方法筛选处理程序函数。对于接口注释的方式，我们可以通过使用@ControllerAdvice、ServletFilter或两者来实现类似的功能。过滤器将应用于生成器生成的所有路由。这意味着嵌套路由中定义的过滤器不适用于“顶层”路由。示例：

@Bean
public RouterFunction<ServerResponse> nestPerson2() {
  return route()
        .path("/persons2", b1 -> b1
          .nest(accept(MediaType.APPLICATION_JSON), b2 -> b2
            .GET("/{id}", accept(MediaType.APPLICATION_JSON), ph::queryPerson)
            .before(request -> ServerRequest.from(request).header("x-pack", "123123").build()))
          .POST("/save", ph::save))
          .after((request, response) -> {
            System.out.println("after execution..." + response.statusCode());
            return response ;
          })
         .filter((request, next) -> {
           if (request.pathVariable("id").equals("100")) {
             return ServerResponse.ok().body("参数错误") ;
           } else {
            return next.handle(request) ;
           }
         })
        .build();
}
public ServerResponse queryPerson(ServerRequest request) throws Exception {
  System.out.println(request.headers().header("x-pack")) ;
  return ok().body(new Person(Integer.valueOf(request.pathVariable("id")), "中国")) ;
}

before：添加了自定义header信息，然后我们可以在queryPerson中获取到，并且该before只能应用于当前这个嵌套的路由中。

after：能够应用所有的路由中

filter：filter方法采用HandlerFilterFunction：采用ServerRequest和HandlerFunction并返回ServerResponse的函数。handler函数参数表示链中的下一个元素。这通常是路由到的处理程序，但如果应用了多个过滤器，它也可以是另一个过滤器。

Swagger

此时的Swagger没有用了，所以你的慎用啊。

完毕！！！