容器功能

1.Spring注入組件的注解

Spring中的傳統注解@Component、@Controller、@Service、@Repository，在SpringBoot中仍然有效，

2.@Configuration

@Configuration是 Spring 3.0 添加的一個注解，用來代替原先 Spring 中的 applicationContext.xml 容器組態檔，所有這個組態檔里面能做到的事情都可以通過這個注解所在類來進行注冊，

在SpringBoot專案中，依然可以使用Spring的容器檔案來注入bean/獲取bean，但是不推薦使用

2.1應用實體

例子：使用SpringBoot的注解@Configuration添加/注入組件

（1）Monster.java

package com.li.springboot.bean;

/**
 * @author 李
 * @version 1.0
 */
public class Monster {
    private Integer id;
    private String name;
    private Integer age;
    private String skill;
    
    //省略無參，全參構造器，getter，setter以及toString方法
}

（2）配置類：BeanConfig.java

package com.li.springboot.config;

import com.li.springboot.bean.Monster;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Scope;

/**
 * @author 李
 * @version 1.0
 * 
 * 1.@Configuration注解標識這是一個配置類，等價于spring的容器組態檔
 * 2.這時我們可以通過@Bean注解注入Bean物件到容器中
 * 3.當一個類被@Configuration標識，這個類也會被注入到容器中，因此也能在容器中獲取這個類物件
 */
@Configuration
public class BeanConfig {
    /**
     * 1.@Bean表示給容器添加了一個組件，即Monster的bean物件
     * 2.name = "monster_n1" 在配置，注入Bean時指定的名字/id,如果沒有設定，
     *   就使用方法名 monster01() ：作為Bean的名字/id
     * 3.Monster ：方法的回傳型別就是注入的bean型別
     * 4.new Monster(200,"牛魔王",500,"芭蕉扇") 就是注入到容器中的具體 bean資訊
     * 5.默認為單例物件，如果要做成多例的，需要添加注解@Scope("prototype")
     */
    @Bean(name = "monster_n1")
    public Monster monster01() {
        return new Monster(200, "牛魔王", 500, "芭蕉扇");
    }
}

（3）MainApp.java

package com.li.springboot;

import com.li.springboot.bean.Monster;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

/**
 * @author 李
 * @version 1.0
 */
@SpringBootApplication(scanBasePackages = {"com.li"})
public class MainApp {
    public static void main(String[] args) {
        ConfigurableApplicationContext ioc =
                SpringApplication.run(MainApp.class, args);

        Monster monster_n1 = ioc.getBean("monster_n1", Monster.class);
        Monster monster_n2 = ioc.getBean("monster_n1", Monster.class);
        System.out.println("monster_n1=" + monster_n1
                + ",n1.hashCode=" + monster_n1.hashCode());
        System.out.println("monster_n2=" + monster_n2
                + ",n2.hashCode=" + monster_n2.hashCode());
    }
}

測驗結果：成功注入容器，并且默認為單例物件

monster_n1=Monster{id=200, name='牛魔王', age=500, skill='芭蕉扇'},n1.hashCode=1532800776
monster_n2=Monster{id=200, name='牛魔王', age=500, skill='芭蕉扇'},n2.hashCode=1532800776

2.2注意事項和細節

（1）配置類本身也是組件，因此也可以在容器中獲取，并且默認也是單例的

（2）SpringBoot2新增特性：proxyBeanMethods--代理 bean 的方法，

ProxyBeanMethods 可以指定 Full 模式和 Lite 模式
- Full模式：(proxyBeanMethods = true)，保證修修飾的配置類中，每個@Bean 方法被呼叫多少次回傳的組件都是單實體的，是代理方式
- Lite模式：(proxyBeanMethods = false)，保證修飾的配置類中，每個@Bean方法被呼叫多少次回傳的組件都是新創建的，多例物件，是非代理方式
- 特別說明：proxyBeanMethods 在呼叫 @Bean 方法時才生效，因此需要先獲取BeanConfig 組件，再呼叫方法，而不是直接通過SpringBoot 主程式得到的容器來獲取bean，直接通過ioc.getBean() 獲取 Bean, proxyBeanMethods 值并不會生效
如何選擇: 組件依賴必須使用 Full 模式（默認），如果不需要組件依賴使用 Lite 模式，
Lite 模也稱為輕量級模式，因為不檢測依賴關系，運行速度快

