06.springMVC常用注解

常用注解

一、RequestParam

1). 使用说明

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

2). 属性

  1. value: 请求参数中的名称
  2. required: 请求参数中是否必须提供此参数。默认值：true、表示必须提供，如果不提供将报错。

3). 使用示例

  1. jsp核心代码
<%-- requestParams注解的使用 --%>
<a href="springmvc/useRequestParam?name=test">requestParam注解</a>
  1. 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {

    /** requestParams注解的使用 */
    @RequestMapping("/useRequestParam")
    public String useRuquestParam(@RequestParam("name") String username,
                                  @RequestParam(value = "age", required = false) Integer age) {
        System.out.println(username);
        System.out.println(age);
        return "success";
    }
}

二、RequestBody

1). 作用

用于获取请求体内容。直接使用得到的是key=value&key=value...结构的数据。

get请求方式不适用

2). 属性

  1. required: 是否必须有请求体。默认值是：true。当取值为true时，get请求方式会报错。
    如果取值为false,get请求得到的是null,所以 此注解不适合get请求方式

3). 使用示例

  1. jsp代码
<%-- requestBody注解 --%>
<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>
  1. 控制器代码

@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {

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

三、PathVariable

1). 使用说明

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

2). 属性

  1. value: 指定url中占位符名称
  2. required: 是否必须提供占位符。

3). 使用案例

  1. jsp代码
<%-- PathVariable注解 --%>
<a href="springmvc/usePathVariable/100">PathVarable注解</a>
  1. 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {

    /** PathVariable注解 */
    @RequestMapping("/usePathVariable/{id}")
    public String usePathVariable(@PathVariable("id") Integer id) {
        System.out.println(id);
        return "success";
    }
}

4). REST风格URL

Representational State Transfer,描述了一个架构样式的网络系统;REST并没有一个明确的标准，而更像是一种设计的风格

1. 优点

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

2. 特性

  1. 资源(Resources): 网络上的一个实体，或者说是网络上的一个具体信息；可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的存在。可以用一个 URI（统一资源定位符）指向它，每种资源对应一个特定的 URI；获取这个资源，访问它的 URI 就可以，因此URI即为每一个资源的独一无二的识别符
  2. 表现层(Representation): 把资源具体呈现出来的形式;比如，文本可以用 txt 格式表现，也可以用 HTML 格式、XML 格式、JSON 格式表现，甚至可以采用二进制格式。
  3. 状态转化(State Transfer): 每发出一个请求，就代表了客户端和服务器的一次交互过程。 HTTP 协议里面，四个表示操作方式的动词： GET、 POST、 PUT、DELETE。它们分别对应四种基本操作： GET 用来获取资源， POST 用来新建资源， PUT 用来更新资源， DELETE 用来删除资源。restfu

3. restful示例

url 提交方式 含义
/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

5). 基于HiddenHttpMethodFilter的示例【了解】

演示中浏览器可能会错，是应为浏览器暂时不支持这些方法

1. 作用

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

2. 使用步骤

  1. 在web.xml中配置该过滤器。
  2. 请求方式必须使用post请求。
  3. 按照要求提供_method请求参数，该参数的取值就是我们需要的请求方式。
HiddenHttpMethodFilter源码分析.png

3. 配置及其代码

  1. web.xml
<!-- restful过滤器 -->
<filter>
    <filter-name>hiddenHttpMethodFilter</filter-name>
    <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>hiddenHttpMethodFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
  1. jsp代码
<%-- HiddenHttpMethodFilter --%>
<%-- 更新 --%>
<form action="springmvc/testRestPUT/1" method="post">
    <input type="hidden" name="_method" value="PUT">
    <input type="submit" value="跟新提交">
</form>
<hr>
<!-- 删除 -->
<form action="springmvc/testRestDELETE/2" method="post">
    <input type="hidden" name="_method" value="DELETE">
    <input type="submit" value="删除提交">
</form>
  1. 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {


    /** PUT请求:更新 */
    @RequestMapping(value = "testRestPUT/{id}", method = RequestMethod.PUT)
    public String testRestfulURLPUT(@PathVariable("id")Integer id) {
        System.out.println(id);
        return "success";
    }

    /** DELETE请求:删除 */
    @RequestMapping(value = "testRestDELETE/{id}", method = RequestMethod.DELETE)
    public String testRestfulDELETE(@PathVariable("id") Integer id) {
        System.out.println(id);
        return "success";
    }
}

四、RequestHeader【一般不用】

1). 使用说明

获取请求消息头，实际开发中一般不用。

2). 属性

  1. value: 提供消息头名称
  2. required: 是否必须有此消息头

3). 使用示例

  1. jsp核心代码
<%-- RequestHeader注解 --%>
<a href="springmvc/useRequestHeader">获取请求消息头</a>
  1. 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {

    /** RequestHeader注解 */
    @RequestMapping("/useRequestHeader")
    public String useRequestHeader(@RequestHeader(value = "Accept-Language",
            required = false)String requestHeader) {
        System.out.println(requestHeader);
        return "success";
    }
}

五、CookieValue

1). 使用说明

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

2). 属性

  1. value: 指定cookie的名称
  2. required: 是否必须有此cookie

3). 使用案例

  1. jsp代码
<%-- CookieValue注解 --%>
<a href="springmvc/useCookieValue">绑定cookie的值</a>
  1. 控制器核心代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {

    /** CookieValue */
    @RequestMapping("/useCookieValue")
    public String useCookieValue(
            @CookieValue(value="JSESSIONID", required = false)
            String cookieValue) {
        System.out.println(cookieValue);
        return "success";
    }
}

六、ModelAttribute

1). 使用说明

