资讯专栏INFORMATION COLUMN

上云采购季！| 2核2G4M爆款云服务器低至59元/年，更有多台、长期优惠，快来选购！

立即前往
首页/文章专栏/Nacos系列：Nacos的Java SDK使用

Nacos系列：Nacos的Java SDK使用

LinkedME2016 / 485人阅读

摘要：发布配置支持程序自动发布配置，创建和修改配置使用同一个方法，配置不存在则创建配置已存在则更新。示例源码项目代码已上传至码云和上，欢迎下载学习参考资料用户指南的推荐阅读系列欢迎来到的世界系列基于的注册中心系列基于的配置中心

Maven依赖

Nacos提供完整的Java SDK，便于配置管理和服务发现及管理，以 Nacos-0.8.0 版本为例

添加Maven依赖：


    com.alibaba.nacos
    nacos-client
    0.8.0

仅仅引入nacos-client是不够的，否则启动时会出现如下错误：

sun.misc.Launcher$AppClassLoader@18b4aac2 JM.Log:WARN Init JM logger with NopLoggerFactory, pay attention. sun.misc.Launcher$AppClassLoader@18b4aac2
java.lang.ClassNotFoundException: org.apache.logging.log4j.core.Logger
    at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
    at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
    at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:335)
    at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
    at java.lang.Class.forName0(Native Method)
    at java.lang.Class.forName(Class.java:264)
    at com.alibaba.nacos.client.logger.log4j2.Log4j2LoggerFactory.(Log4j2LoggerFactory.java:33)
    at com.alibaba.nacos.client.logger.LoggerFactory.(LoggerFactory.java:59)
    at com.alibaba.nacos.client.config.utils.LogUtils.(LogUtils.java:49)
    at com.alibaba.nacos.client.config.NacosConfigService.(NacosConfigService.java:55)
    at java.lang.Class.forName0(Native Method)
    at java.lang.Class.forName(Class.java:264)
    at com.alibaba.nacos.api.config.ConfigFactory.createConfigService(ConfigFactory.java:40)
    at com.alibaba.nacos.api.config.ConfigFactory.createConfigService(ConfigFactory.java:59)
    at com.alibaba.nacos.api.NacosFactory.createConfigService(NacosFactory.java:52)
    at com.learn.nacos.config.NacosConfig.main(NacosConfig.java:12)

根据错误提示，应该还需要添加log4j相关依赖，官网的文档并没有对此说明，我在pom.xml添加了下面这些依赖才不报错


    ch.qos.logback
    logback-classic
    1.1.11


    org.logback-extensions
    logback-ext-spring
    0.1.4


    org.slf4j
    jcl-over-slf4j
    1.7.25


    log4j
    log4j
    1.2.17


    org.slf4j
    slf4j-api
    1.7.25
配置管理

创建ConfigService，可以通过 NacosFactory.createConfigService() 或 ConfigFactory.createConfigService() 来创建，后者是前者的底层实现方式，这两种方式都包含如下两个方法：
createConfigService(serverAddr)
createConfigService(properties)

创建示例：

// 方式一
String serverAddr = "127.0.0.1:8848";
ConfigService configService = ConfigFactory.createConfigService(serverAddr);

// 方式二
ConfigService configService = ConfigFactory.createConfigService(properties)
Properties properties = new Properties();
properties.put("serverAddr", serverAddr);

查看ConfigService源码，它提供了如下方法：

获取 Nacos Server 当前状态：String getServerStatus()
底层源码：

public String getServerStatus() {
    if (worker.isHealthServer()) {
        return "UP";
    } else {
        return "DOWN";
    }
}
根据源码注释，该状态应该是指 Nacos Server 的状态，我把 Nacos Server 关闭之后，再次运行示例，得到的结果仍然是UP，不知道这是不是一个BUG。

发布配置：boolean publishConfig(String dataId, String group, String content) throws NacosException
支持程序自动发布Nacos配置，创建和修改配置使用同一个方法，配置不存在则创建；配置已存在则更新。

底层源码：

try {
    result = agent.httpPost(url, headers, params, encode, POST_TIMEOUT);
} catch (IOException ioe) {
    log.warn("NACOS-0006",
        LoggerHelper.getErrorCodeStr("NACOS", "NACOS-0006", "环境问题", "[publish-single] exception"));
    log.warn(agent.getName(), "[publish-single] exception, dataId={}, group={}, msg={}", dataId, group,
        ioe.toString());
    return false;
}
发布配置后，如果马上用getConfig()读取配置，有时候会读不到，设置了足够的等待时长后才可保证每次正常读取，看了源码才知道Nacos的配置管理(发布、读取、移除)都是通过HTTP接口完成的，但发布配置的时延是多少，官网似乎没有说明？几秒钟的时延在一些对实时性要求很高的场景会不会存在影响呢？

