0227--Spring MVC 注解

先提供原文地址：
http://www.cnblogs.com/leskang/p/5445698.html
<b>一.注解简介</b>
1.@Controller
（1）在SpringMVC 中，控制器Controller 负责处理由DispatcherServlet 分发的请求，它把用户请求的数据经过业务处理层处理之后封装成一个Model ，然后再把该Model 返回给对应的View 进行展示。
（2）在SpringMVC 中提供了一个非常简便的定义Controller 的方法，你无需继承特定的类或实现特定的接口，只需使用@Controller 标记一个类是Controller ，然后使用@RequestMapping 和@RequestParam 等一些注解用以定义URL 请求和Controller 方法之间的映射，这样的Controller 就能被外界访问到。
（3）此外Controller 不会直接依赖于HttpServletRequest 和HttpServletResponse 等HttpServlet 对象，它们可以通过Controller 的方法参数灵活的获取到。
<pre>
@Controller
@RequestMapping(value = "/sys")
public class UserController {
@RequestMapping(value = "/login", method = RequestMethod.POST)
public String login(@Valid SysAdminInfo user, BindingResult result, ModelMap model, HttpServletRequest request) {
......
return "redirect:/";
}
}
</pre>
（4）@Controller 用于标记在一个类上，使用它标记的类就是一个SpringMVC Controller 对象。分发处理器将会扫描使用了该注解的类的方法，并检测该方法是否使用了@RequestMapping 注解。
（5）讲一个类标记为Controller之后，还不能算是pringMVC 的一个控制器类，还需要spring来管理，方式如下两种：
<pre>

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

< context:component-scan base-package = "com.wzl.nacsys.controller" />//路径写到controller的上一层
</pre>
一般我们使用方式二，可以包整个controller的包路径一起加载。

2.@RequestMapping
RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。
RequestMapping注解有六个属性，下面我们把她分成三类进行说明：
（1） value， method
--value：指定请求的实际地址，指定的地址可以是URI Template 模式（后面将会说明）；
--method： 指定请求的method类型， GET、POST、PUT、DELETE等；
（2）consumes，produces
--consumes：指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
--produces： 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；
（3）params，headers
--params： 指定request中必须包含某些参数值是，才让该方法处理。
--headers：指定request中必须包含某些指定的header值，才能让该方法处理请求。

3.@Resource和@Autowired
（1）@Resource和@Autowired都是做bean的注入时使用，其实@Resource并不是Spring的注解（属于J2EE），它的包是javax.annotation.Resource，需要导入，但是Spring支持该注解的注入。
（2）@Resource的作用相当于@Autowired，只不过@Autowired按照byType自动注入。
（3）最好是将@Resource放在setter方法上，因为这样更符合面向对象的思想，通过set、get去操作属性，而不是直接去操作属性。
<pre>
public class TestServiceImpl {
// 下面两种@Resource只要使用一种即可
@Resource(name="userDao")
private UserDao userDao; // 用于字段上

@Resource(name="userDao")
public void setUserDao(UserDao userDao) { // 用于属性的setter方法上
    this.userDao = userDao;
}

}
</pre>

4.@ModelAttribute和 @SessionAttributes
5.@PathVariable
用于将请求URL中的模板变量映射到功能处理方法的参数上，即取出uri模板中的变量作为参数。如：
<pre>
@Controller
public class TestController {
@RequestMapping(value="/user/{userId}/roles/{roleId}",method = RequestMethod.GET)
public String getLogin(@PathVariable("userId") String userId,
@PathVariable("roleId") String roleId){
System.out.println("User Id : " + userId);
System.out.println("Role Id : " + roleId);
return "hello";
}
@RequestMapping(value="/product/{productId}",method = RequestMethod.GET)
public String getProduct(@PathVariable("productId") String productId){
System.out.println("Product Id : " + productId);
return "hello";
}
@RequestMapping(value="/javabeat/{regexp1:[a-z-]+}",
method = RequestMethod.GET)
public String getRegExp(@PathVariable("regexp1") String regexp1){
System.out.println("URI Part 1 : " + regexp1);
return "hello";
}
}
</pre>
6.@requestParam
@requestParam主要用于在SpringMVC后台控制层获取参数，类似一种是request.getParameter("name").

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

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

<b>二.注解使用</b>

1. @RequestMapping 与 @PathVariable结合使用
   （1）使用uri模板：
   <pre>
   @Controller
   @RequestMapping ( "/test/{variable1}" )
   public class MyController {
   @RequestMapping ( "/showView/{variable2}" )
   public ModelAndView showView( @PathVariable("variable1") String variable1, @PathVariable ( "variable2" ) int variable2) {
   ModelAndView modelAndView = new ModelAndView();
   modelAndView.setViewName( "viewName" );
   modelAndView.addObject( " " , " " );
   return modelAndView;
   }
   }
   </pre>
   注意：@PathVariable注解的使用有两种方式：
   --@PathVariable String variable1
   --@PathVariable("variable2") variable2
   前者就默认去URI 模板中找跟参数名相同的变量，但是这种情况只有在使用debug 模式进行编译的时候才可以；
   后者明确规定使用的就是URI 模板中的variable2 变量。当不是使用debug 模式进行编译，或者是所需要使用的变量名跟参数名不相同的时候，就要使用第二种方式明确指出使用的是URI 模板中的哪个变量。

（2） 除了在请求路径中使用URI 模板，定义变量之外，@RequestMapping 中还支持通配符“星 ”：
<pre>
@Controller
@RequestMapping ( "/myTest" )
public class MyController {
@RequestMapping ( "星/wildcard" )
public String testWildcard() {
......
return "wildcard" ;
}
}
</pre>

2.@RequestMapping高级用法
（1）params属性
<pre>
// 参数param1 的值必须等于value1
// 参数param2 必须存在，值无所谓
// 参数param3 必须不存在
@RequestMapping (value= "testParams" , params={ "param1=value1" , "param2" , "!param3" })
public String testParams() {
System. out .println( "test Params..........." );
return "testParams" ;
}
</pre>
（2）method属性
<pre>
@RequestMapping (value= "testMethod" , method={RequestMethod. GET , RequestMethod. DELETE })
public String testMethod() {
return "method" ;
}
</pre>
（3）headers属性
<pre>
// 只有当请求头包含Accept 信息，且请求的host 为localhost 的时候才能正确的访问到testHeaders 方法
@RequestMapping (value= "testHeaders" , headers={ "host=localhost" , "Accept" })
public String testHeaders() {
return "headers" ;
}
</pre>
3、 @RequestMapping 标记的处理器方法支持的方法参数和返回类型

1. 支持的方法参数类型

     （1 ）HttpServlet 对象，主要包括HttpServletRequest 、HttpServletResponse 和HttpSession 对象。 这些参数Spring 在调用处理器方法的时候会自动给它们赋值，所以当在处理器方法中需要使用到这些对象的时候，可以直接在方法上给定一个方法参数的申明，然后在方法体里面直接用就可以了。但是有一点需要注意的是在使用HttpSession 对象的时候，如果此时HttpSession 对象还没有建立起来的话就会有问题。
   

   （2 ）Spring 自己的WebRequest 对象。 使用该对象可以访问到存放在HttpServletRequest 和HttpSession 中的属性值。

   （3 ）InputStream 、OutputStream 、Reader 和Writer 。 InputStream 和Reader 是针对HttpServletRequest 而言的，可以从里面取数据；OutputStream 和Writer 是针对HttpServletResponse 而言的，可以往里面写数据。

   （4 ）使用@PathVariable 、@RequestParam 、@CookieValue 和@RequestHeader 标记的参数。

   （5 ）使用@ModelAttribute 标记的参数。

   （6 ）java.util.Map 、Spring 封装的Model 和ModelMap 。 这些都可以用来封装模型数据，用来给视图做展示。

   （7 ）实体类。 可以用来接收上传的参数。

   （8 ）Spring 封装的MultipartFile 。 用来接收上传文件的。

   （9 ）Spring 封装的Errors 和BindingResult 对象。 这两个对象参数必须紧接在需要验证的实体对象参数之后，它里面包含了实体对象的验证结果。

2. 支持的返回类型

   （1 ）一个包含模型和视图的ModelAndView 对象。

   （2 ）一个模型对象，这主要包括Spring 封装好的Model 和ModelMap ，以及java.util.Map ，当没有视图返回的时候视图名称将由RequestToViewNameTranslator 来决定。

   （3 ）一个View 对象。这个时候如果在渲染视图的过程中模型的话就可以给处理器方法定义一个模型参数，然后在方法体里面往模型中添加值。

   （4 ）一个String 字符串。这往往代表的是一个视图名称。这个时候如果需要在渲染视图的过程中需要模型的话就可以给处理器方法一个模型参数，然后在方法体里面往模型中添加值就可以了。

   （5 ）返回值是void 。这种情况一般是我们直接把返回结果写到HttpServletResponse 中了，如果没有写的话，那么Spring 将会利用RequestToViewNameTranslator 来返回一个对应的视图名称。如果视图中需要模型的话，处理方法与返回字符串的情况相同。

   （6 ）如果处理器方法被注解@ResponseBody 标记的话，那么处理器方法的任何返回类型都会通过HttpMessageConverters 转换之后写到HttpServletResponse 中，而不会像上面的那些情况一样当做视图或者模型来处理。

   （7 ）除以上几种情况之外的其他任何返回类型都会被当做模型中的一个属性来处理，而返回的视图还是由RequestToViewNameTranslator 来决定，添加到模型中的属性名称可以在该方法上用@ModelAttribute(“attributeName”) 来定义，否则将使用返回类型的类名称的首字母小写形式来表示。使用@ModelAttribute 标记的方法会在@RequestMapping 标记的方法执行之前执行。