Spring MVC之常用注解

生活中,最使人疲惫的往往不是道路的遥远,而是心中的郁闷;最使人痛苦的往往不是生活的不幸,而是希望的破灭;最使人颓废的往往不是前途的坎坷,而是自信的丧失;最使人绝望的往往不是挫折的打击,而是心灵的死亡。所以我们要有自己的梦想,让梦想的星光指引着我们走出落漠,走出惆怅,带着我们走进自己的理想。

导读:本篇文章讲解 Spring MVC之常用注解,希望对大家有帮助,欢迎收藏,转发!站点地址:www.bmabk.com,来源:原文

@RequestMapping

作用:
	用于建立请求 URL 和处理请求方法之间的对应关系

位置:
	使用在类上,请求URL 的第一级访问目录。若不写的话,就相当于应用的根目录,需要以/开头。
	使用在方法上,请求 URL 的第二级访问目录,与类上的使用@ReqquestMapping标注的一级目录一起组成访问虚拟路径。
	
属性:
	value:用于指定请求的URL。它和path属性的作用是一样的
	
	method:指定请求的方式
	
	params:用于指定限制请求参数的条件。它支持简单的表达式。要求请求参数的key和value必须和配置的一模一样
		params = {"name"},表示请求参数必须有 name
		params = {"name=123"},表示请求参数中 name只能是 123
		
	headers:用于指定限制请求消息头的条件。
		headers={"Cookie"} , 表示请求头中必须有Cookie
@Controller
@RequestMapping("/test")
public class HelloController {

  @RequestMapping(value = "/hello",method = RequestMethod.POST,params = {"name=123"},headers = {"Cookie"})
    public String hello(){
        System.out.println("Hello StringMVC");
        return "success";
    }
}

@RequestParam

当请求的参数名称与Controller的方法参数名称不一致时,就需要通@RequestParam注解显示的绑定

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

属性:
	value:请求参数中的名称。
	required:请求参数中是否必须提供此参数。默认值:true。表示必须提供,如果不提供将报错。
	defaultValue : 请求参数中若无此参数,则使用defaultValue指定默认值
<form action="${pageContext.request.contextPath}/testRequestParam" method="post">
<input type="text" name="name"><br>
<input type="submit" value="提交"><br>
</form>
   @RequestMapping("/testRequestParam")
    public String testRequestParam(@RequestParam(name="name",required = false,defaultValue = "admin") String username){
        System.out.println(username);
        return "success";
    }

@RequestBody

作用:
	用于获取请求体内容。直接使用得到是 key=value&key=value...结构的数据。	get 请求方式不适用。

属性:
	required:是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false,get 请求得到是 null。
<form action="/testRequestBody" method="post">
	用户名称:<input type="text" name="username" ><br/>
	用户密码:<input type="password" name="password" ><br/>
	<input type="submit" value=" 保存 ">
</form>
    /**
     * 获取请求体的内容
     * @return
     */
    @RequestMapping("/testRequestBody")
    public String testRequestBody(@RequestBody(required=false) String body){
        System.out.println(body);
        return "success";
    }

@ResponseBody

作用:
	该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。

何时使用:
		当返回的数据不是html的标签的页面,而是其他某种格式的数据时(如json、xml等)使用

如何使用:
		当返回自定义对象为JSON数据类型时,需要增加jackson依赖
    @RequestMapping("/testResponseBody")
    @ResponseBody
    public  User testResponseBody(@RequestBody User user){
        // 客户端发送ajax的请求,传的是json字符串,后端把json字符串封装到user对象中
        System.out.println(user);
        // 将user对象转成json响应
        return user;
    }

添加json依赖jar包

<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-core</artifactId>
	<version>2.7.0</version>
</dependency>
<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-databind</artifactId>
	<version>2.7.0</version>
</dependency>
<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-annotations</artifactId>
	<version>2.7.0</version>
</dependency>

mvc配置

<mvc:annotation-driven>
	<mvc:message-converters>
		<bean class="org.springframework.http.converter.StringHttpMessageConverter" />
		<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter"/>
	</mvc:message-converters>
</mvc:annotation-driven>

@PathVariable

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

属性:
	value:用于指定 url 中占位符名称。
	required:是否必须提供占位符。
<a href="/testPathVariable/123">pathVariable 注解</a>
    /**
     * PathVariable注解
     * @return
     */
    @RequestMapping(value="/testPathVariable/{sid}")
    public String testPathVariable(@PathVariable(name="sid") Integer id){
        System.out.println(id);
        return "success";
    }