读取配置：String getConfig(String dataId, String group, long timeoutMs) throws NacosException
timeoutMs指读取配置超时时间，官网推荐设置为3000ms

底层源码：

// 优先使用本地配置
String content = LocalConfigInfoProcessor.getFailover(agent.getName(), dataId, group, tenant);
if (content != null) {
    log.warn(agent.getName(), "[get-config] get failover ok, dataId={}, group={}, tenant={}, config={}", dataId,
        group, tenant, ContentUtils.truncateContent(content));
    cr.setContent(content);
    configFilterChainManager.doFilter(null, cr);
    content = cr.getContent();
    return content;
}

try {
    content = worker.getServerConfig(dataId, group, tenant, timeoutMs);

    cr.setContent(content);
    configFilterChainManager.doFilter(null, cr);
    content = cr.getContent();

    return content;
} catch (NacosException ioe) {
    if (NacosException.NO_RIGHT == ioe.getErrCode()) {
        throw ioe;
    }
    log.warn("NACOS-0003",
        LoggerHelper.getErrorCodeStr("NACOS", "NACOS-0003", "环境问题", "get from server error"));
    log.warn(agent.getName(), "[get-config] get from server error, dataId={}, group={}, tenant={}, msg={}",
        dataId, group, tenant, ioe.toString());
}
从源码上看，配置会先从本地缓存文件读取，如果没读取到，才会去请求Nacos Server的配置，这个缓存文件在哪呢？就在当前用户的nacos目录下
生成的缓存文件：nacos/config/fixed-127.0.0.1_8848_nacos/snapshot/DEFAULT_GROUP/nacos-sdk-java-config，配置内容和发布到Nacos Server的配置内容是一致的。

移除配置：boolean removeConfig(String dataId, String group) throws NacosException
支持程序自动发布Nacos配置，配置不存在时会直接返回成功，移除配置后，本地的缓存文件也会被删除

底层源码：

try {
    result = agent.httpDelete(url, null, params, encode, POST_TIMEOUT);
} catch (IOException ioe) {
    log.warn("[remove] error, " + dataId + ", " + group + ", " + tenant + ", msg: " + ioe.toString());
    return false;
}
移除配置同发布配置一样，如果移除后马上查询，有可能还能将刚移除的配置查出来，也存在一定的时延，需要设置等待时间读取。

添加配置监听：void addListener(String dataId, String group, Listener listener) throws NacosException
支持动态监听配置的变化，运行示例源码，在Nacos控制台把配置内容修改为sdk-java-config:change from nacos console，此时观看IDE控制台，你会看到如下打印信息：

当前线程：com.alibaba.nacos.client.Worker.longPollingfixed-127.0.0.1_8848 ,监听到配置内容变化：sdk-java-config:change from nacos console

移除配置监听：void removeListener(String dataId, String group, Listener listener)
移除监听后，配置的变化不会再监听

启动完整示例，运行结果如下，请注意配置监听线程和配置管理线程不是同一个线程

当前线程：main ,服务状态：UP
添加监听
添加监听成功
发布配置
发布配置成功
当前线程：com.alibaba.nacos.client.Worker.longPollingfixed-127.0.0.1_8848 ,监听到配置内容变化：nacos-sdk-java-config:init
当前线程：main ,发布配置后获取配置内容：nacos-sdk-java-config:init
重新发布配置
重新发布配置成功
当前线程：main ,重新发布配置后获取配置内容：sdk-java-config:update
当前线程：com.alibaba.nacos.client.Worker.longPollingfixed-127.0.0.1_8848 ,监听到配置内容变化：sdk-java-config:update
当前线程：com.alibaba.nacos.client.Worker.longPollingfixed-127.0.0.1_8848 ,监听到配置内容变化：sdk-java-config:change from nacos console
移除配置
移除配置成功
当前线程：main ,移除配置后获取配置内容：null
取消监听
取消监听成功
服务管理

创建NamingService，可以通过 NacosFactory.createNamingService() 或 NamingFactory.createNamingService() 来创建，后者是前者的底层实现方式，这两种方式都包含如下两个方法：
createNamingService(serverAddr)
createNamingService(properties)

创建示例：

