SpringMVC框架的常用注解

上一篇：SpringMVC框架的请求参数

下一篇：SpringMVC框架的返回值及响应数据

文章目录

• 1、RequestParam
• 2、RequestBody
• 3、PathVaribale
• 4、RequestHeader
• 5、CookieValue
• 6、ModelAttribute
• 7、SessionAttributes

1、RequestParam

  RequestParam 注解的作用就是把请求中指定名称的参数给控制器中的形参赋值。

属性	描述
value	请求参数中的名称
required	请求参数中是否必须提供此参数，默认值是true，必须提供

  演示如下：

/**
     * RequestParam注解的使用
     */
    @RequestMapping(value = "/testRequestParam")
    public String testRequestParam(@RequestParam(name = "username") String name,
                                   @RequestParam(name = "password", required = false) String pwd) {
        System.out.println("username:" + name);
        System.out.println("password:" + pwd);
        return "success";
    }
           

2、RequestBody

  RequestBody 注解的作用就是用于获取请求体内容。直接使用得到是

key=value&key=value...

结构的数据。get 请求方式不适用，因为 get 请求是没有请求体的，它把请求的参数都放入地址栏中了。

  此注解常用来接收异步请求的参数，例如 JSON 。

属性	描述
required	是否必须有请求体，默认值是true。为 true 时，get 请求方式会报错。为 false，get 请求得到是 null

  演示如下：

/**
     * RequestBody注解的使用
     */
    @RequestMapping(value = "/testRequestBody")
    public String testRequestBody(@RequestBody(required = false) String body) {
        System.out.println(body);
        return "success";
    }
           

<form action="anno/testRequestBody" method="post">
        username：<input type="text" name="username" /><br>
        password：<input type="text" name="password" /><br>
        <input type="submit" value="submit">
    </form>
    <a href="anno/testRequestBody?body=Atlantis">testRequestBody注解get请求</a>
           

3、PathVaribale

  PathVaribale 注解的作用就是用于绑定 URL 中的占位符。例如：请求 URL 中

/delete/{id}

，这个

{id}

就是 URL 占位符。

  URL 支持占位符是 Spring3.0 之后加入的。是 SpringMVC 支持 REST 风格 URL 的一个重要标志。

  Restful 风格的 URL 指请求路径一样，但可以根据不同的请求方式去执行后台的不同方法。

属性	描述
value	用于指定 url 中占位符名称，同 name 属性作用一致
required	是否必须提供占位符

  演示如下：

/**
     * PathVaribale注解的使用
     */
    @RequestMapping(value = "/testPathVaribale/{uid}")
    public String testPathVaribale(@PathVariable(value = "uid") String id) {
        System.out.println("id:" + id);
        return "success";
    }
           

什么是 REST?

  REST（Representational State Transfer，简称 REST）描述了一个架构样式的网络系统，比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中，他是 HTTP 规范的主要编写者之一。在目前主流的三种 Web 服务交互方案中，REST 相比于 SOAP（Simple Object Access protocol，简单对象访问协议）以及 XML-RPC 更加简单明了，无论是对 URL 的处理还是对 Payload 的编码，REST 都倾向于用更加简单轻量的方法设计和实现。值得注意的是 REST 并没有一个明确的标准，而更像是一种设计的风格。

  它本身并没有什么实用性，其核心价值在于如何设计出符合 REST 风格的网络接口。

restful 的优点

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

restful 的特性

  ①资源（ Resources）：网络上的一个实体，或者说是网络上的一个具体信息。

    它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的存在。可以用一个 URI（统一资源定位符）指向它，每种资源对应一个特定的 URI 。要获取这个资源，访问它的 URI 就可以，因此 URI 即为每一个资源的独一无二的识别符。

  ②表现层（ Representation）：把资源具体呈现出来的形式，叫做它的表现层（ Representation）。

    比如，文本可以用 txt 格式表现，也可以用 HTML 格式、XML 格式、JSON 格式表现，甚至可以采用二进制格式。

  ③状态转化（ State Transfer）：每 发出一个请求，就代表了客户端和服务器的一次交互过程。

    HTTP 协议，是一个无状态协议，即所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生 “状态转化 ”（ State Tran sfer）。而这种转化是建立在表现层之上的，所以就是 “表现层状态转化 ”。

    具体说，就是 HTTP 协议里面，四个表示操作方式的动词： GET、 POST、 PUT、DELETE。它们分别对应四种基本操作： GET 用来获取资源， POST 用来新建资源， PUT 用来更新资源， DELETE 用来删除资源。

restful 的示例

  /account/1 HTTP GET ： 得到 id = 1 的 account

  /account/1 HTTP DELETE： 删除 id = 1 的 account

  /account/1 HTTP PUT： 更新 id = 1 的 account

  /account HTTP POST： 新增 account

  

基于 HiddentHttpMethodFilter 的示例（了解即可）

  由于浏览器 form 表单只支持 GET 与 POST 请求，而 DELETE、PUT 等 method 并不支持，Spring3.0 添加了一个 HiddentHttpMethodFilter 过滤器，可以将浏览器请求改为指定的请求方式，发送给我们的控制器方法，使得支持 GET、POST、PUT 与 DELETE 请求。

  如何使用 HiddentHttpMethodFilter 过滤器？

    第一步，在 web.xml 中配置该过滤器。

    第二步，请求方式必须使用 post 请求。

    第三步，按照要求提供_method 请求参数，该参数的取值就是我们需要的请求方式。

