SpringBoot 如何從容器中獲取物件

2022-08-23 14:01:22

如何從容器中獲取物件

有時候在專案中，我們會自己建立一些類，類中需要使用到容器中的一些類。方法是新建類並實現ApplicationContextAware 介面，在類中建立靜態物件 ApplicationContext 物件，這個物件就如同xml設定中的 applicationContext.xml，容器中類都可以獲取到。

例如@Service、 @Component、@Repository、@Controller 、@Bean 標註的類都能獲取到。

/**
 * 功能描述：Spring Bean 管理類
 *
 */
@Component
public class SpringContextUtils implements ApplicationContextAware {
    /**
     * 上下文物件範例
     */
    private static ApplicationContext applicationContext;
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
    /**
     * 獲取applicationContext
     *
     * @return
     */
    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }
    /**
     * 通過name獲取 Bean.
     *
     * @param name
     * @return
     */
    public static Object getBean(String name) {
        return getApplicationContext().getBean(name);
    }
    /**
     * 通過class獲取Bean.
     *
     * @param clazz
     * @param <T>
     * @return
     */
    public static <T> T getBean(Class<T> clazz) {
        try{
            return getApplicationContext().getBean(clazz);
        }catch (Exception e){
            return null;
        }
    }
    /**
     * 通過name,以及Clazz返回指定的Bean
     *
     * @param name
     * @param clazz
     * @param <T>
     * @return
     */
    public static <T> T getBean(String name, Class<T> clazz) {
        return getApplicationContext().getBean(name, clazz);
    }
}

SpringBoot中的容器

容器功能

1、元件新增

（1）主要註解

@Configuration

告訴SpringBoot這是一個設定類 == 組態檔

注意：spring5.2以後@Configuration多了一個屬性proxyBeanMethods，預設為true

@Configuration(proxyBeanMethods = true)

proxyBeanMethods：代理bean的方法
Full(proxyBeanMethods = true)、【保證每個@Bean方法被呼叫多少次返回的元件都是單範例的】外部無論對設定類中的這個元件註冊方法呼叫多少次獲取的都是之前註冊容器中的單範例物件
Lite(proxyBeanMethods = false)【每個@Bean方法被呼叫多少次返回的元件都是新建立的】
元件依賴必須使用Full模式預設。其他預設是否Lite模式

● Full模式與Lite模式

○ 最佳實戰

■ 設定類元件之間無依賴關係用Lite模式加速容器啟動過程，減少判斷

■ 設定類元件之間有依賴關係，方法會被呼叫得到之前單範例元件，用Full模式

@Bean

給容器中新增元件。以方法名作為元件的id。返回型別就是元件型別。返回的值，就是元件在容器中的範例
設定類裡面使用@Bean標註在方法上給容器註冊元件，預設是單範例的
設定類本身也是元件

（2）基本使用

bean包：

Pet類：

/**
 * 寵物
 */
public class Pet {
    private String name;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Pet(String name) {
        this.name = name;
    }
    public Pet() {
    }
    @Override
    public String toString() {
        return "Pet{" +
                "name='" + name + ''' +
                '}';
    }
}

User類：

/*
使用者
 */
public class User {
    private String name;
    private Integer age;
    public User() {
    }
    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    @Override
    public String toString() {
        return "User{" +
                "name='" + name + ''' +
                ", age=" + age +
                '}';
    }
}

config包：

MyConfig類

@Configuration(proxyBeanMethods = false)//告訴Spring這是一個設定類
public class MyConfig {
    @Bean//給容器中新增元件。以方法名作為元件的id。返回型別就是元件型別。返回的值，就是元件在容器中的範例
    public User user01(){
        return  new User("zhangsan",18);
    }
    @Bean("tom")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}

controller包：

MainApplication類

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan("com")
public class MainApplication {
    public static void main(String[] args) {
        //1、返回我們IOC容器
        ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
        //2、檢視容器裡面的元件
        String[] names = run.getBeanDefinitionNames();
        for (String name : names) {
            System.out.println(name);
        }
        //3、從容器中獲取元件
        MyConfig bean = run.getBean(MyConfig.class);
        System.out.println(bean);
        //如果@Configuration(proxyBeanMethods = true)代理物件呼叫方法。SpringBoot總會檢查這個元件是否在容器中有。
        //保持元件單範例
        User user = bean.user01();
        User user1 = bean.user01();
        System.out.println("元件為："+(user == user1));
    }
}

結果

（3）補充 @Import

給容器匯入一個元件

必須寫在容器中的元件上

 * @Import({User.class, DBHelper.class})
 *      給容器中自動建立出這兩個型別的元件、預設元件的名字就是全類名
 *
 *
 *
 */
@Import({User.class, DBHelper.class})
@Configuration(proxyBeanMethods = false) //告訴SpringBoot這是一個設定類 == 組態檔
public class MyConfig {
}

