Spring中关于bean的注解的介绍

程序员文章站 2022-05-21 22:10:54

...

applicationContext.xml全文：

<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p="http://www.springframework.org/schema/p"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd">
   <bean class="org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor" />

   <bean id="service" class="Service">
   </bean> 

   <bean id="dao" class="Dao"></bean> 
</beans>

在xml代码中看不出service和dao两个bean之间有关系。

Service.java全文：

import org.springframework.beans.factory.annotation.Autowired; 

public class Service {

   @Autowired(required = true) 
    private Dao dao;

    public Dao getDao() {
           return dao;
    }

}

和前文设值注入和构造器注入相比，注解注入有两处不同：

1，不在applicationContext.xml文件中进行注入或引用，看不出bean之间的关系。

2，Service.java文件中，既没有setter方法也没有构造器方法用于注入。只是多了一行：

@Autowired(required = true)

Dao.java全文：

public class Dao {

    public void call() {
        System.out.println("Don't call me, I'll call you.");
    } 
}

HelloWorld.java全文：

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.FileSystemXmlApplicationContext;

public class HelloWorld {

public static void main(String args[]) {
    System.out.println ("Hello World!");
    ApplicationContext context = new FileSystemXmlApplicationContext("web/WEB-INF/classes/applicationContext.xml"); 

Service service = (Service) context.getBean("service");
service.getDao().call();
}
}

ant build编译，ant run运行，输出：

[java] Don't call me, I'll call you.

【】上面是对属性进行了注解，也可以对setter方法和构造方法进行注解。

多个注解可以配合使用。

其他注解方式大约有：

@Required

例如

@required

public setName(String name){}

说明

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

@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 属性不需要指定 ( 或者指定为"")，否则注入失败；

@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(); “required”属性含义和@Required一样，只是@Required只适用于基于XML配置的setter注入方式。

@Autowired 标注作用于 Map 类型时，如果 Map 的 key 为 String 类型，则 Spring 会将容器中所有类型符合 Map 的 value 对应的类型的 Bean 增加进来，用 Bean 的 id 或 name 作为 Map 的 key。

@Autowired 还有一个作用就是，如果将其标注在 BeanFactory 类型、ApplicationContext 类型、ResourceLoader 类型、ApplicationEventPublisher 类型、MessageSource 类型上，那么 Spring 会自动注入这些实现类的实例，不需要额外的操作。

@Qualifier

例如

@Autowired

@Qualifier("softService")

private ISoftPMService softPMService;

说明：

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

@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 默认为类名称开头字母小写

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

参数绑定说明

如果我们使用以下的 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

参数绑定说明

@RequestParam("id")

http://localhost/bbtForum.do?method=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 注解改变默认的绑定规则

1)、request/response/session

既可以是 Servlet API 的也可以是 Portlet API 对应的对象，Spring 会将它们绑定到Servlet 和 Portlet 容器的相应对象上，org.springframework.web.context.request.WebRequest内部包含了 request 对象

2）、java.util.Locale

绑定到 request 对应的 Locale 对象上

3）、java.io.InputStream/java.io.Reader

可以借此访问 request 的内容

4）、java.io.OutputStream / java.io.Writer

可以借此操作 response 的内容

任何标注了 @RequestParam 注解的入参被标注 @RequestParam 注解的入参将绑定到特定的 request 参数上。

5）、java.util.Map / org.springframework.ui.ModelMap

它绑定 Spring MVC 框架中每个请求所创建的潜在的模型对象，它们可以被 Web 视图对象访问（如 JSP ）

命令/ 表单对象（注：一般称绑定使用 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 定义的属性

请求处理方法返回值的可选类型

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 。

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

说明

要配合缓存处理器使用

@PostConstruct 和@PreDestroy

@PostConstruct

在方法上加上注解@PostConstruct ，这个方法就会在Bean 初始化之后被Spring 容器执行

（注：Bean 初始化包括，实例化Bean ，并装配Bean 的属性（依赖注入））。

@PreDestroy

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

@Repository

与@Controller 、@Service 类似，都是向spring 上下文中注册bean ，不在赘述。

@Component （不推荐使用）

@Component

@Component 是所有受Spring 管理组件的通用形式，Spring 还提供了更加细化的注解形式： @Repository 、@Service 、@Controller ，它们分别对应存储层Bean ，业务层Bean ，和展示层Bean 。

目前版本（2.5 ）中，这些注解与@Component 的语义是一样的，完全通用，在Spring 以后的版本中可能会给它们追加更多的语义。所以，我们推荐使用@Repository 、@Service 、@Controller 来替代@Component 。

@Scope

例如

@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中有效）

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

@Value：注入SpEL表达式；

用于注入SpEL表达式，可以放置在字段方法或参数上，使用方式如下：
@Value(value = "SpEL表达式")
字段、方法、参数

1、可以在类字段上使用该注解：
@Value(value = "#{message}")
private String message;

2、可以放置在带@Autowired注解的方法的参数上：
@Autowired
public void initMessage(@Value(value = "#{message}#{message}") String message) {
this.message = message;
}

