前言
最近因为工作需要,搭建了一个微服务项目,其中eureka被用来当作服务注册中心。实际的环境中,微服务难免会发生断线等情况,那么我们怎么知道这个服务挂了呢,这时候就需要对服务的状态进行监听,高屋建瓴下,记录下Eureka各服务状态监听处理。
正文
1、事件
Eureka的server端会发出5个事件通知,分别是
事件 | 作用 |
EurekaInstanceCanceledEvent | 断线事件 |
EurekaInstanceRegisteredEvent | 注册事件 |
EurekaInstanceRenewedEvent | 续约事件 |
EurekaRegistryAvailableEvent | 注册中心启动事件 |
EurekaServerStartedEvent | 注册中心服务端启动事件 |
2、源码分析
源码为InstanceRegistry.java、EurekaServerBootstrap.java、EurekaServerInitializerConfiguration.java,位置如下图所示
拿注册的源码举例
public void register(final InstanceInfo info, final boolean isReplication) {
this.handleRegistration(info, this.resolveInstanceLeaseDuration(info), isReplication);
super.register(info, isReplication);
}
private void handleRegistration(InstanceInfo info, int leaseDuration, boolean isReplication) {
this.log("register " + info.getAppName() + ", vip " + info.getVIPAddress() + ", leaseDuration " + leaseDuration + ", isReplication " + isReplication);
this.publishEvent(new EurekaInstanceRegisteredEvent(this, info, leaseDuration, isReplication));
}
项目注册的时候调用了InstanceRegistry类中的register方法,该方法推送了事件,
由此我们可以得到事件名【EurekaInstanceRegisteredEvent】,下线、续约的事件名也可以在这里找到。
注:InstanceRegistry类中其他的方法代表的含义如下:
方法名 | 含义 |
register | client项目注册的时候调用的方法 |
cancel | client项目下线的时候触发的方法 |
renew | 续约,收到client项目心跳,触发的方法 |
注册中心启动事件在EurekaServerBootstrap类中,服务端启动事件在EurekaServerInitializerConfiguration类中。由此五个server端事件的事件名都得到了。
3、监听方法
创建监听类EurekaStateChangeListener
@Component
public class EurekaStateChangeListener {
}
每个监听的方法都很简单,只需要使用@EventListener 注解,然后配合需要的事件即可,里面具体的业务处理则根据实际情况来。
断线监听
/**
* 断线监听
*
* @param event
*/
@EventListener
public void listen(EurekaInstanceCanceledEvent event) {
// 对应注册的 instanceID
String serviceID = event.getServerId();
String appName = event.getAppName();
String clearTime = DateTimeUtil.getDateTimeString(new Date(event.getTimestamp()));
try {
//具体的业务处理
} catch (Exception e) {
logger.error(ResultCodeEnum.SYSTEMERROR.getName(), e);
}
}
注册监听
@EventListener
public void listen(EurekaInstanceRegisteredEvent event) {
InstanceInfo instanceInfo = event.getInstanceInfo();
String instanceID = instanceInfo.getInstanceId();
String appName = instanceInfo.getAppName();
logger.info("服务{}进行注册", appName + instanceInfo.getHostName() + " "
+ instanceInfo.getIPAddr() + " " + instanceInfo.getPort());
}
续约监听
@EventListener
public void listen(EurekaInstanceRenewedEvent event) {
logger.info("服务{}进行续约", event.getServerId() + " " + event.getAppName());
InstanceInfo instanceInfo = event.getInstanceInfo();
String instanceID = instanceInfo.getInstanceId();
String occurTime = DateTimeUtil.getDateTimeString(new Date(event.getTimestamp()));
String appName = instanceInfo.getAppName();
try {
//具体的业务处理
} catch (Exception e) {
serviceAlarmClearState.put(instanceID, false);
logger.error(ResultCodeEnum.SYSTEMERROR.getName(), e);
}
}
注册中心启动
@EventListener
public void listen(EurekaRegistryAvailableEvent event) {
logger.info("注册中心启动,{}", System.currentTimeMillis());
}
@EventListener
public void listen(EurekaServerStartedEvent event) {
logger.info("注册中心服务端启动,{}", System.currentTimeMillis());
}
实际效果如下图: