赞!SpringMVC中常用注解(案例讲解)

 

SpringMVC中常用注解

  • RequestParam
  • RequestBody
  • PathVaribale
    • 先了解下REST 风格 URL
  • RequestHeader
  • CookieValue
  • ModelAttribute
    • 修饰的方法有返回值
    • 修饰的方法没有返回值
  • SessionAttribute

RequestParam

说明

作用:
把请求中指定名称的参数给控制器中的形参赋值。
属性:
value:请求参数中的名称。
required:请求参数中是否必须提供此参数。默认值:true。表示必须提供,如果不提供将报错。

代码示例

jsp代码:

	
  1. <%--
  2. Created by IntelliJ IDEA.
  3. User: Keafmd
  4. Date: 2021/1/25
  5. Time: 10:48
  6. To change this template use File | Settings | File Templates.
  7. --%>
  8. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
  9. <html>
  10. <head>
  11. <title>常用注解</title>
  12. </head>
  13. <body>
  14. <!-- requestParams 注解的使用 -->
  15. <a href="anno/testRequestParam?name=keafmd">RequestParam</a><br/>
  16. </body>
  17. </html>
  18. 12345678910111213141516171819

控制器代码:

	
  1. package com.Keafmd.controller;
  2. import com.Keafmd.domain.User;
  3. import org.springframework.stereotype.Controller;
  4. import org.springframework.ui.Model;
  5. import org.springframework.ui.ModelMap;
  6. import org.springframework.web.bind.annotation.*;
  7. import org.springframework.web.bind.support.SessionStatus;
  8. import java.util.Date;
  9. import java.util.Map;
  10. /**
  11. * Keafmd
  12. *
  13. * @ClassName: AnnoConteoller
  14. * @Description: 注解的控制器
  15. * @author: 牛哄哄的柯南
  16. * @date: 2021-01-25 10:50
  17. */
  18. @Controller
  19. @RequestMapping("/anno")
  20. public class AnnoConteoller {
  21. /**
  22. * requestParams 注解的使用
  23. * @param username
  24. * @return
  25. */
  26. @RequestMapping("/testRequestParam")
  27. public String testRequestParam(@RequestParam(value="name") String username){
  28. // @RequestParam(value="name") 必须传name,required:请求参数中是否必须提供此参数,默认值是true,必须提供
  29. // 获得当前类名
  30. String clazz = Thread.currentThread().getStackTrace()[1].getClassName();
  31. // 获得当前方法名
  32. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  33. System.out.println("执行了:"+clazz+" - "+method);
  34. System.out.println("username:"+username);
  35. return "success";
  36. }
  37. }
  38. 12345678910111213141516171819202122232425262728293031323334353637383940414243

输出结果:

	
  1. 执行了:com.Keafmd.controller.AnnoConteoller - testRequestParam
  2. username:keafmd
  3. 12

这样我们在href中传入name就会赋值给username。

RequestBody

说明

作用:
用于获取请求体内容。直接使用得到是 key=value&key=value…结构的数据。
get 请求方式不适用。
属性:
required:是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false,get 请求得到是 null。

代码示例

jsp代码:

	
  1. <form action="anno/testRequestBody" method="post">
  2. 用户姓名:<input type="text" name="uname" /><br/>
  3. 用户年龄:<input type="text" name="age" /><br/>
  4. 用户生日:<input type="text" name="birthday" /><br/>
  5. <input type="submit" value="提交">
  6. </form>
  7. 123456

控制器代码:

	
  1. /**
  2. * 获取到请求体的内容 RequestBody
  3. */
  4. @RequestMapping("/testRequestBody")
  5. public String testRequestBody(@RequestBody String body){
  6. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  7. System.out.println("执行了:"+" "+method);
  8. System.out.println("body:"+body);
  9. return "success";
  10. }
  11. 1234567891011

输出结果:

	
  1. 执行了: testRequestBody
  2. body:uname=Keafmd&age=21&birthday=2000-01-01
  3. 12

PathVaribale

先了解下REST 风格 URL

REST(英文:Representational State Transfer,简称 REST)描述了一个架构样式的网络系统,比如 web 应用程序。值得注意的是 REST 并没有一个明确的标准,而更像是一种设计的风格。

说明

作用:
用于绑定 url 中的占位符。例如:请求 url 中 /delete/{id},这个{id}就是 url 占位符。
url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。
属性:
value:用于指定 url 中占位符名称。
required:是否必须提供占位符。

代码示例

