Spring MVC
1. SpringMVC 常用注解
1.1 @RequestParam
作用: 把请求中指定名称的参数给控制器中的形参赋值。
属性:
value
: 请求参数中的名称。required
:请求参数中是否必须提供此参数。 默认值:true
。表示必须提供,如果不提供将报错。
JSP文件:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<%-- RequestParam 注解 --%>
<a href="/annotation/testRequestParam?name=tom">RequestParam</a>
</body>
</html>
Java代码:
@RequestMapping("/testRequestParam")
public String testRequestParam(@RequestParam(name = "name") String username){
System.out.println("执行了...");
System.out.println(username);
return "success";
}
1.2 @RequestBody
作用: 用于获取请求体内容。 直接使用得到是 key=value&key=value...
结构的数据。(get
请求方式不适用。)
属性: required
:是否必须有请求体。默认值是:true
。当取值为 true
时,get
请求方式会报错。如果取值为 false
, get
请求得到是 null
。
JSP文件:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<!-- RequestBody 注解 -->
<form action="/annotation/testRequestBody" method="post">
用户名称: <input type="text" name="username" ><br/>
用户年龄: <input type="text" name="age" ><br/>
<input type="submit" value="提交">
</form>
</body>
</html>
Java代码:
/**
* 获取到请求体的内容
* @param body
* @return
*/
@RequestMapping("/testRequestBody")
public String testRequestBody(@RequestBody String body){
System.out.println("执行了...");
System.out.println(body);
return "success";
}
1.3 @PathVaribale
作用:
- 用于绑定
url
中的占位符。 例如:请求url
中/delete/{id}
, 这个{id}
就是url
占位符。 url
支持占位符是spring3.0
之后加入的。是springmvc
支持rest
风格URL
的一个重要标志。
属性:
value
: 用于指定url
中占位符名称。required
:是否必须提供占位符。
JSP文件:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<!-- PathVariable 注解 -->
<a href="/annotation/testPathVariable/6">PathVariable</a>
</body>
</html>
Java代码:
/**
* PathVariable 注解
* @param id
* @return
*/
@RequestMapping("/testPathVariable/{sid}")
public String testPathVariable(@PathVariable(name = "sid") String id){
System.out.println("执行了...");
System.out.println(id);
return "success";
}
1.4 @RequestHeader
作用: 用于获取请求消息头。
属性:
value
:提供消息头名称required
:是否必须有此消息头
注:在实际开发中一般不怎么用。
JSP文件:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<!-- RequestHeader 注解 -->
<a href="/annotation/testRequestHeader">RequestHeader</a>
</body>
</html>
Java代码:
/**
* RequestHeader 注解
* 获取请求头的值
* @param header
* @return
*/
@RequestMapping("/testRequestHeader")
public String testRequestHeader(@RequestHeader(value = "Accept") String header){
System.out.println("执行了...");
System.out.println(header);
return "success";
}
1.5 @CookieValue
作用: 用于把指定 cookie
名称的值传入控制器方法参数。
属性:
value
:指定cookie
的名称。required
:是否必须有此cookie
。
JSP文件:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<!-- CookieValue 注解 -->
<a href="/annotation/testCookieValue">CookieValue</a>
</body>
</html>
Java代码:
/**
* CookieValue 注解
* 获取Cookie的值
* @param cookieValue
* @return
*/
@RequestMapping("/testCookieValue")
public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookieValue){
System.out.println("testCookieValue执行了...");
System.out.println(cookieValue);
return "success";
}
1.6 @ModelAttribute
作用:
- 该注解是
SpringMVC4.3
版本以后新加入的。它可以用于修饰方法和参数。 - 出现在方法上,表示当前方法会在控制器的方法执行之前,先执行。它可以修饰没有返回值的方法,也可以修饰有具体返回值的方法。
- 出现在参数上,获取指定的数据给参数赋值。
属性: value
:用于获取数据的 key
。 key
可以是 POJO
的属性名称,也可以是 map
结构的 key
。
应用场景: 当表单提交数据不是完整的实体类数据时,保证没有提交数据的字段使用数据库对象原来的数据。
例如:我们在编辑一个用户时,用户有一个创建信息字段,该字段的值是不允许被修改的。在提交表单数据是肯定没有此字段的内容,一旦更新会把该字段内容置为 null
,此时就可以使用此注解解决问题。
JSP文件:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<!-- ModelAttribute 注解 -->
<form action="/annotation/testModelAttribute" method="post">
用户名称: <input type="text" name="uname" ><br/>
用户年龄: <input type="text" name="age" ><br/>
<input type="submit" value="提交">
</form>
</body>
</html>
Java代码:
/**
* ModelAttribute 注解
* @return
*/
@RequestMapping("/testModelAttribute")
public String testModelAttribute(@ModelAttribute("user") User user){
System.out.println("testModelAttribute执行了...");
System.out.println(user);
return "success";
}
/**
* 该方法先执行
*/
@ModelAttribute
public void showUser(String uname, Map<String, User> map){
System.out.println("showUser执行了...");
// 通过用户查询数据库(模拟)
User user = new User();
user.setUname(uname);
user.setAge(20);
user.setDate(new Date());
map.put("user",user);
}
1.7 @SessionAttribute
作用: 用于多次执行控制器方法间的参数共享。
属性:
value
:用于指定存入的属性名称。type
:用于指定存入的数据类型。
JSP文件:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<!-- SessionAttribute 注解 -->
<a href="/annotation/testSessionAttributes">SessionAttributes</a>
<br/>
<a href="/annotation/getSessionAttributes">getSessionAttributes</a>
<br/>
<a href="/annotation/deleteSessionAttributes">deleteSessionAttributes</a>
<br/>
</body>
</html>
Java代码:
/**
* SessionAttribute 注解
* @return
*/
@RequestMapping("/testSessionAttributes")
public String testSessionAttribute(Model model){
System.out.println("testSessionAttributes执行了...");
// 底层会存储到request域对象中
model.addAttribute("msg","hello!");
return "success";
}
/**
* 获取值
* @param modelMap
* @return
*/
@RequestMapping("/getSessionAttributes")
public String getSessionAttributes(ModelMap modelMap){
System.out.println("getSessionAttributes执行了...");
// 底层会存储到request域对象中
String msg = (String) modelMap.get("msg");
System.out.println(msg);
return "success";
}
/**
* 清除Session
* @param status
* @return
*/
@RequestMapping("/deleteSessionAttributes")
public String deleteSessionAttributes(SessionStatus status){
System.out.println("deleteSessionAttributes执行了...");
status.setComplete();
return "success";
}
JSP文件:
<%@ page contentType="text/html;charset=UTF-8" language="java" isELIgnored="false" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<h3>入门成功了</h3>
${msg}
${sessionScope}
</body>
</html>