SpringMVC学习笔记二：常用注解

转载请注明原文地址：http://www.cnblogs.com/ygj0930/p/6831976.html

参考：http://www.cnblogs.com/leskang/p/5445698.html

一、用于定义类的注解：@Controller

@Controller 用于标记在一个类上，使用它标记的类就是一个Controller 对象。

DispatcherServlet将会扫描使用了该注解的类的方法，并检测方法是否使用了@RequestMapping 注解。@Controller 只是定义了一个控制器类，而使用@RequestMapping 注解的方法才是真正处理请求的处理器。单单使用@Controller 标记在一个类上还不能真正意义上的说它就是SpringMVC 的一个控制器类，因为这个时候Spring 还不认识它。那么要如何做Spring 才能认识它呢？这个时候就需要我们把这个控制器类交给Spring 来管理。有两种方式：

　　（1）在SpringMVC 的配置文件中定义MyController 的bean 对象。

　　（2）在SpringMVC 的配置文件中告诉Spring 该到哪里去找标记为@Controller 的Controller 控制器。（推荐使用）

<!--方式一-->

<bean class="com.host.app.web.controller.MyController"/>

<!--方式二-->

< context:component-scan base-package = "包含controller实现类的包" />

二、用于映射请求的注解：@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

RequestMapping注解有六个属性，下面我们把她分成三类进行说明（下面有相应示例）。

1、 value， method；

value：指定请求的实际地址；

method：指定请求的method类型， GET、POST、PUT、DELETE等；

2、consumes，produces

consumes：指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;

produces: 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；

3、params，headers

params：指定request中必须包含某些参数值，才让该方法处理。

如：

@RequestMapping (value= "testParams" , params={ "param1=value1" , "param2" , "!param3" })

分别表示参数param1 的值必须等于value1 ，参数param2 必须存在，值无所谓，参数param3 必须不存在，只有当请求/testParams.do 并且满足指定的三个参数条件的时候才能访问到该方法。

headers：指定request中必须包含某些指定的header值，才能让该方法处理请求。

@RequestMapping (value= "testHeaders" , headers={ "host=localhost" , "Accept" })

三、用于注入成员变量值的注解：@Resource和@Autowired

1、共同点

两者都可以写在字段和setter方法上。两者如果都写在字段上，那么就不需要再写setter方法。

2、不同点

（1）@Autowired

@Autowired为Spring提供的注解，需要导入包org.springframework.beans.factory.annotation.Autowired;只按照byType注入。

@Autowired注解是按照类型（byType）装配依赖对象，默认情况下它要求依赖对象必须存在，如果允许null值，可以设置它的required属性为false。

（2）@Resource

@Resource默认按照ByName自动注入，由J2EE提供，需要导入包javax.annotation.Resource。

@Resource有两个重要的属性：name和type，而Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。

所以，如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不制定name也不制定type属性，这时将通过反射机制使用byName自动注入策略。

@Resource装配顺序：

①如果同时指定了name和type，则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常。

②如果指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常。

③如果指定了type，则从上下文中找到类似匹配的唯一bean进行装配，找不到或是找到多个，都会抛出异常。

④如果既没有指定name，又没有指定type，则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配。

四、用于参数绑定的注解：8个，分四类

1：处理request uri部分的注解

@PathVariable

用于将请求URL中的模板变量映射到处理方法的参数上，即取出uri模板中的变量作为参数。

@RequestMapping(value="/user/{userId}/roles/{roleId}",method = RequestMethod.GET)

     public String getLogin(@PathVariable("userId") String userId, //取出请求URL中的变量值作为参数值

         @PathVariable("roleId") String roleId){

         System.out.println("User Id : " + userId);

         System.out.println("Role Id : " + roleId);

         return "hello";

     }

@PathVariable 与 @PathVariable(“variableName”)的区别：

第一种情况就默认去URI 模板中找跟参数名相同的变量，但是这种情况只有在使用debug 模式进行编译的时候才可以。而第二种情况是明确规定使用的就是URI 模板中的variableName 变量。当不是使用debug 模式进行编译，或者是所需要使用的变量名跟参数名不相同的时候，就要使用第二种方式明确指出使用的是URI 模板中的哪个变量。

2：处理request header部分的注解

@RequestHeader

@RequestHeader 注解，可以把Request请求header部分的值绑定到方法的参数上。

public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,

                              @RequestHeader("Keep-Alive") long keepAlive)  {

}

@CookieValue

@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。

3：处理request body部分的注解

@RequestParam

@requestParam有三个常用参数：defaultValue = , required = , value = ；

defaultValue 表示设置默认值，required 设置是否是必须要传入的参数，value 值表示接受的传入的参数类型。

常用来处理简单类型的绑定，用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容；

@RequestBody

i) 该注解用于读取Request请求的body部分数据，使用系统默认配置的HttpMessageConverter进行解析，然后把相应的数据绑定到要返回的对象上；

ii) 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

@ResponseBody

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

使用时机：返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用；

用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容，例如application/json, application/xml等；

4：处理attribute类型的注解

@ModelAttribute

该Controller的所有方法在调用前，先执行@ModelAttribute方法，可用于方法注解和方法参数的注解中。

当 @ModelAttribute 标记在方法上的时候，该方法将在处理器方法执行之前执行，然后把返回的对象存放在model对象的属性中，属性名称可以用 @ModelAttribute(“attributeName”) 在标记方法的时候指定，若未指定，则使用返回类型的类名称（首字母小写）作为属性名称。

当 @ModelAttribute 标记在处理器方法参数上的时候，表示该参数的值将从模型或者 Session 中取对应名称的属性值，该名称可以通过 @ModelAttribute(“attributeName”) 来指定，若未指定，则使用参数类型的类名称（首字母小写）作为属性名称。

可以把这个@ModelAttribute特性，应用在BaseController当中，所有的Controller继承BaseController，即可实现在调用Controller时，先执行@ModelAttribute方法，实现一些预处理操作。

@SessionAttributes

将值放到session作用域中，用于class级别的注解。