AI 助理
文档备案控制台
开发者社区 微服务 文章 正文

【Nacos系列第一篇】-Nacos之Spring Discovery 以及Config

2019-03-01 6381
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 作者：毕来生 【Nacos系列第一篇】-Nacos之Spring Discovery 以及Config
作者：毕来生

前言

​ 个人比较看好Spring Cloud Alibaba家族。此系列以Nacos为主题，从Spring、Spring boot、Spring Cloud多个方面逐步进行演示，源码解读。目前来看官方文档还有待完善。网络上除了官网外缺少Nacos系列文章。都是零零散散的知识点。如此系列文章哪里写的有不周全，错误之处。欢迎大家指正。谢谢。

​ 因公众号排版问题，可能会有代码显示不完整，请使用电脑版微信内置浏览器/复制链接到浏览器中。

1、Nacos是什么？

来自官网提供Nacos说明

服务（Service）是 Nacos 世界的一等公民。Nacos 支持几乎所有主流类型的“服务”的发现、配置和管理：

Kubernetes Service

gRPC & Dubbo RPC Service

Spring Cloud RESTful Service

Nacos 的关键特性包括一下等等:

  • 服务发现和服务健康监测
  • 动态配置服务
  • 动态 DNS 服务
  • 服务及其元数据管理

Nacos架构图

在这里插入图片描述

2、准备工作

工具：IDEA2018.3 、JDK： 1.8、Maven:3.5（通用配置。后续不在提及此部分。均已此版本演示）

Nacos：0.7.0(写此文章时最新版本，如后续更新。以最新版本给大家演示)

环境：Windows（演示用，后续更新完成后会有一章在linux下演示。有坑，但原理一样。不多赘述。）

Nacos稳定版本：https://github.com/alibaba/nacos/releases

Linux下请下载tar后解压。Windows下请下载zip。

  unzip nacos-server-$version.zip 或者 tar -xvf nacos-server-$version.tar.gz

下载后启动Nacos。Nacos默认启动端口为8848，意为珠穆朗玛峰高度。如启动有端口冲突，请自行调整端口。

3、工程结构

上面说了那么多，现在先整理来看一下我们的工程结构
在这里插入图片描述

附上关键部分代码。

NacosConfiguration

package org.nacos.spring;

import com.alibaba.nacos.api.annotation.NacosProperties;
import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource;
import com.alibaba.nacos.spring.context.annotation.discovery.EnableNacosDiscovery;
import org.springframework.beans.factory.annotation.Configurable;

/**
 * @Author: bilaisheng
 * @Wechat: 878799579
 * @Date: 2019/1/13 19:28
 * @Todo: NacosConfiguration,用以注册以及测试Service Name ： nacos-spring
 * @Version : JDK1.8 , IDEA2018
 */
