對(duì)Spring PostConstruct注解的一點(diǎn)新認(rèn)識(shí)

無(wú)論是Spring還是SpringBoot開發(fā)中路捧,PostConstruct注解的使用頻率還是比較高的,通常用于Bean初始化完成的一些動(dòng)作。

在項(xiàng)目代碼中琼讽,會(huì)將配置從配置中心中讀取熔萧,然后初始化到指定的Bean中糖驴。其他需要?jiǎng)討B(tài)獲取配置的地方,直接依賴注入這個(gè)Bean即可佛致。
示例代碼如下:

ApplicationConfig

動(dòng)態(tài)配置所在的類贮缕,主要是屬性。

@Configuration
@Data
@Slf4j
public class ApplicationConfig {

  /**
     * client host
     */
  private String host;

  /**
     * client port
     */
  private String port;

  public ApplicationConfig() {
    log.info("ApplicationConfig constructor execute");
  }

  @PostConstruct
  public void init() {
    log.info("ApplicationConfig postConstructor execute");
  }
}
ApplicationConfigLoadService

從遠(yuǎn)程配置中心中獲取配置信息俺榆,主要依賴PostConstruct方法感昼。

@Service
@Slf4j
public class ApplicationConfigLoadService {

  @Resource
  private ApplicationConfig applicationConfig;

  public ApplicationConfigLoadService() {
    log.info("ApplicationConfigLoadService constructor execute");
  }

  @PostConstruct
  public void load() {
    log.info("ApplicationConfigLoadService postConstruct execute");
    // 可以是從數(shù)據(jù)庫(kù),或者遠(yuǎn)程的配置中心中讀取配置
    String host = "127.0.0.1";
    String port = "8080";
    applicationConfig.setHost(host);
    applicationConfig.setPort(port);
  }
}
ApplicationClientFactory

使用ApplicationConfig罐脊,基于配置信息定嗓,在類初始化完成后,做一些動(dòng)作萍桌。

@Component
@Slf4j
public class ApplicationClientFactory {

  @Resource
  private ApplicationConfig applicationConfig;

  public ApplicationClientFactory() {
    log.info("ApplicationClientFactory constructor execute");
  }

  @PostConstruct
  public void init() {
    log.info("ApplicationClientFactory postConstruct execute, host:{}, port:{}",
             applicationConfig.getHost(), applicationConfig.getPort());
  }
}

備注:

  1. 主要的類中宵溅,提供了一個(gè)無(wú)參的構(gòu)造方法,以及一個(gè)使用了@PostConstructor注解的初始化方法上炎,主要用于看一下執(zhí)行順序恃逻。
  2. 代碼說(shuō)明
    1. ApplicationConfigLoadService 的初始化方法中加載配置
    2. ApplicationConfig的setter方法完成配置初始化
    3. ApplicationClientFactory依賴ApplicationConfig中的屬性完成一些初始化工作。

將上述代碼執(zhí)行一下藕施,并查看日志寇损。

2021-06-06 15:38:28.591  INFO 2790 --- [           main] c.y.m.c.ApplicationClientFactory         : ApplicationClientFactory constructor execute
2021-06-06 15:38:28.598  INFO 2790 --- [           main] c.y.m.configuration.ApplicationConfig    : ApplicationConfig constructor execute
2021-06-06 15:38:28.599  INFO 2790 --- [           main] c.y.m.configuration.ApplicationConfig    : ApplicationConfig postConstructor execute
2021-06-06 15:38:28.599  INFO 2790 --- [           main] c.y.m.c.ApplicationClientFactory         : ApplicationClientFactory postConstruct execute, host:null, port:null
2021-06-06 15:38:28.602  INFO 2790 --- [           main] c.y.m.c.ApplicationConfigLoadService     : ApplicationConfigLoadService constructor execute
2021-06-06 15:38:28.603  INFO 2790 --- [           main] c.y.m.c.ApplicationConfigLoadService     : ApplicationConfigLoadService postConstruct execut

