在使用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中文网其他相关文章!