Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)

Stella981
• 阅读 996

一、前言

在微服务领域，服务注册与发现是其中很重要的一个模块，主要用于服务治理问题；在分布式Dubbo中常用的服务发现与注册中心是Zookeeper，Cosul与其类似，在SpringCloud刚占领市场的时候，SpringCloud微服务框架默认使用的注册中心组建是Eureka，总所周知，Eureka已经开始闭源了，那么可以替代Eureka的有：Consul、Zookeeper ，这两种比较常用，同样可以很好的与SpringCloud集成，用于替代Eureka，本篇就主要实现SpringCloud整合Consul实现服务注册与发现。

二、Consul是什么

Consul是一个支持多数据中心分布式高可用的服务发现和配置共享的服务软件，采用 Go 语言开发。Consul内置了服务注册与发现框 架、分布一致性协议实现、健康检查、Key/Value存储、多数据中心方案。由于出现得晚些，Consul具有功能完善、部署简单、使用方便等特点。

1. 使用Consul 的优势

  • 使用 Raft 算法来保证一致性, 比 ZooKeeper 的 Paxos 算法更简单直接。
  • 支持多数据中心，内外网的服务采用不同的端口进行监听。 ZooKeeper 和 etcd 均不提供多数据中心功能的- 支持。
  • 支持健康检查，etcd 不提供此功能。
  • 支持 http 和 dns 协议接口。ZooKeeper 的集成较为复杂，etcd 只支持 http 协议。
  • 官方提供 web 管理界面，etcd 无此功能。
  • Consul 1.2 新增 Service Mesh 解决方案。

2. Consul默认支持Ribbon负载均衡

Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)

三、Consul的安装

1. 下载安装

Consul由Go语言开发，因此也继承了Go语言跨平台，易安装的特点，支持Windwos、Linux、macOS，解压即可运行使用；以Windwos为例，去官网下载： https://www.consul.io/downloads.html , 解压后只有一个.exe文件。
Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)

2. 运行Consul

a. 启动Consul命令：

consul agent -dev -ui -node=cy

-dev开发服务器模式启动，-node结点名为cy，-ui可以用界面访问，默认能访问。
Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)

b. 起始访问地址：
访问地址： http://localhost:8500
Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)

四、实现思路

启动Consul后，创建两个基于Consul的客户端服务工程，一个服务提供者和一个服务消费者，使用Feign进行服务消费，客户端配置连接运行的Consul服务，这里先贴一下项目完整结构图；
Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)

五、搭建服务提供者springcloud-consul-provider

1.引入pom依赖

  <!--SpringBoot依赖版本-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.RELEASE</version>
        <relativePath/>
    </parent>

    <!--项目编码、jdk版本、SpringCloud版本定义-->
    <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.RELEASE</spring-cloud.version>
    </properties>

    <!--声明管理SpringCloud版本依赖信息-->
    <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>

    <dependencies>
        <!-- SpringBootWeb组件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--springcloud整合consul组件-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>

        <!-- 引入Feign接口公共层-->
        <!--<dependency>-->
            <!--<groupId>com.thinkingcao</groupId>-->
            <!--<artifactId>springcloud-feign-interface</artifactId>-->
            <!--<version>0.0.1-SNAPSHOT</version>-->
        <!--</dependency>-->

    </dependencies>

    <!--maven插件-->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

2. 启动类上加@EnableDiscoveryClient注解

package com.thinkingcao.api;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@SpringBootApplication
@EnableDiscoveryClient
public class AppMemerProvider {
   
   
   

    public static void main(String[] args) {
   
   
   
        SpringApplication.run(AppMemerProvider.class, args);
    }
}

3. @EnableDiscoveryClient 与@EnableEurekaClient区别

  • @EnableDiscoveryClient注解是基于spring-cloud-commons依赖，并且在classpath中实现； 适合于consul、zookeeper注册中心
  • @EnableEurekaClient注解是基于spring-cloud-netflix依赖，只能为eureka作用；

4. 修改application.yml

##=========服务生产者-会员服务配置========
##服务在7777端口暴露出来
server:
  port: 8764

##配置Spring相关
spring:
  ##应用服务名称,切记不能为下划线consul_member_provider，因为Feign不支持
  application:
    name: consul-member-provider
  ##consul注册中心地址
  cloud:
    consul:
      ##Consul所在主机ip
      host: localhost
      ##Consul监听的端口
      port: 8500
      discovery:
        ##配置开启服务注册到Consul上
        register: true
        ##配置注册到Consul的服务实例名称(Consul里Feign是通过此名称调用，而非spring.application.name)
        service-name: member-provider
        ##配置服务健康检查地址，供Consul调用
        healthCheckPath: /health
        ##Consul 健康检查频率
        healthCheckInterval: 15s

5. 提供会员接口ApiConsulMemberController

package com.thinkingcao.api.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * @desc:  服务生产者(会员服务)
 * @author: cao_wencao
 * @date: 2020-02-22 23:44
 */
@RestController
public class ApiConsulMemberController {
   
   
   

    @Value("${server.port}")
    private String serverPort;

