SpringCloud项目使用Nacos进行服务的注册

本篇介绍Spring cloud项目使用Nacos作为注册中心来进行服务注册及服务发现，并进行简单的测试来验证。

一、简介

nacos是一个集服务发现、服务配置、服务元数据以及流量管理于一体的管理中心，能帮助我们更好的发现、配置和管理微服务。

注意：如果之前使用eureka，需要将相关的依赖注释或删掉

二、引入依赖

创建SpringCloud项目，添加相关的依赖

<dependency>
    <groupId>com.alibaba.cloudgroupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
    <version>2021.1version>
dependency>

<dependency>
    <groupId>com.alibaba.cloudgroupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-configartifactId>
    <version>2021.1version>
dependency>

注意：版本 2021.1 对应的是 Spring Boot 2.x 版本

我选择的是 springcloudalibaba springboot版本：

• spring-cloud-alibaba-dependencies 2.2.1.RELEASE
• spring-boot-starter-parent 2.4.6

<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.0modelVersion>
    <parent>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-parentartifactId>
        <version>2.4.6version>
        <relativePath/> 
    parent>
    <groupId>com.examplegroupId>
    <artifactId>nacos-demoartifactId>
    <version>0.0.1-SNAPSHOTversion>
    <name>nacos-demoname>
    <description>Demo project for Spring Bootdescription>
    <properties>
        <java.version>11java.version>
        <spring-cloud.version>2021.0.5spring-cloud.version>
    properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webartifactId>
        dependency>

        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-starter-bootstrapartifactId>
            <version>3.1.5version>
        dependency>
        
        <dependency>
            <groupId>com.alibaba.cloudgroupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
            <version>2021.1version>
        dependency>
        
        <dependency>
            <groupId>com.alibaba.cloudgroupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-configartifactId>
            <version>2021.1version>
        dependency>

        <dependency>
            <groupId>org.projectlombokgroupId>
            <artifactId>lombokartifactId>
            <optional>trueoptional>
        dependency>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-testartifactId>
            <scope>testscope>
        dependency>
    dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.alibaba.cloudgroupId>
                <artifactId>spring-cloud-alibaba-dependenciesartifactId>
                <version>2.2.1.RELEASEversion>
                <type>pomtype>
                <scope>importscope>
            dependency>
        dependencies>
    dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-maven-pluginartifactId>
                <version>2.4.6version>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombokgroupId>
                            <artifactId>lombokartifactId>
                        exclude>
                    excludes>
                configuration>
            plugin>
        plugins>
    build>
    <repositories>
        <repository>
            <id>spring-milestonesid>
            <name>Spring Milestonesname>
            <url>https://repo.spring.io/milestoneurl>
            <snapshots>
                <enabled>falseenabled>
            snapshots>
        repository>
        <repository>
            <id>spring-snapshotsid>
            <name>Spring Snapshotsname>
            <url>https://repo.spring.io/snapshoturl>
            <releases>
                <enabled>falseenabled>
            releases>
        repository>
    repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-milestonesid>
            <name>Spring Milestonesname>
            <url>https://repo.spring.io/milestoneurl>
            <snapshots>
                <enabled>falseenabled>
            snapshots>
        pluginRepository>
        <pluginRepository>
            <id>spring-snapshotsid>
            <name>Spring Snapshotsname>
            <url>https://repo.spring.io/snapshoturl>
            <releases>
                <enabled>falseenabled>
            releases>
        pluginRepository>
    pluginRepositories>

project>

三、添加配置信息

1.登录nacos配置页，新建命名空间

命名空间Id可自动生成，后面步骤要用到

2.选到刚刚生成的命名空间，添加配置文件

新建配置页：
这里需要指定Data ID 和Group，通过这两个信息找到该配置文件。添加完配置信息后点击右下角的发布按钮。
配置好的列表如下：

四、配置bootstrap.yml文件

注意：想要bootstrap.yml起作用，需要添加如下依赖，不然配置的bootstrap.yml内容不起作用（虽然项目启动正常，但是nacos测试失败，提示：No service to register for nacos client…）：

<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-bootstrapartifactId>
    <version>3.1.5version>
dependency>

在 bootstrap.yml 中配置 应用名、nacos配置（nacos注册中心与配置中心）

nacos:
  namespace: b3d9a502-0d78-4c17-b07b-041162662196 # nacos配置文件的命名空间，默认为 public,如需改动，则在启动参数上加 --nacos.namespace=
  server-addr-local: localhost:8848 # 本次环境
spring:
  # 应用名称
  application:
    name: nacos-demo
  # nacos配置
  cloud:
    nacos:
      # 注册中心
      discovery:
        # 服务注册地址 (nacos服务接口,不能加http前缀，直接访问localhost:8848/nacos可以进入管理页面) 可以配置多个，逗号分隔
        server-addr: ${nacos.server-addr-local}
        # nacos配置文件的命名空间(命名空间ID，Nacos通过不同的命名空间来区分不同的环境，进行数据隔离,服务消费时只能消费到对应命名空间下的服务)
        namespace: ${nacos.namespace}
        # 是否开启Nacos Watch，默认true(类似长连接监听服务端信息变化的功能)
        watch:
          enabled: false
      # 配置中心
      config:
        server-addr: ${nacos.server-addr-local}
        namespace: ${nacos.namespace}
        prefix: ${spring.application.name}
        group: DEFAULT_GROUP
        # 配置文件的格式，默认为properties
        file-extension: yml

Spring Boot是如何找到nacos的配置文件呢？
首先从namespace找到配置文件的命名空间，然后会**通过prefix−{spring.profile.active}.${file-extension}找到我们的配置文件**。
如上，prefix: nacos-demo、file-extension:yml；由于我们未配置spring.profile.active，所以最终我们要找的配置文件名为nacos-demo.yml，也就是我们上面步骤创建的文件名。还要注意的是group也要和我们填写的一致。

说明：之所以需要配置 spring.application.name ，是因为它是构成 Nacos 配置管理 Data ID字段的一部分。

在 Nacos Spring Cloud 中，Data ID的完整格式如下：

${prefix}-${spring.profile.active}.${file-extension}

• prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。

• spring.profile.active 即为当前环境对应的 profile

• 当 spring.profile.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成： ${prefix}.${file-extension}

• file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

• bootstrap.yml的作用:
  
  

四、启动类开启服务注册发现功能

四、测试

我们可以通过spring的注解@Value来读取配置的值。

package com.example.nacosdemo.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author qzz
 */
@RestController
public class TestController {

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

    @RequestMapping("/test")
    public String test(){
        return "test";
    }

    @RequestMapping("/get")
    public String get(){
        return "port:"+port;
    }
}

启动项目，控制台打印日志如下：

说明项目启动成功。

打开nacos的服务列表，发现上面启动的项目在服务列表中，说明服务注册成功：

访问接口，结果如下：

四、完整代码

可以点击此处下载