你知道將Bean交給Spring容器管理有幾種方式(推薦)

更新時(shí)間：2022年10月13日 15:05:27 作者：小簡(jiǎn)(JanYork)

Spring核心是?IOC?和?AOP?，我們?cè)赟pring項(xiàng)目中，我們需要將Bean交給Spring容器，也就是IOC管理，這樣你才可以使用注解來(lái)進(jìn)行依賴注入，這篇文章主要介紹了你知道將Bean交給Spring容器管理有幾種方式,需要的朋友可以參考下

Spring核心

Spring核心是 IOC 和 AOP 。

所謂IoC，對(duì)于spring框架來(lái)說(shuō)，就是由spring來(lái)負(fù)責(zé)控制對(duì)象的生命周期和對(duì)象間的關(guān)系。

至于更詳細(xì)的說(shuō)明，或者去深入理解Spring這兩大核心，不是此篇文章的目的，暫不細(xì)說(shuō)了。

我們?cè)?code>Spring項(xiàng)目中，我們需要將Bean交給Spring容器，也就是IOC管理，這樣你才可以使用注解來(lái)進(jìn)行依賴注入。

包掃描+組件注解

針對(duì)類是我們自己編寫的情況

這種方式是我們?nèi)粘ｉ_(kāi)發(fā)中最常用到的spring將掃描路徑下帶有@Component、@Controller、@Service、@Repository注解的類添加到spring IOC容器中。

如果你使用過(guò)MybatisPlus，那這個(gè)就和他的包掃描注入一樣。

那我們這個(gè)ComponentScan注解，又有三個(gè)配置。

配置項(xiàng)一

basePackages用于定義掃描的包的路徑。

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

比如這樣，就是掃描com.timemail.bootmp整個(gè)包下的，帶有以上指定注解的類，并放入IOC。

我在別的文章上找了一個(gè)完整的示例：

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

//結(jié)果
Person{name='null'}

這就說(shuō)明上面代碼的Person類已經(jīng)被IOC容器所管理了。

配置項(xiàng)二

includeFilters包含規(guī)則

Filter注解用 FilterType.CUSTOM 可以自定義掃描規(guī)則需要實(shí)現(xiàn)TypeFilter接口實(shí)現(xiàn)match方法其中參數(shù) MetadataReader 當(dāng)前類的信息（注解，類路徑，類原信息…） MetadataReaderFactory MetadataReader的工廠類。

配置項(xiàng)三

excludeFilters移除規(guī)則

同包含規(guī)則。

這后兩個(gè)配置項(xiàng)我沒(méi)怎么用過(guò)，也不太熟悉，所以詳細(xì)使用請(qǐng)自行查閱相關(guān)資料。

@Configuration + @Bean

@Configuration + @Bean也是我們常用的一種放入容器的方式。

@Configuration用于聲明配置類

@Bean用于聲明一個(gè)Bean

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

就像這樣。

那我們指知道，在SSM里面，通常我們會(huì)在xml里面去配置bean。

@Configuration
public class ConfigBean {

}

那我們這個(gè)@Configuration注解，就相當(dāng)于一個(gè)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是一樣的，設(shè)置的時(shí)候，這2個(gè)參數(shù)只能選一個(gè)，原因是@AliasFor導(dǎo)致的value：字符串?dāng)?shù)組，第一個(gè)值作為bean的名稱，其他值作為bean的別名autowire：這個(gè)參數(shù)上面標(biāo)注了@Deprecated，表示已經(jīng)過(guò)期了，不建議使用了autowireCandidate：是否作為其他對(duì)象注入時(shí)候的候選bean。initMethod：bean初始化的方法，這個(gè)和生命周期有關(guān)，以后詳解destroyMethod：bean銷毀的方法，也是和生命周期相關(guān)的，以后詳解

擴(kuò)展

被@Configuration修飾的類，spring容器中會(huì)通過(guò)cglib給這個(gè)類創(chuàng)建一個(gè)代理，代理會(huì)攔截所有被@Bean修飾的方法，默認(rèn)情況（bean為單例）下確保這些方法只被調(diào)用一次，從而確保這些bean是同一個(gè)bean，即單例的。

@Import注解導(dǎo)入

先看源碼：

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

@Import只能用于類注解。

這里我直接搬運(yùn)某號(hào)的內(nèi)容吧。

他的講解非常詳細(xì)。

前兩種方式，大家用的可能比較多，也是平時(shí)開(kāi)發(fā)中必須要知道的，@Import注解用的可能不是特別多了，但是也是非常重要的，在進(jìn)行Spring擴(kuò)展時(shí)經(jīng)常會(huì)用到，它經(jīng)常搭配自定義注解進(jìn)行使用，然后往容器中導(dǎo)入一個(gè)配置文件。

關(guān)于@Import注解，我會(huì)多介紹一點(diǎn)，它有四種使用方式。這是@Import注解的源碼，表示只能放置在類上。

@Import直接導(dǎo)入類

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

