spring MVC和spring的注解

摘要: 关于spring MVC和spring的关系 ，注解关系

概述
注释配置相对于 XML 配置具有很多的优势：
它可以充分利用 Java 的反射机制获取类结构信息，这些信息可以有效减少配置的工作。如使用 JPA 注释配置 ORM 映射时，我们就不需要指定 PO 的属性名、类型等信息，如果关系表字段和 PO 属性名、类型都一致，您甚至无需编写任务属性映射信息——因为这些信息都可以通过 Java 反射机制获取。
注释和 Java 代码位于一个文件中，而 XML 配置采用独立的配置文件，大多数配置信息在程序开发完成后都不会调整，如果配置信息和 Java 代码放在一起，有助于增强程序的内聚性。而采用独立的 XML 配置文件，程序员在编写一个功能时，往往需要在程序文件和配置文件中不停切换，这种思维上的不连贯会降低开发效率。

springmvc和struts是一个层次的概念，均属java web mvc框架，只是ssh中第2个s的技术。

ssh一般意义上是指 struts，spring framework以及hibernate。这三个框架作用是不一样的。
hibernate主要是用于持久层，struts主要是用于mvc，而spring主要用于aop和ioc。

spring mvc常用的注解： @Controller 、 @RequestMapping 、 @PathVariable 、 @ModelAttribute 、 @ResponseBody 、 @RequestParam 、 @SessionAttributes 、@CookieValue 、@RequestHeader 九个

@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之下。

2.将@RequestMapping用于整个类不是必须的，如果没有配置，所有的方法的访问路径配置将是完全独立的，没有任何关联。

3.完整的参数项为：@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

4.value的配置还可以采用模版变量的形式 ，例如：@RequestMapping

(value="/owners/{ownerId}", method=RequestMethod.GET)，这点将在介

绍@PathVariable中详细说明。

5.@RequestMapping params的补充说明，你可以通过设置参数条件来限制

访问地址，例如params="myParam=myValue"表达式，访问地址中参数只有

包含了该规定的值"myParam=myValue"才能匹配得上，类似"myParam"之类

的表达式也是支持的，表示当前请求的地址必须有该参数(参数的值可以是

任意)，"!myParam"之类的表达式表明当前请求的地址不能包含具体指定的

参数"myParam"。

6.有一点需要注意的，如果为类定义了访问地址为*.do,*.html之类的，则

在方法级的@RequestMapping，不能再定义value值，否则会报错，例如
Java代码
@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的模板

变量。
例如：
Java代码
@RequestMapping(value="/owners/{ownerId}",

method=RequestMethod.GET)
public String findOwner(@PathVariable String ownerId, Model

model) {
Owner owner = ownerService.findOwner(ownerId);
model.addAttribute("owner", owner);
return "displayOwner";
}

2.@PathVariable用于地址栏使用{xxx}模版变量时使用。
如果@RequestMapping没有定义类似"/{ownerId}" ，这种变量，则使用在

方法中@PathVariable会报错。

@ModelAttribute
1.应用于方法参数,参数可以在页面直接获取，相当于request.setAttribute(,)
2.应用于方法,将任何一个拥有返回值的方法标注上 @ModelAttribute，使其返回值将会进入到模型对象的属性列表中.
3.应用于方法参数时@ModelAttribute("xx"),须关联到Object的数据类型，基本数据类型 如：int,String不起作用。

例如：
Java代码
@ModelAttribute("items")//<——①向模型对象中添加一个名为items的属性
public List populateItems() {
List lists = new ArrayList();
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)

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类型,参数没有传递时为参数指定默认的值。

如：

package com.happyBKs.springmvc.handlers;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

@RequestMapping("class")
@Controller
public class RPTestHandler {

String page="successrm";

@RequestMapping("student")
public String handle(@RequestParam(value="username") String un, @RequestParam(value="age",required=false, defaultValue="0") int age)
{
System.out.println("a student's request has come. username: "+un+", age: "+age);
return page;
}

}

一、基本使用，获取提交的参数
后端代码：

Java代码



@RequestMapping("testRequestParam")

public String filesUpload(@RequestParam String inputStr, HttpServletRequest request) {

System.out.println(inputStr);

int inputInt = Integer.valueOf(request.getParameter("inputInt"));

System.out.println(inputInt);

// ......省略

return "index";

}

