将服务注册到Eureka

Eureka提供了Server当然也提供了Client,如果你对Eureka Server不了解,通过阅读文章查看具体的编码实现。

本章构建的项目其实是一个Eureka Client,因为是向Eureka Server注册的服务,相对于Eureka Server来说相当于一个客户端的形式存在。

我们使用spring-cloud-starter-netflix-eureka-client可以快速的构建Eureka Client项目,简单的配置就可以完成ClientServer之间的通信以及绑定,下面我们来看下具体是怎么向Eureka Server注册服务。

构建项目

同样的是采用idea开发工具创建一个SpringBoot项目,在依赖选择界面对应的添加Web以及Eureka Discovery依赖,直接完成创建项目。
项目的pom.xml内容如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

<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>Finchley.SR1</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-netflix-eureka-client</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>
....//省略部分配置

Eureka Server项目不同依赖的选择的地方是Client项目需要添加spring-cloud-starter-netflix-eureka-client,通过该依赖可以完成服务的注册以及服务之间的通信等。

添加spring-boot-starter-web依赖的目的是为了简单创建一个Controller请求示例,在后面章节我们需要用到该依赖。

Eureka Client的配置

Eureka Client的配置步骤与Eureka Server几乎是一致的,不过采用的注解不同以及配置信息有出入,同样是两步完成配置:

  • 第一步入口类添加注解@EnableDiscoveryClient
    我们在配置Client时通常会采用通用的客户端注解配置,也就是@EnableDiscoveryClient注解,当然如果服务注册中心确定采用的是Eureka也可以使用@EnableEurekaClient注解来完成配置,至于这两个的区别后续章节细讲。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    @SpringBootApplication
    @EnableDiscoveryClient
    public class SpringCloudEurekaProviderApplication {
    /**
    * logger instance
    */
    static Logger logger = LoggerFactory.getLogger(SpringCloudEurekaProviderApplication.class);

    public static void main(String[] args) {
    SpringApplication.run(SpringCloudEurekaProviderApplication.class, args);
    logger.info("「「「「「Eureka服务提供者启动完成.」」」」」");
    }
    }
  • 第二步application.yml配置文件添加配置信息
    我比较喜欢ymal这种配置风格,所以删除了创建项目时创建的application.properties配置文件,自行创建了application.yml,因为层级的原因可以更清晰明了的看清配置,配置内容如下所示:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    # 服务名称
    spring:
    application:
    name: hengboy-spring-cloud-eureka-provider

    # 服务提供者端口号
    server:
    port: 20000

    # 配置Eureka Server 信息
    eureka:
    client:
    service-url:
    defaultZone: http://localhost:10000/eureka/
  • spring.application.name:配置服务的名称

  • server.port:服务端口号

  • eureka.client.service-url:配置Eureka Server服务注册中心地址

运行测试

我们已经完成了Eureka Client的相关配置信息,接下来我们按照下面的步骤进行执行测试。

  1. 启动服务注册中心Eureka Server
  2. 启动本章项目
  3. 查看控制台日志输出信息
  4. 查看服务注册中心管理界面服务列表

运行过程中本章项目控制台输出内容如下所示:

1
2
3
4
......
DiscoveryClient_HENGBOY-SPRING-CLOUD-EUREKA-PROVIDER/192.168.1.75:hengboy-spring-cloud-eureka-provider:20000: registering service...
DiscoveryClient_HENGBOY-SPRING-CLOUD-EUREKA-PROVIDER/192.168.1.75:hengboy-spring-cloud-eureka-provider:20000 - registration status: 204
......

可以看到控制台打印了向我们配置的服务注册中心进行registering service,既然控制台并没有给我抛出相关的异常信息,那么我们猜想是不是Eureka Server服务注册中心的服务列表已经存在了该条记录了呢?

查看Eureka Server 服务列表

我们带着这个疑问打开Eureka Server管理界面地址:http://localhost:10000
Eureka Server 管理界面

管理界面我们可以看到本章的服务已经注册到了Eureka Server服务注册中心,而且是UP状态也就是正常运行状态

在服务注册的过程中,SpringCloud Eureka为每一个服务节点都提供默认且唯一的实例编号(InstanceId)

  • 实例编号默认值:${spring.cloud.client.ipAddress}:${spring.application.name}:${spring.application.instance_id:${server.port}}
  • 本章服务注册时的实例编号192.168.1.75:hengboy-spring-cloud-eureka-provider:20000

如果你想要随心所欲的自定义这个实例编号,那么好可以满足你,不过要注意自定义时要保证唯一性!!!

自定义InstanceId

我们可以来考虑考虑根据什么格式来自定义这个实例编号可以更好的帮助我们定位问题?

一般来说我们在线上运行着的服务来说,我要知道服务的名称这是肯定的,还有就是端口号,因为如果你同一台服务器部署多个相同的服务肯定端口号要有所变动,当然如果你还想要知道当前运行代码的版本号,那要更有利于你分析定位解决运行中遇到的问题,那既然这样,我们就可以采用这种方式进行自定义。
application.yml配置文件内修改实例编号后内容如下所示:

1
2
3
4
5
6
7
8
# 配置Eureka Server 信息
eureka:
client:
service-url:
defaultZone: http://localhost:10000/eureka/
# 自定义实例编号
instance:
instance-id: ${spring.application.name}:${server.port}:@project.version@
  • @project.version@
    源码的版本号我们是采用了获取pom.xml配置文件内设置的version来设置的值,通过@xxx@的方式就可以得到maven的一些相关配置信息来直接使用。
    既然修改了那么我们来看下效果,重启我们本章的项目,启动完成后再次打开Eureka Server的管理界面,查看服务列表,如下图所示:
    修改后的实例编号

可以看到正在UP状态服务的实例编号hengboy-spring-cloud-eureka-provider:20000:v1.0,也就是我们自定义eureka.instance.instance-id的值,至于DOWN状态的服务时间久了就会被Eureka Server所剔除,不会影响我们服务的正常使用。

总结

本章通过一个SpringBoot项目来讲解了怎么将自定义的服务注册到Eureka Server(服务注册中心),简单的两个步骤就可以完成这个注册、绑定、生效的过程,在这个过程中我们还了解到了怎么去自定义服务注册时的实例编号

文章标签: Eureka, SpringBoot, SpringCloud

评论

Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×