在使用springboot進行開發的過程中,我們經常需要處理這樣的場景:在服務啟動的時候,需要向服務註冊中心(例如zk)註冊服務狀態,以便當服務狀態改變的時候,可以故障摘除和負載平衡。
我遇過兩種註冊的途徑:
1、在Spring的webapplication啟動完成後,直接進行註冊;
2、在servlet容器啟動完成後,透過listener進行註冊。
本文透過一個demo講述這兩種註冊方式,使用的是傳統的向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,並進行註冊。
這裡要說明一點,我們這裡透過ApplicationContext來取得zkClient的bean,原因是在webApplication的初始化過程中你不能用Autowired的方式註入Bean,因為在webApplication啟動過程中才會讀所有的configuration並將bean初始化完成,在沒有完成初始化之前,你不能注入bean。
關於註冊的詳細程式碼這裡不展開了。
2、在servlet容器初始化完成後,透過listener的方式進行註冊
照樣先上程式碼
@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實作ServletContextListener接口,並且用@WebListener進行註解,這是springboot註解式的listener書寫方式。
在servlet容器啟動成功之後,會呼叫這個監聽器的contextInitialized方法,servlet容器如果一旦銷毀,不能提供服務了,會呼叫監聽器的contextDestroyed方法。換句話說,這個監聽器在監聽servlet容器的狀態。
然後你只需要在application主類別中開啟listener設定就好。
@ServletComponentScan @SpringBootApplication public class WebApplication { }
3、這兩種方式的比較
對於一個對外提供http協議的web服務,在語義上servlet容器的註冊會顯得清晰一些,但是如果你的spring容器啟動時間過長的話,可能出現servlet初始化完成,並且已經註冊,但是服務不能對外提供訪問的gap time,所以我一般還是使用第一種方式進行註冊。
這種場景是這樣的
可以看到,當servlet註冊成功之後,其實webapplication還沒啟動完成,這時候服務是不能正常提供訪問的。
在zk上可以看到,兩次註冊都已經成功了。
以上是springboot怎麼實現註冊服務的詳細內容。更多資訊請關注PHP中文網其他相關文章!