前端代码：

Html代码



<form action="/gadget/testRequestParam" method="post">

参数inputStr:<input type="text" name="inputStr">

参数intputInt:<input type="text" name="inputInt">

</form>

前端界面：



执行结果：
test1
123

可以看到spring会自动根据参数名字封装进入，我们可以直接拿这个参数名来用

二、各种异常情况处理
1、可以对传入参数指定参数名

Java代码



@RequestParam String inputStr

// 下面的对传入参数指定为aa，如果前端不传aa参数名，会报错

@RequestParam(value="aa") String inputStr

错误信息：
HTTP Status 400 - Required String parameter 'aa' is not present

2、可以通过required=false或者true来要求@RequestParam配置的前端参数是否一定要传

Java代码



// required=false表示不传的话，会给参数赋值为null，required=true就是必须要有

@RequestMapping("testRequestParam")

public String filesUpload(@RequestParam(value="aa", required=true) String inputStr, HttpServletRequest request)

3、如果用@ RequestParam 注解的参数是int基本类型，但是required=false，这时如果不传参数值会报错，因为不传值，会赋值为null给int，这个不可以

Java代码



@RequestMapping("testRequestParam")

public String filesUpload(@RequestParam(value="aa", required=true) String inputStr,

@RequestParam(value="inputInt", required=false) int inputInt

,HttpServletRequest request) {

// ......省略

return "index";

}

解决方法：
“Consider declaring it as object wrapper for the corresponding primitive type.”建议使用包装类型代替基本类型，如使用“Integer”代替“int”

@SessionAttributes

session管理，Spring 允许我们有选择地指定 ModelMap 中的哪些属性需要转存到session 中，以便下一个请求属对应的 ModelMap 的属性列表中还能访问到这些属性。这一功能是通过类定义处标注 @SessionAttributes 注解来实现的。@SessionAttributes 只能声明在类上，而不能声明在方法上。
在 默认情况下，ModelMap 中的属性作用域是 request 级别是，也就是说，当本次请求结束后，ModelMap 中的属性将销毁。如果希望在 多个请求中共享 ModelMap 中的属性，必须将其属性转存到 session 中，这样ModelMap 的属性才可以被跨请求访问。 Spring 允许我们有选择地指定 ModelMap 中的哪些属性需要转存到 session 中，以便下一个请求属对应的ModelMap 的属性 列表中还能访问到这些属性。这一功能是通过类定义处标注 @SessionAttributes 注解来实现的。

代码：

使模型对象的特定属性具有 Session 范围的作用域

Java代码


package com.baobaotao.web;

…

import org.springframework.ui.ModelMap;

import org.springframework.web.bind.annotation.SessionAttributes;

@Controller

@RequestMapping("/bbtForum.do")

@SessionAttributes("currUser") //①将ModelMap中属性名为currUser的属性

//放到Session属性列表中，以便这个属性可以跨请求访问

public class BbtForumController {

…

@RequestMapping(params = "method=listBoardTopic")

public String listBoardTopic(@RequestParam("id")int topicId, User user,

ModelMap model) {

bbtForumService.getBoardTopics(topicId);

System.out.println("topicId:" + topicId);

System.out.println("user:" + user);

model.addAttribute("currUser",user); //②向ModelMap中添加一个属性

return "listTopic";

}

}

我们在 ② 处添加了一个 ModelMap 属性，其属性名为 currUser，而 ① 处通过 @SessionAttributes 注解将ModelMap 中名为 currUser 的属性放置到 Session 中， 所以我们不但可以在 listBoardTopic() 请求所对应的 JSP视图页面中通 过 request.getAttribute(“currUser”) 和 session.getAttribute(“currUser”) 获 取 user 对象，还可以在下一个请求所对应的 JSP 视图页面中通 过 session.getAttribute(“currUser”) 或 ModelMap#get(“currUser”) 访问到这个属性。

这里我们仅将一个 ModelMap 的属性放入 Session 中，其实 @SessionAttributes 允许指定多个属性。你可以通过字符 串数组的方式指定多个属性，如 @SessionAttributes({“attr1”,”attr2”})。此 外，@SessionAttributes 还可以通过属性类型指定要 session 化的 ModelMap 属性， 如 @SessionAttributes(types = User.class)，当然也可以指定多个类，如 @SessionAttributes(types
= {User.class,Dept.class})，还可以联合使用属性名和属性类型指定：@SessionAttributes(types = {User.class,Dept.class},value={“attr1”,”attr2”})。

