Spring常用注解

这是从网上几个前辈的资料里面整合出来的，如有冒犯多多原谅。

@Controller

@Controller 负责注册一个bean 到spring 上下文中，bean 的ID 默认为

类名称开头字母小写,你也可以自己指定，如下

方法一：

@Controller

public class TestController {}

方法二：

@Controller(“tmpController”)

public class TestController {}

@RequestMapping

@RequestMapping

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

1.@RequestMapping用来定义访问的URL，你可以为整个类定义一个

@RequestMapping，或者为每个方法指定一个。

把@RequestMapping放在类级别上，这可令它与方法级别上的

@RequestMapping注解协同工作，取得缩小选择范围的效果。

例如：

@RequestMapping(“/test”)

public class TestController {}

则，该类下的所有访问路径都在/test之下。

2.完整的参数项为：@RequestMapping(value=”“,method ={“”,”“},headers={},params={“”,”“})，各参数说明如下：

value :String[] 设置访问地址

method: RequestMethod[]设置访问方式，字符数组，查看RequestMethod

类，包括GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE,常用

RequestMethod.GET，RequestMethod.POST

headers:String[] headers一般结合method = RequestMethod.POST使用

params: String[] 访问参数设置，字符数组 例如：userId=id

3.value的配置指定请求的实际地址，指定的地址可以是URI Template 模式

value的uri值为以下三类：

A） 可以指定为普通的具体值；

B) 可以指定为含有某变量的一类值；

如：
@RequestMapping(value="/ys/{Id}", method=RequestMethod.GET)
这里Id就是用于匹配的变量

C) 可以指定为含正则表达式的一类值;

如：
@RequestMapping("/ys/{isIDCard1:/^[1-9]\d{7}((0\d)|(1[0-2]))(([0|1|2]\d)|3[0-1])\d{3}")
这里是网上找的，匹配身份证的正则表达式

4.consumes： 指定处理请求的提交内容类型

例如application/json, text/html;

@RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")

方法仅处理request Content-Type为“application/json”类型的请求。

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

@RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, produces="application/json")

方法仅处理request请求中Accept头中包含了"application/json"的请求，同时暗示了返回的内容类型是application/json格式;

6.params： 指定request中必须包含某些参数值符合时才让该方法处理

@RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, params="myParam=myValue")

仅处理请求中包含了名为“myParam”，值为“myValue”的请求；

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

@RequestMapping(value = "/pets", method = RequestMethod.GET,headers="Referer=http://www.ifeng.com/")

仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.ifeng.com/”的请求；

8.有一点需要注意的

如果为类定义了访问地址为.do,.html之类的，则在方法级的@RequestMapping，不能再定义value值，否则会报错，例如

@RequestMapping("/bbs.do")
public class BbsController {
@RequestMapping(params = "method=getList")
public String getList() {
return "list";
}
@RequestMapping(value= "/spList")
public String getSpecialList() {
return "splist";
}
}

如上例：/bbs.do?method=getList 可以访问到方法getList() ；而访

问/bbs.do/spList则会报错.

@PathVariable

@PathVariable用于方法中的参数，表示方法参数绑定到地址URL的模板变量。

当使用@RequestMapping URI template 样式映射时， 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。

例如：

@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {

@RequestMapping("/pets/{petId}")
public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
}
}

上面代码把变量ownerId的值和petId的值，绑定到findPet方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致，需要在@PathVariable("name")指定uri template中的名称。

@ModelAttribute

1.应用于方法参数,参数可以在页面直接获取，相当于

request.setAttribute(,)

2.应用于方法,将任何一个拥有返回值的方法标注上 @ModelAttribute，使其返回值将会进入到模型对象的属性列表中.

3.应用于方法参数时@ModelAttribute(“xx”),须关联到Object的数据类型，基本数据类型 如：int,String不起作用

例如：

@ModelAttribute("items")//<——①向模型对象中添加一个名为items的

属性
public List<String> populateItems() {
List<String> lists = new ArrayList<String>();
lists.add("item1");
lists.add("item2");
return lists;
}
@RequestMapping(params = "method=listAllBoard")
public String listAllBoard(@ModelAttribute("currUser")User user,

ModelMap model) {
bbtForumService.getAllBoard();
//<——②在此访问模型中的items属性
System.out.println("model.items:" + ((List<String>)

model.get("items")).size());
return "listBoard";
}

