21.7 URI的組建

Spring MVC提供了一種機制，可以使用UriComponentsBuilder和UriComponents來組建並編碼URI。

       如下例所示，你能擴充套件並編碼一個URI模板的字串:

UriComponents uriComponents =UriComponentsBuilder.fromUriString(
       "http://example.com/hotels/{hotel}/bookings/{booking}").build();
 
URI uri = uriComponents.expand("42", "21").encode().toUri();
 

       注意，UriComponents是不可變的，而expand()和encode()操作，在必要的時候，會返回新的例項。

       你也可以使用獨立的URI元件來擴充套件並編碼URI：

UriComponents uriComponents =UriComponentsBuilder.newInstance()
       .scheme("http").host("example.com").path("/hotels/{hotel}/bookings/{booking}").build()
       .expand("42", "21")
       .encode();

       在Servlet環境下，ServletUriComponentBuilder的子類提供了一個靜態工廠方法，這個方法可以從Servlet請求中，複製有效的URL資訊。如下:

HttpServletRequest request = ...
 
// 重用原request中的host，scheme格式，埠，路徑和查詢引數的字串
// 替換掉"accountId" 的查詢引數值
 
ServletUriComponentsBuilder ucb =ServletUriComponentsBuilder.fromRequest(request)
       .replaceQueryParam("accountId", "{id}").build()
       .expand("123")
       .encode();

       此外，你也可以選擇拷貝可用資訊中的一部分，並追加到context路徑後面:

// 重用host,port(埠)和context路徑
// 把"/accounts"追加到路徑後面
 
ServletUriComponentsBuilder ucb =ServletUriComponentsBuilder.fromContextPath(request)
       .path("/accounts").build()

        或者，在DispatcherServlet已基於名字進行了對映時（比如/main/*這種），你也可以獲得servlet對映所包含的部分值，如下:

// 重用 host, port,context path
// 追加servlet對映到路徑下的部分值
// 追加"/accounts" 到路徑上
 
ServletUriComponentsBuilder ucb =ServletUriComponentsBuilder.fromServletMapping(request)
       .path("/accounts").build()

21.7.1 組建連線到controller和方法的URI

Spring MVC提供了一種機制，能組建連線到controller的方法中的連結，如下例所示:

UriComponents uriComponents = MvcUriComponentsBuilder
   .fromMethodName(BookingController.class, "getBooking", 21).buildAndExpand(42);
 
URI uri = uriComponents.encode().toUri();

       在上面的例子中，我們提供了實際的方法入參值，在此情況下，這個長整形值21會被看作路徑變數來使用，並且把它新增到URL中。此外，我們提供了42這個值，用來填補在URI中剩餘的變數，比如從類級別請求對映中繼承的”hotel”變數。如果在這個方法裡有更多的入參，你能夠為那些URL並不需要的入參設定為null。一般來說，只有@PathVariable和@RequestParam的入參與構建URL相關。

       還有一種額外的方法來使用MvcUriComponentsBuilder。例如：你可以使用某種類似mock測試的技術，這種技術通過代理來避免基於名稱來參考匹配控制器的方法。(下面的例子假設靜態匯入了MvcUriComponentsBuilder.on):

UriComponents uriComponents =MvcUriComponentsBuilder
   .fromMethodCall(on(BookingController.class).getBooking(21)).buildAndExpand(42);
 
URI uri = uriComponents.encode().toUri();

       上面的例子使用MvcUriComponentsBuilder中的靜態方法。在這個方法內部，它們依賴於ServletUriComponentsBuilder來從現存的請求中，根據它的scheme(結構), host, port(埠),context路徑和servlet路徑，準備好URL。再多數情況下，這樣效果很好，但有些情況下，可能會效率低下。例如:你可能會在請求的context的外面(比如:連結準備時的批量處理過程)或者你需要插入一個路徑的字首(例如: 本地字首從請求路徑中被移除了，並且需要重新新增到連結中)。

       在這種情況下，你可以使用靜態的”fromXxx”過載的方法來允許一個UriComponentsBuilder來使用URL。或者，你可以建立一個帶有URL的MvcUriComponentsBuilder的例項，然後使用這個例項的”withXxx”的方法，例如: 

UriComponentsBuilder base = ServletUriComponentsBuilder.fromCurrentContextPath().path("/en");
MvcUriComponentsBuilder builder = MvcUriComponentsBuilder.relativeTo(base);
builder.withMethodCall(on(BookingController.class).getBooking(21)).buildAndExpand(42);
 
URI uri = uriComponents.encode().toUri();

21.7.2 在檢視中組建連線到controller和方法中的URI

       你同樣可以從類似JSP，Thymeleaf, FreeMarker等檢視中，組建連結到註解式controller中。可以通過使用MvcUriComponentsBuilder中的fromMappingName方法來實現，這個方法是基於名字來進行對映的。

       每一個@RequestMapping都被賦予了一個預設名，這個名字預設是類名中的大寫字母加上方法名的全稱。例如，有個方法叫”getFoo”，這個方法在FooController中，那麼這個預設名就是”FC#getFoo”。這種命名的策略還可以通過建立HandlerMethodMappingNamingStrategy的例項，並把這個例項加入進你的RequestMappingHandlerMapping中來進行自定義。這種預設策略的實現，也會在@RequestMapping中的name屬性存在時進行使用。這表示，預設指定的對映名與另一個名字衝突的時候（比如:過載的方法），你可以在@RequestMapping上顯式地為其指定一個名字。

請注意:

       這些被指定了的請求對映名會在啟動時的TRACE級別記錄日誌。

       Spring的JSP標籤庫提供了一個叫做mvcUrl的功能，這個功能能基於它的的機制，來把需要連線到controller方法的連結準備到位。如下例:

@RequestMapping("/people/{id}/addresses")
public class PersonAddressController {
 
    @RequestMapping("/{country}")
    public HttpEntity getAddress(@PathVariable String country) { ... }
}

       你能夠為其準備好一個連結,如下:

<%@ taglib uri="http://www.springframework.org/tags" prefix="s" %>
...
<a href="${s:mvcUrl(''PAC#getAddress'').arg(0,''US'').buildAndExpand(''123'')}">Get Address</a>

       上面的例子中，依賴了在JSP中聲明瞭Spring標籤庫(比如META-INF/spring.tld)的 mvcUrl這個功能。若需處理更多進階的情況(比如在上一節講到過的自定義URL)，為了使用擁有一個自定基礎URL的特定的MvcUriComponentsBuilder例項，來自定義一個功能，或者是使用自定義的標籤檔案，都是很方便的。