// 方式一
String serverAddr = "127.0.0.1:8848";
NamingService namingService = NamingFactory.createNamingService(serverAddr);

// 方式二
NamingService namingService = NamingFactory.createNamingService(properties)
Properties properties = new Properties();
properties.put("serverAddr", serverAddr);

查看NamingService类源码，它提供了如下方法：

获取 Nacos Server 当前状态：String getServerStatus()

注册服务实例：void registerInstance(多个参数)

方式一：
String serverIp = "127.0.0.1";
int serverPort = 8848;
String serverAddr = serverIp + ":" + serverPort;
String serviceName = "nacos-sdk-java-discovery";
NamingService namingService = NamingFactory.createNamingService(serverAddr);
namingService.registerInstance(serviceName, serverIp, serverPort);

方式二：
Instance instance = new Instance();
instance.setIp(serverIp);//IP
instance.setPort(serverPort);//端口
instance.setServiceName(serviceName);//服务名
instance.setEnabled(true);//true: 上线 false: 下线
instance.setHealthy(healthy);//健康状态
instance.setWeight(1.0);//权重
instance.addMetadata("nacos-sdk-java-discovery", "true");//元数据
NamingService namingService = NamingFactory.createNamingService(serverAddr);
namingService.registerInstance(serviceName, instance);
注册后，本地会生成缓存文件
1、在Nacos安装目录data目录下：data/naming/data/public/com.alibaba.nacos.naming.domains.meta.public##nacos-sdk-java-discovery
2、当前用户的nacos目录下：/nacos/naming/public/failover/nacos-sdk-java-discovery
3、当前用户的nacos目录下：/nacos/naming/public/nacos-sdk-java-discovery
即使删除服务实例，上面三个缓存文件也不会被删除，Nacos控制台服务列表中该服务也还存在着（但服务实例数会变成0）；删除Nacos控制台的该服务，安全目录data目录下的缓存文件会被删除，但当前用户的nacos目录下的文件不会被删除，这里面是什么机制，我暂时还没整明白，等后面整明白了再来补充。

删除服务实例：void deregisterInstance(多个参数)

获取所有服务实例：List getAllInstances(多个参数)

获取所有健康或不健康的服务实例：List selectInstances(多个参数)

随机获取一个健康实例（根据负载均衡算法）：Instance selectOneHealthyInstance(多个参数)

添加服务实例监听：void subscribe(多个参数)

添加服务实例监听：void unsubscribe(多个参数)

分页获取所有服务实例：ListView getServicesOfServer(多个参数)

获取所有监听的服务实例：List getSubscribeServices()

启动完整示例，运行结果如下，请注意服务实例监听线程和服务实例管理线程不是同一个线程

当前线程：main ,服务状态：UP
注册实例
注册实例成功
添加监听
添加监听成功
当前线程：main ,注册实例后获取所有实例：[{"clusterName":"DEFAULT","enabled":true,"instanceId":"127.0.0.1#8848#DEFAULT#nacos-sdk-java-discovery","ip":"127.0.0.1","metadata":{},"port":8848,"serviceName":"nacos-sdk-java-discovery","valid":true,"weight":1.0}]
当前线程：main ,注册实例后获取所有健康实例：[{"clusterName":"DEFAULT","enabled":true,"instanceId":"127.0.0.1#8848#DEFAULT#nacos-sdk-java-discovery","ip":"127.0.0.1","metadata":{},"port":8848,"serviceName":"nacos-sdk-java-discovery","valid":true,"weight":1.0}]
当前线程：com.alibaba.nacos.naming.client.listener ,监听到实例名称：nacos-sdk-java-discovery
当前线程：com.alibaba.nacos.naming.client.listener ,监听到实例内容：[{"clusterName":"DEFAULT","enabled":true,"instanceId":"127.0.0.1#8848#DEFAULT#nacos-sdk-java-discovery","ip":"127.0.0.1","metadata":{},"port":8848,"serviceName":"nacos-sdk-java-discovery","valid":true,"weight":1.0}]
当前线程：main ,注册实例后获取一个健康实例：{"clusterName":"DEFAULT","enabled":true,"instanceId":"127.0.0.1#8848#DEFAULT#nacos-sdk-java-discovery","ip":"127.0.0.1","metadata":{},"port":8848,"serviceName":"nacos-sdk-java-discovery","valid":true,"weight":1.0}
当前线程：com.alibaba.nacos.naming.client.listener ,监听到实例名称：nacos-sdk-java-discovery
当前线程：com.alibaba.nacos.naming.client.listener ,监听到实例内容：[{"clusterName":"DEFAULT","enabled":true,"instanceId":"127.0.0.1#8848#DEFAULT#nacos-sdk-java-discovery","ip":"127.0.0.1","metadata":{"change":"true;"},"port":8848,"serviceName":"nacos-sdk-java-discovery","valid":true,"weight":2.0}]
取消监听
取消监听成功
删除实例
删除实例成功
Exception in thread "main" java.lang.IllegalStateException: no host to srv for serviceInfo: nacos-sdk-java-discovery
    at com.alibaba.nacos.client.naming.core.Balancer$RandomByWeight.selectAll(Balancer.java:45)
    at com.alibaba.nacos.client.naming.core.Balancer$RandomByWeight.selectHost(Balancer.java:53)
    at com.alibaba.nacos.client.naming.NacosNamingService.selectOneHealthyInstance(NacosNamingService.java:270)
    at com.alibaba.nacos.client.naming.NacosNamingService.selectOneHealthyInstance(NacosNamingService.java:263)
    at com.alibaba.nacos.client.naming.NacosNamingService.selectOneHealthyInstance(NacosNamingService.java:253)
    at com.learn.nacos.discovery.NacosDiscovery.main(NacosDiscovery.java:121)