可以看到ApplicationClientFactory的構(gòu)造方法先被執(zhí)行,然后由于依賴ApplicationConfig類铅碍,所以ApplicationConfig的構(gòu)造方法和標(biāo)識(shí)了PostConstruct注解的方法被執(zhí)行润绵,然后才會(huì)執(zhí)行ApplicationClientFactory自己的postConstruct方法。

但是從日志中可以看出胞谈,此時(shí)由于ApplicationConfigLoadService還沒(méi)被加載尘盼,所以讀取到的配置都是空的憨愉。

嘗試的解決方案

方案1:是可以采用DependsOn指定Bean的加載順序。

修改代碼如下:

value即為依賴Bean的名稱卿捎。

@DependsOn(value = {"applicationConfigLoadService"})
@Component
@Slf4j
public class ApplicationClientFactory  
Beans on which the current bean depends. Any beans specified are guaranteed to be
created by the container before this bean. Used infrequently in cases where a bean
does not explicitly depend on another through properties or constructor arguments,
but rather depends on the side effects of another bean's initialization.

從JDK文檔可以看出配紫,DependsOn注解主要的使用場(chǎng)景是當(dāng)前Bean沒(méi)有顯示通過(guò)屬性或者構(gòu)造參數(shù)依賴另外一個(gè)Bean,但是卻要依賴另外一個(gè)Bean的一些初始化動(dòng)作午阵。

在上述代碼示例中躺孝,通過(guò)添加DependsOn注解,可以解決問(wèn)題底桂。

2021-06-06 16:36:59.944  INFO 3688 --- [           main] c.y.m.c.ApplicationConfigLoadService     : ApplicationConfigLoadService constructor execute
2021-06-06 16:36:59.948  INFO 3688 --- [           main] c.y.m.configuration.ApplicationConfig    : ApplicationConfig constructor execute
2021-06-06 16:36:59.949  INFO 3688 --- [           main] c.y.m.configuration.ApplicationConfig    : ApplicationConfig postConstructor execute
2021-06-06 16:36:59.949  INFO 3688 --- [           main] c.y.m.c.ApplicationConfigLoadService     : ApplicationConfigLoadService postConstruct execute
2021-06-06 16:36:59.950  INFO 3688 --- [           main] c.y.m.c.ApplicationClientFactory         : ApplicationClientFactory constructor execute
2021-06-06 16:36:59.951  INFO 3688 --- [           main] c.y.m.c.ApplicationClientFactory         : ApplicationClientFactory postConstruct execute, host:127.0.0.1, port:8080

方案2: 顯示通過(guò)@Resource或者@Autowired注入待依賴的Bean

在DependsOn的JDK代碼中也可以看到植袍,通過(guò)顯示依賴可以解決問(wèn)題。通過(guò)簽名日志可以看出籽懦,當(dāng)顯示依賴注入某個(gè)Bean時(shí)于个,被注入Bean會(huì)依次執(zhí)行對(duì)應(yīng)的構(gòu)造函數(shù)以及@PostConstructor注解的初始化方法。

public class ApplicationClientFactory {

  @Resource
  private ApplicationConfig applicationConfig;

  // 顯示依賴
  @Resource
  private ApplicationConfigLoadService applicationConfigLoadService;

  public ApplicationClientFactory() {
    log.info("ApplicationClientFactory constructor execute");
  }

  @PostConstruct
  public void init() {
    log.info("ApplicationClientFactory postConstruct execute, host:{}, port:{}",
             applicationConfig.getHost(), applicationConfig.getPort());
  }
}

執(zhí)行結(jié)果

2021-06-06 16:08:17.458  INFO 3286 --- [           main] c.y.m.c.ApplicationClientFactory         : ApplicationClientFactory constructor execute
2021-06-06 16:08:17.464  INFO 3286 --- [           main] c.y.m.configuration.ApplicationConfig    : ApplicationConfig constructor execute
2021-06-06 16:08:17.465  INFO 3286 --- [           main] c.y.m.configuration.ApplicationConfig    : ApplicationConfig postConstructor execute
2021-06-06 16:08:17.466  INFO 3286 --- [           main] c.y.m.c.ApplicationConfigLoadService     : ApplicationConfigLoadService constructor execute
2021-06-06 16:08:17.467  INFO 3286 --- [           main] c.y.m.c.ApplicationConfigLoadService     : ApplicationConfigLoadService postConstruct execute
2021-06-06 16:08:17.467  INFO 3286 --- [           main] c.y.m.c.ApplicationClientFactory         : ApplicationClientFactory postConstruct execute, host:127.0.0.1, port:8080

