详解springcloud组件consul服务治理

更新时间：2022年08月11日 15:42:50 作者：求知若渴的蜗牛

Consul是一款由HashiCorp公司开源的，用于服务治理的软件，Spring Cloud Consul对其进行了封装，这篇文章主要介绍了springcloud组件consul服务治理,需要的朋友可以参考下

Consul是一款由HashiCorp公司开源的，用于服务治理的软件，Spring Cloud Consul对其进行了封装。Consul具有如下特点:

服务注册 - 自动注册和取消注册服务实例的网络位置
运行状况检查 - 检测服务实例何时启动并运行
分布式配置 - 确保所有服务实例使用相同的配置

Consul agent有两种运行模式：Server和Client。这里的Server和Client只是Consul集群层面的区分，与搭建在Cluster之上的应用服务无关。以Server模式运行的Consul agent节点用于维护Consul集群的状态，官方建议每个Consul Cluster至少有3个或以上的运行在Server mode的Agent，Client节点不限。

安装Consul

Consul下载地址：https://www.consul.io/downloads.html，本文选择windows 64bit 版本进行演示。

下载后解压，然后在解压目录下运行./consul命令：

可以看到Consul所包含的命令，使用consul [命令] --help可以查看某个命令的具体用法。

执行下面这条命令来启动一个Consul agent

-dev表示创建一个开发环境下的server节点，在该模式下不会有任何持久化操作，即不会有任何数据写入到磁盘，所以这个模式适合用于开发过程，而不适用于生产环境。

启动后，默认的端口号为8500，访问http://localhost:8500

当前就一个consul服务。接下来我们开始创建服务提供者和服务消费者。

cloud-provider-consul-payment8005 服务提供者

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">
    <parent>
        <artifactId>springcloud</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
 
    <artifactId>cloud-provider-consul-payment8005</artifactId>
 
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
 
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
 
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
 
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
        </dependency>
 
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>cloud-api-conmmon</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--swagger 整合swagger需要的依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <!--swagger ui-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>
        <!--SpringBoot热部署配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
 
        <!--consul依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>
 
    </dependencies>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <fork>true</fork>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

编写application.yml配置文件

server:
  port: 8005
spring:
  application:
    name: server-provider-consul
  cloud:
    consul:
      host: localhost  #consul的ip地址
      port: 8500    #consul的段端口号
      discovery:
        register-health-check: false  #不进行检查机制
        service-name: ${spring.application.name}

然后在配置文件里添加如下配置：

spring.cloud.consul.host和spring.cloud.consul.port配置了consul的ip和端口；spring.cloud.consul.discovery.service-name配置了该服务在consul里注册的服务名称；spring.cloud.consul.discovery.register-health-check用于开启健康检查，spring.cloud.consul.discovery.health-check-interval配置了健康检查的周期为10秒，spring.cloud.consul.discovery.health-check-path配置了健康检查路径。

接着新建ConsulController

package com.shiwen.controller;
 
import com.shiwen.entity.CommonResult;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
import java.util.UUID;
 
/**
 * @author wangjie
 * @Title: ConsulController
 * @Description: consul测试类
 * @company: 西安石文软件有限公司
 * @date 2020/10/910:44
 */
@RestController
@RequestMapping("/consul")
public class ConsulController {
 
    @Value("${server.port}")
    private String serverPort;
 
    @RequestMapping("/payment")
    public CommonResult getPayment(){
        return  new CommonResult(200,"consul"+serverPort, UUID.randomUUID().toString());
    }
 
}

最后，要开启服务注册与发行，需要在Spring Boot入口类上添加@EnableDiscoveryClient注解：

package com.shiwen;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
 
/**
 * @author wangjie
 * @Title: ProviderConsulApplication8005
 * @Description: consul服务治理
 * @company: 西安石文软件有限公司
 * @date 2020/10/910:28
 */
@SpringBootApplication
@EnableDiscoveryClient
public class ProviderConsulApplication8005 {
    public static void main(String[] args) {
        SpringApplication.run(ProviderConsulApplication8005.class,args);
    }
}

准备完毕后，打包项目，然后启动两个实例，端口号分别为8005和8006，启动后，再次访问consul管理界面：

服务提供者注册成功，接下来开始搭建服务消费者。

