组件注册方式和常用注解

水深无声 2022-02-20 12:43 189阅读 0赞

### **传统的Spring做法是使用.xml文件来对bean进行注入或者是配置aop、事物，这么做有两个缺点：** ###

*  1、如果所有的内容都配置在.xml文件中，那么.xml文件将会十分庞大；如果按需求分开.xml文件，那么.xml文件又会非常多。总之这将导致配置文件的可读性与可维护性变得很低。
 *  2、在开发中在.java文件和.xml文件之间不断切换，是一件麻烦的事，同时这种思维上的不连贯也会降低开发的效率。

为了解决这两个问题，Spring引入了注解，通过"@XXX"的方式，让注解与Java Bean紧密结合，既大大减少了配置文件的体积，又增加了Java Bean的可读性与内聚性。

## **不使用注解：** ##

spring的配置文件这么写：

<?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:p="http://www.springframework.org/schema/p"
        xmlns:context="http://www.springframework.org/schema/context"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context-3.0.xsd
        ">
        
         <bean id="zoo" class="com.spring.model.Zoo" >
            <property name="tiger" ref="tiger" />
            <property name="monkey" ref="monkey" />
        </bean>
        
        <bean id="tiger" class="com.spring.model.Tiger" />
        <bean id="monkey" class="com.spring.model.Monkey" />
    
    </beans>

## **常用注解** ##

## 一、向Spring容器中组件注册方式 ##

### **1、通过xml定义** ###

### **2、通过@Bean注解** ###

比如下面的代码往容器中注册一个Person对象

@Bean
    public Person person(){
        return new Person("张三", 20);
    }

### **3、通过注解** ###

这种方式比较常见，其中@Controller、@Service、@Repository源码中包括@Component

*  @Service用于标注业务层组件、
 *  @Controller用于标注控制层组件（如struts中的action）
 *  @Repository用于标注数据访问组件，即DAO组件。
 *  @Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

自动扫描：

![20190414163558611.png][]

![20190414163636947.png][]

### **4、通过实现FactoryBean接口** ###

public interface FactoryBean<T> {
        T getObject() throws Exception;
        Class<?> getObjectType();
        boolean isSingleton();
    }
    
    // Sample
    public class PersonFactoryBean implements FactoryBean<Person> {
        ....
    }

实现上述接口的3个方法，并把PersonFactoryBean注册到容器中，就可以把Person也注册到容器中。  
具体创建Person过程的源码可以看FactoryBeanRegistrySupport\#getObjectFromFactoryBean方法。

// 如下代码拿到的是Person对象
    applicationContext.getBean("personFactoryBean")
    
    // 如果想要拿到PersonFactoryBean对象，可以再前面加&
    applicationContext.getBean("&personFactoryBean")

### ** 5、通过@Import注解** ###

**先看看源码：**

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Import {
        /**
        * {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar}
        * or regular component classes to import.
        */
        Class<?>[] value();
    }

源码注释写的也很清楚，可以引入 配置类、ImportSelector、ImportBeanDefinitionRegistrar，甚至是普通class。 通过@Import，我们可以使用如下方式注册组件：

@Import({Person.class, MyImportSelector.class,MyImportBeanDefinitionRegistrar.class})

** 其中：**

*  MyImportSelector实现了ImportSelector接口，selectImports方法返回类全名的String\[\]都会被注册到容器中
 *  MyImportBeanDefinitionRegistrar实现了ImportBeanDefinitionRegistrar接口
    
        // Sample
        public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
        @Override
        public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
            // 指定Bean定义信息
            RootBeanDefinition beanDefinition = new RootBeanDefinition(Person.class);
            // 注册一个Bean，指定bean名
            registry.registerBeanDefinition("person", beanDefinition);
          }
        }
    
    这是一个**非常重要**的注解，在Spring源码中，哪哪都能看到他的身影。

## 二、java配置类相关注解 ##

在getBean是才会创建Bean。

1.  @Configuration 声明当前类为配置类，相当于xml形式的Spring配置（类上），包含了Spring应用上下文中如何创建bean的细节；
    
    ![2019041318080611.png][]
2.  @Bean注解在方法上，声明当前方法的返回值为一个bean，替代xml中的方式（方法上），需要将其注册为Spring应用上下文中的bean，并且可以在方法中完成依赖注入；
3.  @Component 注解表明该类会作为组件类，并告知Spring要为此类创建bean；
4.  @ComponentScan 用于对Component进行扫描，相当于xml中的（类上）；![20190413180858848.png][]
5.  @WishlyConfiguration 为@Configuration与@ComponentScan的组合注解，可以替代这两个注解；
6.  @Scope 注解声明了bean的作用域；proxyMode属性设置作用域代理，代理对bean进行懒解释并将调用委托给会话/请求作用域内真正的bean；![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0ppblhZYW4_size_16_color_FFFFFF_t_70][]
7.  @Lazy  表明是懒加载；
    
    ![20190413181205636.png][]
