常用請(qǐng)求參數(shù)注解使用

路徑變量@PathVariable

@RestController
public class ParameterTestController {

    /**
     * 測(cè)試 @PathVariable 注解
     */
    @GetMapping("/car/{carId}/owner/{userName}")
    public Map<String, Object> getCar(@PathVariable("carId") Integer carId,
                                      @PathVariable("userName") String userName,
                                      @PathVariable Map<String, String> allPathVariable) {

        HashMap<String, Object> map = new HashMap<>();
        map.put("carId", carId);
        map.put("userName", userName);
        map.put("allPathVariable", allPathVariable);

        return map;
    }
}
  • 路徑映射注解中用{}包裹的變量會(huì)與方法的參數(shù)中用了@PathVariable注解的變量對(duì)應(yīng)舟扎,然后在方法中就可以直接去使用路徑變量了

  • 查看@PathVariable注解的源碼注釋如下

    If the method parameter is Map<String, String> then the map is populated with all path variable names and values.
    

    也就是說(shuō)惧财,如果方法的參數(shù)中有一個(gè)Map<String, String>類型的參數(shù)的話趾诗,這個(gè)參數(shù)會(huì)被自動(dòng)裝配,內(nèi)容就是所有的路徑變量的key和value

訪問(wèn)結(jié)果

測(cè)試路徑變量注解 -- @PathVariable

獲取請(qǐng)求頭@RequestHeader

/**
  * 測(cè)試 @RequestHeader 注解
*/
@GetMapping("/get-header")
public Map<String, Object> getHeaders(@RequestHeader("User-Agent") String userAgent,
                                      @RequestHeader MultiValueMap<String, String> multiValueMap,
                                      @RequestHeader HttpHeaders httpHeaders) {
    HashMap<String, Object> map = new HashMap<>();

    map.put("userAgent", userAgent);
    map.put("multiValueMap", multiValueMap);
    map.put("httpHeaders", httpHeaders);

    return map;
}
  • 類似地,該注解源碼注釋中有提到

    If the method parameter is Map<String, String>, MultiValueMap<String, String>, or HttpHeaders then the map is populated with all header names and values.
    

    所以這里測(cè)試的時(shí)候添加了三個(gè)參數(shù),分別是Map<String, String>類型素邪、MultiValueMap<String, String>類型和HttpHeaders類型的參數(shù),然后返回給瀏覽器后查看是否真的自動(dòng)裝配了所有的headers

測(cè)試結(jié)果

測(cè)試獲取請(qǐng)求頭注解 -- @RequestHeader

獲取請(qǐng)求參數(shù)@RequestParam

/**
 * 測(cè)試 @RequestParam 注解
 */
@GetMapping("/get-request-param")
public Map<String, Object> getRequestParam(@RequestParam("username") String userName,
                                           @RequestParam Map<String, String> commonMap,
                                           @RequestParam MultiValueMap<String, String> multiValueMap) {

    HashMap<String, Object> map = new HashMap<>();
    map.put("username", userName);
    map.put("commonMap", commonMap);
    map.put("multiValueMap", multiValueMap);

    return map;
}
  • 與前兩個(gè)注解類似

    If the method parameter is Map<String, String> or MultiValueMap<String, String> and a parameter name is not specified, then the map parameter is populated with all request parameter names and values.
    

測(cè)試結(jié)果

測(cè)試獲取請(qǐng)求參數(shù)注解 -- @RequestParam

獲取cookie值@CookieValue

/**
 * 測(cè)試 @CookieValue 注解
 */
@GetMapping("/get-cookie-value")
public Map<String, Object> getCookieValue(@CookieValue("csrftoken") String csrfToken,
                                          @CookieValue("csrftoken") Cookie csrfTokenCookie) {

    HashMap<String, Object> map = new HashMap<>();
    map.put("csrftoken-string", csrfToken);
    map.put("csrftoken-cookie-obj", csrfTokenCookie);
    String info = csrfTokenCookie.getName() + " ===> " + csrfTokenCookie.getValue();
    map.put("csrftoken-cookie-obj-info", info);

    return map;
}
  • 官方文檔注釋中提到

    The method parameter may be declared as type javax.servlet.http.Cookie or as cookie value type (String, int, etc.).
    

    也就是說(shuō)參數(shù)中可以接收一個(gè)java原生的servlet Cookie對(duì)象

