詳解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集群層面的區(qū)分，與搭建在Cluster之上的應用服務無關。以Server模式運行的Consul agent節(jié)點用于維護Consul集群的狀態(tài)，官方建議每個Consul Cluster至少有3個或以上的運行在Server mode的Agent，Client節(jié)點不限。

安裝Consul

Consul下載地址：https://www.consul.io/downloads.html，本文選擇windows 64bit 版本進行演示。

下載后解壓，然后在解壓目錄下運行./consul命令：

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

執(zhí)行下面這條命令來啟動一個Consul agent

-dev表示創(chuàng)建一個開發(fā)環(huán)境下的server節(jié)點，在該模式下不會有任何持久化操作，即不會有任何數據寫入到磁盤，所以這個模式適合用于開發(fā)過程，而不適用于生產環(huán)境。

啟動后，默認的端口號為8500，訪問http://localhost:8500

當前就一個consul服務。接下來我們開始創(chuàng)建服務提供者和服務消費者。

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());
    }
 
}

最后，要開啟服務注冊與發(fā)行，需要在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}

同樣的，需要開啟服務注冊與發(fā)現需要在入口類上添加@EnableDiscoveryClient注解。

接著創(chuàng)建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