@Import注解的應(yīng)用和擴展

用注解的方式將一個對象交給Spring來管理架专,有三種做法:
1、@Bean
2玄帕、@Componet(@Service部脚、@Configuration等歸為一類)
3、@Import
這里主要講第三種做法裤纹,打開Spring源碼

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

@Import注解只有一個value方法委刘,注釋中指明該注解必須作用于@Configuration定義的類上丧没,value可以為想要交給Spring管理的類文件數(shù)組、ImportSelector或ImportBeanDefinitionRegistrar锡移,接下來我們依次執(zhí)行三種做法

  • 1呕童、指定class數(shù)組
    首先定義兩個類
public class Apple {
}
public class Banana {
}

然后定義配置類,并用@Import注解裝飾淆珊,輸入兩個自定義類

import com.lwl.entity.Apple;
import com.lwl.entity.Banana;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

@Configuration
@Import({Apple.class, Banana.class})
public class AppConfig {
}

測試類中打印容器中類的名稱

public class Test {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
        for (String s : applicationContext.getBeanDefinitionNames()) {
            System.out.println(s);
        }
    }
}

輸出結(jié)果中可以看到Apple和Banana都被成功注入:

結(jié)果1
  • 2夺饲、實現(xiàn)ImportSelector接口
    定義一個新的實體,需求是通過ImportSelector將其注入Spring容器
public class Berry {
}

自定義selector實現(xiàn)ImportSelector接口施符,在方法中返回自定義的類路徑往声,Spring會自動將該路徑下的類注入到容器中

import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.type.AnnotationMetadata;

public class BerryImportSelector implements ImportSelector {
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        return new String[]{"com.lwl.entity.Berry"};
    }
}

修改配置代碼,在@Import中加入BerryImportSelector :

@Configuration
@Import({Apple.class, Banana.class, BerryImportSelector.class})
public class AppConfig {
}

測試代碼不變戳吝,打印結(jié)果:


結(jié)果2

Berry確實被注入進來了

  • 3浩销、實現(xiàn)ImportBeanDefinitionRegistrar接口
    再定義一個新的實體:
public class Tomato {
}

創(chuàng)建TomatoRegistrar實現(xiàn)ImportBeanDefinitionRegistrar接口,在方法當中將類注冊到容器里骨坑,并將beanName修改為MyTomato:

import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;

public class TomatoRegistrar implements ImportBeanDefinitionRegistrar {
    public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {
        RootBeanDefinition beanDefinition = new RootBeanDefinition(Tomato.class);
        beanDefinitionRegistry.registerBeanDefinition("MyTomato", beanDefinition);
    }
}

修改AppConfig代碼撼嗓,將TomatoRegistrar放入@Import中:

@Configuration
@Import({Apple.class, Banana.class, BerryImportSelector.class, TomatoRegistrar.class})
public class AppConfig {
}

測試結(jié)果:

結(jié)果3

總結(jié)

在平時的業(yè)務(wù)開發(fā)當中,將對象放入容器欢唾,使用@Bean和@Compont基本就能夠滿足需求,但是@Import注解能夠方便擴展功能粉捻,舉例:

  • 1礁遣、控制類注入時機
    我希望能夠通過一個簡單的開關(guān)來控制是否注入Berry類,我們可以定義一個注解
import org.springframework.context.annotation.Import;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
@Import({BerryImportSelector.class})
public @interface EnableBerry {
}

修改@AppConfig肩刃,刪除@Import中的BerryImportSelector.class祟霍,


import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

@Configuration
@Import({Apple.class, Banana.class, TomatoRegistrar.class})
public class AppConfig {
}

這時候運行測試,發(fā)現(xiàn)Berry沒有被注入到容器中:

image.png

如果在AppConfig類加上@EnableBerry注解

@Configuration
@Import({Apple.class, Banana.class, TomatoRegistrar.class})
@EnableBerry
public class AppConfig {
}

再次執(zhí)行測試盈包,Berry成功注入:


image.png

SpringCloud中的@EnableEureka沸呐、@EnableDiscoveryClient就是利用這個原理

  • 2、通過代理來改變bean定義
    Spring-Mybatis的@MapperScan注解呢燥,是由@Import注解所修飾崭添,并注入了MapperScannerRegistrar類:
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Import({MapperScannerRegistrar.class})
public @interface MapperScan {

它在registerBeanDefinitions方法中掃描了基礎(chǔ)包,

public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
 scanner.doScan(StringUtils.toStringArray(basePackages));
}

然后提取mapper產(chǎn)生代理類叛氨,最后注冊到容器當中

本文示例代碼見LiuWillow的github——demo-import
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末呼渣,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子寞埠,更是在濱河造成了極大的恐慌屁置,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,427評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件仁连,死亡現(xiàn)場離奇詭異蓝角,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,551評論 3 395
  • 文/潘曉璐 我一進店門使鹅,熙熙樓的掌柜王于貴愁眉苦臉地迎上來揪阶,“玉大人,你說我怎么就攤上這事并徘∏睬” “怎么了?”我有些...
    開封第一講書人閱讀 165,747評論 0 356
  • 文/不壞的土叔 我叫張陵麦乞,是天一觀的道長蕴茴。 經(jīng)常有香客問我,道長姐直,這世上最難降的妖魔是什么倦淀? 我笑而不...
    開封第一講書人閱讀 58,939評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮声畏,結(jié)果婚禮上撞叽,老公的妹妹穿的比我還像新娘。我一直安慰自己插龄,他們只是感情好愿棋,可當我...
    茶點故事閱讀 67,955評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著均牢,像睡著了一般糠雨。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上徘跪,一...
    開封第一講書人閱讀 51,737評論 1 305
  • 那天甘邀,我揣著相機與錄音,去河邊找鬼垮庐。 笑死松邪,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的哨查。 我是一名探鬼主播逗抑,決...
    沈念sama閱讀 40,448評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼解恰!你這毒婦竟也來了锋八?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,352評論 0 276
  • 序言:老撾萬榮一對情侶失蹤护盈,失蹤者是張志新(化名)和其女友劉穎挟纱,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體腐宋,經(jīng)...
    沈念sama閱讀 45,834評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡紊服,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,992評論 3 338
  • 正文 我和宋清朗相戀三年檀轨,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片欺嗤。...
    茶點故事閱讀 40,133評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡参萄,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出煎饼,到底是詐尸還是另有隱情讹挎,我是刑警寧澤,帶...
    沈念sama閱讀 35,815評論 5 346
  • 正文 年R本政府宣布吆玖,位于F島的核電站筒溃,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏沾乘。R本人自食惡果不足惜怜奖,卻給世界環(huán)境...
    茶點故事閱讀 41,477評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望翅阵。 院中可真熱鬧歪玲,春花似錦、人聲如沸掷匠。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,022評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽讹语。三九已至夭委,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間募强,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,147評論 1 272
  • 我被黑心中介騙來泰國打工崇摄, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留擎值,地道東北人。 一個月前我還...
    沈念sama閱讀 48,398評論 3 373
  • 正文 我出身青樓逐抑,卻偏偏與公主長得像鸠儿,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子厕氨,可洞房花燭夜當晚...
    茶點故事閱讀 45,077評論 2 355