SpringMVC——常用注解

引言：

                SpringMVC注解开发是一种springmvc的便捷方式，通过注解降低了配置文件的复杂性。

概述：

                SpringMVC常用的注解有很多，我们今天只总结最常用的几个注解，主要包括注解的含义和作用以及相似注解的区别与联系。

内容：

                 一 @Controller      

                   1 含义：Controller代表控制层，@Controller定义控制层的bean。

                   2 作用：定义Controller的bean，无需继承特定的类或者实现特定的接口（public class ItemsController implements   Controller），只需要使用@Controller标记一个类是Controller即可，如下所示

@Controller
Public class ItemsController{}；

                   3  说明：我们单纯使用@Controller标记一个类并不能真正将该类定义为SpringMVC的一个控制类，需要把它交给Spring来管理才行，也就是在SpringMVC配置文件（springmvc.xml）中进行配置。

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

<bean id="itemsController" name="/queryItems_test.action" class="cn.itcast.ssm.controller.ItemsController" />

                                （2）在SpringMVC的配置文件中告诉控制类所在的包的路径cn.itcast.ssm.controller，通过context：component-scan自动扫描匹配，

<context:component-scan base-package="cn.itcast.ssm.controller"></context:component-scan>

          二 @RequestMapping

                  1 含义：请求映射

                  2 作用：定义Controller方法对应的url，进行处理器映射使用，可以窄化请求映射，即在类头写入该映射，映射request请求与处理器。

                  3 六大属性：

                      （1）value和method

                               1）value：指定请求的实际地址，指定的地址可以是URI Template模式

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

                               3）示例：使用method参数限制了以GET或DELETE方法请求/testMethod的时候才能访问到该controller的testMethod方法。

		      @RequestMapping (value= "testMethod" , method={RequestMethod. GET , RequestMethod. DELETE })
	         public String testMethod() {
		      return "testMethod" ;
	         }

                          （2）consumes和produces

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

                               2）produces：指定返回的内容类型，仅当request请求头中的（Accept）类型中包含该指定类型才返回。

                      （3）params和headers

                               1）params：指定request中必须包含某些参数值，才访问该controller方法

		        @RequestMapping (value= "testParams" , params={ "param1=value1" , "param2" , "!param3" })
		public String testParams() {
			System. out .println( "test Params..........." );
				return "testParams" ;
		}
	 					
	        用@RequestMapping 的params 属性指定了三个参数，这些参数都是针对请求参数而言的，
                它们分别表示参数param1 的值必须等于value1 ，参数param2 必须存在，值无所谓，参数param3 必须不存在，
                只有当请求/testParams.do 并且满足指定的三个参数条件的时候才能访问到该方法。
                所以当请求/testParams.do?param1=value1¶m2=value2 的时候能够正确访问到该testParams 方法，
                当请求/testParams.do?param1=value1¶m2=value2¶m3=value3 的时候就不能够正常的访问到该方法，
                因为在@RequestMapping 的params 参数里面指定了参数param3 是不能存在的。

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

                     @RequestMapping(value="testHeaders",headers={"host=localhost","Accept"})
                public String testHeaders(){
	             return "headers";
                }
                headers属性的用法和功能与params 属性相似。
                在上面的代码中当请求/testHeaders.do 的时候只有当请求头包含Accept 信息，
                且请求的host为localhost 的时候才能正确的访问到testHeaders 方法。

                  4 使用@RequestMapping映射Request请求与处理器的方式

                     （1）通过常见的类路径和方法路径结合访问controller方法

                     （2）使用URI模板：在URI中给定一个变量，然后再映射的时候动态的给该变量赋值。

                     （3）使用通配符                           

		        @Controller
		@RequestMapping ( "/myTest" )
		public class MyController {
			@RequestMapping ( "*/wildcard" )
			public String testWildcard() {
				 System. out .println( "wildcard------------" );
					return "wildcard" ;
			}  
		}

                  5 支持的方法参数类型

                      （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 对象。 这两个对象参数必须紧接在需要验证的实体对象参数之后，它里面包含了实体对象的验证结果。

          三 @Resource和Autowired

                  1 作用：都用来注入bean，其实@Resource并不是Spring的注解，它的包是javax.annotation.Resource，需要导入，只不过Spring支持该注解的注入。

                  2 共同点：都可以写到字段和setter方法上，如果都写在字段上，不需要再实现setter方法。

                  3 不同点：

                     （1）@Autowired：需要导入包org.springframework.beans.factory.annotation.Autowired，按照ByType注入。

		       public class TestServiceImpl {
			// 下面两种@Autowired只要使用一种即可
			@Autowired
			private UserDao userDao; // 用于字段上
			@Autowired
			public void setUserDao(UserDao userDao) { // 用于属性的方法上
				this.userDao = userDao;
			 }
		}

                              @Autowired注解按照类型（ByType）装配依赖对象，默认情况下要求依赖对象必须存在，如果允许为null，可以设置它的required属性为false，如果想用ByName方式，结合@Qualifier注解一起使用，代码如下

		public class TestServiceImpl {
		@Autowired
		@Qualifier("userDao")
		private UserDao userDao; 
	   }

                           （2）@Resource：默认按照ByName自动注入，由J2EE提供，需要导入javax.annotation.Resource。包含俩个重要属性：name和type；属性为name，采用ByName自动注入策略，属性为type采用ByType自动注入策略，如果俩个属性都不使用，通过反射机制使用ByName自动注入策略。@Resource的作用相当于@Autowired，只不过@Autowired按照ByType自动注入。

		public class TestServiceImpl {
			// 下面两种@Resource只要使用一种即可
			@Resource(name="userDao")
			private UserDao userDao; // 用于字段上
			@Resource(name="userDao")
			public void setUserDao(UserDao userDao) { // 用于属性的setter方法上
				this.userDao = userDao;
			}
	    }
            注意：最好将@Resource放在setter方法上，通过set、get去操作属性，而不是直接去操作属性，更符合面向对象的思想 

                                 @Resource装配顺序

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

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

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

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

          四 @ModelAttribute和SessionAttributes：传递和保存数据，在不同模型和控制器之间共享数据。

          五 @PathVariable：将请求URL中的模板变量映射到功能处理方法的参数上，即取出URL模板的变量作为参数

	@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";  
	        }  
	}

                         与@requestParam区别：请求路径上有个id的变量值，可以通过@PathVariable来获取 @RequestMapping(value ="/page/{id}", method = RequestMethod.GET)；@requestParam用来获得静态的URL请求参数，spring注解时action里用到。

          六 @requestParam：用于后台获取参数，类似于request.getParameter("name")

                  三个常用参数：（1）defaultValue：设置默认值；（2）required：是否必须要传入参数，true/false；（3）value：表示接受的传入参数的类型

          七 @ResponseBody：用于Controller方法返回对象，通过适当的HttpMessageConverter转换为指定格式后，写入Response对象的body数据。

                 使用场景：返回json、xml等格式的数据时，返回值不能是html标签的页面。  

          八 @Component：泛指组件，标注不好归类的组件

          九 @Repository：用于标注数据访问层组件，即DAO组件

总结：

                SpringMVC注解开发能减少配置文件的大量配置内容，熟悉常用注解的使用，可以提高我们的开发效率，上述注解是很常用的注解，还有其他常用的注解也需要掌握，例如@Transactional等。注解开发已成为互联网流行的开发方式，注解在手，配置我有。