SpringMVC（3）常用的注解

RequestParam注解

作用

把请求中指定名称的参数给控制器中的形参赋值

属性

value：请求参数中的名称

required：请求参数中是否提供此参数，默认是true，表示必须提供，不提供就报错。

代码如下

控制器中的代码

@Controller
@RequestMapping("/anno")
public class AnnoController {

    // 把请求中指定名称的参数给控制器中的形参赋值
    @RequestMapping("/testRequestParam")
    public String testRequestParam(@RequestParam(name="name") String username){
        System.out.println(username+",");
        return "success";
    }

}

jsp代码

 <a href="anno/testRequestParam?name=哈哈">testRequestParam</a>

输出结果

请求参数中没有age，由于配置了false，程序正常执行，没有报错。

RequestBody注解

作用

用于获取请求体内容，get 请求方式不适用。

直接使用得到是 key=value&key=value...结构的数据。

属性

required：是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false， get 请求得到是 null。

代码如下

jsp

<%--requestBody注解post请求--%>
    <form action="anno/testRequestBody" method="post">
        姓名：<input type="text" name="username"/>
        年龄：<input type="text" name="age"/>
        <input type="submit" value="提交">
    </form>
<%--requestBody注解get请求--%>
    <a href="anno/testRequestBody?body=test">requestBody注解get请求</a>
    </br>

控制器代码

//用于获取请求体内容
@RequestMapping("/testRequestBody")
public String testRequestBody(@RequestBody(required = false) String body){
    System.out.println(body);
    return "success";
}

输出结果

PathVariable注解

作用

用于绑定 url 中的占位符。 例如：请求 url 中 /delete/{id}， 这个{id}就是 url 占位符。
url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。

属性

value： 用于指定 url 中占位符名称。
required：是否必须提供占位符

代码如下

jsp代码

<a href="anno/testPathVariable/10">PathVariable注解</a>

控制器代码

// 用于绑定 url 中的占位符
@RequestMapping("/testPathVariable/{id}")
public String testPathVariable(@PathVariable(value = "id") Integer nid){
    System.out.println(nid);
    return "success";
}

RequestHeader注解

作用

用于获取请求消息头,在实际开发中一般不怎么用。

属性

value：提供消息头名称
required：是否必须有此消息头

代码如下

控制器

// 获取请求头的值
@RequestMapping("/testRequestHeader")
public String testRequestHeader(@RequestHeader(value="Accept-Language",
        required=false)String header){
    System.out.println(header);
    return "success";
}

jsp代码

    <a href="anno/testRequestHeader">RequestHeader注解</a>

输出结果

CookieValue注解

作用

用于把指定 cookie 名称的值传入控制器方法参数。

属性

value：指定 cookie 的名称。
required：是否必须有此 cookie。

代码如下

jsp代码

    <a href="anno/testCookieValue">testCookieValue注解</a>

控制器代码

// 用于把指定 cookie 名称的值传入控制器方法参数。
@RequestMapping("/testCookieValue")
public String testCookieValue(@CookieValue(value = "JSESSIONID")String cookieValue){
    System.out.println(cookieValue);
    return "success";
}

ModelAttribute注解

SpringMVC4.3 版本以后新加入的，可用于修饰方法和参数。

作用

修饰方法：表示当前方法会在控制器的方法执行之前，先执行。

• 修饰没有返回值的方法
• 修饰有具体返回值的方法。

修饰参数：获取指定的数据给参数赋值

属性

value：用于获取数据的 key。

key 可以是 POJO 的属性名称，也可以是 map 结构的 key。

举例：

作用在无返回值的方法

代码

// 测试
@RequestMapping("/testModelAttribute")
public String testModelAttribute(){
    System.out.println("ModelAttribute注解执行了");
    return "success";
}
// 被 ModelAttribute修饰的无返回值方法
@ModelAttribute
public void showUser(){
    System.out.println("showUser执行了");
}

jsp代码

<form action="anno/testModelAttribute" method="post">
    姓名：<input type="text" name="username"/>
    年龄：<input type="text" name="age"/>
    <input type="submit" value="提交">
</form>

输出结果

作用在有返回值的方法

案例：

如果表单提交的数据数据不完整，可以在方法上加上补充，有返回值的情况；

jsp代码

<a href="anno/testModelAttribute?uname=test">ModelAttribute修饰有返回值的方法</a>

控制器代码

@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user) {
    System.out.println("ModelAttribute注解执行了");
    System.out.println(user);
    return "success";
}
// 该方法会先执行
@ModelAttribute
public User showUser(String uname) {
    System.out.println("showUser执行了");
    // 模拟通过用户名查询数据库
    User user = new User();
    user.setUname(uname);
    user.setAge(20);
    user.setDate(new Date());

    return user;
}

输出结果

作用在参数和不带返回值的方法

控制器代码

@RequestMapping("/testModelAttribute")
public String testModelAttribute(@ModelAttribute("abc") User user) {
    System.out.println("ModelAttribute注解执行了");
    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("abc",user);
}

输出结果

SessionAttributes注解

作用

用于多次执行控制器方法间的参数共享。

属性

value：用于指定存入的属性名称
type：用于指定存入的数据类型。

代码如下

/**
 * 把数据存入 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", 18);
    //跳转之前将数据保存到 username、 password 和 age 中，因为注解@SessionAttribute有这几个这几个参数
    return "success";
}
// 获取Session
@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";
}

jsp代码

<!-- SessionAttribute 注解的使用 -->
<a href="anno/testPut">存入 SessionAttribute</a>
<hr/>
<a href="anno/testGet">取出 SessionAttribute</a>
<hr/>
<a href="anno/testClean">清除 SessionAttribute</a>