    @RequestMapping(value="/getMember", method = RequestMethod.GET)
    private String getMember(@RequestParam("userName") String userName){
   
   
   
        return "我是会员服务，订单服务调用会员服务成功啦, 姓名为： " + userName + ", 端口为： " + serverPort;
    }
}

6. Consul健康检查接口HealthCheckController

package com.thinkingcao.api.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @desc: 提供给Consul健康检查的controller
 * @auth: cao_wencao
 * @date: 2020/2/23 0:08
 */
@RestController
public class HealthCheckController {
   
   
   

    //RequestMapping中的url地址需和配置文件中保持一致
    @RequestMapping("/health")
    public String healthCheck() {
   
   
   
        return "ok";
    }
}

7. 启动会员服务

启动springcloud-consul-provider项目，会发现项目实例 member-provider 注册到了 consul 中

Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)

六、搭建服务消费者springcloud-feign-consumer

1.引入pom依赖

 <!--SpringBoot依赖版本-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.RELEASE</version>
        <relativePath/>
    </parent>
    <groupId>com.thinkingcao</groupId>
    <artifactId>springcloud-feign-consumer</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springcloud-feign-consumer</name>
    <description>SpringCloud整合Feign客户端组件消费服务</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    </properties>

    <!--声明管理SpringCloud版本依赖信息-->
    <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>
    
    <dependencies>
        <!-- SpringBootWeb组件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- springcloud整合Feign客户端组件   -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

        <!-- 引入Feign接口公共层-->
        <!--<dependency>-->
            <!--<groupId>com.thinkingcao</groupId>-->
            <!--<artifactId>springcloud-feign-interface</artifactId>-->
            <!--<version>0.0.1-SNAPSHOT</version>-->
        <!--</dependency>-->

        <!--springcloud整合consul组件-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>

        <!-- 健康检查 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <!--lombok代码简化工具-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

2. 启动类添加注解

  • 在启动类添加@EnableFeignClients和@EnableDiscoveryClient注解，表示启用Feign客户端调用和Consul服务注册与发现功能

    package com.thinkingcao.api;

    import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; import org.springframework.cloud.openfeign.EnableFeignClients;

    @SpringBootApplication @EnableFeignClients @EnableDiscoveryClient public class AppOrderConsumer {

    public static void main(String[] args) {



    SpringApplication.run(AppOrderConsumer.class, args);
}

    }

3. 编辑application.yml

##=========服务消费者-订单服务配置========
#服务端口号
server:
  port: 8787

##配置Spring相关
spring:
  ##服务名称
  application:
    name: consul-order_consumer
  ##consul注册中心地址
  cloud:
    consul:
      ##Consul所在主机ip
      host: localhost
      ##Consul监听的端口
      port: 8500
      discovery:
        ##配置注册到Consul的服务实例名称(Consul里Feign是通过此名称调用，而非spring.application.name)
        service-name: order-consumer
        ##配置服务健康检查地址，供Consul调用
        healthCheckPath: /health
        ##Consul 健康检查频率
        healthCheckInterval: 15s

4. 定义 Feign 接口IFeignClientService

  • 定义Feign接口时，其中@FeignClient的value 是 provide 注册在 consul中的服务名。RequestMapping 对应 provider的具体映射。

    package com.thinkingcao.api.Feign;

    import org.springframework.cloud.openfeign.FeignClient; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam;

    /**

    • @desc: Feign声明式客户端调用工具
    • @author: cao_wencao
    • @date: 2020-02-22 12:23

    */ @FeignClient(value = "member-provider") public interface IFeignClientService {

    //通过userId查询会员信息数据
@RequestMapping("/getMember")
public String getOrderToMemberInfo(@RequestParam("userName") String userName);

    }

5. 定义Controller调用Feign接口

package com.thinkingcao.api.controller;

import com.thinkingcao.api.Feign.IFeignClientService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalancerClient;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * @desc:  服务消费者(订单服务)
 * @author: cao_wencao
 * @date: 2020-02-22 12:30
 */
@RestController
public class ApiFeignOrderController {
   
   
   

    @Autowired
    private LoadBalancerClient loadBalancerClient;

    @Autowired
    private DiscoveryClient discoveryClient;

    // @Autowired
    // private OrderService orderService;

    @Autowired(required = false)
    private IFeignClientService feignClientService;

    //基于Feign实现订单调用会员 ，并且实现本地负载均衡
    @RequestMapping(value ="/getMemberInfo",method = RequestMethod.GET)
    public String getMemberInfo(@RequestParam("userName") String userName) {
   
   
   
        String memberInfo = feignClientService.getOrderToMemberInfo(userName);
        return memberInfo;
    }

     /**
     * 获取服务实例
     */
    @RequestMapping(value = "/discover",method = RequestMethod.GET)
    public String discover(){
   
   
   
        String instance = loadBalancerClient.choose("member-provider").getUri().toString();
        return instance;
    }

    /**
     * 获取所有服务
     */
    @RequestMapping("/services")
    public Object services() {
   
   
   
        return discoveryClient.getInstances("member-provider");
    }
}

6. Consul健康检查接口HealthCheckController