jsp代码:

	
  1. <a href="anno/testPathVariable/10">testPathVariable</a><br/>
  2. 1

控制器代码:

	
  1. /**
  2. * PathVariable
  3. * @param id
  4. * @return
  5. */
  6. @RequestMapping("/testPathVariable/{sid}")
  7. public String testPathVariable(@PathVariable(name="sid") String id){
  8. // 获得当前方法名
  9. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  10. System.out.println("执行了:"+" "+method);
  11. System.out.println("id:"+id);
  12. return "success";
  13. }
  14. 12345678910111213

输出结果:

	
  1. 执行了: testPathVariable
  2. id:10
  3. 12

RequestHeader

说明

作用:
用于获取请求消息头。
属性:
value:提供消息头名称
required:是否必须有此消息头
提示:
在实际开发中一般不常用

代码示例

jsp代码:

	
  1. <a href="anno/testRequestHeader">testRequestHeader</a><br/>
  2. 1

控制器代码:

	
  1. /**
  2. * RequestHeader获取请求头的值 不常用
  3. * @param head
  4. * @return
  5. */
  6. @RequestMapping("/testRequestHeader")
  7. public String testRequestHeader(@RequestHeader(value = "Accept") String head){
  8. // 获得当前方法名
  9. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  10. System.out.println("执行了:"+" "+method);
  11. System.out.println("head:"+head);
  12. return "success";
  13. }
  14. 1234567891011121314

输出结果:

	
  1. 执行了: testRequestHeader
  2. head:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3
  3. 12

CookieValue

说明

作用:
用于把指定 cookie 名称的值传入控制器方法参数。
属性:
value:指定 cookie 的名称。
required:是否必须有此 cookie。

代码示例

jsp代码:

	
  1. <a href="anno/testCookieValue">testCookValue</a><br/>
  2. 1

控制器代码:

	
  1. /**
  2. * CookieValue 不常用
  3. * @param cookievalue
  4. * @return
  5. */
  6. @RequestMapping("/testCookieValue")
  7. public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookievalue){
  8. // 获得当前方法名
  9. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  10. System.out.println("执行了:"+" "+method);
  11. System.out.println("cookievalue:"+cookievalue);
  12. return "success";
  13. }
  14. 1234567891011121314

输出结果:

	
  1. 执行了: testCookieValue
  2. cookievalue:DCCFE2C1F975AC04D4F55973ADA5C89C
  3. 12

ModelAttribute

说明

作用:
该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。
出现在方法上,表示当前方***在控制器的方法执行之前,先执行。它可以修饰没有返回值的方法,也可以修饰有具体返回值的方法。
出现在参数上,获取指定的数据给参数赋值。
属性:
value:用于获取数据的 key。key 可以是 POJO 的属性名称,也可以是 map 结构的 key。
应用场景:
当表单提交数据不是完整的实体类数据时,保证没有提交数据的字段使用数据库对象原来的数据。

代码示例

jsp代码:

	
  1. <form action="anno/testModelAttribute" method="post">
  2.     用户姓名:<input type="text" name="uname" /><br/>
  3. 用户年龄:<input type="text" name="age" /><br/>
  4. <input type="submit" value="提交">
  5. </form>
  6. 12345

修饰的方法有返回值

控制器代码:

	
  1. /**
  2. * ModelAttribute
  3. * @return
  4. */
  5. @RequestMapping("/testModelAttribute")
  6. public String testModelAttribute(User user){
  7. // 获得当前方法名
  8. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  9. System.out.println("执行了:"+" "+method);
  10. System.out.println(user);
  11. return "success";
  12. }
  13. //有返回值
  14. @ModelAttribute
  15. public User showUser(String uname){
  16. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  17. System.out.println("执行了:"+" "+method);
  18. User user = new User();
  19. user.setUname(uname);
  20. user.setAge(20);
  21. user.setBirthday(new Date());
  22. return user;
  23. }
  24. 12345678910111213141516171819202122232425

输出结果:

	
  1. 执行了: testModelAttribute
  2. User{uname='牛哄哄的柯南', age=21, birthday=Mon Jan 25 19:34:46 CST 2021}
  3. 12

修饰的方法没有返回值

注意:没有返回值的时候利用Map把参数传回去,testModelAttribute的参数User前加上@ModelAttribute(“abc”)接收Map传回的数据。

