Spring?MVC中的常用注解及用法小結(jié)
一、建立連接
@RequestMappering可以作用在類上(類注解)、也可以作用在方法上(方法注解)。
@RequestMappering后面的括號(hào)中:雙引號(hào)的值會(huì)賦值給value這個(gè)屬性。只有一個(gè)屬性且屬性名為value時(shí)這個(gè)屬性名可以省略不寫。
@RequestMappering默認(rèn)支持get/post請(qǐng)求,可以使用method屬性來(lái)限制請(qǐng)求方式。
@RequestMapping(value = "/hello/t1", method = RequestMethod.GET) public String hello(){ return "hello"; }
二、接收請(qǐng)求
2.1請(qǐng)求中帶有一個(gè)參數(shù)
@RequestMapping("/r1") public String r1(String name){ return "接收到參數(shù) name:"+name; } @RequestMapping("/r2") public String r2(Integer age){ return "接收到參數(shù) age:"+age; }
2.2請(qǐng)求中帶有多個(gè)參數(shù)
@RequestMapping("/r3") public String r3(String name,Integer age){//注意參數(shù)類型要寫Integer不要寫int,因?yàn)檎?qǐng)求中沒(méi)有傳參數(shù)時(shí)則傳的參數(shù)是null,int類型的變量不能接收null return "name:"+name+",age:"+age; }
2.3用對(duì)象接收請(qǐng)求中的參數(shù)
public class UserInfo {//假設(shè)代碼中定義了UserInfo類 private int id; private String name; private Integer age; public UserInfo() { } public UserInfo(int id, String name, Integer age) { this.id = id; this.name = name; this.age = age; } public int getId() { return id; } ... }
@RequestMapping("/r4") public String r4(UserInfo user){ return user.toString(); }
2.4對(duì)請(qǐng)求中的參數(shù)進(jìn)行重命名
從請(qǐng)求中獲取name參數(shù)的值并賦值給代碼中的username參數(shù)。@RequestParam注解里加required = false則表示這個(gè)注解修飾的參數(shù)可以不傳(否則這個(gè)注解修飾的參數(shù)一定要傳),不傳時(shí)這個(gè)參數(shù)的值為null。required默認(rèn)為true。
@RequestMapping("/r5") public String r5(@RequestParam(value = "name",required = false) String username, @RequestParam("age") Integer userage){ return "username:"+username+",age:"+userage; }
2.5請(qǐng)求參數(shù)中帶有數(shù)組
@RequestMapping("/r6") public String r6(String[] arr){ return Arrays.toString(arr)+",length:"+arr.length; }
2.6請(qǐng)求參數(shù)中帶有集合
默認(rèn)情況下,請(qǐng)求中參數(shù)名相同的多個(gè)值,是封裝到數(shù)組中的。如果要封裝到集合,要使?@RequestParam綁定參數(shù)關(guān)系。
以下為綁定參數(shù)關(guān)系的同時(shí)對(duì)參數(shù)中的集合名進(jìn)行重命名:
@RequestMapping("/r7") public String r7(@RequestParam(value = "list", required = false) List<String> list1){ if (list1!=null){ return list1.toString()+",size:"+list1.size(); } return "list為空"; }
2.7json字符串和Java對(duì)象互轉(zhuǎn)
以下這種轉(zhuǎn)換方式:拿到j(luò)son字符串把這個(gè)json字符串轉(zhuǎn)換為java對(duì)象的時(shí)候,會(huì)調(diào)用java對(duì)象無(wú)參的構(gòu)造函數(shù)構(gòu)造成一個(gè)空的對(duì)象,再對(duì)字符串進(jìn)行解析對(duì)空對(duì)象的屬性進(jìn)行賦值。所以java對(duì)象所屬的類中如果我們自己寫了有參的構(gòu)造方法則要把無(wú)參的構(gòu)造方法加上。
public static void main(String[] args) throws JsonProcessingException { ObjectMapper objectMapper = new ObjectMapper(); UserInfo userInfo = new UserInfo(); userInfo.setName("lingliang"); userInfo.setAge(16); userInfo.setId(1); //對(duì)象轉(zhuǎn)json String s = objectMapper.writeValueAsString(userInfo); System.out.println(s); //json字符串轉(zhuǎn)成Java對(duì)象 UserInfo userInfo1 = objectMapper.readValue(s, UserInfo.class); System.out.println(userInfo1); }
2.8前端傳遞json數(shù)據(jù)給后端、json數(shù)據(jù)在請(qǐng)求正文中、后端接收json數(shù)據(jù)
@RequestMapping("/r8") public String r8(@RequestBody UserInfo userInfo){ return userInfo.toString(); }
2.9獲取url中的參數(shù)
@RequestMapping("/r9/{articleId}") public String r9(@PathVariable Integer articleId){ return "articleId:"+articleId; }
2.10獲取url中的參數(shù)并對(duì)參數(shù)進(jìn)行重命名
將url中的參數(shù)name重命名為userName:
@RequestMapping("/r10/{name}/{age}") public String r10(@PathVariable("name") String userName, @PathVariable Integer age){ return "name:"+userName+",age:"+age; }
2.11上傳文件
即獲取請(qǐng)求中的文件。@RequestPart這個(gè)注解不寫也行,這個(gè)注解可以對(duì)file進(jìn)行重命名。
@RequestMapping("/r11") public String r11(@RequestPart MultipartFile file) throws IOException { String fileName = file.getOriginalFilename(); file.transferTo(new File("D:/temp/"+fileName)); return "獲取上傳文件: "+file.getOriginalFilename(); }
三、獲取cookie和session
3.1傳統(tǒng)方式獲取cookie(可以獲取到所有的cookie)
@RequestMapping("/getCookie1") public String getCookie(HttpServletRequest request){ Cookie[] cookies = request.getCookies(); //Arrays.stream(cookies).forEach(x -> System.out.println(x.getName()+":"+x.getValue())); if (cookies!=null){ for (Cookie c: cookies){ System.out.println(c.getName()+":"+c.getValue()); } return "獲取Cookie成功"; } return "Cookie 為空"; }
3.2簡(jiǎn)潔方式獲取cookie(可以獲取到指定的cookie)
@RequestMapping("/getCookie2") public String getCookie2(@CookieValue("byte") String byte){ return "byte:" + byte; }
3.3傳統(tǒng)方式設(shè)置session和獲取session
@RequestMapping("/setSession") public String setSession(HttpServletRequest request){ HttpSession session = request.getSession(); session.setAttribute("userName","zhangsan"); return "設(shè)置Session成功"; } @RequestMapping("/getSession1") public String getSession(HttpServletRequest request){ HttpSession session = request.getSession(); String userName = (String)session.getAttribute("userName"); return "登錄用戶:"+ userName; }
3.4簡(jiǎn)潔方式獲取session
簡(jiǎn)潔方式1獲取session:
@RequestMapping("/getSession2") public String getSession(HttpSession session){//如果后端還沒(méi)有session則HttpSession session會(huì)幫我們創(chuàng)建一個(gè)session,只是這個(gè)session里面沒(méi)有內(nèi)容。這預(yù)防了空指針異常的出現(xiàn)。 String userName = (String)session.getAttribute("userName"); return "登錄用戶:" + userName; }
簡(jiǎn)潔方式2獲取session:
@RequestMapping("/getSession3") public String getSession(@SessionAttribute(value = "userName", required = false) String userName){ return "登錄用戶:" + userName; }
四、獲取header
4.1傳統(tǒng)方式獲取header,可以獲取到全部header
@RequestMapping("/getHeader") public String getHeader(HttpServletRequest request){ String userAgent = request.getHeader("User-Agent"); return "userAgent:"+userAgent; }
4.2簡(jiǎn)潔方式獲取header
這種方式想獲取到全部header則參數(shù)聲明要寫得非常長(zhǎng)。
@RequestMapping("/getHeader2") public String getHeader2(@RequestHeader("User-Agent") String userAgent){ return "userAgent:"+userAgent; }
五、返回響應(yīng)
(1)返回靜態(tài)頁(yè)面。
(2)返回?cái)?shù)據(jù)。
(3)返回HTML片段。
(4)返回json。
(5)設(shè)置狀態(tài)碼、編碼方式、header。
元注解(即可以注解到其它注解的注解):
1)@Target({ElementType}.TYPE):表示注解的使用范圍,TYPE表示注解的使用范圍是類。
2)@Retention(RetentionPolicy.RUNTIME):表示注解的生命周期。
3)@Documented。
@RestController=@Controller+@ResponseBody。
@Controller是在告訴Spring,Spring要幫我們管理哪些程序,用@Controller修飾則默認(rèn)返回的是頁(yè)面。
@ResponseBody表示返回?cái)?shù)據(jù),其既可以修飾類又可以修飾方法,修飾類表示該類內(nèi)的所有方法返回的都是數(shù)據(jù),修飾方法表示該方法返回的是數(shù)據(jù)。
@Controller //@RestController @RequestMapping("/return") public class ReturnController { @RequestMapping("/r1") public String r1(){ return "/index.html";//返回靜態(tài)頁(yè)面 } @ResponseBody @RequestMapping("/r2") public String r2(){ return "hello, spring";//返回?cái)?shù)據(jù) } @ResponseBody @RequestMapping("/r3") public String r3(){ return "<h1>我是返回的html片段</h1>";//返回html片段 } @ResponseBody @RequestMapping("/r4") public UserInfo r4(){ UserInfo userInfo = new UserInfo(); userInfo.setId(1); userInfo.setName("lingliang"); userInfo.setAge(16); return userInfo;//返回json。當(dāng)方法返回值類型為對(duì)象的時(shí)候,Spring會(huì)把響應(yīng)的Content-Type自動(dòng)設(shè)置為application/json。當(dāng)返回的是數(shù)據(jù),方法返回值類型為String的時(shí)候,默認(rèn)情況下,Spring會(huì)把響應(yīng)的Content-Type自動(dòng)設(shè)置為text/html。 } @ResponseBody @RequestMapping("/r5") public Map<String,String> r5(){ HashMap map = new HashMap(); map.put("k1","v1"); map.put("k2","v2"); return map;//Spring會(huì)把響應(yīng)的Content-Type自動(dòng)設(shè)置為application/json。 } @RequestMapping("/r6") public String r6(){ return "/a.js";//Spring會(huì)把響應(yīng)的Content-Type自動(dòng)設(shè)置為application/javascript。 } @RequestMapping("/r7") public String r7(){ return "/b.css";//Spring會(huì)把響應(yīng)的Content-Type自動(dòng)設(shè)置為text/css。 } @ResponseBody @RequestMapping("/r8") public String r8(HttpServletResponse response){ response.setStatus(401); return "設(shè)置狀態(tài)碼成功";//設(shè)置狀態(tài)碼。狀態(tài)碼不影響界面的展示。 } @ResponseBody //@RequestMapping("/r9") @RequestMapping(value = "/r9", produces = "application/json; charset=utf8")//設(shè)置響應(yīng)的Content-Type,因?yàn)楫?dāng)返回的是數(shù)據(jù),方法返回值類型為String的時(shí)候,默認(rèn)情況下,Spring會(huì)把響應(yīng)的Content-Type自動(dòng)設(shè)置為text/html。 public String r9(){ return "{\"OK\":1}";//返回的是一個(gè)json數(shù)據(jù)。 } @ResponseBody @RequestMapping(value = "/r10") public String r10(HttpServletResponse response){ response.setHeader("myHeader","myHeaderValue");//設(shè)置自定義的header。 return "設(shè)置header成功"; } }
到此這篇關(guān)于Spring MVC中的常用注解及其用法的文章就介紹到這了,更多相關(guān)Spring MVC常用注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring boot如何通過(guò)@Scheduled實(shí)現(xiàn)定時(shí)任務(wù)及多線程配置
這篇文章主要介紹了Spring boot如何通過(guò)@Scheduled實(shí)現(xiàn)定時(shí)任務(wù)及多線程配置,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-12-12Tomcat 服務(wù)器 在45秒內(nèi)未啟動(dòng)成功的解決方法
下面小編就為大家?guī)?lái)一篇Tomcat 服務(wù)器 在45秒內(nèi)未啟動(dòng)成功的解決方法。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-11-11詳解Java編程中線程同步以及定時(shí)啟動(dòng)線程的方法
這篇文章主要介紹了詳解Java編程中線程同步以及定時(shí)啟動(dòng)線程的方法, 講到了wait()與notify()方法以及阻塞隊(duì)列等知識(shí),需要的朋友可以參考下2016-01-01Java實(shí)現(xiàn)畫圖的詳細(xì)步驟(完整代碼)
今天給大家?guī)?lái)的是關(guān)于Java的相關(guān)知識(shí),文章圍繞著Java實(shí)現(xiàn)畫圖的詳細(xì)步驟展開(kāi),文中有非常詳細(xì)的介紹及代碼示例,需要的朋友可以參考下2021-06-06Calcite使用SQL實(shí)現(xiàn)查詢excel內(nèi)容
因?yàn)閏alcite本身沒(méi)有excel的適配器,?所以本文將模仿calcite-file,?搞一個(gè)calcite-file-excel實(shí)現(xiàn)查詢excel內(nèi)容,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2025-01-01SpringBoot項(xiàng)目整合mybatis的方法步驟與實(shí)例
今天小編就為大家分享一篇關(guān)于SpringBoot項(xiàng)目整合mybatis的方法步驟與實(shí)例,小編覺(jué)得內(nèi)容挺不錯(cuò)的,現(xiàn)在分享給大家,具有很好的參考價(jià)值,需要的朋友一起跟隨小編來(lái)看看吧2019-03-03SpringBoot接口返回結(jié)果封裝方法實(shí)例詳解
在實(shí)際項(xiàng)目中,一般會(huì)把結(jié)果放在一個(gè)封裝類中,封裝類中包含http狀態(tài)值,狀態(tài)消息,以及實(shí)際的數(shù)據(jù)。這里主要記錄兩種方式,通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),需要的朋友參考下吧2021-09-09