spring注解说明之Spring2.5 注解介绍(3.0通用)

void
此时逻辑视图名由请求处理方法对应的 URL确定,如以下的方法：
@RequestMapping("/welcome.do")
public void welcomeHandler() {}
对应的逻辑视图名为 'welcome'
String
此时逻辑视图名为返回的字符，如以下的方法：
@RequestMapping(method = RequestMethod.GET)
public String setupForm(@RequestParam("ownerId") int ownerId, ModelMap model) {
Owner owner = this.clinic.loadOwner(ownerId);
model.addAttribute(owner);
return "ownerForm";
}
对应的逻辑视图名为 “ ownerForm ”
org.springframework.ui.ModelMap
和返回类型为 void一样,逻辑视图名取决于对应请求的 URL,如下面的例子：
@RequestMapping("/vets.do")
public ModelMap vetsHandler() {
return new ModelMap(this.clinic.getVets());
}
对应的逻辑视图名为'vets',返回的ModelMap将被作为请求对应的模型对象,可以在JSP视图页面中访问到。
ModelAndView
当然还可以是传统的 ModelAndView.

例如
@Controller
public class SoftCreateController extends SimpleBaseController {}
或者
@Controller("softCreateController")
说明
@Controller负责注册一个bean到spring上下文中,bean的ID默认为类名称开头字母小写

例如
@Service
public class SoftCreateServiceImpl implements ISoftCreateService {}
或者
@Service("softCreateServiceImpl")
说明
@Service负责注册一个bean到spring上下文中,bean的ID默认为类名称开头字母小写

例如
@Autowired
private ISoftPMService softPMService;
或者
@Autowired(required=false)
private ISoftPMService softPMService = new SoftPMServiceImpl();
说明
@Autowired根据bean类型从spring上下文中进行查找，注册类型必须唯一，否则报异常。
与@Resource 的区别在于,@Resource允许通过bean名称或bean类型两种方式进行查找@Autowired(required=false)表示.
如果spring上下文中没有找到该类型的bean时,才会使用new SoftPMServiceImpl();@Autowired标注作用于 Map类型时,
如果 Map的 key为 String类型,则 Spring会将容器中所有类型符合 Map的 value对应的类型的 Bean增加进来,用Bean的 id或 name作为 Map的 key。
@Autowired还有一个作用就是,如果将其标注在 BeanFactory、ApplicationContext、ResourceLoader、ApplicationEventPublisher、MessageSource类型上，
那么 Spring会自动注入这些实现类的实例，不需要额外的操作。

类注解
@Controller
@RequestMapping("/bbtForum.do")
public class BbtForumController {
@RequestMapping(params = "method=listBoardTopic")
public String listBoardTopic(int topicId,User user) {}
}
方法注解
@RequestMapping("/softpg/downSoftPg.do")
@RequestMapping(value="/softpg/ajaxLoadSoftId.do",method = POST)
@RequestMapping(value = "/osu/product/detail.do", params = { "modify=false" }, method =POST)
说明
@RequestMapping可以声明到类或方法上
参数绑定说明,如果我们使用以下的 URL请求：
例：http://localhost/bbtForum.domethod=listBoardTopic&topicId=1&userId=10&userName=tom
topicId URL 参数将绑定到 topicId入参上，
而 userId 和 userName URL 参数将绑定到 user对象的 userId和 userName属性中。
和 URL请求中不允许没有 topicId参数不同，虽然 User的 userId属性的类型是基本数据类型，但如果 URL中不存在 userId 参数，
Spring也不会报错，此时 user.userId值为 0 。如果 User对象拥有一个 dept.deptId的级联属性，那么它将和 dept.deptId URL参数绑定。

参数绑定说明
@RequestParam("id")
http://localhost/bbtForum.domethod=listBoardTopic&id=1&userId=10&userName=tom
listBoardTopic(@RequestParam("id")int topicId,User user)中的 topicId绑定到 id这个 URL参数,那么可以通过对入参使用 @RequestParam注解来达到目的
@RequestParam(required=false)：参数不是必须的，默认为true
@RequestParam(value="id",required=false) 请求处理方法入参的可选类型Java基本数据类型和 String
默认情况下将按名称匹配的方式绑定到 URL参数上,可以通过 @RequestParam注解改变默认的绑定规则 request/response/session既可以是 Servlet API的也可以是 Portlet API对应的对象,Spring会将它们绑定到Servlet和 Portlet容器的相应对象上 org.springframework.web.context.request.WebRequest内部包含了request对象
java.util.Locale绑定到 request对应的 Locale对象上
java.io.InputStream/java.io.Reader可以借此访问request的内容
java.io.OutputStream/java.io.Writer可以借此操作 response 的内容
任何被标注 @RequestParam注解的入参将绑定到特定的request参数上。
java.util.Map/org.springframework.ui.ModelMap它绑定Spring MVC框架中每个请求所创建的潜在的模型对象,它们可以被 Web视图对象访问(如SP)
命令/表单对象（注：一般称绑定使用 HTTP GET发送的 URL参数的对象为命令对象，而称绑定使用HTTP POST发送的 URL参数的对象为表单对象）它们的属性将以名称匹配的规则绑定到 URL参数上,同时完成类型的转换。
而类型转换的规则可以通过 @InitBinder注解或通过 HandlerAdapter的配置进行调整
org.springframework.validation.Errors/org.springframework.validation.BindingResult为属性列表中的命令/表单对象的校验结果,注意检验结果参数必须紧跟在命令/表单对象的后面
org.springframework.web.bind.support.SessionStatus可以通过该类型 status对象显式结束表单的处理，这相当于触发 session清除其中的通过@SessionAttributes定义的属性

