SpringMVC-常用注解

RequestParam

使用说明

作用：

把请求中指定名称的参数给控制器中的形参赋值。
属性：
- value：请求参数中的名称；
- name：请求参数中的名称；和value一样；
- required：请求参数中是否必须提供此参数。默认值：true。表示必须提供，如果不提供将报错。

使用示例

jsp页面代码：

1 2	<%--常用注解RequestParam--%> <a href="anno/testRequestParam?name=你好">RequestParam</a>

控制器代码：

//    RequestParam注解示例
@RequestMapping(value = "/testRequestParam")
public String testRequestParam(@RequestParam(value = "name") String username){
    System.out.println("执行了。。。。。");
    System.out.println(username);
    return "success";
}

RequestBody

使用说明

作用：

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

使用示例

jsp页面代码：

<%--常用注解RequestBody--%>
<form action="anno/testRequestBody" method="post">
    用户姓名：<input type="text" name="username" /></br>
    用户年龄：<input type="text" name="age" /></br>
    <input type="submit" value="提交">
</form>

控制器代码：

//    RequestBody注解示例
@RequestMapping(value = "/testRequestBody")
public String testRequestBody(@RequestBody String body){
    System.out.println("执行了。。。。。");
    System.out.println(body);
    return "success";
}

结果：

RequestBody结果

PathVariable

使用说明

作用：

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

使用示例

jsp页面代码：

1 2	<%--常用注解PathVariable--%> <a href="anno/testPathVariable/10">PathVariable</a>

控制器代码：

//    PathVariable注解示例
@RequestMapping(value = "/testPathVariable/{sid}")
public String testPathVariable(@PathVariable(name = "sid") String id){
    System.out.println("执行了。。。。。");
    System.out.println(id);
    return "success";
}

结果：

PathVariable结果

Restful风格

restful风格

优点：结构清晰、符合标准、易于理解、扩展方便，所以挣得越来越多网站采用。

RequestHeader

使用说明

作用：

用于获取请求消息头。
属性：
- value：提供消息头名称；
- required：是否必须有此消息头。
备注：在实际开发中一般不怎么用。

使用示例

jsp页面代码：

1 2	<%--常用注解RequestHeader--%> <a href="anno/testRequestHeader">RequestHeader</a>

控制器代码：

//    PathVariable注解示例 获取
@RequestMapping(value = "/testRequestHeader")
public String testRequestHeader(@RequestHeader(value = "Accept") String header){
    System.out.println("执行了。。。。。");
    System.out.println(header);
    return "success";
}

CookieValue

使用说明

作用：

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

使用示例

jsp页面代码：

1 2	<%--常用注解CookieValue--%> <a href="anno/testCookieValue">CookieValue</a>

控制器代码：

//    CookieValue注解示例 获取cookie的值
@RequestMapping(value = "/testCookieValue")
public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookieValue){
    System.out.println("执行了。。。。。");
    System.out.println(cookieValue);
    return "success";
}

ModelAttribute

使用说明

作用：

该注解是SpringMVC4.3版本以后新加入的。它可以修饰方法和参数。
- 出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可以修饰有返回值的方法。
- 出现在参数上，获取指定的数据给参数赋值。
属性：
- value：用于获取数据的key。key可以是POJO的属性名称，也可以是map结构的key。
应用场景：

当表单提交数据不是完整的实体类数据时，保证没有提交数据的字段使用数据库对象原来的数据。

使用示例

出现在方法上

jsp页面代码：

<%--常用注解ModelAttribute--%>
<form action="anno/testModelAttribute" method="post">
    用户姓名：<input type="text" name="uname" /></br>
    用户年龄：<input type="text" name="age" /></br>
    <input type="submit" value="提交">
</form>

控制器代码：

/**
 * ModelAttribute注解示例
 * 如果参数user记为parUser中有部分数据没有提交，如date，正常会输出date属性值为null
 * 但是showUser()方法使用了@ModelAttribute注解，返回了user对象记为backUser
 * 这时，parUser中的date值会使用backUser中的date值，
 * 即将backUser有的属性但是parUser没有的属性添加到parUser
 */
@RequestMapping(value = "/testModelAttribute")
public String testModelAttribute(User user){
    System.out.println("testModelAttribute执行了。。。。。");
    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(19);
user.setDate(new Date());
return user;
}

说明：

如果参数user记为parUser中有部分数据没有提交，如date，正常会输出date属性值为null；
但是showUser()方法使用了@ModelAttribute注解，返回了user对象记为backUser；
这时，parUser中的date值会使用backUser中的date值；
即将backUser有的属性但是parUser没有的属性添加到parUser。