3、还可以放置在带@Autowired注解的构造器的参数上：
@Autowired
private TestBean43(@Value(value = "#{message}#{message}") String message) {
this.message = message;
}
具体测试详见DependencyInjectWithAnnotationTest 类的testValueInject测试方法。

@Qualifier：限定描述符，用于细粒度选择候选者；

@Autowired默认是根据类型进行注入的，因此如果有多个类型一样的Bean候选者，则需要限定其中一个候选者，否则将抛出异常，@Qualifier限定描述符除了能根据名字进行注入，但能进行更细粒度的控制如何选择候选者，具体使用方式如下：
@Qualifier(value = "限定标识符")
字段、方法、参数

（1）、根据基于XML配置中的<qualifier>标签指定的名字进行注入，使用如下方式指定名称：
<qualifier type="org.springframework.beans.factory.annotation.Qualifier" value="限定标识符"/>

其中type属性可选，指定类型，默认就是Qualifier注解类，name就是给Bean候选者指定限定标识符，一个Bean定义中只允许指定类型不同的<qualifier>，如果有多个相同type后面指定的将覆盖前面的。
1、准备测试Bean：

package cn.javass.spring.chapter12;
import javax.sql.DataSource;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;

public class TestBean31 {
private DataSource dataSource;
@Autowired
//根据<qualifier>标签指定Bean限定标识符
public void initDataSource(@Qualifier("mysqlDataSource") DataSource dataSource) {
this.dataSource = dataSource;
}
public DataSource getDataSource() {
return dataSource;
}
}

2、在Spring配置文件（chapter12/dependecyInjectWithAnnotation.xml）添加如下Bean配置：

<bean id="testBean31" class="cn.javass.spring.chapter12.TestBean31"/>

我们使用@Qualifier("mysqlDataSource")来指定候选Bean的限定标识符，我们需要在配置文件中使用<qualifier>标签来指定候选Bean的限定标识符“mysqlDataSource”：

<bean id="mysqlDataSourceBean" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<qualifier value="mysqlDataSource"/>
</bean>

3、测试方法如下：

@Test
public void testQualifierInject1() {
TestBean31 testBean31 = ctx.getBean("testBean31", TestBean31.class);
try {
//使用<qualifier>指定的标识符只能被@Qualifier使用
ctx.getBean("mysqlDataSource");
Assert.fail();
} catch (Exception e) {
//找不到该Bean
Assert.assertTrue(e instanceof NoSuchBeanDefinitionException);
}
Assert.assertEquals(ctx.getBean("mysqlDataSourceBean"), testBean31.getDataSource());
}

从测试可以看出使用<qualifier>标签指定的限定标识符只能被@Qualifier使用，不能作为Bean的标识符，如“ctx.getBean("mysqlDataSource")”是获取不到Bean的。
（2）、缺省的根据Bean名字注入：最基本方式，是在Bean上没有指定<qualifier>标签时一种容错机制，即缺省情况下使用Bean标识符注入，但如果你指定了<qualifier>标签将不会发生容错。

1、准备测试Bean：

package cn.javass.spring.chapter12;
//省略import
public class TestBean32 {
private DataSource dataSource;
@Autowired
@Qualifier(value = "mysqlDataSource2") //指定Bean限定标识符
//@Qualifier(value = "mysqlDataSourceBean")
//是错误的注入，不会发生回退容错，因为你指定了<qualifier>
public void initDataSource(DataSource dataSource) {
this.dataSource = dataSource;
}
public DataSource getDataSource() {
return dataSource;
}
}

2、在Spring配置文件（chapter12/dependecyInjectWithAnnotation.xml）添加如下Bean配置：

<bean id="testBean32" class="cn.javass.spring.chapter12.TestBean32"/>
<bean id="oracleDataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"/>

3、测试方法如下：

@Test
public void testQualifierInject2() {
TestBean32 testBean32 = ctx.getBean("testBean32", TestBean32.class);
Assert.assertEquals(ctx.getBean("oracleDataSource"), testBean32.getDataSource());
}

默认情况下（没指定<qualifier>标签）@Qualifier的value属性将匹配Bean 标识符。

【】http://hi.baidu.com/vr2rv/item/9dd77a87ea7447deef083d38

【】http://www.2cto.com/kf/201203/124576.html

上一篇：白茶是什么味道?白茶怎么保存?

下一篇： Java中非静态成员变量、静态成员变量的初始化时机。

Spring中关于bean的注解的介绍

Spring启动后获取所有拥有特定注解的Bean实例代码

Spring框架中 @Autowired 和 @Resource 注解的区别

Spring 中 @Service 和 @Resource 注解的区别

Spring中常用注解的详细介绍

Spring在web.xml中的配置详细介绍

JSP 中Spring Bean 的作用域详解

sqlserver中关于WINDOWS性能计数器的介绍

c#中关于string的特性介绍以及注意事项

Spring中Bean的生命周期使用解析

关于Spring注解@Async引发其他注解失效的解决