16、Java的SDK

概述部分

Maven 坐标

<dependency> 
<groupId>com.alibaba.nacos</groupId> 
<artifactId>nacos-client</artifactId> 
<version>${version}</version> 
</dependency> 

配置管理

获取配置

描述

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

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

请求参数

返回值

请求示例

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(); 
} 

异常说明

读取配置超时或网络异常，抛出 NacosException 异常。

监听配置

描述

如果希望 Nacos 推送配置变更，可以使用 Nacos 动态监听配置接口来实现。

public void addListener(String dataId, String group, Listener listener) 

请求参数

返回值

请求示例

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); 
configService.addListener(dataId, group, new Listener() { 
    @Override 
    public void receiveConfigInfo(String configInfo) { 
        System.out.println("recieve1:" + configInfo); 
    } 
    @Override 
    public Executor getExecutor() { 
        return null; 
    } 
}); 

// 测试让主线程不退出，因为订阅配置是守护线程，主线程退出守护线程就会退出。 正式代码中无需下面代码 
while (true) { 
    try { 
        Thread.sleep(1000); 
    } catch (InterruptedException e) { 
        e.printStackTrace(); 
    } 
} 

删除监听

描述

取消监听配置，取消监听后配置不会再推送。

public void removeListener(String dataId, String group, Listener listener) 

请求参数

使用示例

String serverAddr = "{serverAddr}"; 
String dataId = "{dataId}"; 
String group = "{group}"; 
Properties properties = new Properties(); 
properties.put("serverAddr", serverAddr); 
ConfigService configService = NacosFactory.createConfigService(properties); 
configService.removeListener(dataId, group, yourListener); 

发布配置

描述

用于通过程序自动发布 Nacos 配置，以便通过自动化手段降低运维成本。

**注意：**创建和修改配置时使用的同一个发布接口，当配置不存在时会创建配置，当配置已存在时会更新配置。

public boolean publishConfig(String dataId, String group, String content) throws NacosException 

请求参数

返回参数

请求示例

try { 
    // 初始化配置服务，控制台通过示例代码自动获取下面参数 
    String serverAddr = "{serverAddr}"; 
    String dataId = "{dataId}"; 
    String group = "{group}"; 
    Properties properties = new Properties(); 
    properties.put("serverAddr", serverAddr); 
    ConfigService configService = NacosFactory.createConfigService(properties); 
    boolean isPublishOk = configService.publishConfig(dataId, group, "content"); 
    System.out.println(isPublishOk); 
} catch (NacosException e) { 
    // TODO Auto-generated catch block 
    e.printStackTrace(); 
} 

异常说明

读取配置超时或网络异常，抛出 NacosException 异常。

删除配置

描述

用于通过程序自动删除 Nacos 配置，以便通过自动化手段降低运维成本。

注意： 当配置已存在时会删除该配置，当配置不存在时会直接返回成功消息。

public boolean removeConfig(String dataId, String group) throws NacosException 

请求参数

返回参数

请求示例

try { 
    // 初始化配置服务，控制台通过示例代码自动获取下面参数 
    String serverAddr = "{serverAddr}"; 
    String dataId = "{dataId}"; 
    String group = "{group}"; 
    Properties properties = new Properties(); 
    properties.put("serverAddr", serverAddr); 

    ConfigService configService = NacosFactory.createConfigService(properties); 
    boolean isRemoveOk = configService.removeConfig(dataId, group); 
    System.out.println(isRemoveOk); 
} catch (NacosException e) { 
    // TODO Auto-generated catch block 
    e.printStackTrace(); 
} 

异常说明

读取配置超时或网络异常，抛出 NacosException 异常。

服务发现SDK

注册实例

描述注册一个实例到服务。

void registerInstance(String serviceName, String ip, int port) throws NacosException; 

void registerInstance(String serviceName, String ip, int port, String clusterName) throws NacosException; 

void registerInstance(String serviceName, Instance instance) throws NacosException; 

请求参数

返回参数

无

请求示例

NamingService naming = NamingFactory.createNamingService(System.getProperty("serveAddr")); 
naming.registerInstance("nacos.test.3", "11.11.11.11", 8888, "TEST1"); 

