SpringCloud系列（18）--将服务提供者Provider注册进Consul

news2024/12/27 12:19:56

前言：在上一章节中我们把服务消费者Consumer注册进了Zookeeper，并且成功通过服务消费者Consumer调用了服务提供者Provider，而本章节则是关于如何将服务提供者Provider注册进Consul里

准备环境：

先安装Consul，如果没有安装的同学可以参考以下文章来进行安装

https://blog.csdn.net/m0_64284147/article/details/132510817

1、再次创建一个服务提供者模块，命名为providerconsul-payment8006

(1)在父工程下新建模块

(2)选择模块的项目类型为Maven并选择模块要使用的JDK版本

(3)填写子模块的名称，然后点完成即可完成创建

效果图：

(4)修改providerconsul-payment8006子模块的pom.xml文件，然后reolad一下，下载依赖

例：

<?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>springcloud01</artifactId>
        <groupId>com.ken.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>providerconsul-payment8006</artifactId>

    <dependencies>
        <!--以下依赖都没写版本号，没写版本号的情况下会引用父项目的版本-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--监控-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!--热部署-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <!--lombok插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--引入自己定义的api调用包，可以使用Payment模块的entity-->
        <dependency>
            <groupId>com.ken.springcloud</groupId>
            <artifactId>api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <!--SpringCloud consul server-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>
    </dependencies>
</project>

2、为子模块添加名为application的yml配置文件（注：yml是官方推荐的配置文件格式，最好使用yml文件而不是properties文件）

效果图：

3、修改application.yml文件配置

#服务端口号
server:
  port: 8006

#服务名称
spring:
  application:
    name: consul-provider-payment
#consul注册中心地址
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        service-name: ${spring.application.name}

4、为providerconsul-payment8006子模块新建一个主启动类，类名输入com.ken.springcloud.PaymentMain8006，然后创建即可

效果图：

5、编写provider-payment8006子模块的主启动类

package com.ken.springcloud;

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

@SpringBootApplication
//该注解用于向使用consul或zookeeper作为注册中心时注册服务
@EnableDiscoveryClient
public class PaymentMain8006 {
    public static void main(String[] args) {
        SpringApplication.run(PaymentMain8006.class, args);
    }
}

6、在com.ken.springcloud包下新建controller包和PaymentController控制类，在类名输入controller.PaymentController，然后创建即可

效果图：

7、编写PaymentController控制类的内容

package com.ken.springcloud.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.UUID;

@RestController
@Slf4j
public class PaymentController {

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

    @GetMapping("/payment/consul")
    public String paymentConsul() {
        return "springcloud with consul:" + serverPort + "\t" + UUID.randomUUID();
    }

}