快捷導(dǎo)航

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

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

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

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

我遇到過兩種注冊的途徑：

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

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

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

1、Spring webapplication啟動完成后注冊

先上代碼看一下

@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("注冊2: WebApplication啟動完成后");
  ZkClient zkClient = context.getBean(ZkClient.class);
  zkClient.register();
  IS_REGISTRY = true;
  logger.info("注冊2: 注冊成功");
 }
 }
}

這里，我們在WebApplication中，獲取zkClient，并進(jìn)行注冊。

這里需要說明一點，我們這里通過ApplicationContext來獲取zkClient的bean，原因是在webApplication的初始化過程中你不能用Autowired的方式注入Bean，因為在webApplication啟動過程中才會讀所有的configuration并將bean初始化完成，在沒有完成初始化之前，你不能注入bean。

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

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

照樣先上代碼

@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("注冊1: Servelet容器啟動成功后");
  zkClient.register();
  logger.info("注冊1: 注冊成功");
  }
  IS_REGISTRY = true;
 } catch (Exception e) {
  IS_REGISTRY = false;
  logger.info("注冊1: 注冊失敗");
 }
 }
 @Override
 public void contextDestroyed(ServletContextEvent servletContextEvent) {
 if (IS_REGISTRY) {
  zkClient.stop();
 }
 }
}

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

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

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

@ServletComponentScan
@SpringBootApplication
public class WebApplication {
}

3、這兩種方式的比較

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

這種場景是這樣的