文章目录
Spring Cloud 学习 | - 01 - Eureka服务注册与发现
学习
Spring Cloud
之路,文中Spring Boot
版本为2.1.3.RELEASE
,Spring Cloud
版本为Greenwich.SR1
。因能力有限,难免会有不足或者错误之处,还望不吝指正,谢!
1. 创建Eureka注册中心项目,并引入依赖:
新建一个Spring Boot
项目(可以使用 Spring Initializr 快速创建),添加如下依赖:
<?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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.xudc</groupId>
<artifactId>spring-cloud-eureka</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring-cloud-eureka</name>
<description>Demo project for Spring Boot Eureka</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.SR1</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</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>
2. 开启Eureka注解
2.1 在主启动类XxxApplication
上加上注解@EnableEurekaServer
,并启动运行。
@SpringBootApplication
@EnableEurekaServer
public class SpringCloudEurekaApplication {
public static void main(String[] args) {
SpringApplication.run(SpringCloudEurekaApplication.class, args);
}
}
我们看到控制台报错:
com.netflix.discovery.shared.transport.TransportException: Cannot execute request on any known server
at com.netflix.discovery.shared.transport.decorator.RetryableEurekaHttpClient.execute(RetryableEurekaHttpClient.java:112) ~[eureka-client-1.9.8.jar:1.9.8]
at com.netflix.discovery.shared.transport.decorator.EurekaHttpClientDecorator.register(EurekaHttpClientDecorator.java:56) ~[eureka-client-1.9.8.jar:1.9.8]
at com.netflix.discovery.shared.transport.decorator.EurekaHttpClientDecorator$1.execute(EurekaHttpClientDecorator.java:59) ~[eureka-client-1.9.8.jar:1.9.8]
at com.netflix.discovery.shared.transport.decorator.SessionedEurekaHttpClient.execute(SessionedEurekaHttpClient.java:77) ~[eureka-client-1.9.8.jar:1.9.8]
at com.netflix.discovery.shared.transport.decorator.EurekaHttpClientDecorator.register(EurekaHttpClientDecorator.java:56) ~[eureka-client-1.9.8.jar:1.9.8]
at com.netflix.discovery.DiscoveryClient.register(DiscoveryClient.java:829) ~[eureka-client-1.9.8.jar:1.9.8]
at com.netflix.discovery.InstanceInfoReplicator.run(InstanceInfoReplicator.java:121) ~[eureka-client-1.9.8.jar:1.9.8]
at com.netflix.discovery.InstanceInfoReplicator$1.run(InstanceInfoReplicator.java:101) [eureka-client-1.9.8.jar:1.9.8]
at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511) [na:1.8.0_172]
at java.util.concurrent.FutureTask.run$$$capture(FutureTask.java:266) [na:1.8.0_172]
at java.util.concurrent.FutureTask.run(FutureTask.java) [na:1.8.0_172]
at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$201(ScheduledThreadPoolExecutor.java:180) [na:1.8.0_172]
at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:293) [na:1.8.0_172]
at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149) [na:1.8.0_172]
at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624) [na:1.8.0_172]
at java.lang.Thread.run(Thread.java:748) [na:1.8.0_172]
大意为:不能再任何一个已知的服务器上执行请求。先不管这个错误,直接访问服务地址http://localhost:8080/
(Spring Boot项目默认启动端口是8080),发现可以正常访问:
2.2 为什么会报异常?
这是因为默认设置下,eureka服务注册中心自己也属于客户端,也要来尝试注册它自己,所以需要禁用它的客户端注册行为,默认它是开启的。
3. 修改配置文件application.yml
如果没有 application.yml
可以新增,也可以使用 application.properties
来进行配置。我们使用.yml
文件,结构更清晰些。
新增如下内容:
eureka:
client:
service-url:
register-with-eureka: false #由于该应用为注册中心,所以设置为false,代表不向注册中心注册自己
fetch-registry: false #由于注册中心的职责就是维护服务实例,它并不需要去检索服务,所以也设置为false
重启服务,控制台并没有报错。
从Eureka管理页面,我们看到服务默认注册到 http://localhost:8761/eureka/
这个地址,代码如下:
如果需要修改注册服务的url,可以修改eureka.client.service-url
,这个接收的是个Map<String, String>,可以这么写:
eureka:
client:
service-url:
defaultZone: http://localhost:${server.port}/eureka # EurekaServer的地址,现在是自己的地址,如果是集群,需要加上其它Server的地址
同时,我可以给设置服务的启动端口也为8761,完整的 .yml
文件如下:
## app port conf
server:
port: 8761
spring:
application:
name: spring-cloud-eureka
eureka:
client:
service-url:
defaultZone: http://localhost:${server.port}/eureka # EurekaServer的地址,现在是自己的地址,如果是集群,需要加上其它Server的地址
register-with-eureka: false #由于该应用为注册中心,所以设置为false,代表不向注册中心注册自己
fetch-registry: false #由于注册中心的职责就是维护服务实例,它并不需要去检索服务,所以也设置为false
重启,访问 http://localhost:8761/
,至此,Eureka注册中心服务便好了。
4. 创建一个注册到Eureka中心的服务提供者
快速创建一个 Spring Boot
项目,并添加 Eureka Client
依赖,具体POM如下:
<?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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.xudc</groupId>
<artifactId>user-provider</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>user-provider</name>
<description>Demo project for Spring Boot User Provider</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.SR1</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</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>
5. 开启Eureka客户端注解
这里我们使用 @EnableDiscoveryClient
,而不是 @EnableEurekaClient
:
- @EnableDiscoveryClient基于spring-cloud-commons,可以对spring cloud中discovery service的多种实现(eureka、consul、zookeeper等等)生效;
- @EnableEurekaClient基于spring-cloud-netflix,只适用于以eureka作注册中心;
@SpringBootApplication
@EnableDiscoveryClient
public class UserProviderApplication {
public static void main(String[] args) {
SpringApplication.run(UserProviderApplication.class, args);
}
}
6. 编写配置文件application.yml
server:
port: 8080
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka
保存,并启动客户端,访问Eureka管理页面 http://localhost:8761/eureka
,我们发现已经有了注册的服务:
但是有个问题,应用名称显示 UNKNOWN
,我们希望显示服务的名称。
6.1 显示应用名称
在 application.yml
中新增以下代码:
spring:
application:
name: user-provider
保存并重启,我们看到控制台已经打印我们更改的服务名称:
页面也显示了:
这里还有个问题,当我们鼠标放在服务状态上,左下角显示的是机器的名称,我们希望显示的是ip地址,以便于我们在生产中迅速的定位故障机器:
6.2 显示服务的IP地址
在 application.yml
中新增以下代码:
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka
instance:
prefer-ip-address: true # 返回ip而不是host名称
# ip-address: 127.0.0.1 # 指定自己的ip信息
我们也可以指定IP信息。
重启服务,我们看到已经显示IP而非Host Name了:
完整的 application.yml
配置:
server:
port: 8080
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka
instance:
prefer-ip-address: true # 返回ip而不是host名称
# ip-address: 127.0.0.1 # 指定自己的ip信息
spring:
application:
name: user-provider