SpringMVC--常用注解
RequestParam
使用说明
作用：
把请求中指定名称的参数给控制器中的形参赋值。
属性：
- value： 请求参数中的名称。
- required：请求参数中是否必须提供此参数。 默认值： true。表示必须提供，如果不提供将报错
使用示例
jsp 中的代码：
<!-- requestParams 注解的使用 -->
<a href="springmvc/useRequestParam?name=test">requestParam 注解</a>
控制器中的代码：
/** * requestParams 注解的使用 * @param username * @return * */
@RequestMapping("/useRequestParam")
public String useRequestParam(@RequestParam("name")String username,
@RequestParam(value="age",required=false)Integer age){
System.out.println(username+","+age);
return "success";
}
运行结果：
RequestBody
使用说明
作用：
- 用于获取请求体内容。 直接使用得到是 key=value&key=value…结构的数据。
- get 请求方式不适用。
属性： - required：是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false， get 请求得到是 null。
使用示例
- post 请求 jsp 代码：
<!-- request body 注解 -->
<form action="springmvc/useRequestBody" method="post">
用户名称： <input type="text" name="username" ><br/>
用户密码： <input type="password" name="password" ><br/>
用户年龄： <input type="text" name="age" ><br/>
<input type="submit" value="保存">
</form>
- get 请求 jsp 代码：
<a href="springmvc/useRequestBody?body=test">requestBody 注解 get 请求</a>
- 控制器代码：
/** * RequestBody 注解 * @param user * @return */
@RequestMapping("/useRequestBody")
public String useRequestBody(@RequestBody(required=false) String body){
System.out.println(body);
return "success";
}
- post 请求运行结果：
- get 请求运行结果：
PathVaribale
使用说明
作用：
- 用于绑定 url 中的占位符。 例如：请求 url 中 /delete/{id}， 这个{id}就是 url 占位符。
- url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。
属性： - value： 用于指定 url 中占位符名称。
- required：是否必须提供占位符
使用示例
- jsp 代码：
<!-- PathVariable 注解 -->
<a href="springmvc/usePathVariable/100">pathVariable 注解</a>
- 控制器代码：
/** * PathVariable 注解 * @param user * * @return */
@RequestMapping("/usePathVariable/{id}")
public String usePathVariable(@PathVariable("id") Integer id){
System.out.println(id);
return "success";
}
- 运行结果：
基于 HiddentHttpMethodFilter 的示例
作用：
- 由于浏览器 form 表单只支持 GET 与 POST 请求，而 DELETE、 PUT 等 method 并不支持， Spring3.0 添加了一个过滤器，可以将浏览器请求改为指定的请求方式，发送给我们的控制器方法，使得支持 GET、 POST、 PUT与 DELETE 请求。
使用方法：
- 第一步：在 web.xml 中配置该过滤器。
- 第二步：请求方式必须使用 post 请求。
- 第三步：按照要求提供_method 请求参数，该参数的取值就是我们需要的请求方式。
源码分析
<!-- 保存 -->
<form action="springmvc/testRestPOST" method="post">
用户名称： <input type="text" name="username"><br/>
<!-- <input type="hidden" name="_method" value="POST"> -->
<input type="submit" value="保存">
</form>
<hr/>
<!-- 更新 -->
<form action="springmvc/testRestPUT/1" method="post">
用户名称： <input type="text" name="username"><br/>
<input type="hidden" name="_method" value="PUT">
<input type="submit" value="更新">
</form>
<hr/>
<!-- 删除 -->
<form action="springmvc/testRestDELETE/1" method="post">
<input type="hidden" name="_method" value="DELETE">
<input type="submit" value="删除">
</form>
<hr/>
<!-- 查询一个 -->
<form action="springmvc/testRestGET/1" method="post">
<input type="hidden" name="_method" value="GET">
<input type="submit" value="查询">
</form>
- 控制器中示例代码：
/** * post 请求：保存 * @return */
@RequestMapping(value="/testRestPOST",method=RequestMethod.POST)
public String testRestfulURLPOST(User user){
System.out.println("rest post"+user);
return "success";
}
/** * put 请求：更新 * @return */
@RequestMapping(value="/testRestPUT/{id}",method=RequestMethod.PUT)
public String testRestfulURLPUT(@PathVariable("id")Integer id,User user){
System.out.println("rest put "+id+","+user);
return "success";
}
/** * post 请求：删除 * @return */
@RequestMapping(value="/testRestDELETE/{id}",method= RequestMethod.DELETE)
public String testRestfulURLDELETE(@PathVariable("id")Integer id){
System.out.println("rest delete "+id);
return "success";
}
/** * post 请求：查询 * @return */
@RequestMapping(value="/testRestGET/{id}",method=RequestMethod.GET)
public String testRestfulURLGET(@PathVariable("id")Integer id){
System.out.println("rest get "+id);
return "success";
}
- 运行结果：
RequestHeader
使用说明
作用：
- 用于获取请求消息头。
属性：
- value：提供消息头名称
- required：是否必须有此消息头
注： 在实际开发中一般不怎么用。
使用示例
- jsp 中代码：
<!-- RequestHeader 注解 -->
<a href="springmvc/useRequestHeader">获取请求消息头</a>
控制器中代码：
/** * RequestHeader 注解 * @param user * @return */
@RequestMapping("/useRequestHeader")
public String useRequestHeader(@RequestHeader(value="Accept-Language",
required=false)String requestHeader){
System.out.println(requestHeader);
return "success";
}
- 运行结果：
CookieValue
作用：
- 用于把指定 cookie 名称的值传入控制器方法参数。
属性：
- value：指定 cookie 的名称。
- required：是否必须有此 cookie。
使用示例
- jsp 中的代码：
<!-- CookieValue 注解 -->
<a href="springmvc/useCookieValue">绑定 cookie 的值</a>
- 控制器中的代码：
/** * Cookie 注解注解 * @param user * @return */
@RequestMapping("/useCookieValue")
public String useCookieValue(@CookieValue(value="JSESSIONID",required=false)
String cookieValue){
System.out.println(cookieValue);
return "success";
}
- 运行结果：
ModelAttribute
作用：
- 该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。
出现在方法上，表示当前方***在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可以修饰有具体返回值的方法。出现在参数上，获取指定的数据给参数赋值。
属性：
- value：用于获取数据的 key。 key 可以是 POJO 的属性名称，也可以是 map 结构的 key。
应用场景：
-
当表单提交数据不是完整的实体类数据时，保证没有提交数据的字段使用数据库对象原来的数据。
-
例如：
我们在编辑一个用户时，用户有一个创建信息字段，该字段的值是不允许被修改的。在提交表单数
据是肯定没有此字段的内容，一旦更新会把该字段内容置为 null，此时就可以使用此注解解决问题。
使用示例 ----基于 POJO 属性的基本使用
- jps 代码：
<!-- ModelAttribute 注解的基本使用 -->
<a href="springmvc/testModelAttribute?username=test">测试 modelattribute</a>
- 控制器代码：
/** * 被 ModelAttribute 修饰的方法 * @param user */
@ModelAttribute
public void showModel(User user) {
System.out.println("执行了 showModel 方法"+user.getUsername());
}
/** * 接收请求的方法 * @param user * @return */
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user) {
System.out.println("执行了控制器的方法"+user.getUsername());
return "success";
}
- 运行结果：
SessionAttribute
使用说明
作用：
- 用于多次执行控制器方法间的参数共享。
属性：
- value：用于指定存入的属性名称
- type：用于指定存入的数据类型。
使用示例
- jsp 中的代码：
<!-- SessionAttribute 注解的使用 -->
<a href="springmvc/testPut">存入 SessionAttribute</a>
<hr/>
<a href="springmvc/testGet">取出 SessionAttribute</a>
<hr/>
<a href="springmvc/testClean">清除 SessionAttribute</a>
- 控制器中的代码：
@Controller("sessionAttributeController")
@RequestMapping("/springmvc")
@SessionAttributes(value ={"username","password"},types={Integer.class})
public class SessionAttributeController {
/** * 把数据存入 SessionAttribute * @param model * @return * Model 是 spring 提供的一个接口，该接口有一个实现类 ExtendedModelMap * 该类继承了 ModelMap，而 ModelMap 就是 LinkedHashMap 子类 */
@RequestMapping("/testPut")
public String testPut(Model model){
model.addAttribute("username", "泰斯特");
model.addAttribute("password","123456");
model.addAttribute("age", 31);
//跳转之前将数据保存到 username、 password 和 age 中，因为注解@SessionAttribute 中有 这几个参数
return "success";
}
@RequestMapping("/testGet")
public String testGet(ModelMap model){
System.out.println(model.get("username")+";"+model.get("password")+";"+model.get("age"));
return "success";
}
@RequestMapping("/testClean")
public String complete(SessionStatus sessionStatus){
sessionStatus.setComplete();
return "success";
}
}
- 运行结果：