控制器代码:

	
  1. /**
  2. * ModelAttribute
  3. * @return
  4. */
  5. @RequestMapping("/testModelAttribute")
  6. public String testModelAttribute(@ModelAttribute("abc")User user){
  7. // 获得当前方法名
  8. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  9. System.out.println("执行了:"+" "+method);
  10. System.out.println(user);
  11. return "success";
  12. }
  13. //无返回值
  14. @ModelAttribute
  15. public void showUser(String uname, Map<String,User> map){
  16. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  17. System.out.println("执行了:"+" "+method);
  18. User user = new User();
  19. user.setUname(uname);
  20. user.setAge(20);
  21. user.setBirthday(new Date());
  22. map.put("abc",user);
  23. }
  24. 12345678910111213141516171819202122232425

输出结果:

	
  1. 执行了: testModelAttribute
  2. User{uname='牛哄哄的柯南', age=21, birthday=Mon Jan 25 19:32:20 CST 2021}
  3. 12

SessionAttribute

说明

作用:
用于多次执行控制器方法间的参数共享。
属性:
value:用于指定存入的属性名称
type:用于指定存入的数据类型。

代码示例

jsp代码:

	
  1. <a href="anno/testSessionAttributes">存入SessionAttributes</a><br/>
  2. <a href="anno/getSessionAttributes">获取SessionAttributes</a><br/>
  3. <a href="anno/delSessionAttributes">清除SessionAttributes</a><br/>
  4. 123

控制器代码:

注意:需要在类的上面添加@SessionAttributes(value = {"msg"}) //把msg=牛哄哄的柯南存到session域中。

	
  1. package com.Keafmd.controller;
  2. import com.Keafmd.domain.User;
  3. import org.springframework.stereotype.Controller;
  4. import org.springframework.ui.Model;
  5. import org.springframework.ui.ModelMap;
  6. import org.springframework.web.bind.annotation.*;
  7. import org.springframework.web.bind.support.SessionStatus;
  8. import java.util.Date;
  9. import java.util.Map;
  10. /**
  11. * Keafmd
  12. *
  13. * @ClassName: AnnoConteoller
  14. * @Description: 注解的控制器
  15. * @author: 牛哄哄的柯南
  16. * @date: 2021-01-25 10:50
  17. */
  18. @Controller
  19. @RequestMapping("/anno")
  20. @SessionAttributes(value = {"msg"}) //把msg=牛哄哄的柯南存到session域中
  21. public class AnnoConteoller {
  22. /**
  23. * SessionAttributes注解,存入msg
  24. * @return
  25. */
  26. @RequestMapping("/testSessionAttributes")
  27. public String testSessionAttributes(Model model){
  28. // 获得当前方法名
  29. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  30. System.out.println("执行了:"+" "+method);
  31. //底层会存到Request域中
  32. model.addAttribute("msg","牛哄哄的柯南");
  33. return "success";
  34. }
  35. /**
  36. * 获取
  37. * @param modelMap
  38. * @return
  39. */
  40. @RequestMapping("/getSessionAttributes")
  41. public String getSessionAttributes(ModelMap modelMap){
  42. // 获得当前方法名
  43. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  44. System.out.println("执行了:"+" "+method);
  45. //从session域中取出来
  46. String msg = (String)modelMap.get("msg");
  47. System.out.println(msg);
  48. return "success";
  49. }
  50. /**
  51. * 清除
  52. * @param sessionStatus
  53. * @return
  54. */
  55. @RequestMapping("/delSessionAttributes")
  56. public String delSessionAttributes(SessionStatus sessionStatus) {
  57. // 获得当前方法名
  58. String method = Thread.currentThread().getStackTrace()[1].getMethodName();
  59. System.out.println("执行了:"+" "+method);
  60. //从session域中清除
  61. sessionStatus.setComplete();
  62. return "success";
  63. }
  64. }
  65. 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677

依次点击存入->获取->清除->获取。

输出结果:

	
  1. 执行了: testSessionAttributes
  2. 执行了: getSessionAttributes
  3. 牛哄哄的柯南
  4. 执行了: delSessionAttributes
  5. 执行了: getSessionAttributes
  6. null
  7. 123456

在success.jsp可以通过${msg}和${sessionScope}获取到在类上面把msg存入到session域的内容:牛哄哄的柯南和{msg=牛哄哄的柯南}
在success.jsp可以通过${requestScope}获取到在testSessionAttributes方法中存入Request域中的内容。

以上就是SpringMVC中常用注解(案例讲解)的全部内容。

点点关注!

看完记得点赞+评论+转发哦~

全部评论

相关推荐

点赞 评论 收藏
转发
点赞 收藏 评论
分享
牛客网
牛客企业服务