2.SpringCloud：Nacos注册中心+OpenFeign+Loadbalancer

目录

概述

源代码工程结构

工程全局pom.xml

payment模块（即一个支付服务）

 order模块（即一个订单服务）

启动与验证

 启动payment服务

 启动order服务

查看Nacos

调用验证

附1：Nacos服务注册发现客户端临时暂存目录

附2：Nacos隔离三层概念

附3：Java代码与Nacos注册中心交互

附4：通过curl调用open API 

从Nacos中列出某服务下的实例：

从Nacos获得某个实例信息：

发布/修改 Nacos实例（注意URL中元数据格式不是JSON）：

---

概述

• 服务提供方：payment
• 服务消费方：order服务（需要调用payment服务）
• 以上均在一个project工程，但分属不同的模块module
• nacos服务端已经安装完毕并启动。

源代码工程结构

  ---- Project

      ∟ payment      [module]

      ∟ order           [module]

      ∟ pom.xml           [全局pom文件]

工程全局pom.xml

通过全局pom.xml配置各模块需要的依赖的信息

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.6</version>
        <relativePath/>
    </parent>

    <modules>
        <module>payment</module>
        <module>order</module>
    </modules>

    <groupId>com.example</groupId>
    <artifactId>myproject-global-pom</artifactId>
    <version>0.0.1-DEFAULT</version>
    <packaging>pom</packaging>
    <description>This is my project global pom config</description>
    <properties>
        <java.version>1.8</java.version>
        <springcloud.version>3.1.5</springcloud.version>
        <springcloudalibaba.version>2021.0.4.0</springcloudalibaba.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>${springcloudalibaba.version}</version>
            <exclusions>
                <exclusion>
                    <groupId>com.alibaba.nacos</groupId>
                    <artifactId>nacos-client</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
            <version>1.4.5</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
            <version>${springcloud.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
            <version>${springcloud.version}</version>
        </dependency>
        
    </dependencies>

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

payment模块（即一个支付服务）

该payment模块的pom.xml文件如下：

<?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>myproject-global-pom</artifactId>
        <groupId>com.example</groupId>
        <version>0.0.1-DEFAULT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>payment</artifactId>
    <version>0.2.2-SNAPSHOT</version>
</project>

该payment模块的application.properties配置文件

#本服务的默认监听端口
server.port=8080

spring.application.name=payment

#Nacos注册中心服务端的地址和端口(形式ip:port,ip:port,...) 在启动时，会向多个地址都发起注册
spring.cloud.nacos.discovery.server-addr=39.100.80.168:8848

#如定义了此属性，则nacos取此名作为服务名，否则取spring.application.name作为默认服务名
spring.cloud.nacos.discovery.service=paymentService

 关于springcloud中nacos客户端更多的配置项可参加nacos官网（关于 Nacos Starter 更多的配置项信息）：https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-discovery

在package=com.example.payment下，SpringBoot 主类PaymentApplication.class中增加一个@EnableDiscoveryClient注解：开启服务注册发现机制

@SpringBootApplication
@EnableDiscoveryClient
public class PaymentApplication {
    public static void main(String[] args) {
        SpringApplication.run(PaymentApplication.class, args);
    }
}

新建一个controller用于模拟资金支付逻辑。 在package=com.example.payment.contronller下新增一个类如下：

@RestController
public class PaymentController {
    @Value("${server.port}")
    private int myport;

    @GetMapping("/dopay/{orderid}")
    public ResponseEntity<String> paylogic(@PathVariable("orderid") Long orderid) {
        return ResponseEntity.ok("支付服务successful! orderid=" + orderid + ", 支付成功。 支付服务的端口为port=" + myport );
    }
}

 order模块（即一个订单服务）

该order模块的pom.xml文件如下：

<?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>myproject-global-pom</artifactId>
        <groupId>com.example</groupId>
        <version>0.0.1-DEFAULT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>order</artifactId>
    <version>1.0-SNAPSHOT</version>
</project>

该order模块的application.properties配置文件

#本服务的默认监听端口
server.port=4444

spring.application.name=customerOrder

#Nacos服务端的地址和端口(形式ip:port,ip:port,...)
spring.cloud.nacos.discovery.server-addr=39.100.80.168:8848

#如定义了此属性，则nacos取此名作为服务名，否则取spring.application.name作为默认服务名
spring.cloud.nacos.discovery.service=orderService

#向Nacos注册时，本服务对外暴露的IP地址 （若不配置，则从本机上的网卡自动选择作为对外暴露的IP）
#spring.cloud.nacos.discovery.ip=x.x.x.x

关于springcloud中nacos客户端更多的配置项可参加nacos官网（关于 Nacos Starter 更多的配置项信息）：https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-discovery

在package=com.example.order下，SpringBoot 主类OrderApplication.class中增加两个注解，分别开启服务注册发现机制，OpenFeign客户端

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }
}

 定义openFeign客户端接口（package=com.example.order.feignclients）。只需要定义interface即可，无需手动实现。

@FeignClient(value = "paymentService")    // Feign客户端制定目标服务的名字（根据此名字从注册中心订阅具体的服务实例信息）
public interface IPaymentServiceClient {

    @GetMapping("/dopay/{payid}")  // 目标服务(服务提供方）的内具体的调用URL路径
    public ResponseEntity<String> dodopay(@PathVariable("payid") Long payid);
}

新建一个controller用于模拟订单处理。 在package=com.example.order.contronller下新增一个类如下：

@RestController
public class OrderController {

    @Autowired
    private IPaymentServiceClient paymentServiceClient;

    @GetMapping("/consumer/{orderid}")
    public ResponseEntity<String> consumerFeign( @PathVariable("orderid") Long orderid) {
        return ResponseEntity.ok ("调用订单模拟服务完成。 订单orderid:" + orderid + ",   调用返回的Body:" + paymentServiceClient.dodopay(orderid).getBody() );
    }
}

