SpringCloud下使用Eureka的服务发现与消费

在之前的章节我们已经把服务注册到Eureka Server,那么我们该怎么调用已经注册后的服务呢?
我们本章来简单的介绍我们具体该怎么调用服务节点请求内容。

本章目标

消费Eureka注册的服务节点的请求信息。

构建项目

我们只需要创建一个服务节点项目即可,因为服务提供者也是消费者,然后将本项目注册到之前编写的服务注册中心,下载文章搭建Eureka服务注册中心源码运行即可。
我们使用idea开发工具创建一个SpringBoot项目,对应的选择spring-boot-starter-webspring-cloud-starter-netflix-ribbonspring-cloud-starter-netflix-eureka-client三个依赖,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
<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>
<!--ribbon-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
</dependency>
<!--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>

添加完依赖后我们需要对本项目进行配置,让本项目注册到服务中心,在之前的章节将服务注册到Eureka有讲过,这里就不做过多的赘述。

配置Eureka客户端

打开XxxApplication入口类,添加@EnableDiscoveryClient注解,如下所示:

1
2
3
4
5
@SpringBootApplication
@EnableDiscoveryClient
public class SpringCloudEurekaConsumerApplication {
//...
}

修改application.yml配置文件

下面我们修改application.yml配置文件,添加Eureka Client对应的配置信息,如下所示:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# 服务名称
spring:
application:
name: hengboy-spring-cloud-eureka-consumer
# 启动端口号
server:
port: 20002
# Eureka 服务注册中心配置
eureka:
client:
service-url:
defaultZone: http://localhost:10000/eureka/
# 配置优先使用IP地址注册服务
instance:
prefer-ip-address: true

获取服务实例信息

如果你只是将服务注册到服务注册中心也就是Eureka Server上,到现在已经完全没有问题了,但是我们想要通过服务名(spring.application.name)来获取服务实例列表该怎么操作呢?

本章内容涉及一点有关Ribbon的知识点,我们通过添加依赖spring-cloud-starter-netflix-ribbon就可以直接使用RestTemplate类进行发送http请求,而且RestTemnplate可以直接使用服务名进行发送请求!!!

实例化RestTemplate

spring-cloud-starter-netflix-ribbon依赖并没有为我们实例化RestTemplate,我们需要手动进行实例化,我采用@Bean方式进行实例化,在XxxApplication类内添加如下代码:

1
2
3
4
5
6
7
8
9
10
/**
* 实例化RestTemplate对象实例
*
* @return
*/
@Bean
@LoadBalanced
public RestTemplate restTemplate() {
return new RestTemplate();
}

在这里有个@LoadBalanced注解,我们后续章节会对它详细的讲解,博客搜索关键字LoadBalanced查询文章信息,不过如果你不添加并使用这个注解,你是没有办法通过服务名直接发送请求的,会出现错误信息。

了解DiscoveryClient

我们需要创建一个发送请求以及请求消费Controller,如下所示:

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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/**
* 消费者控制器
*
* @author:于起宇 <p>
* ================================
* Created with IDEA.
* Date:2018/9/29
* Time:5:55 PM
* 简书:http://www.jianshu.com/u/092df3f77bca
* 码云:https://gitee.com/hengboy
* GitHub:https://github.com/hengyuboy
* ================================
* </p>
*/
@RestController
@RequestMapping(value = "/consumer")
public class ConsumerController {
/**
* logger instance
*/
static Logger logger = LoggerFactory.getLogger(ConsumerController.class);
/**
* 注入服务客户端实例
*/
@Autowired
private DiscoveryClient discoveryClient;
/**
* 注入restTemplate模板
*/
@Autowired
private RestTemplate restTemplate;

/**
* 服务消费者业务逻辑方法
* 该方法使用restTemplate访问获取返回数据
*
* @return
*/
@RequestMapping(value = "/logic")
public String home() {
return "this is home page";
}

/**
* 请求地址
* 输出服务的基本信息
*/
@RequestMapping(value = "/index")
public void index() {
discoveryClient.getInstances("hengboy-spring-cloud-eureka-consumer")
.stream()
.forEach(
instance -> {
logger.info("服务地址:{},服务端口号:{},服务实例编号:{},服务地址:{}", instance.getHost(), instance.getPort(), instance.getServiceId(), instance.getUri());
String response = restTemplate.getForEntity("http://" + instance.getServiceId() + "/consumer/logic", String.class).getBody();
logger.info("响应内容:{}", response);
}

);
}
}

在上面代码中我们注入了DiscoveryClient,这是一个接口类,具体该接口的实现类是什么要取决你使用的是什么服务注册中心,我们本章采用的Eureka理所当然使用的是Eureka实现类,源码可以查看org.springframework.cloud.netflix.eureka.EurekaDiscoveryClient,在EurekaDiscoveryClient内可以看到具体是怎么通过服务名获取实例的列表,部分源码如下所示:

1
2
3
4
5
6
7
8
9
10
@Override
public List<ServiceInstance> getInstances(String serviceId) {
List<InstanceInfo> infos = this.eurekaClient.getInstancesByVipAddress(serviceId,
false);
List<ServiceInstance> instances = new ArrayList<>();
for (InstanceInfo info : infos) {
instances.add(new EurekaServiceInstance(info));
}
return instances;
}

你如果对具体的源码执行流程感兴趣,可以使用断点来一步一步的观察。
在获取ServiceInstance服务实例后,可以得到实例的一些基本信息如:

  • serviceId:服务名称、服务的实例编号,也就是spring.application.name配置信息
  • host:注册该实例的hostName
  • port:注册该实例的端口号,对应server.port配置信息
  • uri:服务地址
  • metadata:服务自定义的元数据map集合

    请求转发流程

    执行流程:我们在访问/consumer/index请求地址时,会通过RestTemplate转发请求访问http://hengboy-spring-cloud-eureka-consumer/consumer/logic地址并返回信息this is home page

运行测试

我们的测试流程如下:

  1. 启动服务注册中心
  2. 启动本章项目
  3. 访问http://localhost:20002/consumer/index
  4. 查看控制台输出内容是否有this is home page

访问有多种形式,你可以浏览器直接访问地址,我通过curl命令来访问地址,打开terminal输入以下命令:

1
curl http://localhost:20002/consumer/index

请求正常,查看控制台输出内容如下所示:

1
2
3
2018-10-04 15:23:36.333  INFO 29075 --- [io-20002-exec-5] c.y.c.h.s.e.consumer.ConsumerController  : 服务地址:192.168.1.75,服务端口号:20002,服务实例编号:HENGBOY-SPRING-CLOUD-EUREKA-CONSUMER,服务地址:http://192.168.1.75:20002
......
2018-10-04 15:23:36.748 INFO 29075 --- [io-20002-exec-5] c.y.c.h.s.e.consumer.ConsumerController : 响应内容:this is home page

总结

本章通过Ribbon简单的实现了服务节点的消费,通过RestTemplate发送请求来获取响应内容,需要注意的是我们并不是通过IP:Port的形式,而是通过服务名的形式发送请求,这都归功于@LoadBalanced这个注解,这个注解在讲解Ribbon时会详细的说明。

本文由程序员 - 恒宇少年编写,遵循CC 4.0 BY-SA版权协议,转载请注明文章出处,如需公众号转载,请联系「微信

文章标签: Eureka, SpringCloud

评论

Your browser is out-of-date!

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

×