知識庫 / Spring / Spring MVC RSS 訂閱

public RouterFunction<ServerResponse> productSearch(ProductService ps) {
    return route().nest(RequestPredicates.path("/product"), builder -> {
        builder.GET("/name/{name}", req -> ok().body(ps.findByName(req.pathVariable("name"))));
    }).build();
}

在傳統方法中，我們通過傳遞一個指向 @Controller 的路徑來實現。但是，組建 Web 服務的功能等效方法是 route() 方法上的 nest() 方法。

在這裏，我們首先提供想要組建新路由的路徑，即 /product。然後，我們使用構建器對象，如同在之前的示例中一樣，添加路由。

nest() 方法負責將添加到構建器對象中的路由與主 RouterFunction 合併。

5.   錯誤處理

另一個常見用例是使用自定義錯誤處理機制。我們可以使用 onError() 方法在 route() 上定義自定義異常處理器。

這相當於在註解式方法中使用的 @ExceptionHandler。但由於它可以為每個路由組定義單獨的異常處理器，因此它更具靈活性。

讓我們為我們之前創建的產品搜索路由添加一個異常處理器，以處理當產品未找到時拋出的自定義異常：

public RouterFunction<ServerResponse> productSearch(ProductService ps) {
    return route()...
      .onError(ProductService.ItemNotFoundException.class,
         (e, req) -> EntityResponse.fromObject(new Error(e.getMessage()))
           .status(HttpStatus.NOT_FOUND)
           .build())
      .build();
}

onError() 方法接受 Exception 類對象，並期望從功能實現中獲取一個 ServerResponse。

我們使用了 EntityResponse，它是 ServerResponse 的子類型，用於在此處構建響應對象，該對象來自自定義數據類型 Error。然後我們添加狀態，並使用 EntityResponse.build()，它返回一個 ServerResponse 對象。

6. 過濾器

使用過濾器是一種常見的實現身份驗證以及管理諸如日誌記錄和審計等橫切關注點的途徑。 過濾器用於決定是否繼續或中止請求的處理。

例如，我們想要創建一個新的路由，將產品添加到目錄中：

public RouterFunction<ServerResponse> adminFunctions(ProductService ps) {
    return route().POST("/product", req -> ok().body(ps.save(req.body(Product.class))))
      .onError(IllegalArgumentException.class, 
         (e, req) -> EntityResponse.fromObject(new Error(e.getMessage()))
           .status(HttpStatus.BAD_REQUEST)
           .build())
        .build();
}

由於這是一個管理功能，因此我們也需要驗證調用服務的用户。

我們可以通過在 route() 中添加 filter() 方法來實現這一點。

public RouterFunction<ServerResponse> adminFunctions(ProductService ps) {
   return route().POST("/product", req -> ok().body(ps.save(req.body(Product.class))))
     .filter((req, next) -> authenticate(req) ? next.handle(req) : 
       status(HttpStatus.UNAUTHORIZED).build())
     ....;
}

在這裏，filter() 方法提供請求以及下一個處理程序，我們使用它進行簡單的身份驗證，如果驗證成功，則允許產品保存；如果驗證失敗，則返回 UNAUTHORIZED 錯誤給客户端。

7. 跨界關注點

有時，我們可能需要在請求之前、之後或周圍執行一些操作。例如，我們可能希望記錄傳入請求和傳出響應的某些屬性。

讓我們在應用程序找到匹配傳入請求時，每次都記錄一條語句。 我們將使用 before() 方法在 route() 上進行操作：

@Bean
RouterFunction<ServerResponse> allApplicationRoutes(ProductController pc, ProductService ps) {
    return route()...
      .before(req -> {
          LOG.info("Found a route which matches " + req.uri()
            .getPath());
          return req;
      })
      .build();
}

同樣，我們也可以在請求處理完成後，使用 route() 方法中的 after() 方法添加一個簡單的日誌語句：

@Bean
RouterFunction<ServerResponse> allApplicationRoutes(ProductController pc, ProductService ps) {
    return route()...
      .after((req, res) -> {
          if (res.statusCode() == HttpStatus.OK) {
              LOG.info("Finished processing request " + req.uri()
                  .getPath());
          } else {
              LOG.info("There was an error while processing request" + req.uri());
          }
          return res;
      })          
      .build();
    }

8. 結論

在本教程中，我們首先對使用函數式方法定義控制器進行了簡要介紹。然後，我們比較了 Spring MVC 註解與其函數式等效項。

接下來，我們實現了使用函數式控制器的簡單 Web 服務，該服務返回產品列表。

然後，我們繼續實現 Web 服務控制器的常見用例，包括嵌套路由、錯誤處理、添加訪問控制過濾器以及管理諸如日誌記錄等橫切關注點。