当前线程：main ,删除实例后获取所有实例：[]
当前线程：main ,删除实例后获取所有健康实例：[]

以上就是 Nacos Java SDK 配置管理和服务管理功能的介绍，请参考示例源码学习。

示例源码

项目：learn-nacos-sdk-java

代码已上传至码云和Github上，欢迎下载学习

Gitee

Github

参考资料

Nacos用户指南：Java的SDK

推荐阅读

Nacos系列：欢迎来到Nacos的世界！

Nacos系列：基于Nacos的注册中心

Nacos系列：基于Nacos的配置中心

GPU云服务器 云服务器 Nacos 阿里云服务器跑nacos卡住 java的使用 java的的使用

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/73379.html

相关文章

  • Nacos系列：Nacos的三种部署模式

    摘要：数据源内嵌的数据库，通过命令直接启动即可，无需额外安装。参考资料部署手册集群部署说明推荐阅读系列欢迎来到的世界系列基于的注册中心系列基于的配置中心系列的使用 三种部署模式 Nacos支持三种部署模式 1、单机模式：可用于测试和单机使用，生产环境切忌使用单机模式（满足不了高可用） 2、集群模式：可用于生产环境，确保高可用 3、多集群模式：可用于多数据中心场景 单机模式 启动 Nacos ...

    vibiu 评论0 收藏0

  • Nacos系列：欢迎来到Nacos的世界！

    摘要：元数据数据如配置和服务描述信息，如服务版本权重容灾策略负载均衡策略鉴权配置各种自定义标签，从作用范围来看，分为服务级别的元信息集群的元信息及实例的元信息。 什么是Nacos? Nacos 是构建以服务为中心的现代应用架构 (例如微服务范式、云原生范式) 的服务基础设施。 Nacos可以做什么？ 1、动态配置服务：支持以中心化、外部化和动态化的方式管理所有环境的配置。动态配置消除了配置变...

    waruqi 评论0 收藏0

  • Nacos（一）：Nacos介绍

    摘要：年月阿里巴巴高级技术专家许真恩慕义发布了首个开源版本，作为的开源实现截止目前已经更新到了的大版本，并且支持大规模生产版本。支持目前几乎所有主流的微服务生态体系。 前言 6月份阿里开源的Nacos出了1.0.1版本，从去年7月份第一个release版本到现在一直在默默关注 官方的版本规划为：Nacos从0.8.0开始支持生产可用，1.0版本可大规模生产可用，2.0版本接入k8s、Spri...

    NicolasHe 评论0 收藏0

  • Nacos系列：基于Nacos的配置中心

    摘要：杀只鸡而已，你拿牛刀来做甚释义小团队小项目选择简单的配置管理方式就好了，要什么配置中心，纯属没事找事。，我就啰嗦到这里吧，下面正式介绍作为配置中心是怎么使用的。 前言 在看正文之前，我想请你回顾一下自己待过的公司都是怎么管理配置的，我想应该会有以下几种方式： 1、硬编码没有什么配置不配置的，直接写在代码里面，比如使用常量类优势：对开发友好，开发清楚地知道代码需要用到什么配置劣势：涉及秘...

    ralap 评论0 收藏0

发表评论

登陆后可评论

0条评论

LinkedME2016

男|高级讲师
我要私信

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<