Spring注解

118 阅读6分钟

一、Spring Bean的基本注解

Spring除了xml配置文件进行配置之外,还可以使用注解方式进行配置,注解方式慢慢成为xml配置的替代方案。我们有了xml开发的经验,学习注解开发就方便了许多,注解开发更加快捷方便。 Spring提供的注解有三个版本:

  • 2.0时代,Spring开始出现注解
  • 2.5时代,Spring的Bean配置可以使用注解完成
  • 3.0时代,Spring其他配置也可以使用注解完成,我们进入全注解时代

基本Bean注解,主要是使用注解的方式替代原有xml的 < bean> 标签及其标签属性的配置

    <bean id="" name="" class="" scope="" lazy-init="" init-method="" destroy-method="" 
    	abstract="" autowire="" factory-bean="" factory-method="">
    </bean>

使用@Component 注解替代< bean>标签

image.png

可以通过@Component注解的value属性指定当前Bean实例的beanName,也可以省略不写,不写的情况下为当前类名首字母小写

    // 获取方式:applicationContext.getBean("userDao");
    @Component("userDao")
    public class UserDaoImpl implements UserDao {
    }

    // 获取方式:applicationContext.getBean("userDaoImpl");
    @Component
    public class UserDaoImpl implements UserDao {
    }

使用注解对需要被Spring实例化的Bean进行标注,但是需要告诉Spring去哪找这些Bean,要配置组件扫描路径

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/xmlSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="
    http://www.springframework.org/schema/beans 
    http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/context 
    http://www.springframework.org/schema/context/spring-context.xsd
    ">
    <!-- 告知Spring框架去com.itheima包及其子包下去扫描使用了注解的类 -->
    <context:component-scan base-package="com.itheima"/>

    </beans>

Spring 是通过注解方式配置 < bean> 标签中的属性 image.png 使用上述注解完成UserDaoImpl的基本配置

    @Component("userDao")
    @Scope("singleton")
    @Lazy(true)
    public class UserDaoImpl implements UserDao{
    	@PostConstruct
    	public void init(){}
    	
    	@PreDestroy
    	public void destroy(){}
    }

由于JavaEE开发是分层的,为了每层Bean标识的注解语义化更加明确,@Component又衍生出如下三个注解: image.png

    @Repository("userDao")
    public class UserDaoImpl implements UserDao{}

    @Service("userService")
    public class UserServiceImpl implements UserService{}

    @Controller("userController")
    public class UserController {}

二、Spring Bean的依赖注入注解

Bean依赖注入的注解,主要是使用注解的方式替代xml的 < property> 标签完成属性的注入操作

    <bean id="" class=""> <property name="" value=""/>
    	<property name="" value=""/>
    	<property name="" ref=""/>
    </bean>

Spring主要提供如下注解,用于在Bean内部进行属性注入的: image.png

  1. 通过@Value直接注入普通属性
<!---->

    // 方式一
    @Value("haohao")
    private String username;

    // 方式二
    @Value("haohao")
    public void setUsername(String username){
    	System.out.println(username);
    }
  1. 通过@Value注入properties文件中的属性

加载properties文件

    <context:property-placeholder location="classpath:jdbc.properties"/>
    // 方式一
    @Value("${jdbc.username}")
    private String username;

    // 方式二
    @Value("${jdbc.username}")
    public void setUsername(String username){
    	System.out.println(username);
    }
  1. @Autowired注解,用于根据类型进行注入 // 使用在属性上直接注入
<!---->

    @Autowired
    private UserDao userDao;

    // 使用在方法上直接注入
    @Autowired
    public void setUserDao(UserDao userDao){
    	System.out.println(userDao);
    }

    // 使用在方法上直接注入,可以注入同一类型的多个bean,例如userDao、userDao2...

    @Autowired
    public void yyy(List<UserDao> userDaoList){
    	System.out.println(userDaoList);
    }

当容器中同一类型的Bean实例有多个时,会尝试自动根据名字进行匹配:

    // 匹配当前Bean
    @Repository("userDao")
    public class UserDaoImpl implements UserDao{}

    @Repository("userDao2")
    public class UserDaoImpl2 implements UserDao{}
  1. @Qualifier配合@Autowired可以完成根据名称注入Bean实例,使用@Qualifier指定名称
<!---->

    @Autowired
    @Qualifier("userDao2")
    private UserDao userDao;

    @Autowired
    @Qualifier("userDao2")
    public void setUserDao(UserDao userDao){
    	System.out.println(userDao);
    }
  1. @Resource注解既可以根据类型注入,也可以根据名称注入,无参就是根据类型注入,有参数就是根据名称注入
<!---->

    @Resource
    private UserDao userDao;

    @Resource(name = "userDao2")
    public void setUserDao(UserDao userDao){
    	System.out.println(userDao);
    }

PS:@Resource注解存在与 javax.annotation 包中,Spring对其进行了解析

三、Spring 非自定义Bean注解

非自定义Bean不能像自定义Bean一样使用@Component进行管理,非自定义Bean要通过工厂的方式进行实例化,使用@Bean标注方法即可,@Bean的属性为beanName,如不指定,则当前工厂方法名称作为beanName