启动与验证

在maven中分别对payment和order模块分别进行package打包，然后启动。

 启动payment服务

   对payment启动两个实例，服务端口分别为8888和9999.

 java -jar payment-0.2.2-SNAPSHOT.jar --server.port=8888

 java -jar payment-0.2.2-SNAPSHOT.jar --server.port=9999

 启动order服务

java -jar order-1.0-SNAPSHOT.jar

查看Nacos

  这是从Nacos可以看到paymentService和orderService有两个服务。其中paymentService有两个实例

调用验证

curl http://localhost:4444/consumer/66

调用结果如下，可以看到paymentService两个实例轮训交替提供服务。这是应为openFeign使用spring could loadbalance组件，该组件默认是使用RR轮训算法。

 

 另外：如果在springboot启动时，配置了--logging.level.root=DEBUG属性开启debug日志，可以发现openfeign调用时在http协议具体属性，比如可观察到开启了keep-alive。

附1：Nacos服务注册发现客户端临时暂存目录

• Nacos客户端会将从Nacos服务端发现的服务及实例列表信息暂存到客户端本地（若服务及实例有变更，会自动更新至到客户端本地）。
• Nacos客户端在在本地临时暂存的目录为：$HOME/nacos/naming/            ($HOME为客户端应用启动用户所在的HOME路径)
   

附2：Nacos隔离三层概念

如下图：

• namespace：可用于资源完全隔离，不同namespace下的config配置资源不共享，服务不互通（无法发现找到）。可通过namespace实现多租户隔离
• group：可用于资源分组。在同一namespace下，不同group的config配置资源不共享，服务不互通（无法无法发现找到）。可通过group实现不同环境隔离
• cluster_name：区分服务实例所在集群。在同一namespace下，同一group下，不同cluster的服务是互通的（可相互访问）。可通过不同cluster识别服务运行的不同集群或数据中心。服务注册发现存在此概念，config配置不存在此概念。

注意1：注册中心和配置中心的Group两者是不同的，各自管各自。

注意2：以上层的设置，对于同一服务实例可以在Nacos注册中心、配置中心分别配置不同group。既同一个服务在向Nacos向Nacos获取配置时申明的group=A，而向Nacos注册服务时申明的group=B，这是允许的。
 

附3：Java代码与Nacos注册中心交互
 

      a、 不使用Springboot Bean方式，通过以下方式直接访问Nacos服务端

NamingService namingService = NacosFactory.createNamingService(serverAddrList);

namingService.getAllInstances("serviceName");
namingService.getAllInstances("serviceName", "groupName");
namingService.getAllInstances(......);
namingService.shutDown();


...... ConfigService 类似，省略 ......

       b、 若在Springboot Bean中，通过自动注入获得namingService对象：

    @Autowired
    NacosServiceManager nacosServiceManager;

    @Autowired
    NacosConfigManager nacosConfigManager;

 
 
...... 省略 ......
     NamingService namingService = nacosServiceManager.getNamingService();
     ConfigService configService = nacosConfigManager.getConfigService();
...... 然后使用该对象操作（省略）......
 

附4：通过curl调用open API 

从Nacos中列出某服务下的实例：

curl -X GET http://39.100.80.168:8848/nacos/v1/ns/instance/list?serviceName=paymentService

返回结果：

{"name":"DEFAULT_GROUP@@paymentServicecurl","groupName":"DEFAULT_GROUP","clusters":"","cacheMillis":10000,"hosts":[],"lastRefTime":1686204572768,"checksum":"","allIPs":false,"reachProtectionThreshold":false,"valid":true}{"name":"DEFAULT_GROUP@@paymentService","groupName":"DEFAULT_GROUP","clusters":"","cacheMillis":10000,"hosts":[{"ip":"192.168.163.1","port":8080,"weight":0.8,"healthy":true,"enabled":true,"ephemeral":true,"clusterName":"BJ","serviceName":"DEFAULT_GROUP@@paymentService","metadata":{"my.key2":"value2","gjs.canhandle.vCustomerDistribution":"value1"},"instanceHeartBeatInterval":5000,"instanceHeartBeatTimeOut":15000,"ipDeleteTimeout":30000}],"lastRefTime":1686204572823,"checksum":"","allIPs":false,"reachProtectionThreshold":false,"valid":true}

从Nacos获得某个实例信息：

curl -X GET "http://39.100.80.168:8848/nacos/v1/ns/instance/?serviceName=paymentService&ip=192.168.163.1&port=8080&clusterName=BJ"

返回结果：

{"service":"DEFAULT_GROUP@@paymentService","ip":"192.168.163.1","port":8080,"clusterName":"BJ","weight":0.8,"healthy":true,"instanceId":null,"metadata":{"my.key2":"value2","gjs.canhandle.vCustomerDistribution":"value1"}}

发布/修改 Nacos实例（注意URL中元数据格式不是JSON）：

curl -X PUT "http://39.100.80.168:8848/nacos/v1/ns/instance/?serviceName=paymentService&ip=192.168.163.1&port=8080&clusterName=BJ&metadata=my.key2=newvalue44,bb.xx=44,yyy=455555"

返回结果：

ok

再次调用从Nacos获得某个实例信息：

{"service":"DEFAULT_GROUP@@paymentService","ip":"192.168.163.1","port":8080,"clusterName":"BJ","weight":1.0,"healthy":true,"instanceId":null,"metadata":{"yyy":"455555","my.key2":"newvalue44","gjs.canhandle.vCustomerDistribution":"value1","bb.xx":"44"}}

更多的API操作见Nacos官网Open API 指南