（3）配置類可以有多個，就和Spring可以有多個容器組態檔一樣

例子：測驗proxyBeanMethods--代理 bean 的方法，

以2.1的代碼為例，Monster.java不變

（1）修改配置類的注解為@Configuration(proxyBeanMethods = true)，其他不變

（2）修改MainApp.java：

package com.li.springboot;

import ...

/**
 * @author 李
 * @version 1.0
 */
@SpringBootApplication(scanBasePackages = {"com.li"})
public class MainApp {
    public static void main(String[] args) {
        //啟動SpringBoot應用程式/專案
        ConfigurableApplicationContext ioc =
                SpringApplication.run(MainApp.class, args);

        //1.先得到BeanConfig組件
        BeanConfig beanConfig = ioc.getBean(BeanConfig.class);
        //2.通過beanConfig物件呼叫方法才能生效！！
        Monster monster_01 = beanConfig.monster01();
        Monster monster_02 = beanConfig.monster01();
        System.out.println("monster_01=" + monster_01 
                           + ",hashcode=" + monster_01.hashCode());
        System.out.println("monster_02=" + monster_02 
                           + ",hashcode=" + monster_02.hashCode());
    }
}

注意：proxyBeanMethods 在呼叫 @Bean 方法時才生效，因此需要先獲取BeanConfig 組件，再呼叫方法，

測驗結果：哈希值相同，說明獲取的物件是同一個，為單例物件

monster_01=Monster{id=200, name='牛魔王', age=500, skill='芭蕉扇'},hashcode=1075996552
monster_02=Monster{id=200, name='牛魔王', age=500, skill='芭蕉扇'},hashcode=1075996552

（3）將配置類的注解改為：@Configuration(proxyBeanMethods = false)，然后重新測驗

測驗結果：每次回傳的物件都是新的物件，即多例物件

monster_01=Monster{id=200, name='牛魔王', age=500, skill='芭蕉扇'},hashcode=1164699452
monster_02=Monster{id=200, name='牛魔王', age=500, skill='芭蕉扇'},hashcode=594916129

3.@Import

@Import 是 Spring 3.0 添加的新注解，用來修飾 @Configuration 注解修飾的類，在 Spring Boot 里面應用很多，它可以將普通類匯入到spring容器中做管理，

原始碼：

package org.springframework.context.annotation;

import ...

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {
    Class<?>[] value();
}

通過原始碼可以看到該注解可以指定class的陣列，通過該陣列注入指定型別的Bean

3.1應用實體

（1）創建兩個Bean，Dog.java和Cat.java

package com.li.springboot.bean;

/**
 * @author 李
 * @version 1.0
 */
public class Dog {
}

package com.li.springboot.bean;

/**
 * @author 李
 * @version 1.0
 */
public class Cat {
}

（2）配置類BeanConfig.java

package com.li.springboot.config;

import com.li.springboot.bean.Cat;
import com.li.springboot.bean.Dog;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

/**
 * @author 李
 * @version 1.0
 * 通過@Import方式注入了組件，默認的組件名字/id為型別的全類名：
 *  com.li.springboot.bean.Dog 和 com.li.springboot.bean.Cat
 */
@Import({Dog.class, Cat.class})
@Configuration//標識這是一個配置類，等價于組態檔
public class BeanConfig {

}

（3）MainApp.java

package com.li.springboot;

import ...

/**
 * @author 李
 * @version 1.0
 */
