SpringBoot-@PathVariable


 

URL變量

在上一個博客中,學習了如何在@Controller中創建@RequestMapping(或者響應的簡寫)來處理不同的URL請求。但是在Web應用中URL通常不是一成不變的,例如微博兩個不同用戶的個人主頁對應兩個不同的URL:http://weibo.com/user1,http://weibo.com/user2。我們不能對於每一個用戶都編寫一個被@RequestMapping注解的方法來處理其請求,也就是說,對於相同模式的URL(例如不同用戶的主頁,它們僅僅是URL中的某一部分不同,為他們各自的用戶名,我們說它們具有相同的模式)。

定義URL變量規則

可以在@RequestMapping注解中用{}來表明它的變量部分,例如:

@RequestMapping("/users/{username}")

這里{username}就是我們定義的變量規則,username是變量的名字,那么這個URL路由可以匹配下列任意URL並進行處理:

  • /users/tianmaying
  • /users/ricky
  • users/tmy1234

需要注意的是,在默認情況下,變量中不可以包含URL的分隔符/,例如路由不能匹配/users/tianmaying/ricky,即使你認為tianmaying/ricky是一個存在的用戶名。

獲取URL變量

在路由中定義變量規則后,通常我們需要在處理方法(也就是@RequestMapping注解的方法)中獲取這個URL的具體值,並根據這個值(例如用戶名)做相應的操作,SpringMVC提供的@PathVariable可以幫助我們:

復制代碼
@RequestMapping("/users/{username}")
    @ResponseBody
    public String userProfile(@PathVariable String username){
//        return String.format("user %s", username);
        return "user" + username; 
    }
復制代碼

在上述例子中,當@Controller處理HTTP請求時,userProfile的參數username會自動設置為URL中對應變量username(同名賦值)的值,例如當HTTP請求為/users/fpc

,URL變量username的值fpc會被賦給函數參數username,函數的返回值自然是userfpc。

在默認的情況下,Spring會對@PathVariable注解的變量進行自動賦值,當然你也可以指定@PathVariable使用哪一個URL中的變量:

復制代碼
@RequestMapping("/users/{username}")
    @ResponseBody
    public String userProfile(@PathVariable("username") String username){
//        return String.format("user %s", username);
        return "user" + username; 
    }
復制代碼

運行結果:

 定義多個URL變量

可以定義URL路由,其中包含多個URL變量:

@RequestMapping("/user/{username}/blog/{blogId}")
    @ResponseBody
    public String getUerBlog(@PathVariable String username , @PathVariable int blogId) {
        return "user: " + username + "blog->" + blogId;
    }

這種情況下,Spring能夠根據名字自動賦值對應的函數參數值,當然也可以在@PathVariable中顯示地表明具體的URL變量值。

在默認情況下,@PathVariable注解的參數可以是一些基本的簡單類型:int,long,Date,String等,Spring能根據URL變量的具體值以及函數參數的類型來進行轉換,例如/user/fpc/blog/1,會將“fpc”的值賦給username,而1賦值給int變量blogId。

運行結果:

匹配正則表達式

很多時候,需要對URL變量進行更加精確的定義,例如-用戶名只可能包含小寫字母,數字,下划線,我們希望:

  • /user/fpc是一個合法的URL
  • /user/#$$$則不是一個合法的URL

除了簡單地定義{username}變量,還可以定義正則表達式進行更精確的控制,定義語法是{變量名:正則表達式}[a-zA-Z0-9_]+是一個正則表達式,表示只能包含小寫字母,大寫字母,數字,下划線。如此設置URL變量規則后,不合法的URL則不會被處理,直接由SpringMVC框架返回404Not Found。

@RequestMapping("/user/{username:[a-zA-Z0-9_]+}/blog/{blogId}")

總結

  • 在@RequestMapping注解中定義URL變量規則
  • 在@RequestMapping注解方法中獲取URL變量-@PathVariable
  • @PathVariable指定URL變量名
  • 定義多個URL變量
  • 用正則表達式精確定義URL變量
 
 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM