springmvc注解详解

随着Annotation的流行,一些主流框架都加入了对Annotation的支持。使用Annotation能够简化很多配置工作,能够很大程度上提高程序开发的效率。本文将 Spring 2.5 新增的 Sping MVC 注解功能,介绍如何使用注解配置替换传统的基于 XML 的 Spring MVC 配置。
弃用了struts,用spring mvc框架做了几个项目,感觉都不错,而且使用了注解方式,可以省掉一大堆配置文件。本文主要介绍使用注解方式配置的spring mvc。

@Controller

@Controller 负责注册一个bean到spring上下文中,bean的ID默认为类名称开头字母小写,你也可以自己指定,如下:

//方法一: 
@Controller 
public class TestController {} 

//方法二:            
@Controller("tmpController") 
public class TestController {} 
@RequestMapping
  1. @RequestMapping用来定义访问的URL,你可以为整个类定义一个@RequestMapping,或者为每个方法指定一个。
    把@RequestMapping放在类级别上,这可令它与方法级别上的@RequestMapping注解协同工作,取得缩小选择范围的效果。
    例如:
@RequestMapping("/test") 
public class TestController {} 

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

  1. 将@RequestMapping用于整个类不是必须的,如果没有配置,所有的方法的访问路径配置将是完全独立的,没有任何关联。
  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的配置还可以采用模版变量的形式,例如:
    @RequestMapping(value="/owners/{ownerId}",method=RequestMethod.GET)这点将在介绍@PathVariable中详细说明。
  4. @RequestMapping params的补充说明,你可以通过设置参数条件来限制访问地址,例如params="myParam=myValue"表达式,访问地址中参数只有包含了该规定的值"myParam=myValue"才能匹配得上,类似"myParam"之类的表达式也是支持的,表示当前请求的地址必须有该参数(参数的值可以是任意),"!myParam"之类的表达式表明当前请求的地址不能包含具体指定的参数"myParam"。
  5. 有一点需要注意的,如果为类定义了访问地址为.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
  1. @PathVariable用于方法中的参数,表示方法参数绑定到地址URL的模板变量。
@RequestMapping(value="/owners/{ownerId}", method=RequestMethod.GET)  
public String findOwner( , Model model) {  
  Owner owner = ownerService.findOwner(ownerId);    
  model.addAttribute("owner", owner);    
  return "displayOwner";  
}  
  1. @PathVariable用于地址栏使用{xxx}模版变量时使用。如果@RequestMapping没有定义类似"/{ownerId}" ,这种变量,则使用在方法中@PathVariable会报错。
@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 属性。

@ResponseBody

这个注解可以直接放在方法上,表示返回类型将会直接作为HTTP响应字节流输出(不被放置在Model,也不被拦截为视图页面名称)。可以用于ajax。

@RequestParam

@RequestParam是一个可选参数,例如:@RequestParam("id")注解,所以它将和URL所带参数 id进行绑定如果入参是基本数据类型(如int、long、float等),URL请求参数中一定要有对应的参数,否则将抛出org.springframework.web.util.NestedServletException 异常,提示无法将 null 转换为基本数据类型.

@RequestParam包含3个配置 @RequestParam(required = ,value="", defaultValue="")
required :参数是否必须,boolean类型,可选项,默认为true
value: 传递的参数名称,String类型,可选项,如果有值,对应到设置方法的参数
defaultValue:String类型,参数没有传递时为参数默认指定的值

@SessionAttributes

Spring 允许我们有选择地指定ModelMap中的哪些属性需要转存到session中,以便下一个请求属对应的ModelMap的属性列表中还能访问到这些属性。这一功能是通过类定义处标注 @SessionAttributes 注解来实现的。@SessionAttributes 只能声明在类上,而不能声明在方法上。
例如:

@SessionAttributes("currUser") // 将ModelMap 中属性名为currUser 的属性 
@SessionAttributes({"attr1","attr2"}) 
@SessionAttributes(types = User.class) 
@SessionAttributes(types = {User.class,Dept.class}) 
@SessionAttributes(types = {User.class,Dept.class},value={"attr1","attr2"}) 


@CookieValue 获取cookie信息 
@RequestHeader 获取请求的头部信息
@ControllerAdvice 全局异常处理器 和@ExceptionHandler配合使用
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,761评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,953评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,998评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,248评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,130评论 4 356
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,145评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,550评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,236评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,510评论 1 291
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,601评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,376评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,247评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,613评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,911评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,191评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,532评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,739评论 2 335

推荐阅读更多精彩内容