此時(shí)可以看到在ApplicationClientFactory的postConstruc中暮顺,依賴的ApplicationConfig是有對(duì)應(yīng)屬性值的厅篓。

但是,此處會(huì)存在一個(gè)風(fēng)險(xiǎn)問(wèn)題捶码,由于applicationConfigLoadService這個(gè)變量在當(dāng)前類中并未實(shí)際使用羽氮,僅僅是為了依賴其postConstruct方法。對(duì)于后續(xù)維護(hù)的同學(xué)惫恼,很有可能無(wú)意將其移除档押。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市祈纯,隨后出現(xiàn)的幾起案子汇荐,更是在濱河造成了極大的恐慌,老刑警劉巖盆繁,帶你破解...
    沈念sama閱讀 222,252評(píng)論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異旬蟋,居然都是意外死亡油昂,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,886評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門倾贰,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)冕碟,“玉大人,你說(shuō)我怎么就攤上這事匆浙“菜拢” “怎么了?”我有些...
    開封第一講書人閱讀 168,814評(píng)論 0 361
  • 文/不壞的土叔 我叫張陵首尼,是天一觀的道長(zhǎng)挑庶。 經(jīng)常有香客問(wèn)我言秸,道長(zhǎng),這世上最難降的妖魔是什么迎捺? 我笑而不...
    開封第一講書人閱讀 59,869評(píng)論 1 299
  • 正文 為了忘掉前任举畸,我火速辦了婚禮,結(jié)果婚禮上凳枝,老公的妹妹穿的比我還像新娘抄沮。我一直安慰自己,他們只是感情好岖瑰,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,888評(píng)論 6 398
  • 文/花漫 我一把揭開白布叛买。 她就那樣靜靜地躺著,像睡著了一般蹋订。 火紅的嫁衣襯著肌膚如雪率挣。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,475評(píng)論 1 312
  • 那天辅辩,我揣著相機(jī)與錄音难礼,去河邊找鬼。 笑死玫锋,一個(gè)胖子當(dāng)著我的面吹牛蛾茉,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播撩鹿,決...
    沈念sama閱讀 41,010評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼谦炬,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了节沦?” 一聲冷哼從身側(cè)響起键思,我...
    開封第一講書人閱讀 39,924評(píng)論 0 277
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎甫贯,沒(méi)想到半個(gè)月后吼鳞,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,469評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡叫搁,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,552評(píng)論 3 342
  • 正文 我和宋清朗相戀三年赔桌,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片渴逻。...
    茶點(diǎn)故事閱讀 40,680評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡疾党,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出惨奕,到底是詐尸還是另有隱情雪位,我是刑警寧澤,帶...
    沈念sama閱讀 36,362評(píng)論 5 351
  • 正文 年R本政府宣布梨撞,位于F島的核電站雹洗,受9級(jí)特大地震影響香罐,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜队伟,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,037評(píng)論 3 335
  • 文/蒙蒙 一穴吹、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧嗜侮,春花似錦港令、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,519評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至击吱,卻和暖如春淋淀,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背覆醇。 一陣腳步聲響...
    開封第一講書人閱讀 33,621評(píng)論 1 274
  • 我被黑心中介騙來(lái)泰國(guó)打工朵纷, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人永脓。 一個(gè)月前我還...
    沈念sama閱讀 49,099評(píng)論 3 378
  • 正文 我出身青樓袍辞,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親常摧。 傳聞我的和親對(duì)象是個(gè)殘疾皇子搅吁,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,691評(píng)論 2 361

推薦閱讀更多精彩內(nèi)容