@Component
public class ConfigBean {
	// 将方法返回值Bean实例,以@Bean注解指定的名称存储到Spring容器中
	@Bean("dataSource")
	public DataSource dataSource(){
		DruidDataSource dataSource = new DruidDataSource();
		dataSource.setDriverClassName("com.mysql.jdbc.Driver");
		dataSource.setUrl("jdbc:mysql://localhost:3306/mybatis");
		dataSource.setUsername("root");
		dataSource.setPassword("root");
		return dataSource;
	}
}

PS:工厂方法所在类必须要被Spring管理。例如上面的工厂方法dataSource()所在的类ConfigBean需要先被注入到容器中

如果@Bean工厂方法需要参数的话,则有如下几种注入方式:

  • 使用@Autowired 根据类型自动进行Bean的匹配,@Autowired可以省略 ;
  • 使用@Qualifier 根据名称进行Bean的匹配;
  • 使用@Value 根据名称进行普通数据类型匹配。
    @Bean
    @Autowired //根据类型匹配参数
    public Object objectDemo01(UserDao userDao){
    	System.out.println(userDao);
    	return new Object();
    }

    @Bean
    public Object objectDemo02(@Autowired UserDao userDao){// @Autowired作用在参数上时,可以省略
    	System.out.println(userDao);
    	return new Object();
    }

    // @Qualifier可以单独使用在参数上,根据名称注入
    @Bean
    public Object objectDemo03(@Qualifier("userDao") UserDao userDao, @Value("${jdbc.username}") String username){
    	System.out.println(userDao);
    	System.out.println(username);
    	return new Object();
    }

四、Spring 配置类的注解

@Component等注解替代了< bean>标签,但是像< import>、< context:componentScan> 等非< bean> 标签怎样去使用注解替代呢?

    <!-- 加载properties文件 --> 
    <context:property-placeholder location="classpath:jdbc.properties"/>
    <!-- 组件扫描 --> 
    <context:component-scan base-package="com.itheima"/>
    <!-- 引入其他xml文件 --> 
    <import resource="classpath:beans.xml"/>

1. @Configuration

定义一个配置类替代原有的xml配置文件,< bean>标签以外的标签,一般都是在配置类上使用注解完成的

@Configuration注解标识的类为配置类,替代原有xml配置文件,该注解第一个作用是标识该类是一个配置类,第二个作用是具备@Component作用

    @Configuration
    public class ApplicationContextConfig {}

2. @ComponentScan

@ComponentScan 组件扫描配置,替代原有xml文件中的< context:component-scan base-package=“”/>

@Configuration
@ComponentScan(basePackages = {"com.itheima.service", "com.itheima.dao"})
public class ApplicationContextConfig {}

base-package的配置方式:

  • 指定一个或多个包名:扫描指定包及其子包下使用注解的类
  • 不配置包名:扫描当前@componentScan注解配置类所在包及其子包下的类

3. @PropertySource

@PropertySource 注解用于加载外部properties资源配置,替代原有xml中的 < context:property-placeholder location=" "/> 配置

@Configuration
@ComponentScan
@PropertySource({"classpath:jdbc.properties","classpath:xxx.properties"})
public class ApplicationContextConfig {}

4. @Import

@Import 用于加载其他配置类,替代原有xml中的< import resource=“classpath:beans.xml”/>配置

    @Configuration
    @ComponentScan
    @PropertySource("classpath:jdbc.properties")
    @Import(OtherConfig.class)
    public class ApplicationContextConfig {}

<!---->

    // 其他配置类,在主配置类中通过@Import被注入
    public class OtherConfig{}

二、Spring 配置其他注解

1. @Primary

扩展:@Primary注解用于标注相同类型的Bean优先被使用权,@Primary 是Spring3.0引入的,与@Component 和@Bean一起使用,标注该Bean的优先级更高,则再通过类型获取Bean或通过@Autowired根据类型进行注入时,会选用优先级更高的

@Primary配合自定义bean使用

    @Repository("userDao")
    public class UserDaoImpl implements UserDao{}

    @Repository("userDao2")
    @Primary
    public class UserDaoImpl2 implements UserDao{}

@Primary配合非自定义bean使用

    @Bean
    public UserDao userDao01() {
    	return new UserDaoImpl();
    }

    @Bean
    @Primary
    public UserDao userDao02() { 
    	return new UserDaoImpl2();
    }

2. @Profile

扩展:@Profile 注解的作用是进行环境切换

    <beans profile="test">>

注解 @Profile 标注在类或方法上,标注当前产生的Bean从属于哪个环境,只有激活了当前环境,被标注的Bean才能被注册到Spring容器里,不指定环境的Bean,任何环境下都能注册到Spring容器里

    @Repository("userDao")
    @Profile("test")
    public class UserDaoImpl implements UserDao{}

    @Repository("userDao2")
    public class UserDaoImpl2 implements UserDao{}

可以使用以下两种方式指定被激活的环境:

  • 使用命令行动态参数,虚拟机参数位置加载 -Dspring.profiles.active=test
  • 使用代码的方式设置环境变量 System.setProperty(“spring.profiles.active”, “test”);