将Bean交给Spring容器管理有几种方式？

后端 4月前 0 15

Spring中心

Spring中心是 IOC 和 AOP 。

所谓IoC，对于spring结构来说，便是由spring来担任操控目标的生命周期和目标间的关系。

至于更详细的说明，或许去深化了解Spring这两大中心，不是此篇文章的目的，暂不细说了。

咱们在Spring项目中，咱们需求将Bean交给Spring容器，也便是IOC办理，这样你才能够运用注解来进行依靠注入。

包扫描+组件注解

针对类是咱们自己编写的情况

这种办法是咱们日常开发中最常用到的spring将扫描途径下带有@Component、@Controller、@Service、@Repository注解的类添加到spring IOC容器中。

假如你运用过MybatisPlus，那这个就和他的包扫描注入相同。

那咱们这个ComponentScan注解，又有三个装备。

装备项一

basePackages用于界说扫描的包的途径。

@ComponentScan(basePackages = "com.timemail.bootmp")

比方这样，便是扫描com.timemail.bootmp整个包下的，带有以上指定注解的类，并放入IOC。

我在其他文章上找了一个完好的示例：

@Component
public class Person {
  private String name;
  public String getName() {
    return name;
   }
  public void setName(String name) {
    this.name = name;
   }
  @Override
  public String toString() {
    return "Person{" +
        "name='" + name + ''' +
        '}';
   }
}
@ComponentScan(basePackages = "com.springboot.initbean.*")
public class Demo1 {
  public static void main(String[] args) {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
    Person bean = applicationContext.getBean(Person.class);
    System.out.println(bean);
   }
}

//成果
Person{name='null'}

这就说明上面代码的Person类现已被IOC容器所办理了。

装备项二

includeFilters包括规矩

Filter注解用 FilterType.CUSTOM 能够自界说扫描规矩需求完成TypeFilter接口完成match办法其间参数 MetadataReader 当时类的信息（注解，类途径，类原信息…） MetadataReaderFactory MetadataReader的工厂类。

装备项三

excludeFilters移除规矩

同包括规矩。

这后两个装备项我没怎么用过，也不太熟悉，所以详细运用请自行查阅相关材料。

`@Configuration` + `@Bean`

@Configuration + @Bean也是咱们常用的一种放入容器的办法。

@Configuration用于声明装备类

@Bean用于声明一个Bean

@Configuration
public class Demo {
  @Bean
  public Person person() {
    Person person = new Person();
    person.setAge(10);
    return person;
   }
}

就像这样。

那咱们指知道，在SSM里边，通常咱们会在xml里边去装备bean。

@Configuration
public class ConfigBean {

}

那咱们这个@Configuration注解，就相当于一个Bean的xml装备。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
  http://www.springframework.org/schema/beans/spring-beans-4.3.xsd">

</beans>

Bean注解中的特点

咱们@Bean注解还有许多特点能够装备。

咱们能够检查其源码：

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) //@1
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Bean {

  @AliasFor("name")
  String[] value() default {};

  @AliasFor("value")
  String[] name() default {};

  @Deprecated
  Autowire autowire() default Autowire.NO;

  boolean autowireCandidate() default true;

  String initMethod() default "";

  String destroyMethod() default AbstractBeanDefinition.INFER_METHOD;
}

value和name是相同的，设置的时候，这2个参数只能选一个，原因是@AliasFor导致的

value：字符串数组，第一个值作为bean的名称，其他值作为bean的别名

autowire：这个参数上面标注了@Deprecated，表明现已过期了，不建议运用了

autowireCandidate：是否作为其他目标注入时候的候选bean。

initMethod：bean初始化的办法，这个和生命周期有关，今后详解

destroyMethod：bean毁掉的办法，也是和生命周期相关的，今后详解

扩展

被@Configuration润饰的类，spring容器中会经过cglib给这个类创立一个署理，署理会拦截一切被@Bean润饰的办法，默许情况（bean为单例）下确保这些办法只被调用一次，从而确保这些bean是同一个bean，即单例的。

@Import注解导入

先看源码：


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

@Import只能用于类注解。

这儿我直接搬运公众号：小哈学Java的内容吧。

他的讲解非常详细。

前两种办法，大家用的或许比较多，也是平时开发中必须要知道的，@Import注解用的或许不是特别多了，可是也是非常重要的，在进行Spring扩展时经常会用到，它经常调配自界说注解进行运用，然后往容器中导入一个装备文件。

关于@Import注解，我会多介绍一点，它有四种运用办法。这是@Import注解的源码，表明只能放置在类上。

@Import直接导入类

public class Person {
  private String name;
  public String getName() {
    return name;
   }
  public void setName(String name) {
    this.name = name;
   }
  @Override
  public String toString() {
    return "Person{" +
        "name='" + name + ''' +
        '}';
   }
}
/**
* 直接运用@Import导入person类，然后尝试从applicationContext中取，成功拿到
**/
@Import(Person.class)
public class Demo1 {
  public static void main(String[] args) {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
    Person bean = applicationContext.getBean(Person.class);
    System.out.println(bean);
   }
}

上述代码直接运用@Import导入了一个类，然后主动的就被放置在IOC容器中了。

留意：咱们的Person类上就不需求任何的注解了，直接导入即可。

@Import + ImportSelector

其实在@Import注解的源码中，说的现已很清楚了，感兴趣的能够看下，咱们完成一个ImportSelector的接口，然后完成其间的办法，进行导入。