package com.thinkingcao.api.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @desc: 提供给Consul健康检查的controller
 * @auth: cao_wencao
 * @date: 2020/2/23 0:08
 */
@RestController
public class HealthCheckController {
   
   
   

    //RequestMapping中的url地址需和配置文件中保持一致
    @RequestMapping("/health")
    public String healthCheck() {
   
   
   
        return "ok";
    }
}

7. 启动订单服务

启动springcloud-feign-consumer项目，会发现项目实例 order-consumer注册到了 consul 中，这时候有两个服务都注册其中

Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)

七、测试

实现订单调用会员服务接口，为了测试Feign+Ribbon+Cosul实现负载均衡效果，需要启动两个会员提供者服务实例；启动会员服务两个实例后，稍等片刻。
Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)

这是浏览器交替显示结果：

我是会员服务，订单服务调用会员服务成功啦, 姓名为： “Thinkingcao”, 端口为： 8764
我是会员服务，订单服务调用会员服务成功啦, 姓名为： “Thinkingcao”, 端口为： 8765

Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)
Spring Cloud系列教程(六)：服务注册与发现Consul(Finchley版本)

八、项目源码

1. 项目源码： https://github.com/Thinkingcao/SpringCloudLearning/tree/master/springcloud-consul

七、SpringCloud系列教程

1.Spring Cloud系列教程(七)： Spring Cloud系列教程(七)：服务注册与发现ZooKeeper(Finchley版本)

SpringCloud教程汇总： Spring Cloud系列教程(汇总篇)：专栏汇总篇(持续更新中)

本文同步分享在 博客“Thinkingcao”（CSDN）。
如有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。

consulspring框架string前端前端
点赞
收藏
评论区
推荐文章
blmius blmius
•
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时，报错：原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等，这样可以更容易地在不同的环境中使用MySQL。全局s
4061
0
0
待兔 待兔
•
3个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
1039
0
0
Jacquelyn38 Jacquelyn38
•
3年前
2020年前端实用代码段，为你的工作保驾护航
有空的时候，自己总结了几个代码段，在开发中也经常使用，谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
2355
0
0
Easter79 Easter79
•
3年前
springcloud eureka.instance
1.在springcloud中服务的 InstanceID默认值是:${spring.cloud.client.hostname}:${spring.application.name}:${spring.application.instance\_id:${server.port}},也就是：主机名：应用名：应用端口。如图1
753
0
0
Easter79 Easter79
•
3年前
SpringCloud consul 微服务（注册到主机名的问题）
目前项目在使用consul做服务注册与发现，做SpringSecurityOAuth2权限认证的authorization\_code模式的时候发现一个异常坑爹的问题这是开始的服务注册代码块bootstrap.yml：spring:cloud:consul:port:8500
940
0
0
Easter79 Easter79
•
3年前
SpringCloud注册中心高可用搭建
SpringCloud的注册中心可以由Eureka、Consul、Zookeeper、ETCD等来实现，这里推荐使用SpringCloudEureka来实现注册中心，它基于Netfilix的Eureka做了二次封装，完成分布式服务中服务治理的功能，微服务系统中的服务注册与发现都通过这个注册中心来进行管理。引入EurekaServer依赖
759
0
0
Easter79 Easter79
•
3年前
SpringCloud常用组件
springcloud中有五大核心组件Eureka、Ribbon、Feign、Hystrix、Zuul，简单记录如下。Eureka是微服务架构中的注册中心，专门负责服务的注册与发现。EurekaClient组件专门负责将服务的信息注册到EurekaServer中，而EurekaServer是一个注册中心，里面有一个注册表，保存了各服务所在
720
0
0
Stella981 Stella981
•
3年前
Golang注册Eureka的工具包goeureka发布
1.简介提供Go微服务客户端注册到Eureka中心。点击：github地址(https://www.oschina.net/action/GoToLink?urlhttps%3A%2F%2Fgithub.com%2FSimonWang00%2Fgoeureka)，欢迎各位多多star!（已通过测试验证，用于正式生产部署）2.原理
990
0
0
Stella981 Stella981
•
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段，id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
1139
0
0
helloworld_70591445 helloworld_70591445
•
3年前
AWS国庆双重礼，仅限7天
自2021年10月1日00:00起至2021年10月7日24:00，新注册并激活（需全部完成账号注册的五个步骤，否则账号状态并未激活）AWS海外区域账户，填写页面下方表单，即可申领价值$200美元的AWS海外区域账户服务抵扣券直充到您的账户，用以抵扣服务消费，助您轻松体验多个云迁移应用场景。同时，您还可获赠。国庆双重礼，仅限7天$200美元AWS服务抵
884
0
0
Stella981
Stella981
Lv1
接天莲叶无穷碧，映日荷花别样红。
文章
1.7w
粉丝
42
获赞
28
热门文章
OpenVPN下载、安装、配置及使用详解
GitHub神器，一个可以白嫖全网无损音乐的神器
OpenWrt 路由器过滤广告的N种方法
Python—执行系统命令的四种方法（os.system、os.popen、commands、subprocess）
SS端加密以及obfs混淆