Spring Cloud服务治理之Eureka
Spring Cloud Eureka
Spring Cloud Eureka主要负责完成微服务架构中的服务治理功能,是微服务架构中最为核心的和基础的模块,主要用来实现各个微服务实例的自动化注册和发现。
服务注册中心
在服务治理框架中,通常会构建一个注册中心,每个服务单元向注册中心登记自己提供的服务,将主机与端口号、版本号、通讯协议等一些附加信息告知注册中心,注册中心按照服务名分类组织服务清单。
首先创建一个基础的SpringBoot的工程,命名为eureka-server,其pom.xml如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>eureka-server</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<name>eureka-server</name>
<description>The project for SpringCloud server register center </description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<spring-cloud.version>Dalston.SR5</spring-cloud.version>
</properties>
<dependencies>
<!--Eureka Server 依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka-server</artifactId>
</dependency>
<!-- log4j 日志依赖-->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</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>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
在启动类中添加Eureka的相应的注解
@EnableEurekaServer
@SpringBootApplication
public class EurekaServerApplication {
static Logger logger = LoggerFactory.getLogger(EurekaServerApplication.class);
public static void main(String[] args) {
SpringApplication.run(EurekaServerApplication.class, args);
logger.info("Eureka Server 启动完成");
}
}
其中通过@EnableEurekaServer注解启动一个服务注册中心。
在默认设置下,服务注册中心会将自己作为客户端注册自己,在单节点服务注册模式下需要禁用他的客户端注册行为,可以修改配置application.properties文件中的属性实现:
#该配置文件为单节点的EurekaServer的配置信息
#应用别名
spring.application.name = eureka-server
#注册中心的端口
server.port = 1111
#指定主机名
eureka.instance.hostname = localhost
#表示是否将自己注册在EurekaServer上,默认为true。由于当前应用就是EurekaServer,所以置为false
eureka.client.register-with-eureka = false
#表示表示是否从EurekaServer获取注册信息,默认为true。单节点不需要同步其他的EurekaServer节点的数据,多节点时必须配置成true或者使用默认配置
eureka.client.fetch-registry = false
#设置Eureka的地址
eureka.client.serviceUrl.defaultZone = http://${eureka.instance.hostname}:${server.port}/eureka/
在完成相关配置详细之后,启动应用并访问http://localhost:1111。可以看到如下所示的Eureka的信息面板
其中Instances currently registered with Eureka栏是空的,说明该注册中心还没有注册任何服务。
服务注册提供者
在搭建完服务注册中心后,可以将一个微服务应用想服务注册中心发布自己,并提供实际的服务。创建一个SpringBoot应用,命名为hello-server,其pom.xml如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>hello</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>hello</name>
<description>The project for Spring Cloud server provider </description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<spring-cloud.version>Dalston.SR5</spring-cloud.version>
</properties>
<dependencies>
<!--Web依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--Eureka Client 依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- log4j日志打印 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</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>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
在启动类中通过注解@EnableDiscoveryClient,激活Eureka中的DiscpveryClient实现,代码如下:
@EnableDiscoveryClient
@SpringBootApplication
public class HelloApplication {
static Logger logger = LoggerFactory.getLogger(HelloApplication.class);
public static void main(String[] args) {
SpringApplication.run(HelloApplication.class, args);
logger.info("Hello-service 启动完成");
}
}
服务注册提供者基本已实现,为了方便实现一个测试请求处理的接口,代码如下:
@RestController
public class HelloController {
private final Logger logger = Logger.getLogger(getClass());
@Resource
private Registration registration;
@Autowired
private DiscoveryClient client; // 服务发现客户端
@RequestMapping(value = "/hello",method = RequestMethod.GET)
public String index(HttpServletRequest requet){
//获取可以的服务实例清单
List<ServiceInstance> instanceList = client.getInstances(registration.getServiceId());
try {
for (ServiceInstance instance:instanceList) {
//遍历循环查找当前机器的服务实例
if(requet.getLocalPort()==instance.getPort()){
String result = "/testBalance, host:port=" + instance.getUri() + ", "
+ "service_id:" + instance.getServiceId();
System.err.println(result);
break;
}
}
}catch (Exception ex){
logger.info("没有找到对应的instance");
}
return "hello world";
}
}
最后,在application.propertier配置文件中,通过spring.application.name属性来为服务命名,在通过eureka.client.serviceUrl.defaultZone属性指定服务注册中心的地址,完成配置如下:
#应用别名
spring.application.name = hello-service
#设置Eureka的地址
eureka.client.serviceUrl.defaultZone = http://peer1:1111/eureka/,http://peer2:1112/eureka/
#定义服务续约任务的调用时间间隔,默认为30s
eureka.instance.lease-renewal-interval-in-seconds=30
#定义服务失效的时间,默认为90s
eureka.instance.lease-expiration-duration-in-seconds=90
启动应用并访问http://localhost:8080/hello。可以看到如下所示的信息:
将服务注册中心和服务注册提供者启动,并访问服务注册中心的地址http://localhost:1111,可以看到Eureka信息面板中Instances currently registered with Eureka栏多了一个HELLO-SERVICE的服务实例
高可用注册中心
在微服务架构中,各个组件均为高可用部署,服务注册中心亦如此,Eureka Server就是通过将自己作为服务向注册中心注册自己,以实现服务清单的互相同步,达到高可用的效果。将之前的Eureka-Server扩展实现构建一个双节点的注册中心集群。
创建一个application-peer1.properties,作为pee1服务中心的配置,并将serviceUrl指向peer2,其配置文件如下:
#该配置文件为高可用服务注册中心(多节点)的EurekaServer的配置信息
#应用别名
spring.application.name = eureka-server
#注册中心的端口
server.port = 1111
#指定主机名
eureka.instance.hostname = peer1
#设置Eureka的地址
eureka.client.serviceUrl.defaultZone = http://peer2:1112/eureka/
创建一个application-peer2.properties,作为pee2服务中心的配置,并将serviceUrl指向peer1,其配置文件如下:
#该配置文件为高可用服务注册中心(多节点)的EurekaServer的配置信息
#应用别名
spring.application.name = eureka-server
#注册中心的端口
server.port = 1112
#指定主机名
eureka.instance.hostname = peer2
#设置Eureka的地址
eureka.client.serviceUrl.defaultZone = http://peer1:1111/eureka/
在/etc/hosts文件中添加对peer1和peer2的转化,让配置的host形式的ServiceUrl能正确的访问到本地,windows下的host文件路径C:\Windows\System32\drivers\etc
127.0.0.1 localhost
127.0.0.1 peer1
127.0.0.1 peer2
通过spring.profile.active属性分别启动peer1和peer2:
java -jar D:\WorkSpace-Study\SpringCloud\eureka-server\target\eureka-server-1.0.0.jar --spring.profiles.active=peer1
java -jar D:\WorkSpace-Study\SpringCloud\eureka-server\target\eureka-server-1.0.0.jar --spring.profiles.active=peer2
访问peer1的注册中心http://peer1:1111/,如图,registered-replicas中已经有peer2节点的eureka-server,同样,访问peer2的注册中心http://peer2:1112/,也能看到peer1节点的eureka-server,并且这些节点都在可用分片中(available-replicas)之中,当关闭peer1,刷新http://peer2:1112/,可以看到peer1的节点变味了不可用分片(unavailable-replicas)
再设置多节点的服务注册中心之后,服务提供方只需在properties中将服务注册中心的配置进去即可,如图:
#应用别名
spring.application.name = hello-service
#设置Eureka的地址
eureka.client.serviceUrl.defaultZone = http://peer1:1111/eureka/,http://peer2:1112/eureka/
#定义服务续约任务的调用时间间隔,默认为30s
eureka.instance.lease-renewal-interval-in-seconds=30
#定义服务失效的时间,默认为90s
eureka.instance.lease-expiration-duration-in-seconds=90
启动该服务,访问http://peer1:1111/和http://peer2:1112/,可以看到hello-service服务被同时注册到peer1和peer2上,若断开peer1,由于服务液相peer2注册,故在peer2上的其他服务也能访问hello-service,从而实现高可用
如果想使用IP地址的形式来定义注册中心的地址,需在配置文件中增加配置参数eureka.instance.prefer-ip-address=true,该值默认为false
服务发现和消费
创建一个Spring Boot的基础工程来实现服务消费者,取名为ribbon-consumer,其pom.xml如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>consumer</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<name>consumer</name>
<description>The project for Spring Cloud server consumer</description>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<spring-cloud.version>Dalston.SR5</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--引入 netflix-ribbon -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-ribbon</artifactId>
</dependency>
<!--Eureka Client 依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- log4j日志打印 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</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>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
创建应用主类,并通过@EnableDiscoveryClient注解让该应用注册为Eureka客户端应用,已获得服务发现的能力,同时在该主类中创建RestTemplate的Spring Bean实例,并通过@LoadBalanced注解开启客户端负载均衡,代码如下:
@EnableDiscoveryClient
@SpringBootApplication
public class ConsumerApplication {
static Logger logger = LoggerFactory.getLogger(ConsumerApplication.class);
@Bean
@LoadBalanced
RestTemplate restTemplate(){
return new RestTemplate();
}
public static void main(String[] args) {
SpringApplication.run(ConsumerApplication.class, args);
logger.info("consumer-service 启动完成");
}
}
创建ConsumerController类并实现/ribbon-consumer接口,在该接口中,通过在ResTemplate来实现对HELLO-SERVICE服务提供的/hello接口进行调用,访问的地址是服务名HELLO-SERVICE,而不是一个具体地址,具体代码如下:
@RestController
public class ConsumerController {
@Autowired
RestTemplate restTemplate;
@RequestMapping(value="/ribbon-consumer",method = RequestMethod.GET)
public String helloConsumer(){
return restTemplate.getForEntity("http://HELLO-SERVICE/hello",String.class).getBody();
}
}
在application.properties中配置Eureka服务注册中心的位置,必须与之前的HELLO-SERVICE一样,否者不能发现该服务,同事设置该消费者的端口为9000,代码如下:
spring.application.name = ribbon-consumer
server.port = 9000
eureka.client.serviceUrl.defaultZone = http://localhost:1111/eureka
启动ribbon-consumer应用之后,Eureka信息面板如下:
通过http://localhost:9000/ribbon-consumer发起GET请求,成功返回“hello world”,在控制台中可以看到HELLO-SERVICE的服务列表情况,如下:
尝试多发几次请求,并观察两个HELLO-SERVICE的控制台。可以看到交替打印的日志