Spring注解解释

Spring注解可以实现快速实例注入，而无需进行繁杂的xml配置。
原文地址：http://bbs.51cto.com/thread-1136892-1.html

• @Controller
• @Service
• @Autowired
• @RequestMapping
• @RequestParam
• @ModelAttribute
• @Cacheable
• @CacheFlush
• @Resource
• @PostConstruct
• @PreDestroy
• @Repository
• @Component （不推荐使用）
• @Scope
• @SessionAttributes
• @InitBinder
• @Required
• @Qualifier

@Controller

@Controller
public class SoftCreateController extends SimpleBaseController {}

@Controller("softCreateController")

@Controller负责注册一个bean到Spring上下文中，bean的ID默认为类名称开头字母小写

@Service

@Service
public class SoftCreateServiceImpl implements ISoftCreateService {}

@Service("softCreateServiceImpl")

@Service负责注册一个bean到Spring上下文中，bean的ID默认为类名称开头字母小写

@Autowired

@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会自动注入这些实现类的实例，不需要额外的操作。

@RequestMapping

@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可以声明到类或方法上

@RequestParam

如果我们使用以下的URL请求：

http://localhost/bbtForum.do?method=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(required=false)：参数不是必须的，默认为true
@RequestParam(value=”id”,required=false)

@ModelAttribute

作用域：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和@CacheFlush

@Cacheable：声明一个方法的返回值应该被缓存

@Cacheable(modelId = "testCaching")

@CacheFlush ：声明一个方法是清空缓存的触发器

@CacheFlush(modelId = "testCaching")

说明：要配合缓存处理器使用，
参考： http://hanqunfeng.iteye.com/blog/603719

@Resource

@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 和@PreDestroy

@PostConstruct
在方法上加上注解@PostConstruct，这个方法就会在Bean 初始化之后被Spring容器执行（注：Bean初始化包括，实例化Bean，并装配Bean的属性（依赖注入）。

@PreDestroy
在方法上加上注解@PreDestroy，这个方法就会在Bean被销毁前被Spring容器执行。

@repository

与@Controller、@Service类似，都是向Spring上下文中注册bean

@component（不推荐使用）

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

@scope

@Scope("session")
@Repository()
public class UserSessionBean implements Serializable {}

在使用XML定义Bean时，可以通过bean的scope属性来定义一个Bea 的作用范围，同样可以通过@scope注解来完成。

@Scope中可以指定如下值：
1. singleton:定义bean的范围为每个Spring容器一个实例（默认值）
2. prototype:定义bean可以被多次实例化（使用一次就创建一次）
3. request:定义bean的范围是http请求（SpringMVC中有效）
4. session:定义bean的范围是http会话（SpringMVC中有效）
5. global-session:定义bean的范围是全局http会话（portlet中有效）

@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"})

@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

@Required              
public setName(String name){} 

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

@Qualifier

@Autowired
@Qualifier("softService")
private ISoftPMService softPMService; 

使用@Autowired时，如果找到多个同一类型的bean，则会抛异常，此时可以使用@Qualifier(“beanName”)，明确指定bean的名称进行注入，此时与@Resource指定name属性作用相同。