@Configuration測試程式碼如下

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan("com")
public class MainApplication {
    public static void main(String[] args) {
        //1、返回我們IOC容器
        ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
        //2、檢視容器裡面的元件
        String[] names = run.getBeanDefinitionNames();
        for (String name : names) {
            System.out.println(name);
        }
        //3、從容器中獲取元件
        MyConfig bean = run.getBean(MyConfig.class);
        System.out.println(bean);
        //如果@Configuration(proxyBeanMethods = true)代理物件呼叫方法。SpringBoot總會檢查這個元件是否在容器中有。
        //保持元件單範例
        User user = bean.user01();
        User user1 = bean.user01();
        System.out.println("元件為："+(user == user1));
        //5、獲取元件
        String[] beanNamesForType = run.getBeanNamesForType(User.class);
        System.out.println("======");
        for (String s : beanNamesForType) {
            System.out.println(s);
        }
        DBHelper bean1 = run.getBean(DBHelper.class);
        System.out.println(bean1);
    }
}

@Conditional

條件裝配：滿足Conditional指定的條件，則進行元件注入

ConditionalOnBean：當容器中存在指定的bean元件時才幹某些事情
ConditionalOnMissingBean：當容器中不存在指定的bean元件時才幹某些事情
ConditionalOnClass：當容器中有某個類時才幹某些事情
ConditionalOnResource：當專案的類路徑存在某個資源時，才幹什麼事

=====================測試條件裝配==========================
@Configuration(proxyBeanMethods = false) //告訴SpringBoot這是一個設定類 == 組態檔
//@ConditionalOnBean(name = "tom")
@ConditionalOnMissingBean(name = "tom")
public class MyConfig {
    @Bean //給容器中新增元件。以方法名作為元件的id。返回型別就是元件型別。返回的值，就是元件在容器中的範例
    public User user01(){
        User zhangsan = new User("zhangsan", 18);
        //user元件依賴了Pet元件
        zhangsan.setPet(tomcatPet());
        return zhangsan;
    }
    @Bean("tom22")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}

測試：

public static void main(String[] args) {
        //1、返回我們IOC容器
        ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
        //2、檢視容器裡面的元件
        String[] names = run.getBeanDefinitionNames();
        for (String name : names) {
            System.out.println(name);
        }
        boolean tom = run.containsBean("tom");
        System.out.println("容器中Tom元件："+tom);
        boolean user01 = run.containsBean("user01");
        System.out.println("容器中user01元件："+user01);
        boolean tom22 = run.containsBean("tom22");
        System.out.println("容器中tom22元件："+tom22);
    }

2、原生組態檔引入（xml檔案引入）

@ImportResource

匯入資源

@ImportResource("classpath:beans.xml")//匯入spring的組態檔
@Import({User.class, DBHelper.class})
@Configuration(proxyBeanMethods = false)//告訴Spring這是一個設定類
@ConditionalOnMissingBean(name = "tom")
public class MyConfig {

======================beans.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"
       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 https://www.springframework.org/schema/context/spring-context.xsd">
    <bean id="haha" class="com.atguigu.boot.bean.User">
        <property name="name" value="zhangsan"></property>
        <property name="age" value="18"></property>
    </bean>
    <bean id="hehe" class="com.atguigu.boot.bean.Pet">
        <property name="name" value="tomcat"></property>
    </bean>
</beans>

測試

======================測試=================
        boolean haha = run.containsBean("haha");
        boolean hehe = run.containsBean("hehe");
        System.out.println("haha："+haha);//true
        System.out.println("hehe："+hehe);//true

3、設定繫結

如何使用Java讀取到properties檔案中的內容，並且把它封裝到JavaBean中，以供隨時使用；

(1) @Component + @ConfigurationProperties

properties檔案

/**
 * 只有在容器中的元件，才會擁有SpringBoot提供的強大功能
 */
@Component
@ConfigurationProperties(prefix = "mycar")
public class Car {
    private String brand;
    private Integer price;
    public String getBrand() {
        return brand;
    }
    public void setBrand(String brand) {
        this.brand = brand;
    }
    public Integer getPrice() {
        return price;
    }
    public void setPrice(Integer price) {
        this.price = price;
    }
    @Override
    public String toString() {
        return "Car{" +
                "brand='" + brand + ''' +
                ", price=" + price +
                '}';
    }
}

(2) @EnableConfigurationProperties + @ConfigurationProperties

@Configuration(proxyBeanMethods = false) //告訴SpringBoot這是一個設定類 == 組態檔
@ConditionalOnMissingBean(name = "tom")
@ImportResource("classpath:beans.xml")
//@EnableConfigurationProperties(Car.class)
//1、開啟Car設定繫結功能
//2、把這個Car這個元件自動註冊到容器中
public class  MyConfig {

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。