8.  @Conditional（Class对象）条件注解，满足条件才可进行Bean注册。
    
    ![20190414095601179.png][]
    
    ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0ppblhZYW4_size_16_color_FFFFFF_t_70 1][]
9.  @Value("...") 作用是通过注解将常量、配置文件中的值、其他bean的属性值注入到变量中，作为变量的初始值;
    
        @Value("normal")
        private String normal; // 注入普通字符串
        
        @Value("classpath:com/hry/spring/configinject/config.txt")
        private Resource resourceFile; // 注入文件资源
        
        @Value("http://www.baidu.com")
        private Resource testUrl; // 注入URL资源
    
    **bean****属性、系统属性、表达式注入@Value("\#\{\}")，**bean属性注入需要注入者和被注入者属于同一个IOC容器，或者父子IOC容器关系，在同一个作用域内。
    
        @Value("#{beanInject.another}")
        private String fromAnotherBean; // 注入其他Bean属性：注入beanInject对象的属性another，类具体定义见下面
        
        @Value("#{systemProperties['os.name']}")
        private String systemPropertiesName; // 注入操作系统属性
        
        @Value("#{ T(java.lang.Math).random() * 100.0 }")
        private double randomNumber; //注入表达式结果
    
    **配置文件属性注入@Value("$\{\}")，**可以获取对应属性文件（.properties）中定义的属性值。
    
    **先加载配置文件：**![20190414161911168.png][]
    
    ![20190414161447764.png][]
    
    **使用：**
    
        @Value("${bird.color}")
        private String color;
10.  
    
    @PropertySource(value=“配置文件”) 加载指定的属性文件。

# Spring中的Bean单例是线程安全的吗？ #

**原型Bean**

对于原型Bean,每次创建一个新对象，也就是线程之间并不存在Bean共享，自然是不会有线程安全的问题。

**单例Bean**

对于单例Bean,所有线程都共享一个单例实例Bean,因此是存在资源的竞争。

如果单例Bean,是一个无状态Bean，也就是线程中的操作不会对Bean的成员执行查询以外的操作，那么这个单例Bean是线程安全的。比如Spring mvc 的Service层、Dao层用默认singleton就行，虽然Service类也有dao这样的属性，但dao这些类都是没有状态信息的，也就是相当于不变(immutable)类，所以不影响。Struts2中的Action因为会有User、BizEntity这样的实例对象，是有状态信息的，在多线程环境下是不安全的，所以Struts2默认的实现是Prototype模式。在Spring中，Struts2的Action中，scope要配成prototype作用域。

对于有状态的bean，Spring官方提供的bean，一般提供了通过ThreadLocal去解决线程安全的方法，比如RequestContextHolder、TransactionSynchronizationManager、LocaleContextHolder等。

**使用ThreadLocal的好处**

使得多线程场景下，多个线程对这个单例Bean的成员变量并不存在资源的竞争，因为ThreadLocal为每个线程保存线程私有的数据。这是一种以空间换时间的方式。

**当然也可以通过加锁的方法来解决线程安全，这种以时间换空间的场景在高并发场景下显然是不实际的。**

**多例模式是线程安全（自动懒加载）的**

[20190414163558611.png]: /images/20220220/f818882c7bc64118b967db7df7d1bf1b.png
[20190414163636947.png]: /images/20220220/e8d315a0e3cf4c2ca5ebd18f5b93af00.png
[2019041318080611.png]: /images/20220220/cf3dfd6ebe104d6f9e16a2d12afe81f3.png
[20190413180858848.png]: /images/20220220/88b6e71b821046a6aebee38ea3ea148e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0ppblhZYW4_size_16_color_FFFFFF_t_70]: /images/20220220/0fc5850284a24f0aa2d128cd407cf30e.png
[20190413181205636.png]: /images/20220220/e5a85fdbd89e4a2fb8c62707bd869254.png
[20190414095601179.png]: /images/20220220/2fa3c53780254ae8beb04006dccd4641.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0ppblhZYW4_size_16_color_FFFFFF_t_70 1]: /images/20220220/8c5f6d61ef5248d18828e4ce06215af9.png
[20190414161911168.png]: /images/20220220/b02310e8860242afa4d2faed53487824.png
[20190414161447764.png]: /images/20220220/fd0be85cff704feeba7b2c74c53f8ac5.png