@Import(MyImportSelector.class)
public class Demo1 {
  public static void main(String[] args) {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
    Person bean = applicationContext.getBean(Person.class);
    System.out.println(bean);
   }
}
class MyImportSelector implements ImportSelector {
  @Override
  public String[] selectImports(AnnotationMetadata importingClassMetadata) {
    return new String[]{"com.springboot.pojo.Person"};
   }
}

我自界说了一个MyImportSelector完成了ImportSelector接口，重写selectImports办法，然后将咱们要导入的类的全限定名写在里边即可，完成起来也是非常简略。

@Import + ImportBeanDefinitionRegistrar

这种办法也需求咱们完成ImportBeanDefinitionRegistrar接口中的办法，详细代码如下:

@Import(MyImportBeanDefinitionRegistrar.class)
public class Demo1 {
  public static void main(String[] args) {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
    Person bean = applicationContext.getBean(Person.class);
    System.out.println(bean);
   }
}
class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
  @Override
  public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
    // 构建一个beanDefinition, 关于beanDefinition我后续会介绍，能够简略了解为bean的界说.
    AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Person.class).getBeanDefinition();
    // 将beanDefinition注册到Ioc容器中.
    registry.registerBeanDefinition("person", beanDefinition);
   }
}

上述完成其实和Import的第二种办法差不多，都需求去完成接口，然后进行导入。接触到了一个新的概念，BeanDefinition，能够简略了解为bean的界说(bean的元数据)，也是需求放在IOC容器中进行办理的，先有bean的元数据，applicationContext再依据bean的元数据去创立Bean。

@Import + DeferredImportSelector

这种办法也需求咱们进行完成接口，其实它和@Import的第二种办法差不多，DeferredImportSelector 它是 ImportSelector 的子接口，所以完成的办法和第二种无异。仅仅Spring的处理办法不同，它和Spring Boot中的主动导入装备文件推迟导入有关，非常重要。运用办法如下:

@Import(MyDeferredImportSelector.class)
public class Demo1 {
  public static void main(String[] args) {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
    Person bean = applicationContext.getBean(Person.class);
    System.out.println(bean);
   }
}
class MyDeferredImportSelector implements DeferredImportSelector {
  @Override
  public String[] selectImports(AnnotationMetadata importingClassMetadata) {
    // 也是直接将Person的全限定名放进去
    return new String[]{Person.class.getName()};
   }
}

关于@Import注解的运用办法，大约就以上三种，当然它还能够调配@Configuration注解运用，用于导入一个装备类。

FactoryBean接口

说到FactoryBean，咱们许多入门的开发者很简单将他与BeanFactory搞混。

BeanFactory他是一切Spring Bean的容器根接口，给Spring 的容器界说一套标准，给IOC容器提供了一套完好的标准，比方咱们常用到的getBean办法等。

也便是咱们常说的Bean的工厂。

而咱们的FactoryBean，它实际上便是一个Bean，Factory是他的姓名，顾名思义嘛。

@Configuration
public class Demo1 {
  @Bean
  public PersonFactoryBean personFactoryBean() {
    return new PersonFactoryBean();
   }
  public static void main(String[] args) {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Demo1.class);
    Person bean = applicationContext.getBean(Person.class);
    System.out.println(bean);
   }
}
class PersonFactoryBean implements FactoryBean<Person> {

  @Override
  public Person getObject() throws Exception {
    return new Person();
   }

  @Override
  public Class<?> getObjectType() {
    return Person.class;
   }
}

这儿，咱们能够先看看FactoryBean中的办法：

他是一个接口类。

那咱们就需求有一个类来继承这个接口，并且重写办法。

这儿，咱们将需求注册的Bean的类，放到FactoryBean的泛型中。

getObject办法用于直接回来创立的目标。

getObjectType直接回来类的class。

然后实际上，仍是要运用@Bean注解，将继承接口的类目标回来。

然后Configuration注解，将此类改为springboot的装备类，相当于springmvc中的xml文件。

咱们能够经过AnnotationConfigApplicationContext的getBean办法，来看看是否被IOC办理。

运转后，能够看到，目标地址被输出了。

说明成功了。

运用 BeanDefinitionRegistryPostProcessor

写这篇文章时，我也是查阅了网上许多大佬的材料。

有一种我不熟悉的办法。

于是……

开端原文照搬….

其实这种办法也是利用到了 BeanDefinitionRegistry，在Spring容器启动的时候会执行 BeanDefinitionRegistryPostProcessor的 postProcessBeanDefinitionRegistry ()办法，大约意思便是等beanDefinition加载结束之后，对beanDefinition进行后置处理，能够在此进行调整IOC容器中的beanDefinition，从而搅扰到后边进行初始化bean。

public class Demo1 {
  public static void main(String[] args) {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
    MyBeanDefinitionRegistryPostProcessor beanDefinitionRegistryPostProcessor = new MyBeanDefinitionRegistryPostProcessor();
    applicationContext.addBeanFactoryPostProcessor(beanDefinitionRegistryPostProcessor);
    applicationContext.refresh();
    Person bean = applicationContext.getBean(Person.class);
    System.out.println(bean);
   }
}
class MyBeanDefinitionRegistryPostProcessor implements BeanDefinitionRegistryPostProcessor {
  @Override
  public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
    AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Person.class).getBeanDefinition();
    registry.registerBeanDefinition("person", beanDefinition);
   }
  @Override
  public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
   }
}

上述代码中，咱们手动向beanDefinitionRegistry中注册了person的BeanDefinition，终究成功将person加入到applicationContext中。

讲完了，下次再会。