@Configurable
@EnableNacosConfig(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
@NacosPropertySource(dataId = "nacos-spring", autoRefreshed = true)
public class NacosConfiguration {
}
  • @EnableNacosConfig 注解启用 Nacos Spring 的配置管理服务。
  • @NacosPropertySource 加载了 dataId 为 nacos-spring`的配置源，并开启自动更新。
  • 对 Nacos Spring 的用户来说，在自身应用中就只是设置 “autoRefreshed” 的一个布尔值。然后在需要修改配置的时候，调用 Nacos 修改配置的接口，或使用 Nacos 的控制台去修改，配置发生变更后， Nacos 就会把最新的配置推送到该应用的所有机器上。

NacosDiscoveryController

package org.nacos.spring.controller;

import com.alibaba.nacos.api.annotation.NacosInjected;
import com.alibaba.nacos.api.config.annotation.NacosValue;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.naming.NamingService;
import com.alibaba.nacos.api.naming.pojo.Instance;
import com.alibaba.nacos.spring.context.annotation.discovery.EnableNacosDiscovery;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.Date;
import java.util.List;

import static org.springframework.web.bind.annotation.RequestMethod.GET;

/**
 * @Author: bilaisheng
 * @Wechat: 878799579
 * @Date: 2019/1/13 19:29
 * @Todo: NacosDisCoveryTest
 * @Version : JDK1.8 , IDEA2018
 */
@Controller
@RequestMapping("nacos")
public class NacosDiscoveryController {

    @NacosInjected
    private NamingService namingService;

    @NacosValue(value = "${useLocalCache:false}", autoRefreshed = true)
    private boolean useLocalCache;

    @RequestMapping("/{str}")
    public String helloNacos(@PathVariable String str){
        return new Date() + "Hello Nacos " + str;
    }

    @RequestMapping("/instance")
    @ResponseBody
    public List<Instance> getInstance(@PathVariable  String serviceName) throws NacosException {
        return namingService.getAllInstances(serviceName);
    }

    @RequestMapping(value = "/get", method = GET)
    @ResponseBody
    public boolean get() {
        return useLocalCache;
    }
}

​ 此文件为普通Spring映射控制器，话说Nacos Spring还是小马哥@mercyblitz亲自操刀。大家可以不用怀疑质量啦。相信很多同学都快被小马哥逼的要劝退了。

​ 着重说明一下，这个也是Nacos中常用的方法之一。

    @RequestMapping("/instance")
    @ResponseBody
    public List<Instance> getInstance(@PathVariable  String serviceName) throws NacosException {
        return namingService.getAllInstances(serviceName);
    }
获取全部实例 
List<Instance> getAllInstances(String serviceName) throws NacosException;

List<Instance> getAllInstances(String serviceName, List<String> clusters) throws NacosException;

请求参数

名称 类型 描述
serviceName 字符串 服务名
clusters List 集群列表

返回参数

List 实例列表。

获取配置

描述

用于服务启动的时候从 Nacos 获取配置。

public String getConfig(String dataId, String group, long timeoutMs) throws NacosException

请求参数

参数名 参数类型 描述
dataId string 配置 ID，采用类似 package.class（如com.taobao.tc.refund.log.level）的命名规则保证全局唯一性，class 部分建议是配置的业务含义。全部字符小写。只允许英文字符和 4 种特殊字符（"."、":"、"-"、"_"），不超过 256 字节。
group string 配置分组，建议填写产品名:模块名（Nacos:Test）保证唯一性，只允许英文字符和4种特殊字符（"."、":"、"-"、"_"），不超过128字节。
timeout long 读取配置超时时间，单位 ms，推荐值 3000。

返回值

参数类型 描述
string 配置值

请求示例

try {
    String serverAddr = "{serverAddr}";
    String dataId = "{dataId}";
    String group = "{group}";
    Properties properties = new Properties();
    properties.put("serverAddr", serverAddr);
    ConfigService configService = NacosFactory.createConfigService(properties);
    String content = configService.getConfig(dataId, group, 5000);
    System.out.println(content);
} catch (NacosException e) {
    // TODO Auto-generated catch block
    e.printStackTrace();
}

​

​ 上述两个文件中关于Nacos使用，请参考官网NacosSDK。里面详细标注了每个方法以及对应参数以及测试案例。

父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">
  <modelVersion>4.0.0</modelVersion>

  <groupId>org.bilaisheng.nacos</groupId>
  <artifactId>nacos-spring-examples</artifactId>
  <packaging>pom</packaging>
  <version>1.0-SNAPSHOT</version>
  <modules>
    <module>nacos-spring-discvoery</module>
  </modules>

  <name>nacos-spring-examples</name>

  <properties>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <spring.framework.version>5.1.3.RELEASE</spring.framework.version>
    <servlet-api.version>4.0.1</servlet-api.version>
    <nacos-spring-context.version>0.2.2-RC1</nacos-spring-context.version>
  </properties>

  <dependencyManagement>
    <dependencies>
      <!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
      <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>${servlet-api.version}</version>
        <scope>provided</scope>
      </dependency>

      <!-- https://mvnrepository.com/artifact/org.springframework/spring-core -->
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${spring.framework.version}</version>
      </dependency>

      <!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${spring.framework.version}</version>
      </dependency>

      <!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>${spring.framework.version}</version>
      </dependency>

      <!-- https://mvnrepository.com/artifact/com.alibaba.nacos/nacos-spring-context -->
      <dependency>
        <groupId>com.alibaba.nacos</groupId>
        <artifactId>nacos-spring-context</artifactId>
        <version>${nacos-spring-context.version}</version>
      </dependency>

    </dependencies>
  </dependencyManagement>
</project>

本工程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>nacos-spring-examples</artifactId>
        <groupId>org.bilaisheng.nacos</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>nacos-spring-discvoery</artifactId>
    <dependencies>
        <!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
        </dependency>

        <!-- https://mvnrepository.com/artifact/com.alibaba.nacos/nacos-spring-context -->
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-spring-context</artifactId>
        </dependency>
    </dependencies>
</project>

页面请求

页面请求同普通Spring相同，启动后根据http://ip:端口/controller/xxx。

喜欢就关注我吧

在这里插入图片描述

文章标签：
Java
Nacos
Spring
Apache
毕来生
目录
相关文章
阿里云云原生
|
11月前
|
人工智能 Java Nacos
基于 Spring AI Alibaba + Nacos 的分布式 Multi-Agent 构建指南
本文将针对 Spring AI Alibaba + Nacos 的分布式多智能体构建方案展开介绍，同时结合 Demo 说明快速开发方法与实际效果。
阿里云云原生
5703 115
游客gxacrkxssutjq
|
12月前
|
XML Java Nacos
Spring Boot 整合Nacos 版本兼容适配 史上最详细文档
本文介绍SpringBoot整合Nacos的完整流程，涵盖Nacos下载安装、配置中心与服务发现集成、版本兼容性问题及实战配置。重点解决SpringBoot 3.3.0与Nacos版本适配难题，推荐使用Spring Cloud Alibaba方案，并提供项目开源地址供参考学习。
游客gxacrkxssutjq
4438 3
游客2cgvtedhdpwze
|
Dubbo 数据可视化 Java
整合SpringBoot、Dubbo与Nacos：一个快速入门教程
经过上述步骤，消费者模块成功引用了生产者提供的服务，并通过Spring Web将服务映射到了特定的URL路径上。消费者模块成功地调用并展示了生产者提供的数据，并在不移除特定依赖项的情况下确保了系统的正常运行。
游客2cgvtedhdpwze
871 0
蓝易云
|
Cloud Native Java Nacos
springcloud/springboot集成NACOS 做注册和配置中心以及nacos源码分析
通过本文，我们详细介绍了如何在 Spring Cloud 和 Spring Boot 中集成 Nacos 进行服务注册和配置管理，并对 Nacos 的源码进行了初步分析。Nacos 作为一个强大的服务注册和配置管理平台，为微服务架构提供
蓝易云
5174 14
蓝易云
|
监控 Java Nacos
使用Spring Boot集成Nacos
通过上述步骤，Spring Boot应用可以成功集成Nacos，利用Nacos的服务发现和配置管理功能来提升微服务架构的灵活性和可维护性。通过这种集成，开发者可以更高效地管理和部署微服务。
蓝易云
5297 17
星兽
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解，它通过@Import导入配置选择器，加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories，改用新格式的.imports文件进行配置。
星兽
1488 0
2G冲浪词条
|
人工智能 Java 测试技术
Spring Boot 集成 JUnit 单元测试
本文介绍了在Spring Boot中使用JUnit 5进行单元测试的常用方法与技巧，包括添加依赖、编写测试类、使用@SpringBootTest参数、自动装配测试模块（如JSON、MVC、WebFlux、JDBC等），以及@MockBean和@SpyBean的应用。内容实用，适合Java开发者参考学习。
2G冲浪词条
1435 0
Quan_Chen
|
前端开发 Java 数据库
微服务——SpringBoot使用归纳——Spring Boot集成Thymeleaf模板引擎——Thymeleaf 介绍
本课介绍Spring Boot集成Thymeleaf模板引擎。Thymeleaf是一款现代服务器端Java模板引擎，支持Web和独立环境，可实现自然模板开发，便于团队协作。与传统JSP不同，Thymeleaf模板可以直接在浏览器中打开，方便前端人员查看静态原型。通过在HTML标签中添加扩展属性（如`th:text`），Thymeleaf能够在服务运行时动态替换内容，展示数据库中的数据，同时兼容静态页面展示，为开发带来灵活性和便利性。
Quan_Chen
617 0

热门文章

最新文章

  • 1
    Spring3 整合 Hibernate4实现数据库操作(1)
  • 2
    让SpringBoot不需要Controller、Service、DAO、Mapper，卧槽！这款工具绝了！
  • 3
    Spring-IOC
  • 4
    深入探索Spring Cloud与Spring Boot：构建微服务架构的实践经验
  • 5
    如何使用Spring Boot与Redis集成
  • 6
    SpringBoot整合RabbitMQ实践详解
  • 7
    spring cloud zuul 简介及使用（一）
  • 8
    基于 SpringBoot+Vue 的家政服务管理平台（附源码）
  • 9
    SpringBoot - 子模块下spring-boot-configuration-processor不生效问题
  • 10
    在Spring2.5中定制自己的属性编辑器
  • 1
    基于 Spring AI Alibaba + Nacos 的分布式 Multi-Agent 构建指南
    5703
  • 2
    Nacos 3.1.0 正式发布，支持 A2A 注册中心与 MCP 注册协议增强
    2617
  • 3
    函数计算 × MSE Nacos : 轻松托管你的 MCP Server
    992
  • 4
    Spring Boot 整合Nacos 版本兼容适配 史上最详细文档
    4438
  • 5
    MCP Registry 官方发布：Nacos 原生支持，借助 HiMarket 构建企业级私有 MCP 市场
    1053
  • 6
    MSE Nacos Controller：为 Kubernetes 生态构建配置管理与服务发现的桥梁
    1054
  • 7
    如何实现 AI Agent 自主发现和使用 MCP 服务 —— Nacos MCP Router 部署最佳实践
    2211
  • 8
    简单的php版本nacos客户端
    456
  • 9
    基于 Nacos + Higress 的 MCP 开发新范式，手把手教程来了！
    4172
  • 10
    Nacos 3.0 架构升级，AI 时代更安全的 Registry
    969

    • 相关课程

    更多
  • Spring Cloud Alibaba Nacos 详解（上）
  • 全面讲解Spring Cloud Alibaba技术栈（知识精讲+项目实战）第二阶段
  • 微服务实战-服务注册中心 - Nacos
  • 微服务实战-分布式配置中心 - Config
  • 微服务实战-服务注册与发现 - Nacos Discovery
  • Nacos发展历程以及最佳实践

    • 相关电子书

    更多
  • Java Spring Boot开发实战系列课程【第7讲】：Spring Boot 2.0安全机制与MVC身份验证实战(Java面试题)
  • workshop专场-微服务专场-开发者动手实践营-微服务-使用Nacos进行服务的动态发现和流量调度
  • Nacos 启航，发布第一个版本, 云原生时代助力用户微服务平台建设
    • 下一篇
    一条命令迁移，帮你实现 OpenClaw 与 Hermes Agent 记忆互通！