Spring通過註解註入組件的方法

組件聲明

在類上聲明 @Component、@Configuration、@RestController、@Service、@Repository 等註解，表示這個類需要被註入IoC容器。

1、@Configuration 和 @Bean

@Configuration 常用來和 @Bean 配合使用，來註入第三方組件。

例子：註入 Druid 數據源

@Configuration
public class DruidConfig {
  @Bean
  @ConfigurationProperties(prefix = "spring.datasource")
  public DataSource druidDataSource() {
    return new DruidDataSource();
  }
}

2、FactoryBean

通過實現介面 FactoryBean 來註入

例子：利用 FactoryBean 註入 Dog

// 實現 FactoryBean
public class DogFactoryBean implements FactoryBean<Dog> {

  // 對象
  @Override
  public Dog getObject() throws Exception {
    return new Dog();
  }

  // 類型
  @Override
  public Class<?> getObjectType() {
    return Dog.class;
  }

  // 是否單例，true表示是單例
  @Override
  public boolean isSingleton() {
    return true;
  }
}
// 註入 DogFactoryBean
@Configuration
public class MyConfig {
  @Bean
  DogFactoryBean dog() {
    return new DogFactoryBean();
  }
}

通過名字 dog 可以獲取容器中的 Dog 對象；如果想獲取 DogFactoryBean 對象，可以用 &dog 來獲取。

3、@Import

在類上聲明，可以快速註入多個第三方的類，常配合 ImportSelector、ImportBeanDefinitionRegistrar 使用

例子：註入 Dog、Cat 類
方式 1：註解註入

@Import({Dog.class, Cat.class})
public class MyConfig {}

方式 2：實現介面 ImportSelector

// 實現 ImportSelector
public class MyImport implements ImportSelector {
  @Override
  public String[] selectImports(AnnotationMetadata metadata) {
    return new String[]{"com.xxx.Dog", "com.xxx.Cat"};
  }
}
// 導入 MyImport
@Import({MyImport.class})
public class MyConfig {}

方式 3：實現介面 ImportBeanDefinitionRegistrar

// 實現 ImportBeanDefinitionRegistrar
public class MyImportBean implements ImportBeanDefinitionRegistrar {
  @Override
  public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
    BeanDefinition dogBean = new RootBeanDefinition(Dog.class);
    registry.registerBeanDefinition("dog", dogBean);
    BeanDefinition catBean = new RootBeanDefinition(Cat.class);
    registry.registerBeanDefinition("cat", beanDefinitions);
  }
}
// 導入 MyImportBean
@Import({MyImportBean.class})
public class MyConfig {}

4、@Conditional

可以自定義滿足條件後才註入組件。

例子：當容器中存在 Dog 時，才註入 Cat

// 實現 Condition
public class MyCondition implements Condition {
  @Override
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
    for (String name : Objects.requireNonNull(context.getBeanFactory()).getBeanDefinitionNames()) {
      if ("com.xxx.Dog".equals(name)) {
        return true;
      }
    }
    return false;
  }
}
// 按條件註入 Cat
@Configuration
public class MyConfig {
    @Conditional(MyCondition.class)
    @Bean
    Cat cat() {
        return new Cat();
    }
}

Springboot 提供了一些 @Conditional 的實現

@ConditionalOnClass：存在該類時生效
@ConditionalOnBean：存在該Bean是生效
@ConditionalOnProperty：配置正確時生效
@ConditionalOnResource：資源存在是生效

5、其它註解

Springboot 提供的配置生效順序的註解

@AutoConfigureAfter：在指定的配置類生效後再註入
@AutoConfigureBefore：在指定的配置類生效後再註入