4、RequestHeader

  RequestHeader注解的作用就是用于获取请求消息头。（在实际开发中一般不怎么用）

属性	描述
value	提供消息头名称
required	是否必须有此消息头

  演示如下：

/**
     * RequestHeader注解的使用
     */
    @RequestMapping(value = "/testRequestHeader")
    public String testRequestHeader(@RequestHeader(value = "Accept") String header) {
        System.out.println("header:" + header);
        return "success";
    }
           

5、CookieValue

  CookieValue 注解的作用就是用于把指定 cookie 名称的值传入控制器方法参数。

属性	描述
value	指定 cookie 的名称
required	是否必须有此 cookie

  演示如下：

/**
     * CookieValue注解的使用
     */
    @RequestMapping(value = "/testCookieValue")
    public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookieValue) {
        System.out.println("JSESSIONID:" + cookieValue);
        return "success";
    }
           

6、ModelAttribute

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

  出现在方法上，表示当前方法会在控制器的方法执行之前，先执行。它可以修饰没有返回值的方法，也可以修饰有具体返回值的方法。

  出现在参数上，获取指定的数据给参数赋值。

属性	描述
value	用于获取数据的 key。key 可以是 POJO 的属性名称，也可以是 map 结构的 key

  应用场景：

    当表单提交数据不是完整的实体类数据时，要保证没有提交数据的字段使用数据库对象原来的数据。简单来说，我们在编辑一个用户时，用户有一个创建信息字段，该字段的值是不允许被修改的。在提交表单数据是肯定没有此字段的内容，一旦更新会把该字段内容置为 null，此时就可以使用此注解解决问题。

  演示如下：

// JavaBean
public class User implements Serializable {
    private String username;
    private String password;
    private Integer age;
    private Date date;

	// 省略get、set和toString方法
}
           

/**
     * ModelAttribute注解的使用
     */
    @RequestMapping(value = "/testModelAttribute")
    public String testModelAttribute() {
        System.out.println("testModelAttribute...");
        return "success";
    }

    /**
     * 被ModelAttribute修饰的方法，先被执行
     */
    @ModelAttribute
    public void showUser() {
        System.out.println("showUser...");
    }
           

<form action="anno/testModelAttribute" method="post">
        username：<input type="text" name="username" /><br>
        password：<input type="text" name="password" /><br>
        <input type="submit" value="submit">
    </form>
           

  （1）ModelAttribute 修饰方法带返回值

/**
     * ModelAttribute注解的使用
     */
    @RequestMapping(value = "/testModelAttribute")
    public String testModelAttribute(User user) {
        System.out.println(user.toString());
        return "success";
    }

    /**
     * 被ModelAttribute修饰的方法，先被执行
     */
    @ModelAttribute
    public User showUser(String username,String password) {
        // 通过用户名查询数据库（模拟）
        User user = new User();
        user.setUsername(username);
        user.setPassword(password);
        user.setAge(23);
        user.setDate(new Date());
        return user;
    }
           

  （2）ModelAttribute 修饰方法不带返回值

/**
     * ModelAttribute注解的使用
     */
    @RequestMapping(value = "/testModelAttribute")
    public String testModelAttribute(@ModelAttribute(value = "newUser") User user) {
        System.out.println(user.toString());
        return "success";
    }

    /**
     * 被ModelAttribute修饰的方法，先被执行
     */
    @ModelAttribute
    public void showUser(String username, String password, Map<String, User> map) {
        // 通过用户名查询数据库（模拟）
        User user = new User();
        user.setUsername(username);
        user.setPassword(password);
        user.setAge(21);
        user.setDate(new Date());
        map.put("newUser", user);
    }
           

7、SessionAttributes

  SessionAttributes 注解的作用就是用于多次执行控制器方法间的参数共享。

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

  演示如下：

@Controller
@RequestMapping(value = "/anno")
@SessionAttributes(value = {"user"}) //把user存入Session域中
public class AnnoController {
    /**
     * SessionAttributes注解的使用
     */
    @RequestMapping(value = "/setSessionAttributes")
    public String setSessionAttributes(Model model) {
        // model底层会把数据存储到request域对象中
        model.addAttribute("user", "Atlantis");
        return "success";
    }

    @RequestMapping(value = "/getSessionAttributes")
    public String getSessionAttributes(ModelMap modelMap) {
        String user = (String) modelMap.get("user");
        System.out.println("getSession:" + user);
        return "success";
    }

    @RequestMapping(value = "/delSessionAttributes")
    public String delSessionAttributes(SessionStatus status) {
        status.setComplete();
        return "success";
    }
           

<a href="anno/setSessionAttributes">设置Session</a>
    <a href="anno/getSessionAttributes">获取Session</a>
    <a href="anno/delSessionAttributes">删除Session</a>
           

Request：${requestScope.user}<br>
    Session：${sessionScope.user}