Instance instance = new Instance(); 
instance.setIp("55.55.55.55"); 
instance.setPort(9999); 
instance.setHealthy(false); 
instance.setWeight(2.0); 
Map<String, String> instanceMeta = new HashMap<>(); 
instanceMeta.put("site", "et2"); 
instance.setMetadata(instanceMeta); 

Service service = new Service("nacos.test.4"); 
service.setApp("nacos-naming"); 
service.sethealthCheckMode("server"); 
service.setEnableHealthCheck(true); 
service.setProtectThreshold(0.8F); 
service.setGroup("CNCF"); 
Map<String, String> serviceMeta = new HashMap<>(); 
serviceMeta.put("symmetricCall", "true"); 
service.setMetadata(serviceMeta); 
instance.setService(service); 

Cluster cluster = new Cluster(); 
cluster.setName("TEST5"); 
AbstractHealthChecker.Http healthChecker = new AbstractHealthChecker.Http(); 
healthChecker.setExpectedResponseCode(400); 
healthChecker.setCurlHost("USer-Agent|Nacos"); 
healthChecker.setCurlPath("/xxx.html"); 
cluster.setHealthChecker(healthChecker); 
Map<String, String> clusterMeta = new HashMap<>(); 
clusterMeta.put("xxx", "yyyy"); 
cluster.setMetadata(clusterMeta); 

instance.setCluster(cluster); 

naming.registerInstance("nacos.test.4", instance); 

注销实例

描述

删除服务下的一个实例。

void deregisterInstance(String serviceName, String ip, int port) throws NacosException; 

void deregisterInstance(String serviceName, String ip, int port, String clusterName) throws NacosException; 

请求参数

返回参数

无

请求示例

NamingService naming = NamingFactory.createNamingService(System.getProperty("serveAddr")); 
naming.deregisterInstance("nacos.test.3", "11.11.11.11", 8888, "DEFAULT"); 

获取全部实例

描述

获取服务下的所有实例。

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

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

请求参数

返回参数

List 实例列表。

请求示例

NamingService naming = NamingFactory.createNamingService(System.getProperty("serveAddr")); 
System.out.println(naming.getAllInstances("nacos.test.3")); 

获取健康或不健康实例列表

描述

根据条件获取过滤后的实例列表。

List<Instance> selectInstances(String serviceName, boolean healthy) throws NacosException; 

List<Instance> selectInstances(String serviceName, List<String> clusters, boolean healthy) throws NacosException; 

请求参数

返回参数

List 实例列表。

请求示例

NamingService naming = NamingFactory.createNamingService(System.getProperty("serveAddr")); 
System.out.println(naming.selectInstances("nacos.test.3", true)); 

获取一个健康实例

描述

根据负载均衡算法随机获取一个健康实例。

Instance selectOneHealthyInstance(String serviceName) throws NacosException; 

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

请求参数

返回参数

Instance 实例。

请求示例

NamingService naming = NamingFactory.createNamingService(System.getProperty("serveAddr")); 
System.out.println(naming.selectOneHealthyInstance("nacos.test.3")); 

监听服务

描述

监听服务下的实例列表变化。

void subscribe(String serviceName, EventListener listener) throws NacosException; 

void subscribe(String serviceName, List<String> clusters, EventListener listener) throws NacosException; 

请求参数

返回参数

无

请求示例

NamingService naming = NamingFactory.createNamingService(System.getProperty("serveAddr")); 
naming.subscribe("nacos.test.3", event -> { 
    if (event instanceof NamingEvent) { 
        System.out.println(((NamingEvent) event).getServceName()); 
        System.out.println(((NamingEvent) event).getInstances()); 
    } 
}); 

取消监听服务

描述

取消监听服务下的实例列表变化。

void unsubscribe(String serviceName, EventListener listener) throws NacosException; 

void unsubscribe(String serviceName, List<String> clusters, EventListener listener) throws NacosException; 

请求参数

返回参数

无

请求示例

NamingService naming = NamingFactory.createNamingService(System.getProperty("serveAddr")); 
naming.unsubscribe("nacos.test.3", event -> {}); 

版权声明：「DDKK.COM 弟弟快看，程序员编程资料站」本站文章，版权归原作者所有