Spring Cloud之Eureka注册中心

Eureka服务端/客户端简单部署与使用

服务端部署

1.maven中添加eureka-server依赖， 由于spring-cloud-dependencies中管理了各个组件的版本，所以eureka-server不需要重复定义版本：

<dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>
</dependencies>
<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
</dependencyManagement>

2.applications.properties添加注册中心的配置项：

eureka.client.register-with-eureka=false
eureka.client.fetch-registry=false
eureka.client.service-url.defaultZone=http://localhost:${server.port}/eureka

eureka.client.register-with-eureka：指示此实例是否应向eureka服务器注册其信息以供其他人发现。

eureka.client.fetch-registry：指示此客户端是否应从eureka服务器获取eureka注册表信息。

eureka.client.service-url.defaultZone：注册中心的地址

具体其他的配置项可以参考EurekaClientConfigBean这个配置类的属性。

3.启动类添加@EnableEurekaServer注解并启动

@EnableEurekaServer
@SpringBootApplication
public class SpringCloudEurekaServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringCloudEurekaServerApplication.class, args);
    }

}

4.打开地址: http://localhost:{server.port} ,其中server.port为自己配置的端口

 

客户端部署

1.在maven添加eureka-client的依赖

<dependency>
   <groupId>org.springframework.cloud</groupId>
   <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

2.application.yml添加客户端的配置，其中localhost为注册中心服务端的IP，8761为注册中心服务端的端口

spring:
  application:
    name: eureka-client
server:
  port: 8082
eureka:
  client:
    enabled: true
    fetch-registry: false
    serviceUrl:
      defaultZone: http://localhost:8761/eureka

具体其他的配置项可以参考EurekaClientConfigBean这个配置类的属性。

3.启动配添加@EnableDiscoveryClient注解并启动

@EnableDiscoveryClient
@SpringBootApplication
public class SpringCloudEurekaClientApplication {


    public static void main(String[] args) {
        SpringApplication.run(SpringCloudEurekaClientApplication.class, args);
    }

}

4.查看注册中心是否已注册客户端服务

 

服务端如何接收请求

当注册中心启动完成以后，我们可以通过http://IP:PORT/eureka/apps这个地址可以查看注册到注册中心的所有应用列表：

可以通过http://IP:PORT/eureka/apps/{serviceName}查看某个服务的实例列表：

可以通过http://IP:PORT/eureka/apps/{serviceName}/{instanceId}查看某个服务的某个具体实例的详情：

其实以上这些地址是eureka通过jesey发布的rest风格的接口，具体接口的定义是在ApplicationsResource和ApplicationResource中，同样的当客户端服务注册到注册中心时，服务端提供了一个rest风格接收客户端的请求，服务端接收请求发生在ApplicationResource.addInstance()：

    @POST
    @Consumes({"application/json", "application/xml"})
    public Response addInstance(InstanceInfo info,
                                @HeaderParam(PeerEurekaNode.HEADER_REPLICATION) String isReplication) {
        logger.debug("Registering instance {} (replication={})", info.getId(), isReplication);
        // validate that the instanceinfo contains all the necessary required fields
        if (isBlank(info.getId())) {
            return Response.status(400).entity("Missing instanceId").build();
        } else if (isBlank(info.getHostName())) {
            return Response.status(400).entity("Missing hostname").build();
        } else if (isBlank(info.getIPAddr())) {
            return Response.status(400).entity("Missing ip address").build();
        } else if (isBlank(info.getAppName())) {
            return Response.status(400).entity("Missing appName").build();
        } else if (!appName.equals(info.getAppName())) {
            return Response.status(400).entity("Mismatched appName, expecting " + appName + " but was " + info.getAppName()).build();
        } else if (info.getDataCenterInfo() == null) {
            return Response.status(400).entity("Missing dataCenterInfo").build();
        } else if (info.getDataCenterInfo().getName() == null) {
            return Response.status(400).entity("Missing dataCenterInfo Name").build();
        }

        // handle cases where clients may be registering with bad DataCenterInfo with missing data
        DataCenterInfo dataCenterInfo = info.getDataCenterInfo();
        if (dataCenterInfo instanceof UniqueIdentifier) {
            String dataCenterInfoId = ((UniqueIdentifier) dataCenterInfo).getId();
            if (isBlank(dataCenterInfoId)) {
                boolean experimental = "true".equalsIgnoreCase(serverConfig.getExperimental("registration.validation.dataCenterInfoId"));
                if (experimental) {
                    String entity = "DataCenterInfo of type " + dataCenterInfo.getClass() + " must contain a valid id";
                    return Response.status(400).entity(entity).build();
                } else if (dataCenterInfo instanceof AmazonInfo) {
                    AmazonInfo amazonInfo = (AmazonInfo) dataCenterInfo;
                    String effectiveId = amazonInfo.get(AmazonInfo.MetaDataKey.instanceId);
                    if (effectiveId == null) {
                        amazonInfo.getMetadata().put(AmazonInfo.MetaDataKey.instanceId.getName(), info.getId());
                    }
                } else {
                    logger.warn("Registering DataCenterInfo of type {} without an appropriate id", dataCenterInfo.getClass());
                }
            }
        }

        registry.register(info, "true".equals(isReplication));
        return Response.status(204).build();  // 204 to be backwards compatible
    }

PeerAwareInstanceRegistryImpl.register

在 addInstance 方法中，最终调用的是 PeerAwareInstanceRegistryImpl.register 方法。先来看PeerAwareInstanceRegistryImpl的类关系图：

从类关系图可以看出，PeerAwareInstanceRegistry的最顶层接口为LeaseManager与LookupService, 其中LookupService定义了最基本的发现示例的行为，LeaseManager定义了处理客户端注册，续约，注销等操作，接下来看下register内容：

public void register(final InstanceInfo info, final boolean isReplication) {
        int leaseDuration = Lease.DEFAULT_DURATION_IN_SECS;
        if (info.getLeaseInfo() != null && info.getLeaseInfo().getDurationInSecs() > 0) {
            //如果客户端有自己定义心跳超时时间，则采用客户端的时间
            leaseDuration = info.getLeaseInfo().getDurationInSecs();
        }
        super.register(info, leaseDuration, isReplication);
        //复制到Eureka Server集群中的其他节点
        replicateToPeers(Action.Register, info.getAppName(), info.getId(), info, null, isReplication);
    }

    leaseDuration 表示租约过期时间，默认是90s，也就是当服务端超过90s没有收到客户端的心跳，则主动剔除该节点，客户端可以自定义
    调用super.register发起节点注册
    将信息复制到Eureka Server集群中的其他机器上，同步的实现也很简单，就是获得集群中的所有节点，然后逐个发起注册

AbstractInstanceRegistry.register

简单来说，Eureka-Server的服务注册，实际上是将客户端传递过来的实例数据保存到Eureka-Server中的ConcurrentHashMap中。

public void register(InstanceInfo registrant, int leaseDuration, boolean isReplication) {
        try {
            read.lock();
            //根据appName从registry中获得当前实例信息