3.3、URI 模板模式（Template Pattern）

caiyongji 發(fā)布于2019-08-14 14:37 / 2762人閱讀

摘要：模板可以很方便地用于訪問一個(gè)方法中的的被選擇的部分。為模板擬定的文檔定義了一個(gè)是怎樣被參數(shù)化的。為了處理注解，需要按名找到匹配模板的變量。在定義模板變量時(shí)，你需要更高的精確度。語法的第一部分定義了變量名，第二部分是一個(gè)正則表達(dá)式。

????這一部分是對 Spring 5 文檔的直接翻譯，連接是這個(gè)。這一部分的示例不再貼代碼，請到這個(gè)項(xiàng)目的 mvc 分支下查看，本篇示例的控制器名稱是 URITemplateController。

????URI 模板可以很方便地用于訪問一個(gè) @RequestMapping 方法中的 URL 的被選擇的部分。
????URI 模板是一個(gè)像URI的字符串，它包含一個(gè)或多個(gè)變量名。當(dāng)你用值來替代這些變量時(shí)，這個(gè)模板就會變成一個(gè) URI。為 URI 模板擬定的 RFC 文檔定義了一個(gè) URI 是怎樣被參數(shù)化的。比如，URI 模板 http://www.example.com/users/{userId} 包含一個(gè)變量 userId。把值 fred 賦到這個(gè)變量中就產(chǎn)生了 http://www.example.com/users/...。
????在 Spring MVC 中，你可是在一個(gè)方法參數(shù)上使用注解 @PathVariable，來把這個(gè)參數(shù)綁定到一個(gè)URI模板變量上：

@GetMapping("/owners/{ownerId}")
public String findOwner(@PathVariable String ownerId, Model model) 
{
    Owner owner = ownerService.findOwner(ownerId);
    model.addAttribute("owner", owner);
    return "displayOwner";
}

????URI 模板 “/owners/{ownerId}” 指定了一個(gè)名叫 ownerId 的變量。當(dāng)控制器處理這個(gè)請求時(shí)，ownerId 的值被設(shè)置為從 URI 中解析出來的合適的部分。比如，當(dāng)請求 /owners/fred 進(jìn)來時(shí)，fred 就是 ownerId 的值。

????為了處理注解 @PathVariable，Spring MVC 需要按名找到匹配URI模板的變量。你可以在這個(gè)注解中指定：

@GetMapping("/owners/{ownerId}")
public String findOwner(@PathVariable("ownerId") String theOwner, Model model) 
{
    // implementation omitted
}

????如果 URI 模板變量名匹配方法參數(shù)名，那么你可以省略詳細(xì)配置。只要你的代碼在編譯時(shí)帶有調(diào)試信息或者在使用 Java 8 編譯時(shí)使用參數(shù) -parameters，Spring MVC 就會匹配方法參數(shù)名到 URI 模板變量名：

@GetMapping("/owners/{ownerId}")
public String findOwner(@PathVariable String ownerId, Model model) 
{
    // implementation omitted
}

????一個(gè)方法可以有任何數(shù)量的注解 @PathVariable：

@GetMapping("/owners/{ownerId}/pets/{petId}")
public String findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) 
{
    Owner owner = ownerService.findOwner(ownerId);
    Pet pet = owner.getPet(petId);
    model.addAttribute("pet", pet);
    return "displayPet";
}

????當(dāng)在一個(gè)Map參數(shù)上使用 @PathVariable 注解時(shí)，這個(gè) Map 會被填上所有的 URI 模板變量。

????一個(gè) URI 模板可以被集成到類和方法級別的@RequestMapping 注解上。方法 findPet() 可以被一個(gè) /owners/42/pets/21 這樣的 URI 調(diào)用。

@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController 
{
    @RequestMapping("/pets/{petId}")
public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) 
{
        // implementation omitted
    }
}

????一個(gè) @PathVariable 參數(shù)可以是任何簡單類型，比如 int，long，Date 等。Spring 自動轉(zhuǎn)換到合適的類型，如果轉(zhuǎn)換失敗，就拋出一個(gè) TypeMismatchException 異常。你也可以注冊自己的數(shù)據(jù)類型轉(zhuǎn)換支持。參見“方法參數(shù)和類型轉(zhuǎn)換”和“自定義 WebDataBinder 初始化”。

????在定義URI模板變量時(shí)，你需要更高的精確度。考慮 URL“/spring-web/spring-web-3.0.5.jar”。你怎么把它分成幾部分呢？
????注解 @RequestMapping 支持在 URI 模板變量中使用正則表達(dá)式。語法 {varName:regex} 的第一部分定義了變量名，第二部分是一個(gè)正則表達(dá)式。例如：

@RequestMapping("/spring-web/{symbolicName:[a-z-]+}-{version:d.d.d}{extension:.[a-z]+}")
public void handle(@PathVariable String version, @PathVariable String extension) 
{
    // ...
}