快捷導(dǎo)航

springboot 注冊(cè)服務(wù)注冊(cè)中心(zk)的兩種方式詳解

更新時(shí)間：2018年01月09日 13:40:20 作者：扎心了老鐵

本文通過一個(gè)demo講述一下這兩種注冊(cè)方式，使用的是傳統(tǒng)的向zk注冊(cè)的方案。對(duì)springboot 注冊(cè)zk的相關(guān)知識(shí)感興趣的朋友一起看看吧

在使用springboot進(jìn)行開發(fā)的過程中，我們經(jīng)常需要處理這樣的場(chǎng)景：在服務(wù)啟動(dòng)的時(shí)候，需要向服務(wù)注冊(cè)中心(例如zk)注冊(cè)服務(wù)狀態(tài)，以便當(dāng)服務(wù)狀態(tài)改變的時(shí)候，可以故障摘除和負(fù)載均衡。

我遇到過兩種注冊(cè)的途徑：

1、在Spring的webapplication啟動(dòng)完成后，直接進(jìn)行注冊(cè)；

2、在servlet容器啟動(dòng)完成后，通過listener進(jìn)行注冊(cè)。

本文通過一個(gè)demo講述一下這兩種注冊(cè)方式，使用的是傳統(tǒng)的向zk注冊(cè)的方案。

1、Spring webapplication啟動(dòng)完成后注冊(cè)

先上代碼看一下

@SpringBootApplication
public class WebApplication {
 private static final Logger logger = LoggerFactory.getLogger(WebApplication.class);
 private static volatile boolean IS_REGISTRY = false;
 public static void main(String[] args) {
 ApplicationContext context = run(WebApplication.class, args);
 if (IS_REGISTRY) {
  logger.info("注冊(cè)2: WebApplication啟動(dòng)完成后");
  ZkClient zkClient = context.getBean(ZkClient.class);
  zkClient.register();
  IS_REGISTRY = true;
  logger.info("注冊(cè)2: 注冊(cè)成功");
 }
 }
}

這里，我們?cè)赪ebApplication中，獲取zkClient，并進(jìn)行注冊(cè)。

這里需要說明一點(diǎn)，我們這里通過ApplicationContext來獲取zkClient的bean，原因是在webApplication的初始化過程中你不能用Autowired的方式注入Bean，因?yàn)樵趙ebApplication啟動(dòng)過程中才會(huì)讀所有的configuration并將bean初始化完成，在沒有完成初始化之前，你不能注入bean。

關(guān)于注冊(cè)的詳細(xì)代碼這里不展開了。

2、在servlet容器初始化完成后，通過listener的方式進(jìn)行注冊(cè)

照樣先上代碼

@WebListener
public class RegisterListener implements ServletContextListener {
 protected final Logger logger = LoggerFactory.getLogger(this.getClass());
 private static volatile boolean IS_REGISTRY = false;
 @Autowired
 private ZkClient zkClient;
 @Override
 public void contextInitialized(ServletContextEvent servletContextEvent) {
 try {
  if (!IS_REGISTRY) {
  logger.info("注冊(cè)1: Servelet容器啟動(dòng)成功后");
  zkClient.register();
  logger.info("注冊(cè)1: 注冊(cè)成功");
  }
  IS_REGISTRY = true;
 } catch (Exception e) {
  IS_REGISTRY = false;
  logger.info("注冊(cè)1: 注冊(cè)失敗");
 }
 }
 @Override
 public void contextDestroyed(ServletContextEvent servletContextEvent) {
 if (IS_REGISTRY) {
  zkClient.stop();
 }
 }
}

你需要先寫一個(gè)listener，這個(gè)listener實(shí)現(xiàn)ServletContextListener接口，并且用@WebListener進(jìn)行注解，這是springboot注解式的listener書寫方式。

在servlet容器啟動(dòng)成功之后，會(huì)調(diào)用這個(gè)監(jiān)聽器的contextInitialized方法，servlet容器如果一旦銷毀，不能提供服務(wù)了，會(huì)調(diào)用監(jiān)聽器的contextDestroyed方法。換句話說，這個(gè)監(jiān)聽器在監(jiān)聽servlet容器的狀態(tài)。

然后你只需要在application主類中打開listener配置就好。

@ServletComponentScan
@SpringBootApplication
public class WebApplication {
}

3、這兩種方式的比較

對(duì)于一個(gè)對(duì)外提供http協(xié)議的web服務(wù)，在語義上servlet容器的注冊(cè)會(huì)顯得清晰一些，但是如果你的spring容器啟動(dòng)時(shí)間過長的話，可能出現(xiàn)servlet初始化完成，并且已經(jīng)注冊(cè)，但是服務(wù)不能對(duì)外提供訪問的gap time，所以我一般還是使用第一種方式進(jìn)行注冊(cè)。

這種場(chǎng)景是這樣的