前言:由于版本原因,部分关于Spring Cloud的书中使用的是Spring Boot 1.x 版本,很多配置或名称在新版本中已经发生了改变。此篇文章记录的是使用较新的Spring Boot 2.x和Spring Cloud Finchley.RELEASE搭建服务注册和发现组件Eureka的步骤(部分代码以截图形式展现)。
一、搭建Eureka
1. 编写 Eureka Server
使用IDEA创建一个新的项目。
选择maven->Next(无需选择maven模板)。
填写项目的GroupId(公司域名倒写)和ArtifactId(项目名)
检查无误后点击Finish即可。
删除自动创建的src目录。
编写pom.xml文件,添加Spring Boot(2.1.2.RELEASE)父项目和Spring Cloud(Finchley.RELEASE)的依赖。
注意:在添加Spring Cloud依赖时,必须指定type属性为pom,否则maven会报错。默认情况下,type属性为jar,但当依赖的jar包特别多时,会导致pom.xml文件过大,这时我们可以将所有的jar包打成一个pom,然后去依赖这一个pom,就可以依赖所有的jar包。
创建一个maven子模块。鼠标移到项目名上点击鼠标右键->New->Module。
仍然不用做任何选择直接Next。
填写子模块的ArtifactId为eureka-server,点击Next。
填写Module name检查无误后点击Finish即可。
编写子项目eureka-server的pom.xml文件,添加spring-cloud-starter-netflix-eureka-server的依赖,当前Spring Cloud版本为Finchley.RELEASE,其它版本如有不同可去mvnrepository查找对应ArtifactId。
在子模块中创建Spring Boot启动类EurekaServerApplication.java和配置文件application.yml(properties文件也可)。
注意:启动类应放置在源码包下。
编写启动类。添加@SpringBootApplication和@EnableEurekaServer注解。声明这是一个Spring Boot启动类同时也是一个Eureka Server。
编写main方法。
编写配置文件application.yml。
至此,一个Eureka Server就编写完成。
如果遇到了一些“意料之外”的错误,可点击IDEA右侧的maven工具,查看项目依赖是否有误。可尝试刷新或重新打开项目。
运行启动类的main方法,在浏览器中输入application.yml中配置的地址(http://localhost:8761)即可查看此Eureka Server的相关信息。
可以看得该Instance currently registered with Eureka这一项还没有任何内容,因为还没有Eureka Client向该注册中心注册服务。下面就来编写一个Eureka Client。
2. 编写 Eureka Client
与创建eureka-server模块步骤相同。
创建一个maven子模块。鼠标移到项目名上点击鼠标右键->New->Module。仍然不用做任何选择直接Next。填写子模块的ArtifactId为eureka-client,点击Next。填写Module name检查无误后点击Finish即可。
编写子项目eureka-client的pom.xml文件。
添加spring-cloud-starter-netflix-eureka-client的依赖,当前Spring Cloud版本为Finchley.RELEASE,其它版本如有不同可去mvnrepository查找对应ArtifactId。
添加spring-boot-starter-web的依赖,client必须添加该依赖,无需指定版本。
eureka
cn.org.lilu
1.0-SNAPSHOT
4.0.0
eureka-client
org.springframework.boot
spring-boot-starter-web
org.springframework.cloud
spring-cloud-starter-netflix-eureka-client
2.1.2.RELEASE
创建Spring Boot启动类EurekaClientApplication.java和配置文件application.yml(properties文件也可)。
注意:启动类应放置在源码包下。
编写配置文件application.yml。应用服务名为eureka-client,端口号1234,服务注册地址为http://localhost:8761/eureka/。
server:
port: 1234
spring:
application:
name: eureka-client
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka/
编写启动类。添加@EnableEurekaClient注解声明这是一个Eureka Client。
package cn.org.lilu;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
/**
* @Auther: lilu
* @Date: 2019/6/28
* @Description:
*/
@SpringBootApplication
@EnableEurekaClient
public class EurekaClientApplication {
public static void main(String[] args) {
SpringApplication.run(EurekaClientApplication.class,args);
}
}
至此,一个Eureka Client就编写完成。运行EurekaClientApplication类的main方法。成功后控制台会打印:
INFO 70912 --- [nfoReplicator-0] com.netflix.discovery.DiscoveryClient : DiscoveryClient_EUREKA-CLIENT/localhost:eureka-client:1234 - registration status: 204
而Eureka Server端的控制台会打印:
INFO 73316 --- [nio-8761-exec-5] c.n.e.registry.AbstractInstanceRegistry : Registered instance EUREKA-CLIENT/localhost:eureka-client:1234 with status UP (replication=false)
此时Eureka Client已向Eureka Server注册了,访问http://localhost:8761,可看到Instance currently registered with Eureka这项下已有一个实例注册。
二、搭建高可用Eureka Server集群
1. 编写双节点Eureka Server集群
实际线上生产环境中,前文编写的单节点Eureka Server可靠性不足。
Eureka Client会定时连接Eureka Server,获取服务注册表中的信息并缓存到本地。微服务在消费远程API时总是使用本地缓存中的数据,因此一般情况下,即使单节点的Eureka Server发生宕机,也不会影响到各微服务之间的调用,但如果当Eureka Server发生宕机时,某些微服务恰好也出现了不可用的情况,此时Eureka Client中的缓存并未进行更新,仍然认为服务可用,就会影响到微服务之间的调用,甚至影响整个应用系统的高可用性。因此,生产环境中需要部署一个高可用Eureka Server集群。
Eureka Server可通过运行多个实例并相互注册的方式实现高可用。集群中的多个实例会彼此增量的同步数据,保证所有节点数据一致性。节点之间相互注册是Eureka Server的默认行为,无需做任何配置。
下面构建一个双节点Eureka Server集群。
创建一个maven子模块。鼠标移到项目名上点击鼠标右键->New->Module。不做任何选择直接Next。填写子模块的ArtifactId为eureka-server-cluster,点击Next。填写Module name检查无误后点击Finish即可。
编写子模块eureka-server-cluster的pom.xml文件。
添加spring-cloud-starter-netflix-eureka-server的依赖,当前Spring Cloud版本为Finchley.RELEASE,其它版本如有不同可去mvnrepository查找对应ArtifactId。
eureka
cn.org.lilu
1.0-SNAPSHOT
4.0.0
eureka-server-cluster
org.springframework.cloud
spring-cloud-starter-netflix-eureka-server
2.1.2.RELEASE
创建Spring Boot启动类EurekaServerClusterApplication.java和配置文件application.yml(properties文件也可)。
注意:启动类应放置在源码包下。
我们要在本地搭建Eureka Server集群环境,需要运行多个Eureka Server实例,可采用多配置文件格式,在启动时指定具体的配置文件。也可利用开发工具IDEA,在启动一个实例后,修改配置文件再启动另一个实例。这样可以很方便地在本地环境进行测试。
下面介绍利用开发工具IDEA启动多个实例的方法。
首先需要修改设置Run/Debug Configurations,点击Edit Configurations...,找到EurekaServerClusterApplication启动配置,勾选Allow parallel run选项。我的IDEA版本为2018.3.3。网上看到很多人写的是去掉Single instance only选项,应该是版本原因。
为了在本地模拟2个Server服务节点,需要修改本地host文件,Windows系统在C:\Windows\System32\drivers\etc\hosts中修改,其它系统自行百度文件位置。使用Notpad++或其它记事本软件以管理员身份打开该文件,在文件末尾添加如下内容后保存(注意文件属性是否设置了只读,否则无法保存)。
127.0.0.1 peer1
127.0.0.1 peer2
编写启动类。添加@EnableEurekaServer注解声明这是一个Eureka Server。
package cn.org.lilu;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
/**
* @Auther: lilu
* @Date: 2019/6/27
* @Description:
*/
@SpringBootApplication
@EnableEurekaServer
public class EurekaServerClusterApplication {
public static void main(String[] args) {
SpringApplication.run(EurekaServerClusterApplication.class,args);
}
}
编写配置文件application.yml。由于在一台电脑上部署,Server节点的端口不能相同。为了让两个节点进行相互注册,在节点配置1中设置另一个Eureka Server的地址,同样在节点配置2中也设置另一个Eureka Server的地址,这样就实现了相互注册。
spring:
application:
name: peer-cluster
# 节点配置1
#server:
# port: 8761
#eureka:
# instance:
# hostname: peer1
# client:
# # 设置Eureka Server地址
# service-url:
# defaultZone: http://peer2:8762/eureka/
# 节点配置2
server:
port: 8762
eureka:
instance:
hostname: peer2
client:
# 设置Eureka Server地址
service-url:
defaultZone: http://peer1:8761/eureka/
打开节点配置1的注释,将节点配置2注释起来,运行启动类中的main方法,此时控制台会出现报错信息,原因是另一个Server节点还未启动。修改配置文件application.yml,将节点配置1注释起来,打开节点配置2的注释,再次运行启动类中的main方法,运行成功后,可以看得之前出现报错信息的控制台中打印了如下内容。
INFO 38848 --- [nio-8762-exec-2] c.n.e.registry.AbstractInstanceRegistry : Registered instance PEER-CLUSTER/localhost:peer-cluster:8761 with status UP (replication=false)
此时两个Server节点之间已经完成了相互注册。访问http://peer1:8761和http://peer2:8762可查看相关信息。
至此,一个双节点的Eureka Server就搭建完成。
下面介绍使用多配置文件的方式启动多个Eureka Server实例的方法(部分书中使用了该方法)。
仍然需要修改本地host文件,上文中已说明相关步骤。另外创建两个配置文件application-peer1.yml和application-peer2.yml。与application.yml在同一目录。将刚才的节点配置1的内容复制到application-peer1.yml中,将节点配置2的内容复制到application-peer2.yml中,修改application.yml中的配置。三个配置文件代码如下。
application.yml
spring:
profiles:
active: native
application:
name: peer-cluster
application-peer1.yml
server:
port: 8761
eureka:
instance:
hostname: peer1
client:
# 设置Eureka Server地址
service-url:
defaultZone: http://peer2:8762/eureka/
application-peer2.yml
server:
port: 8762
eureka:
instance:
hostname: peer2
client:
# 设置Eureka Server地址
service-url:
defaultZone: http://peer1:8761/eureka/
由于需要打成jar包运行,在pom.xml文件中添加maven插件。完整的pom.xml内容如下。
eureka
cn.org.lilu
1.0-SNAPSHOT
4.0.0
eureka-server-cluster
org.springframework.cloud
spring-cloud-starter-netflix-eureka-server
2.1.2.RELEASE
org.springframework.boot
spring-boot-maven-plugin
可直接使用IDEA提供的maven工具打包。点击IDEA右侧的maven工具,找到eureka-server-cluster项目下的Lifecycle,点击package即可打包。
生成的jar包在target目录下。
右击target目录,点击Open in Terminal进入命令行。
输入下面的命令指定配置文件为application-peer1.yml按回车键。
java -jar eureka-server-cluster-1.0-SNAPSHOT.jar --spring.profiles.active=peer1
运行后控制台会输出报错信息,不用管。再次右击target目录,点击Open in Terminal进入第二个命令行,输入下面的命令指定配置文件为application-peer2.yml按回车键。
java -jar eureka-server-cluster-1.0-SNAPSHOT.jar --spring.profiles.active=peer2
启动完成后,两个Server就完成了相互注册,仍可访问http://peer1:8761和http://peer2:8762查看相关信息。
以上就是使用多配置文件格式搭建双节点Eureka Server集群。
2. 将应用注册到Eureka Server集群上
修改模块eureka-client的配置文件application.yml,配置多个Eureka Server地址,使用英文逗号分隔。
server:
port: 1234
spring:
application:
name: eureka-client
eureka:
client:
service-url:
defaultZone: http://peer1:8761/eureka/,http://peer2:8762/eureka/
启动eureka-client模块,访问http://peer1:8761或http://peer2:8762可看到应用已经注册到Eureka Server集群上了。
当然,微服务即使只配置Eureka Server集群中的某个节点,也能正常注册到Eureka Server集群,因为多个Eureka Server之间的数据会相互同步。不过为了适应某些极端场景,建议在客户端配置多个Eureka Server节点。