结果：

提交表单anno/testModelAttribute，得到结果showUser先执行：

ModelAttribute结果

出现在参数上

控制器代码：

/**
 * ModelAttribute注解示例
 * 如果参数user记为parUser中有部分数据没有提交，如date，正常会输出date属性值为null
 * 但是showUser()方法使用了@ModelAttribute注解，并且将user对象保存在key为"hello"的map对象中
 * 在此方法的参数前加了@ModelAttribute注解，将key为"hello"的map对象取出来，得到showUser()方法中保存的user对象记为backUser
 * 这时，parUser中的date值会使用backUser中的date值，
 * 即将backUser有的属性但是parUser没有的属性添加到parUser
 */
@RequestMapping(value = "/testModelAttribute")
public String testModelAttribute(@ModelAttribute(value = "hello") 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(19);
    user.setDate(new Date());
    map.put("hello", user);
}

说明：

如果参数user记为parUser中有部分数据没有提交，如date，正常会输出date属性值为null；
但是showUser()方法使用了@ModelAttribute注解，并且将user对象保存在key为”hello”的map对象中；
在此方法的参数前加了@ModelAttribute注解，将key为”hello”的map对象取出来，得到showUser()方法中保存的user对象记为backUser；
这时，parUser中的date值会使用backUser中的date值，
即将backUser有的属性但是parUser没有的属性添加到parUser。

结果：

提交表单anno/testModelAttribute，得到结果showUser先执行：

ModelAttribute结果

SessionAttributes

使用说明

作用：

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

使用示例

jsp页面代码：

<%--常用注解SessionAttributes--%>
<a href="anno/testSessionAttributes">数据存入SessionAttributes</a>
<br>
<a href="anno/getSessionAttributes">使用Model从SessionAttributes取出数据</a>
<br>
<a href="anno/getSessionAttributes2">使用ModelMap从SessionAttributes取出数据</a>
<br>
<a href="anno/delSessionAttributes">清除SessionAttributes数据</a>

控制器代码：@SessionAttributes作用在类上面

@Controller
@RequestMapping(value = "/anno")
@SessionAttributes(value = {"msg"}) //把msg=美美存入到session域中
public class AnnoController {
        //    SessionAttributes注解示例 存入数据
    @RequestMapping(value = "/testSessionAttributes")
    public String testSessionAttributes(Model model){
        System.out.println("testSessionAttributes执行了。。。。。");
        //底层会存储到request域对象中
        model.addAttribute("msg","美美");
        return "success";
    }
    //使用Model从SessionAttributes中取出数据
    @RequestMapping(value = "/getSessionAttributes")
    public String getSessionAttributes(Model model){
        System.out.println("getSessionAttributes执行了。。。。。");
        //底层会存储到request域对象中
        String msg = (String) model.getAttribute("msg");
        System.out.println(msg);
        return "success";
    }
    //使用ModelMap从SessionAttributes中取出数据
    @RequestMapping(value = "/getSessionAttributes2")
    public String getSessionAttributes2(ModelMap modelMap){
        System.out.println("getSessionAttributes执行了。。。。。");
        //底层会存储到request域对象中
        String msg = (String) modelMap.getAttribute("msg");
        System.out.println(msg);
        return "success";
    }
    //清除SessionAttributes中的数据
    @RequestMapping(value = "/delSessionAttributes")
    public String delSessionAttributes(SessionStatus status){
        System.out.println("delSessionAttributes执行了。。。。。");
        status.setComplete();
        return "success";
    }
}

结果：

先执行”anno/testSessionAttributes”；

然后执行”anno/getSessionAttributes”；

然后执行”anno/getSessionAttributes2”；

然后执行”anno/delSessionAttributes”；

最后执行”anno/getSessionAttributes”。

SessionAttributes结果

最后更新： 2020年07月01日 23:51

原始链接： http://ligangit.com/2020/06/30/SpringMVC-常用注解/

赏

Li Gang's blog

在码农的世界里挣扎的人

SpringMVC-常用注解

SpringMVC-常用注解

RequestParam

使用说明

使用示例

RequestBody

使用说明

使用示例

PathVariable

使用说明

使用示例

Restful风格

RequestHeader

使用说明

使用示例

CookieValue

使用说明

使用示例

ModelAttribute

使用说明

使用示例

出现在方法上

出现在参数上

SessionAttributes

使用说明

使用示例