在 ① 处，通过使用 @ModelAttribute 注解，populateItem() 方法将在

任何请求处理方法执行前调用，Spring MVC 会将该方法返回值以“items

”为名放入到隐含的模型对象属性列表中。

所以在 ② 处，我们就可以通过 ModelMap 入参访问到 items 属性，当执

行 listAllBoard() 请求处理方法时，② 处将在控制台打印

出“model.items:2”的信息。当然我们也可以在请求的视图中访问到模型

对象中的 items 属性。

@RequestHeader

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

这是一个Request 的header部分：

Host                    localhost:8080
Accept                  text/html,application/xhtml+xml,application/xml;q=0.9
Accept-Language         fr,en-gb;q=0.7,en;q=0.3
Accept-Encoding         gzip,deflate
Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7
Keep-Alive              300

@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
@RequestHeader("Keep-Alive") long keepAlive)  {

}

上面的代码，把request header部分的 Accept-Encoding的值，绑定到参数encoding上了， Keep-Alive header的值绑定到参数keepAlive上。

@CookieValue

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

例如有如下Cookie值：

JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84

@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {

}

把JSESSIONID的值绑定到displayHeaderInfo方法的参数cookie上。

@RequestParam

A） 常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String–> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；

B）用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容，提交方式GET、POST；

C ) @RequestParam包含3个配置 @RequestParam(required = ,value=”“, defaultValue = “”)

required :参数是否必须，boolean类型,可选项，默认为true

value: 传递的参数名称，String类型,可选项，如果有值，对应到设置方法的参数

defaultValue:String类型,参数没有传递时为参数默认指定的值

@RequestMapping(method = RequestMethod.GET)
public String setupForm(@RequestParam("petId") int petId, ModelMap model) {
Pet pet = this.clinic.loadPet(petId);
model.addAttribute("pet", pet);
return "petForm";
}

@RequestBody

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

它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body，然后绑定到相应的bean上的。

因为配置有FormHttpMessageConverter，所以也可以用来处理 application/x-www-form-urlencoded的内容，处理完的结果放在一个MultiValueMap

@RequestMapping(value = "/something", method = RequestMethod.PUT)
public void handle(@RequestBody String body, Writer writer) throws IOException {
writer.write(body);
}

作用：

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

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

A) GET、POST方式提时， 根据request header Content-Type的值来判断:

application/x-www-form-urlencoded， 可选（即非必须，因为这种情况的数据@RequestParam, @ModelAttribute也可以处理，当然@RequestBody也能处理）；
multipart/form-data, 不能处理（即使用@RequestBody不能处理这种格式的数据）；
其他格式， 必须（其他格式包括application/json, application/xml等。这些格式的数据，必须使用@RequestBody来处理）；

B) PUT方式提交时， 根据request header Content-Type的值来判断:

application/x-www-form-urlencoded， 必须；
multipart/form-data, 不能处理；
其他格式， 必须；

@SessionAttributes session管理

该注解用来绑定HttpSession中的attribute对象的值，允许我们有选择地指定 ModelMap 中的哪些属性需要转存到 session 中便于在方法中的参数里使用。

该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；

@Controller
@RequestMapping("/editPet.do")
@SessionAttributes("currUser") // 将ModelMap 中属性名为currUser 的属性放入session
public class EditPetForm {
// ...
}

@SessionAttributes({"attr1","attr2"})
@SessionAttributes(types = User.class)
@SessionAttributes(types = {User.class,Dept.class})
@SessionAttributes(types = {User.class,Dept.class},value={"attr1","attr2"})

@ModelAttribute

用于方法上时： 通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；

用于参数上时： 用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：

A） @SessionAttributes 启用的attribute 对象上；

B） @ModelAttribute 用于方法上时指定的model对象；

C） 上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。

1 ) 用到方法上

@ModelAttribute
public Account addAccount(@RequestParam String number) {
return accountManager.findAccount(number);
}
这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）；

2 ) 用在参数上

@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)
public String processSubmit(@ModelAttribute Pet pet) {

}
先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。