@SpringBootApplication(scanBasePackages = {"com.li"})
public class MainApp {
    public static void main(String[] args) {
        //啟動SpringBoot應用程式/專案
        ConfigurableApplicationContext ioc =
                SpringApplication.run(MainApp.class, args);
        //測驗@Import
        Dog dogBean = ioc.getBean(Dog.class);
        Cat catBean = ioc.getBean(Cat.class);
        System.out.println("dogBean=" + dogBean);
        System.out.println("catBean=" + catBean);
    }
}

測驗結果：

dogBean=com.li.springboot.bean.Dog@12477988
catBean=com.li.springboot.bean.Cat@2caf6912

4.@Conditional

條件裝配：滿足 Conditional 指定的條件，才進行組件注入
它可以修飾類，介面或者列舉型別，還可以修飾在方法上
@Conditional 是一個根注解，它的下面有很多擴展注解

@Conditional擴展注解	作用
@ConditionalOnJava	當JVM版本為指定的版本范圍時觸發實體化
@ConditionalOnBean	當容器中至少存在一個指定name或class的Bean時，進行實體化
@ConditionalOnMissingBean	當容器中指定name或class的Bean都不存在時，進行實體化
@ConditionalOnExpression	基于SpEL運算式的條件判斷,當為true的時候進行實體化
@ConditionalOnClass	當類路徑下至少存在一個指定的class時，進行實體化
@ConditionalOnMissingClass	當容器中指定class都不存在時，進行實體化
@ConditionalOnSingleCandidate	當指定的Bean在容器中只有一個，或者有多個但是指定了首選的Bean時觸發實體化
@ConditionalOnProperty	當指定的屬性有指定的值時進行實體化
@ConditionalOnResource	當類路徑下有指定的資源時觸發實體化
@ConditionalOnWebApplication	當專案是一個Web專案時進行實體化
@ConditionalOnNotWebApplication	當專案不是一個Web專案時進行實體化
@ConditionalOnJndi	在JNDI存在的條件下觸發實體化

4.1應用實體

演示在SpringBoot中通過@ConditionalOnBean來注入組件

（1）指定條件：當容器中有name="monster_nmw"組件時，才注入dog01，代碼如下：

package com.li.springboot.config;

import ...

/**
 * @author 李
 * @version 1.0
 */

@Configuration
public class BeanConfig {
    @Bean
    public Monster monster01() {
        return new Monster(200, "牛魔王", 500, "芭蕉扇");
    }
    
    /**
     * 1.@ConditionalOnBean(name = "monster_nmw")
     *  表示當容器中存在id為monster_nmw的Bean時（對型別不做約束），
     *	dog01這個Dog Bean才能注入到容器中
     * 2.如果不符合條件，則不能注入容器
     */
    @Bean
    @ConditionalOnBean(name = "monster_nmw")
    public Dog dog01() {
        return new Dog();
    }
}

（2）MainApp.java

package com.li.springboot;

import ...

/**
 * @author 李
 * @version 1.0
 */
@SpringBootApplication(scanBasePackages = {"com.li"})
public class MainApp {
    public static void main(String[] args) {
        ConfigurableApplicationContext ioc =
                SpringApplication.run(MainApp.class, args);
        //演示@ConditionalOnBean的使用
        Dog dog01 = ioc.getBean("dog01", Dog.class);
        System.out.println("dog01=" + dog01);
    }
}

測驗結果：運行出錯，因為容器中沒有名為monster_nmw的 Bean，因此不能注入Dog Bean，也就無法通過getBean獲取到Dog Bean物件，

5.@ImportResource

作用：原生功能組態檔引入，可以直接匯入Spring傳統的beans.xml到配置類中，可以認為是SpringBoot對Spring的兼容，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/546670.html

標籤：Java

上一篇：Git 倉庫7K stars！學Java開源專案austin要多久？

下一篇：FastAdmin的API介面生成器插件，使用validate驗證時報錯等問題。

day02-容器功能