作用域:request
例如
@RequestMapping("/base/userManageCooper/init.do")
public String handleInit(@ModelAttribute("queryBean") ManagedUser sUser,Model model,){
或者
@ModelAttribute("coopMap")// 将coopMap 返回到页面
public Map<Long,CooperatorInfo> coopMapItems(){}
说明
@ModelAttribute声明在属性上,表示该属性的value来源于model里"queryBean",并被保存到model里@ModelAttribute声明在方法上,表示该方法的返回值被保存到model里

@Cacheable:声明一个方法的返回值应该被缓存。例如：@Cacheable(modelId = "testCaching")
@CacheFlush:声明一个方法是清空缓存的触发器。例如：@CacheFlush(modelId = "testCaching")
说明
要配合缓存处理器使用，参考： http://hanqunfeng.iteye.com/blog/603719
spring3.0没有对缓存提供支持,不过3.1之后就有了,可以参考:Spring3.1 Cache注解

例如
@Resource
private DataSource dataSource; // inject the bean named 'dataSource'
或者
@Resource(name="dataSource")
@Resource(type=DataSource.class)
说明
@Resource默认按bean的name进行查找,如果没有找到会按type进行查找,此时与@Autowired类似.在没有为 @Resource注解显式指定 name属性的前提下,
如果将其标注在 BeanFactory、ApplicationContext、ResourceLoader、ApplicationEventPublisher、MessageSource类型上,
那么Spring会自动注入这些实现类的实例,不需要额外的操作。此时 name属性不需要指定 (或者指定为""),否则注入失败.

在方法上加上注解@PostConstruct,这个方法就会在Bean初始化之后被Spring容器执行(注:Bean初始化包括,实例化Bean,并装配Bean 的属性(依赖注入))。
@PreDestroy
在方法上加上注解@PreDestroy,这个方法就会在Bean被销毁前被Spring容器执行。
@Repository
与@Controller、@Service类似,都是向spring上下文中注册bean,不在赘述。

@Component是所有受Spring管理组件的通用形式,Spring还提供了更加细化的注解形式:
@Repository、@Service、@Controller它们分别对应存储层Bean,业务层Bean,和展示层Bean.
版本(2.5)中,这些注解与@Component的语义是一样的,完全通用,在Spring以后的版本中可能会给它们追加更多的语义.
所以,我们推荐使用@Repository、@Service、@Controller来替代@Component。

例如
@Scope("session")
@Repository
public class UserSessionBean implementsSerializable {}
说明
在使用XML定义Bean时,可以通过bean的scope属性来定义一个Bean的作用范围,同样可以通过@Scope注解来完成,@Scope中可以指定如下值：
singleton:定义bean的范围为每个spring容器一个实例(默认值)
prototype:定义bean可以被多次实例化(使用一次就创建一次)
request:定义bean的范围是http请求(springMVC中有效)
session:定义bean的范围是http会话(springMVC中有效)
global-session:定义bean的范围是全局http会话(portlet中有效)

说明
Spring允许我们有选择地指定 ModelMap中的哪些属性需要转存到 session中,以便下一个请求属对应的 ModelMap的属性列表中还能访问到这些属性。
这一功能是通过类定义处标注 @SessionAttributes注解来实现的.
@SessionAttributes只能声明在类上,而不能声明在方法上.
例如
@SessionAttributes("currUser") //将ModelMap中属性名为currUser的属性保存到session
@SessionAttributes({"attr1","attr2"})
@SessionAttributes(types = User.class)
@SessionAttributes(types = {User.class,Dept.class})
@SessionAttributes(types = {User.class,Dept.class},value={"attr1","attr2"})
@InitBinder
说明
如果希望某个属性编辑器仅作用于特定的 Controller,可以在 Controller中定义一个标注 @InitBinder注解的方法
也可以在该方法中向 Controller了注册若干个属性编辑器
例如
@InitBinder
public void initBinder(WebDataBinder binder) {
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
dateFormat.setLenient(false);
binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, false));
}

例如
@required
public setName(String name){}
说明
@required负责检查一个bean在初始化时其声明的set方法是否被执行,当某个被标注了@Required的 Setter方法没有被调用，
则 Spring 在解析的时候会抛出异常,以提醒开发者对相应属性进行设置. @Required注解只能标注在 Setter方法之上。
因为依赖注入的本质是检查 Setter方法是否被调用了,而不是真的去检查属性是否赋值了以及赋了什么样的值。
如果将该注解标注在非setXxxx()类型的方法则被忽略。

例如
@Autowired
@Qualifier("softService")
private ISoftPMService softPMService;
说明
使用@Autowired时,如果找到多个同一类型的bean,则会抛异常,此时可以使用 @Qualifier("beanName"),明确指定bean的名称进行注入
此时与 @Resource指定name属性作用相同。