測(cè)試結(jié)果

測(cè)試獲取cookie值注解 -- @CookieValue

獲取請(qǐng)求體@RequestBody

  • 對(duì)于POST猪半、PUT兔朦、PATCH等有請(qǐng)求體的請(qǐng)求,要獲取請(qǐng)求體的數(shù)據(jù)磨确,就用該注解
/**
 * 測(cè)試 @RequestBody 注解
 */
@PostMapping("/post-request-body")
public Map<String, Object> getRequestBody(@RequestBody String requestBody) {

    HashMap<String, Object> map = new HashMap<>();
    map.put("requestBody", requestBody);

    return map;
}

測(cè)試結(jié)果

請(qǐng)求表單
請(qǐng)求結(jié)果

獲取request請(qǐng)求域@RequestAttribute

  • 使用模板語(yǔ)言的時(shí)候才會(huì)用到這個(gè)沽甥,前后端分離的話就用不上
  • 可以獲取原生HttpServletRequestsetAttribute方法設(shè)置的屬性
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市乏奥,隨后出現(xiàn)的幾起案子摆舟,更是在濱河造成了極大的恐慌,老刑警劉巖英融,帶你破解...
    沈念sama閱讀 218,682評(píng)論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件盏檐,死亡現(xiàn)場(chǎng)離奇詭異歇式,居然都是意外死亡驶悟,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,277評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門材失,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)痕鳍,“玉大人,你說(shuō)我怎么就攤上這事龙巨×簦” “怎么了?”我有些...
    開(kāi)封第一講書人閱讀 165,083評(píng)論 0 355
  • 文/不壞的土叔 我叫張陵旨别,是天一觀的道長(zhǎng)诗赌。 經(jīng)常有香客問(wèn)我,道長(zhǎng)秸弛,這世上最難降的妖魔是什么铭若? 我笑而不...
    開(kāi)封第一講書人閱讀 58,763評(píng)論 1 295
  • 正文 為了忘掉前任洪碳,我火速辦了婚禮,結(jié)果婚禮上叼屠,老公的妹妹穿的比我還像新娘瞳腌。我一直安慰自己,他們只是感情好镜雨,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,785評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布嫂侍。 她就那樣靜靜地躺著,像睡著了一般荚坞。 火紅的嫁衣襯著肌膚如雪挑宠。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書人閱讀 51,624評(píng)論 1 305
  • 那天颓影,我揣著相機(jī)與錄音痹栖,去河邊找鬼。 笑死瞭空,一個(gè)胖子當(dāng)著我的面吹牛揪阿,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播咆畏,決...
    沈念sama閱讀 40,358評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼南捂,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了旧找?” 一聲冷哼從身側(cè)響起溺健,我...
    開(kāi)封第一講書人閱讀 39,261評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎钮蛛,沒(méi)想到半個(gè)月后鞭缭,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,722評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡魏颓,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評(píng)論 3 336
  • 正文 我和宋清朗相戀三年岭辣,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片甸饱。...
    茶點(diǎn)故事閱讀 40,030評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡沦童,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出叹话,到底是詐尸還是另有隱情偷遗,我是刑警寧澤,帶...
    沈念sama閱讀 35,737評(píng)論 5 346
  • 正文 年R本政府宣布驼壶,位于F島的核電站氏豌,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏热凹。R本人自食惡果不足惜泵喘,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,360評(píng)論 3 330
  • 文/蒙蒙 一瞭吃、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧涣旨,春花似錦歪架、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 31,941評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至烹棉,卻和暖如春攒霹,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背浆洗。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 33,057評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工催束, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人伏社。 一個(gè)月前我還...
    沈念sama閱讀 48,237評(píng)論 3 371
  • 正文 我出身青樓抠刺,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親摘昌。 傳聞我的和親對(duì)象是個(gè)殘疾皇子速妖,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,976評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容