快捷導(dǎo)航

詳解springcloud組件consul服務(wù)治理

更新時(shí)間：2022年08月11日 15:42:50 作者：求知若渴的蝸牛

Consul是一款由HashiCorp公司開源的，用于服務(wù)治理的軟件，Spring Cloud Consul對(duì)其進(jìn)行了封裝，這篇文章主要介紹了springcloud組件consul服務(wù)治理,需要的朋友可以參考下

Consul是一款由HashiCorp公司開源的，用于服務(wù)治理的軟件，Spring Cloud Consul對(duì)其進(jìn)行了封裝。Consul具有如下特點(diǎn):

服務(wù)注冊 - 自動(dòng)注冊和取消注冊服務(wù)實(shí)例的網(wǎng)絡(luò)位置
運(yùn)行狀況檢查 - 檢測服務(wù)實(shí)例何時(shí)啟動(dòng)并運(yùn)行
分布式配置 - 確保所有服務(wù)實(shí)例使用相同的配置

Consul agent有兩種運(yùn)行模式：Server和Client。這里的Server和Client只是Consul集群層面的區(qū)分，與搭建在Cluster之上的應(yīng)用服務(wù)無關(guān)。以Server模式運(yùn)行的Consul agent節(jié)點(diǎn)用于維護(hù)Consul集群的狀態(tài)，官方建議每個(gè)Consul Cluster至少有3個(gè)或以上的運(yùn)行在Server mode的Agent，Client節(jié)點(diǎn)不限。

安裝Consul

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

下載后解壓，然后在解壓目錄下運(yùn)行./consul命令：

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

執(zhí)行下面這條命令來啟動(dòng)一個(gè)Consul agent

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

啟動(dòng)后，默認(rèn)的端口號(hào)為8500，訪問http://localhost:8500

當(dāng)前就一個(gè)consul服務(wù)。接下來我們開始創(chuàng)建服務(wù)提供者和服務(wù)消費(fèi)者。

cloud-provider-consul-payment8005 服務(wù)提供者

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的段端口號(hào)
      discovery:
        register-health-check: false  #不進(jìn)行檢查機(jī)制
        service-name: ${spring.application.name}

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

spring.cloud.consul.host和spring.cloud.consul.port配置了consul的ip和端口；spring.cloud.consul.discovery.service-name配置了該服務(wù)在consul里注冊的服務(wù)名稱；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());
    }
 
}

最后，要開啟服務(wù)注冊與發(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服務(wù)治理
 * @company: 西安石文軟件有限公司
 * @date 2020/10/910:28
 */
@SpringBootApplication
@EnableDiscoveryClient
public class ProviderConsulApplication8005 {
    public static void main(String[] args) {
        SpringApplication.run(ProviderConsulApplication8005.class,args);
    }
}

準(zhǔn)備完畢后，打包項(xiàng)目，然后啟動(dòng)兩個(gè)實(shí)例，端口號(hào)分別為8005和8006，啟動(dòng)后，再次訪問consul管理界面：

服務(wù)提供者注冊成功，接下來開始搭建服務(wù)消費(fèi)者。

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: 如果沒有配置該項(xiàng)配置，devtools不會(huì)起作用的，即應(yīng)用不會(huì)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}

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

接著創(chuàng)建ConsulController來消費(fèi)cloud-provider-consul-payment8005提供的payment服務(wù)：

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: 調(diào)用
 * @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的值為服務(wù)提供者在consul注冊中心的實(shí)例名稱，即server-provider-consul。通過DiscoveryClient我們可以獲取到所有名稱為server-provider-consul的服務(wù)實(shí)例信息。consul內(nèi)置了Ribbon，所以我們還可以通過@LoadBalanced標(biāo)注的RestTemplate來實(shí)現(xiàn)負(fù)載均衡服務(wù)調(diào)用打包部署項(xiàng)目，

訪問：http://localhost/order/info