cloud-provider-consul-order80

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">
    <parent>
        <artifactId>springcloud</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
 
    <artifactId>cloud-provider-consul-order80</artifactId>
 
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
 
        <!--swagger 整合swagger需要的依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <!--swagger ui-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>
 
        <!--SpringBoot热部署配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
 
        <dependency>
            <groupId>org.example</groupId>
            <artifactId>cloud-api-conmmon</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
 
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>
 
    </dependencies>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <fork>true</fork> <!-- fork: 如果没有配置该项配置，devtools不会起作用的，即应用不会restear -->
                </configuration>
            </plugin>
        </plugins>
    </build>
 
</project>

配置application.yml：

server:
  port: 80
spring:
  application:
    name: server-consumer
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        register-health-check: false
        service-name: ${spring.application.name}

同样的，需要开启服务注册与发现需要在入口类上添加@EnableDiscoveryClient注解。

接着创建ConsulController来消费cloud-provider-consul-payment8005提供的payment服务：

package com.shiwen.controller;
 
import com.shiwen.entity.CommonResult;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
 
/**
 * @author wangjie
 * @Title: ConsulController
 * @Description: 调用
 * @company: 西安石文软件有限公司
 * @date 2020/10/911:57
 */
@RestController
@RequestMapping("/order")
public class ConsulController {
 
    private String sonsulUrl="http://server-provider-consul";
 
    @Autowired
    private RestTemplate restTemplate;
 
    @RequestMapping("/info")
    public CommonResult getCommonInfor(){
       return restTemplate.getForObject(sonsulUrl+"/consul/payment",CommonResult.class);
    }
}

sonsulUrl的值为服务提供者在consul注册中心的实例名称，即server-provider-consul。通过DiscoveryClient我们可以获取到所有名称为server-provider-consul的服务实例信息。consul内置了Ribbon，所以我们还可以通过@LoadBalanced标注的RestTemplate来实现负载均衡服务调用打包部署项目，

访问：http://localhost/order/info

再次访问http://localhost/order/info

到此这篇关于springcloud组件consul服务治理的文章就介绍到这了,更多相关springcloud consul服务治理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java最简洁数据结构之冒泡排序快速理解
冒泡排序是编程中数据结构绕不过的一个基础点，有关于冒泡排序的文章也有很多，但可能会比较缭乱未能理解，本章将一子u为简洁明了的例图带你通关冒泡排序
2021-11-11
HDFS中JAVA API的使用
HDFS是一个分布式文件系统，既然是文件系统，就可以对其文件进行操作，比如说新建文件、删除文件、读取文件内容等操作。下面记录一下使用JAVA API对HDFS中的文件进行操作的过程
2017-07-07
Spring WebSocket 404错误的解决方法
这篇文章主要为大家详细介绍了Spring WebSocket 404错误的解决方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-12-12
SpringBoot实现统一封装返回前端结果集的示例代码
在实际项目开发过程中，我们经常将返回数据的基本形式统一为JSON格式的数据。但项目可能是由很多人开发的，所以我们最好将返回的结果统一起来。本文介绍了SpringBoot实现统一封装返回前端结果集的示例代码，需要的可以参考一下
2022-06-06
java 中OkHttp的使用方法及实例
这篇文章主要介绍了java 中OkHttp的使用方法及实例的相关资料,需要的朋友可以参考下
2017-06-06
Java实现断点续传功能的示例代码
这篇文章主要为大家详细介绍了如何利用Java语言实现网络资源的断点续传功能，文中的示例代码讲解详细，具有一定的学习价值，感兴趣的可以了解一下
2022-10-10
详解spring cloud hystrix请求缓存(request cache)
这篇文章主要介绍了详解spring cloud hystrix请求缓存(request cache)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-05-05
springcloud中RabbitMQ死信队列与延迟交换机实现方法
死信队列是消息队列中非常重要的概念，同时我们需要业务场景中都需要延迟发送的概念，比如12306中的30分钟后未支付订单取消，那么本期，我们就来讲解死信队列，以及如何通过延迟交换机来实现延迟发送的需求，感兴趣的朋友一起看看吧
2022-05-05
Java中如何将list转为树形结构
这篇文章主要介绍了Java中如何将list转为树形结构,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2023-09-09
SpringCloud Gateway使用详解
Spring Cloud Gateway是一个基于Spring Boot 2.x和Spring WebFlux的API网关，可以帮助我们构建微服务架构中的统一入口。感兴趣的同学可以参考一下
2023-04-04