该注解是SpringMVC4.3版本以后加入的。可以用来修饰方法和参数。

  1. 出现在方法上，表示当前方法会在控制器的方法执行前先执行。有无返回值的方法都可以被修饰。
  2. 出现在参数上，获取指定的数据给参数赋值。

2). 属性

  1. value: 用于获取数据的key。key可以是pojo的属性名称，也可以是map结构的key。

3). 应用场景

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

4). 基于POJO的应用场景I：ModelAttribute修饰方法不带返回值

  1. jsp
<%-- ModelAttribute注解的基本使用 --%>
<a href="springmvc/testModelAttribute?username=test">测试</a>
  1. 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {

    /** 被ModelAttribute修饰的方法，在控制器【所有的】执行前执行 */
    @ModelAttribute
    public void showModel(User user) {
        System.out.println("ModelAttribute: " + user.getUsername());
    }

    /** 接收请求的方法 */
    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(User user) {
        System.out.println("Controller: " + user.getUsername());
        return "success";
    }
}

5). 基于POJO的应用场景II：ModelAttribute修饰方法带返回值

例如，有个需求，修改用户信息，比如根据用户名修改年龄，但是用户的密码不能被修改；ModelAttribute注解的底层会保留从数据库查询的对应信息，在封装时从请求数据中读取到null,不会覆盖之前查询的字段！控制器中拿到的对应字段就不是null值了。

  1. jsp
<%-- 修改用户信息 --%>
<form action="springmvc/updateUser" method="post">
    用户名称：<input type="text" name="username"> <br>
    用户年龄：<input type="text" name="age"> <br>
    <input type="submit" value="保存">
</form>
  1. 控制器
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {

    /** 模拟取数据库查询数据 */
    private User findUserByName(String username) {
        User user = new User();
        user.setUsername(username);
        user.setAge(19);
        user.setPassword("abc123");
        return user;
    }

    /** 查询数据库中的信息 */
    @ModelAttribute
    public User showModel(String username) {
        // 模拟取数据库查询
        User abc = findUserByName(username);
        System.out.println("执行了ModelAttribute查询: " + abc );
        return abc;
    }

    /** 模拟修改用户的方法 */
    @RequestMapping("/updateUser")
    public String testModelAttribute(User user) {
        System.out.println("控制器中修改了用户，模拟持久化:" + user);
        return "success";
    }
}

6). 基于Map的应用场景实例I：ModelAttribute修饰方法不带返回值

需求与上一个案例一样

  1. jsp
<%-- 修改用户信息 --%>
<form action="springmvc/updateUser" method="post">
    用户名称：<input type="text" name="username"> <br>
    用户年龄：<input type="text" name="age"> <br>
    <input type="submit" name="保存">
</form>
  1. 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {

    /** 模拟取数据库查询数据 */
    private User findUserByName(String username) {
        User user = new User();
        user.setUsername(username);
        user.setAge(19);
        user.setPassword("abc123");
        return user;
    }

    /** 模拟查询数据库中用户的信息 */
    @ModelAttribute
    public void showModel(String username, Map<String, User> map) {
        // 模拟去数据库查询
        User user = findUserByName(username);
        System.out.println("ModelAttribute 查询了数据库：" + user);
        map.put("abc", user);
    }

    /** 模拟持久化用户 */
    @RequestMapping("/updateUser")
    public String testModelAttribute(@ModelAttribute("abc")User user) {
        System.out.println("控制器持久化用户：" + user);
        return "success";
    }
}

七、SessionAttribute

1). 功能

用于多次执行控制器方法间的参数共享，将数据存放到session域中，只能作用类上！

2). 属性

  1. value: 用于指定存入的属性名称
  2. type: 用于指定存入的数据类型

3). 使用案例

  1. jsp
<%-- SessionAttribute注解的使用 --%>
<a href="springmvc/testPut">存入SessionAttribute</a>
<hr>
<a href="springmvc/testGet">取出SessionAttribute</a>
<hr>
<a href="springmvc/testClean">清除SessionAttribute</a>
  1. 控制器代码

Model接口的实现类会将数据存放到request域中,而取数据要从ModelMap接口的实现类中取,SessionStatus接口实现类用于清除该session SpringMVC底层是传递的实现类，开发者在开发时使用多态调用接口方法即可； Model是spring提供的一个接口，该接口有一个实现类ExtendModelMap该类继承了ModelMap,而ModelMap就是LikedHashMap的子类。

/** SessionAttribute注解的使用 */
@Controller("sessionAttributeController")
@RequestMapping("/springmvc")
@SessionAttributes(value = {"username", "password"}, types = {Integer.class})
public class AnnotationTestController {

    @RequestMapping("/testPut")
    public String testPut(Model model) {
        /* 跳转之前将数据保存到request域中，
         * 由于类上又配置了@SessionAttribute注解，且变量名一样！
         * 会将这些数据存入到session域中！ */
        model.addAttribute("username", "切斯特尔");
        model.addAttribute("password", "abc123");
        model.addAttribute("age", 32);
        return "success";
    }

    @RequestMapping("/testGet")
    public String testGet(ModelMap model) {
        System.out.println(model.get("username"));
        System.out.println(model.get("password"));
        System.out.println(model.get("age"));
        return "success";
    }

    /** 清除该session */
    @RequestMapping("/testClean")
    public String complete(SessionStatus sessionStatus) {
        /** 清除该session */
        sessionStatus.setComplete();
        return "success";
    }
}
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,125评论 6赞 498
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,293评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 162,054评论 0赞 351
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,077评论 1赞 291
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,096评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,062评论 1赞 295
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,988评论 3赞 417
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,817评论 0赞 273
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,266评论 1赞 310
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,486评论 2赞 331
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,646评论 1赞 347
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,375评论 5赞 342
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,974评论 3赞 325
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,621评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,642评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,538评论 2赞 352