二、@ModelAttribute

我们可以在 需要访问 Session 属性的 controller 上加上 @SessionAttributes，然后在 action 需要的 User 参数上加上 @ModelAttribute，并保证两者的属性名称一致。SpringMVC 就会自动将 @SessionAttributes 定义的属性注入到 ModelMap 对象，在 setup action 的参数列表时，去
ModelMap 中取到这样的对象，再添加到参数列表。只要我们不去调用 SessionStatus 的 setComplete() 方法，这个对象就会一直保留在 Session 中，从而实现 Session 信息的共享。

Java代码

@Controller

@SessionAttributes("currentUser")

public class GreetingController{

@RequestMapping

public void hello(@ModelAttribute("currentUser")
User user){

//user.sayHello()

}

}

Spring MVC 对于@ModelAttribute 、@SessionAttributes 的详细处理流程

1）Spring MVC 在调用处理方法之前，在请求线程中自动的创建一个隐含的模型对象。

2）调用所有方法级的 标注了 @ModelAttribute 的方法，并将方法返回值添加到隐含的模型对象中。

3）如果方法所在的控制器 （标记 @Controller的类）没有标记 @SessionAttributes("sessionXXX") 注释，则该处理步骤可跳过。

查看Session 中是否存在 sessionXXX 属性，如果有，将其添加到隐含的模型对象中。如果隐含的模型对象中已经存在了sessionXXX属性，则其值将会被覆盖。

以下的步骤是针对 标记@ModelAttribute("xxx") 方法入参 的

4）如果隐含的模型对象已经存在xxx属性，则将其赋值给入参，并将用户的请求消息 赋值给入参的相应属性 (PS:支持级联属性)，并返回，以下的处理步骤不再进行。

5）如果 方法所在的控制器、标记了 @SessionAttributes("xxx") 注释，则继续进行该处理步骤，否则直接进入步骤6。

查找 Session，如果没有找到 xxx 属性，则抛出异常 HttpSessionRequiredException 。

如果找到则将其赋值给入参，并将用户的请求消息 赋值给入参的相应属性 (PS:支持级联属性)，并返回，以下的处理步骤不再进行。

6）创建入参实例，并将其赋值给入参，并将用户的请求消息 赋值给入参的相应属性 (PS:支持级联属性)。至此，处理完毕。

最后
@CookieValue 获取cookie信息
@RequestHeader 获取请求的头部信息

Spring的注解：

@Service用于标注业务层组件

@Controller用于标注控制层组件（如struts中的action）

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

@Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

[java] view plain copy

@Service

public class VentorServiceImpl implements iVentorService {

}

@Repository

public class VentorDaoImpl implements iVentorDao {

}

component-scan标签默认情况下自动扫描指定路径下的包（含所有子包），将带有@Component、@Repository、 @Service、@Controller标签的类自动注册到spring容器。对标记了 Spring's @Required、@Autowired、JSR250's @PostConstruct、@PreDestroy、@Resource、JAX-WS's @WebServiceRef、EJB3's @EJB、JPA's @PersistenceContext、@PersistenceUnit等注解的类进行对应的操作使注解生效（包含了annotation- config标签的作用）。

@Autowired

注释，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作 。

Spring 通过一个

BeanPostProcessor

对

@Autowired

进行解析，所以要让

@Autowired

起作用必须事先在 Spring 容器中声明

AutowiredAnnotationBeanPostProcessor

Bean。

@Resource

@Resource 的作用相当于 @Autowired，只不过 @Autowired 按 byType 自动注入，面@Resource 默认按 byName 自动注入罢了。@Resource 有两个属性是比较重要的，分别是 name 和 type，Spring 将@Resource 注释的 name 属性解析为 Bean 的名字，而 type 属性则解析为 Bean 的类型。所以如果使用 name 属性，则使用 byName 的自动注入策略，而使用 type 属性时则使用 byType 自动注入策略。如果既不指定 name 也不指定 type 属性，这时将通过反射机制使用 byName 自动注入策略。

Resource 注释类位于 Spring 发布包的 lib/j2ee/common-annotations.jar 类包中，因此在使用之前必须将其加入到项目的类库中。来看一个使用@Resource的例子：

