SpringMVC的常用注解
注解 |
说明 |
@Controller |
用于说明这个类是一个控制器 |
@RequestMapping |
用于注释一个控制器类或者控制器类的方法 |
@RequestParam |
用于将指定的请求参数赋值给方法中的形参。 |
@PathVariable |
用户获得请求URL中的动态参数。 |
@RequestHeader |
用于将请求的头信息区数据映射到功能处理方法的参数上。 |
@CookieValue |
用于将请求的Cookie数据映射到功能处理方法的参数上。 |
@SessionAttributes |
用于指定Model中的某些属性转存到HttpSession对象中。 |
@ModelAttribute |
用于将请求参数绑定到Model对象。 |
1、 @Controller注解
@Controller用于标记一个类,使用它标记的类就是一个SpringMVC Controller对象,即一个控制器类。Spring使用扫描机制查找应用程序中所有基于注解的控制器类。分发处理器会扫描使用了该注解的类的方法,并检测该方法是否使用了@RequestMapping注解,而且使用了@RequestMapping注解的方法才是真正处理请求的处理器。为了保证Spring能找到控制器,需要完成下面两件事情:
① 在springmvc-config.xml中头文件引入spring-context(context是Spring的IOC容器,是用来调用别人的功能的)。
② 使用<context:component-scan/>元素(用于启动包扫描功能)。
2、 @RequestMapping
@RequestMapping可以用来注释一个控制器类,此时,所有方法都将映射为相对于类级别的请求。同时也可以用于注释方法。
属性 |
说明 |
value |
说明注释方法的路径名称。 |
method |
说明用哪些HTTP请求方式处理,如POST或GET。 |
consumes |
指定处理request请求的提交内容类型,仅处理为”application/jspn”类型的请求。 |
produces |
指定返回的内容类型,必须是request请求头中包含的类型,进处理”application/json”的请求,同时指定了返回的内容类型为”application/json”。 |
params |
指定request中必须包含某些参数值。 |
headers |
指定rquest中必须包含某些指定的header值。 |
而且请求处理方法可出现的参数类型,每个请求处理方法可以有多个不同类型的参数,请求处理方法可返回的类型也有多种。
Model和ModelAndView
a) Model或ModelMap:Spring MVC在调用处理方法之前会创建一个隐含的模型对象,作为模型数据的存储容器。如果处理方法的参数为Model或ModelMap类型,则Spring MVC会将隐含模型的引用传递给这些参数。在处理方法内部,开发者就可以通过这个参数对象访问模型中的所有数据,也可以向模型中添加新的属性数据。
在处理方法中,Model和ModelMap对象都可以使用如下方法添加模型数据:
addObject(String attributeName, Object attributeValue);
b) ModelAndView:控制器处理方法的返回值如果是ModelAndView,则其既包含模型数据信息,也包含使徒信息,这样Spring MVC将使用包含的视图对模型数据进行渲染。
在处理方法中可以使用ModelAndView对象的如下方法添加模型数据:
addObject(String attributeName, Object attributeValue);
可以通过如下方法设置视图:
setViewName(String viewName);
3、 @RequestParam
@RequestParam直接用于参数绑定,可指定如下表的属性:
属性 |
类型 |
是否必要 |
说明 |
name |
String |
否 |
指定请求头绑定的名称 |
value |
String |
否 |
name属性的别名 |
required |
Boolean |
否 |
指示参数是否必须绑定 |
defaultValue |
String |
否 |
如果没有传递参数而是用的默认值 |
4、 @PathVariable
@PathVariable注解可以方便地获得请求URL中的动态参数。@PathVariable注解只支持一个属性value,类型为String,表示绑定的名称,如果省略则默认绑定同名参数。
5、 @RequestHeader
@RequestHeader注解用于将请求的头信息区数据映射到功能处理方法的参数上。下表是支持的属性:
属性 |
类型 |
是否必要 |
说明 |
name |
String |
否 |
指定请求头绑定的名称 |
value |
String |
否 |
name属性的别名 |
required |
Boolean |
否 |
指定参数是否必须绑定 |
defaultValue |
String |
否 |
如果没有传递参数而使用的默认值 |
6、 @CookieValue
@CookieValue注解用于将请求的Cookie数据映射到功能处理方法的参数上。下表是该注解支持的属性:
属性 |
类型 |
是否必要 |
说明 |
name |
String |
否 |
指定请求头绑定的名称 |
value |
String |
否 |
name属性的别名 |
required |
Boolean |
否 |
指定参数是否必须绑定 |
defaultValue |
String |
否 |
如果没有传递参数而使用的默认值 |
7、 @SessionAttributes
@SessionAttributes注解允许我们有选择地制定Model中的哪些属性需要转存到HttpSession当中。@SessionAttributes只能声明在类上。下表是该注解支持的属性:
属性 |
类型 |
是否必要 |
说明 |
names |
String[] |
否 |
Model中属性的名称,即存储在HttpSession当中的属性名称 |
value |
String[] |
否 |
names属性的别名 |
types |
Class<?>[] |
否 |
指示参数是否必须绑定 |
8、 @ModelAttribute
@ModelAttribute注解将请求参数绑定到Model对象。@ModelAttribute注解只支持一个属性value,类型为String,表示绑定的属性名称。
被@ModelAttribute注解的方法会在Contorller每个方法执行前被执行,因此在一个Controller映射到多个URL时,要谨慎使用。