spring mvc 常用注解

RequestParam

作用：

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

属性：

　　value：请求参数中的名称。

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

使用：

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

/**
     * RequestParam:把接受到的参数name和形参username联系在一起
     *      且传入的参数名必须是name
     * @param username
     * @return
     */
    @RequestMapping("/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。

使用：

/**
     * 获取请求体内容
     * @param body
     * @return
     */
    @RequestMapping("/testRequestBody")
    public String testRequestBody(@RequestBody String body){
        System.out.println("执行了。。。");
        System.out.println(body);
        return "success";
    }

PathVaribale

作用：

　　用于绑定 url 中的占位符。例如：请求 url 中 /delete/{id}，这个{id}就是 url 占位符。

　　url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。

属性：

　　value：用于指定 url 中占位符名称。

　　required：是否必须提供占位符。

使用：

 /**
     * restful风格
     * PathVariable注解
     *  localhost:8080/myWeb/anno/testPathVariable/10
     *  把10作为参数id传给该方法
     * @return
     */
    @RequestMapping("/testPathVariable/{id}")
    public String testPathVariable(@PathVariable(name="id") String id){
        System.out.println("执行了");
        System.out.println(id);
        return "success";
    }

CookieValue

作用：

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

属性：

　　value：指定 cookie 的名称。

　　required：是否必须有此 cookie。

使用：

<a href="/myWeb/anno/testCookieValue">CookieValue</a><br/>

 /**
     * 获取Cookie的值
     * @return
     */
    @RequestMapping("/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。

应用场景：

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

　　例如：

　　　　我们在编辑一个用户时，用户有一个创建信息字段，该字段的值是不允许被修改的。

　　　　在提交表单数据是肯定没有此字段的内容，一旦更新会把该字段内容置为 null，此时就可以使用此注解解决问题。

 使用：两种用法

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

/**
     * ModelAttribute注解：
     *  对应的第二种写法：把user从map对象里取出来作为参数
     * @return
     */
    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("abc") User user){
        System.out.println("执行了");
        System.out.println(user);
        return "success";
    }

    /**
     * 第二种写法，在执行testModelAttribute前通过uname补完user，然后放到map里
     *  再执行下一个方法
     * @param uname
     * @param map
     */
    @ModelAttribute
    public void showUser(String uname, Map<String,User> map){
        System.out.println("执行了");
        User user = new User();
        user.setUname(uname);
        user.setAge(20);
        user.setDate(new Date());
        map.put("abc",user);
    }

    /**
     * 该方法会在所有方法前先执行一次，然后将返回值作为参数交给下一个应该执行的方法
     * 这是一种写法
     */
    /*
    @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;
    }
    */

SessionAttribute

作用：

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

属性：

　　value：用于指定存入的属性名称

　　type：用于指定存入的数据类型。 

使用：

 

<a href="/myWeb/anno/testSessionAttributes">setSessionAttributes</a><br/>
<a href="/myWeb/anno/getSessionAttributes">getSessionAttributes</a><br/>
<a href="/myWeb/anno/delSessionAttributes">delSessionAttributes</a><br/>

/**
     * SessionAttributes的注解：作用在类上，把request域中的键值对存到session域中
     * @return
     */
    @RequestMapping(value = "/testSessionAttributes")
    public String testSessionAttributes(Model model){
        System.out.println("testSessionAttributes...");
        //向request域对象存个值：底层会存储到request域对象中
        model.addAttribute("msg","美美");
        return "success";
    }

    /**
     * 从session域中获取值
     * @param ModelMap是Model的实现类
     * @return
     */
    @RequestMapping(value = "/getSessionAttributes")
    public String getSessionAttributes(ModelMap modelMap){
        System.out.println("getSessionAttributes...");
        System.out.println((String)modelMap.get("msg"));
        return "success";
    }

    /**
     * 清除session里的内容
     * @param status
     * @return
     */
    @RequestMapping(value = "delSessionAttributes")
    public String delSessionAttributes(SessionStatus status){
        System.out.println("delSessionAttributes...");
        status.setComplete();
        return "success";
    }
}

/**
作用在类上时
*/
@SessionAttributes(value = {"msg"}) //等于把msg=美美 又存入到session域对象中
public class AnnoController {}

<br/>