JSR-250 为初始化之后/销毁之前方法的指定定义了两个注释类，分别是 @PostConstruct 和 @PreDestroy，这两个注释只能应用于方法上。标注了 @PostConstruct 注释的方法将在类实例化后调用，而标注了 @PreDestroy 的方法将在类销毁之前调用。

虽然我们可以通过 @Autowired 或 @Resource 在 Bean 类中使用自动注入功能，但是 Bean 还是在 XML 文件中通过 <bean> 进行定义 —— 也就是说，在 XML 配置文件中定义 Bean，通过@Autowired 或 @Resource 为 Bean 的成员变量、方法入参或构造函数入参提供自动注入的功能。能否也通过注释定义 Bean，从 XML 配置文件中完全移除 Bean 定义的配置呢？那是肯定的，我们通过 Spring 2.5 提供的@Component 注释就可以达到这个目标了。

为什么 @Repository 只能标注在 DAO 类上呢？这是因为该注解的作用不只是将类识别为 Bean，同时它还能将所标注的类中抛出的数据访问异常封装为 Spring 的数据访问异常类型。 Spring 本身提供了一个丰富的并且是与具体的数据访问技术无关的数据访问异常结构，用于封装不同的持久层框架抛出的异常，使得异常独立于底层的框架。

Spring 2.5 在 @Repository 的基础上增加了功能类似的额外三个注解：@Component、@Service、@Constroller，它们分别用于软件系统的不同层次：

@Component 是一个泛化的概念，仅仅表示一个组件 (Bean) ，可以作用在任何层次。
@Service 通常作用在业务层，但是目前该功能与 @Component 相同。
@Constroller 通常作用在控制层，但是目前该功能与 @Component 相同。

通过在类上使用 @Repository、@Component、@Service 和 @Constroller 注解，Spring 会自动创建相应的 BeanDefinition 对象，并注册到 ApplicationContext 中。这些类就成了 Spring 受管组件。这三个注解除了作用于不同软件层次的类，其使用方式与 @Repository 是完全相同的。

@Component 有一个可选的入参，用于指定 Bean 的名称，在 Boss 中，我们就将 Bean 名称定义为“boss”。一般情况下，Bean 都是 singleton 的，需要注入 Bean 的地方仅需要通过 byType 策略就可以自动注入了，所以大可不必指定 Bean 的名称。

在使用 @Component 注释后，Spring 容器必须启用类扫描机制以启用注释驱动 Bean 定义和注释驱动 Bean 自动注入的策略。
@Scope

spring中bean的scope属性，有如下5种类型：

singleton 表示在spring容器中的单例，通过spring容器获得该bean时总是返回唯一的实例
prototype表示每次获得bean都会生成一个新的对象
request表示在一次http请求内有效（只适用于web应用）
session表示在一个用户会话内有效（只适用于web应用）
globalSession表示在全局会话内有效（只适用于web应用）

在多数情况，我们只会使用singleton和prototype两种scope，如果在spring配置文件内未指定scope属性，默认为singleton。 scope是prototype的情况下，同一个bean定义会返回不同的对象。

是否有了这些 IOC 注释，我们就可以完全摒除原来 XML 配置的方式呢？NO。有以下几点原因：

注释配置不一定在先天上优于 XML 配置。如果 Bean 的依赖关系是固定的，（如 Service 使用了哪几个 DAO 类），这种配置信息不会在部署时发生调整，那么注释配置优于 XML 配置；反之如果这种依赖关系会在部署时发生调整，XML 配置显然又优于注释配置，因为注释是对 Java 源代码的调整，您需要重新改写源代码并重新编译才可以实施调整。
如果 Bean 不是自己编写的类（如 JdbcTemplate、SessionFactoryBean 等），注释配置将无法实施，此时 XML 配置是唯一可用的方式。
注释配置往往是类级别的，而 XML 配置则可以表现得更加灵活。比如相比于 @Transaction 事务注释，使用 aop/tx 命名空间的事务配置更加灵活和简单。

所以在实现应用中，我们往往需要同时使用注释配置和 XML 配置，对于类级别且不会发生变动的配置可以优先考虑注释配置；而对于那些第三方类以及容易发生调整的配置则应优先考虑使用 XML 配置。Spring 会在具体实施 Bean 创建和 Bean 注入之前将这两种配置方式的元信息融合在一起。