什么是 rest 风格?

REST(英文:Representational State Transfer,简称 REST)描述了一个架构样式的网络系统,比如 web 应用程序。

在目前主流的三种 Web服务交互方案中,REST 相比于 SOAP(Simple Object Access protocol,简单对象访问协议)以及 XML-RPC 更加简单明了,无论是对 URL 的处理还是对 Payload 的编码,REST 都倾向于用更加简单轻量的方法设计和实现。

值得注意的是 REST 并没有一个明确的标准,而更像是一种设计的风格。它本身并没有什么实用性,其核心价值在于如何设计出符合 REST 风格的网络接口。

简单的说Restful是一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。主要用于客户端和服务器交互类的软件,基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存机制等。

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 的示例:

/user/123  HTTP GET : 获取 id = 123 的 user
/user/123  HTTP DELETE: 删除 id = 123 的 user
/user/123  HTTP PUT: 更新 id = 123 的 user
/user HTTP POST: 新增 user

@RequestHeader

作用:
	用于获取请求消息头。

属性:
	value:请求头的名称
	required:是否必须携带此请求头
<a href="/testRequestHeader">获取请求头消息</a>
    @RequestMapping(value="/testRequestHeader")
    public String testRequestHeader(@RequestHeader(value="Accept") String header)  {
        System.out.println(header);
    }

@CookieValue

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

属性:
	value:指定 cookie 的名称。
	required:是否必须携带此cookie
<a href="/testCookieValue">绑定获取Cookie的值</a>
   /**
     * 获取Cookie的值
     * @return
     */
    @RequestMapping(value="/testCookieValue")
    public String testCookieValue(@CookieValue(value="JSESSIONID") String jsessionId){
        System.out.println(jsessionId);
        return "success";
    }

@ ModelAttribute

作用:
	该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。
	出现在方法上,表示当前方法会在控制器的方法执行之前,先执行。
	可以修饰没有返回值的方法,也可以修饰有具体返回值的方法。
	当出现在参数上,获取指定的数据给参数赋值。

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

修饰没有返回值的方法

<a href="/testModelAttribute?uname=admin">ModelAttribute</a>

	/**
	  * User对象将拥有完整数据,包括age=20
	  * @return
	  */
    @RequestMapping(value="/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("user") User user){
        System.out.println(user);
        return "success";
    }
    
	/**
	  * ModelAttribute注解修饰方法先执行
	  * @return
	  */
    @ModelAttribute
    public void showUser(String uname, Map<String,User> map){
        User user = new User();
        user.setUname(uname);
        user.setAge(20);
        map.put("user",user);
    }

修饰有具体返回值的方法

<a href="/testModelAttribute?uname=admin">ModelAttribute</a>

	 /**
	  * User对象将拥有完整数据,包括age=20
	  * @return
	  */	
    @RequestMapping(value="/testModelAttribute")
    public String testModelAttribute(User user){
        System.out.println(user);
        return "success";
    }

 /**
  * ModelAttribute注解修饰方法先执行
  * @return
  */
 @ModelAttribute
    public User getUser(String uname){
        User user = new User();
        user.setUname(uname);
        user.setAge(20);
        return user;
    }

@SessionAttribute

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

属性:
	value:用于指定存入的属性名称
	type:用于指定存入的数据类型。
<a href="/testSessionAttributes">存入SessionAttribute</a>
<hr/>
<a href="/getSessionAttributes">取出SessionAttribute</a>
<hr/>
<a href="/delSessionAttributes">清除SessionAttribute</a>
@Controller
@SessionAttributes(value ={"username","password"},types={String.class})
public class SessionAttributeController {

	//存入值
	//Model 是 spring 提供的一个接口,该接口有一个实现类 ExtendedModelMap
	//该类继承了 ModelMap,而 ModelMap 就是 LinkedHashMap 子类
    @RequestMapping(value="/testSessimsgonAttributes")
    public String testSessionAttributes(Model model){
        // 底层存储到request域对象中
        model.addAttribute("msg","testSessimsgonAttributes");
        return "success";
    }

	//获取值
    @RequestMapping(value="/getSessionAttributes")
    public String getSessionAttributes(ModelMap modelMap){
        String msg = (String) modelMap.get("msg");
        System.out.println(msg);
        return "success";
    }

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

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/137119.html

(0)
飞熊的头像飞熊bm

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!