上述代碼直接使用@Import導(dǎo)入了一個(gè)類，然后自動(dòng)的就被放置在IOC容器中了。

注意：我們的Person類上就不需要任何的注解了，直接導(dǎo)入即可。

@Import + ImportSelector

其實(shí)在@Import注解的源碼中，說(shuō)的已經(jīng)很清楚了，感興趣的可以看下，我們實(shí)現(xiàn)一個(gè)ImportSelector的接口，然后實(shí)現(xiàn)其中的方法，進(jìn)行導(dǎo)入。

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

我自定義了一個(gè)MyImportSelector實(shí)現(xiàn)了ImportSelector接口，重寫selectImports方法，然后將我們要導(dǎo)入的類的全限定名寫在里面即可，實(shí)現(xiàn)起來(lái)也是非常簡(jiǎn)單。

@Import + ImportBeanDefinitionRegistrar

這種方式也需要我們實(shí)現(xiàn)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) {
        // 構(gòu)建一個(gè)beanDefinition, 關(guān)于beanDefinition我后續(xù)會(huì)介紹，可以簡(jiǎn)單理解為bean的定義.
        AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Person.class).getBeanDefinition();
        // 將beanDefinition注冊(cè)到Ioc容器中.
        registry.registerBeanDefinition("person", beanDefinition);
    }
}

上述實(shí)現(xiàn)其實(shí)和Import的第二種方式差不多，都需要去實(shí)現(xiàn)接口，然后進(jìn)行導(dǎo)入。接觸到了一個(gè)新的概念，BeanDefinition，可以簡(jiǎn)單理解為bean的定義(bean的元數(shù)據(jù))，也是需要放在IOC容器中進(jìn)行管理的，先有bean的元數(shù)據(jù)，applicationContext再根據(jù)bean的元數(shù)據(jù)去創(chuàng)建Bean。

@Import + DeferredImportSelector

這種方式也需要我們進(jìn)行實(shí)現(xiàn)接口，其實(shí)它和@Import的第二種方式差不多，DeferredImportSelector 它是 ImportSelector 的子接口，所以實(shí)現(xiàn)的方法和第二種無(wú)異。只是Spring的處理方式不同，它和Spring Boot中的自動(dòng)導(dǎo)入配置文件延遲導(dǎo)入有關(guān)，非常重要。使用方式如下:

@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的全限定名放進(jìn)去
        return new String[]{Person.class.getName()};
    }
}

關(guān)于@Import注解的使用方式，大概就以上三種，當(dāng)然它還可以搭配@Configuration注解使用，用于導(dǎo)入一個(gè)配置類。

FactoryBean接口

說(shuō)到FactoryBean，我們很多入門的開(kāi)發(fā)者很容易將他與BeanFactory搞混。

BeanFactory他是所有Spring Bean的容器根接口，給Spring 的容器定義一套規(guī)范，給IOC容器提供了一套完整的規(guī)范，比如我們常用到的getBean方法等。

也就是我們常說(shuō)的Bean的工廠。

而我們的FactoryBean，它實(shí)際上就是一個(gè)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中的方法：

他是一個(gè)接口類。

那我們就需要有一個(gè)類來(lái)繼承這個(gè)接口，并且重寫方法。

這里，我們將需要注冊(cè)的Bean的類，放到FactoryBean的泛型中。

getObject方法用于直接返回創(chuàng)建的對(duì)象。

getObjectType直接返回類的class。

然后實(shí)際上，還是要使用@Bean注解，將繼承接口的類對(duì)象返回。

然后Configuration注解，將此類改為springboot的配置類，相當(dāng)于springmvc中的xml文件。

我們可以通過(guò)AnnotationConfigApplicationContext的getBean方法，來(lái)看看是否被IOC管理。

運(yùn)行后，可以看到，對(duì)象地址被輸出了。

說(shuō)明成功了。

使用 BeanDefinitionRegistryPostProcessor

寫這篇文章時(shí)，我也是查閱了網(wǎng)上很多大佬的資料。

有一種我不熟悉的方法。

于是…

開(kāi)始原文照搬…

其實(shí)這種方式也是利用到了 BeanDefinitionRegistry，在Spring容器啟動(dòng)的時(shí)候會(huì)執(zhí)行 BeanDefinitionRegistryPostProcessor的 postProcessBeanDefinitionRegistry ()方法，大概意思就是等beanDefinition加載完畢之后，對(duì)beanDefinition進(jìn)行后置處理，可以在此進(jìn)行調(diào)整IOC容器中的beanDefinition，從而干擾到后面進(jìn)行初始化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 {
 
    }
}

上述代碼中，我們手動(dòng)向beanDefinitionRegistry中注冊(cè)了person的BeanDefinition，最終成功將person加入到applicationContext中。

到此這篇關(guān)于你知道將Bean交給Spring容器管理有幾種方式的文章就介紹到這了,更多相關(guān)Spring容器管理Bean內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: