如果你也对鸿蒙开发感兴趣,加入“Harmony自习室”吧!扫描下方名片,关注公众号,公众号更新更快,同时也有更多学习资料和技术讨论群。
1、概述
多播DNS也简称MDNS(Multicast DNS),他主要提供局域网内的本地服务管理能力(添加/移除/解析和发现服务)。
❓ 什么是本地服务?
指的是在区域网内服务的提供方,典型的例子有:打印机、扫描器。
需要特别注意的是:由于多播DNS相关的管理都是基于网络,因此大部分情况下,HarmonyOS提供的API都是异步API。
MDNS模块相关的API介绍类图整理如下:
MDNS模块的使用分为两个主要场景:a)管理本地服务(添加/移除/解析);b)发现本地服务。下面这对这两个场景做简单介绍。
2、本地服务的添加/解析/移除
从上面API介绍的类图上可以看到,本地服务管理(添加/移除/解析)的核心API如下:
一般情况下,我们的开发步骤为:
-
设备连接WiFi。
-
从@kit.NetworkKit里导入mdns的命名空间。
-
调用addLocalService方法,添加本地服务。
-
通过resolveLocalService方法,解析本地网络的IP地址(非必要,根据需求使用)。
-
通过removeLocalService方法,移除本地服务。
// 从@kit.NetworkKit中导入mdns命名空间
import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { featureAbility } from '@kit.AbilityKit';
let context = getContext(this) as Context;
class ServiceAttribute {
key: string = "111"
value: Array<number> = [1]
}
// 建立LocalService对象
let localServiceInfo: mdns.LocalServiceInfo = {
serviceType: "_print._tcp",
serviceName: "servicename",
port: 5555,
host: {
address: "10.14.**.***"
},
serviceAttribute: [{key: "111", value: [1]}]
}
// addLocalService添加本地服务
mdns.addLocalService(context, localServiceInfo).then((data: mdns.LocalServiceInfo) => {
console.log(JSON.stringify(data));
});
// resolveLocalService解析本地服务对象(非必要,根据需求使用)
mdns.resolveLocalService(context, localServiceInfo).then((data: mdns.LocalServiceInfo) => {
console.log(JSON.stringify(data));
});
// removeLocalService移除本地服务
mdns.removeLocalService(context, localServiceInfo).then((data: mdns.LocalServiceInfo) => {
console.log(JSON.stringify(data));
});
3、发现本地服务
发现本地服务我们需要借助于 DiscoveryService对象来完成,在上文中,我们看到其核心API如下:
一般情况下,我们的开发步骤为:
-
设备连接WiFi。
-
从@kit.NetworkKit里导入mdns的命名空间。
-
创建DiscoveryService对象,用于发现指定服务类型的MDNS服务。
-
订阅MDNS服务发现相关状态变化。
-
启动搜索局域网内的MDNS服务。
-
停止搜索局域网内的MDNS服务。
-
取消订阅的MDNS服务
// 从@kit.NetworkKit中导入mdns命名空间
import { common, featureAbility, UIAbility } from '@kit.AbilityKit';
import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { window } from '@kit.ArkUI';
// 构造单例对象
export class GlobalContext {
private constructor() {}
private static instance: GlobalContext;
private _objects = new Map<string, Object>();
public static getContext(): GlobalContext {
if (!GlobalContext.instance) {
GlobalContext.instance = new GlobalContext();
}
return GlobalContext.instance;
}
getObject(value: string): Object | undefined {
return this._objects.get(value);
}
setObject(key: string, objectClass: Object): void {
this._objects.set(key, objectClass);
}
}
// Stage模型获取context
class EntryAbility extends UIAbility {
value:number = 0;
onWindowStageCreate(windowStage: window.WindowStage): void{
GlobalContext.getContext().setObject("value", this.value);
}
}
let context = GlobalContext.getContext().getObject("value") as common.UIAbilityContext;
// 创建DiscoveryService对象,用于发现指定服务类型的MDNS服务
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
// 订阅MDNS服务发现相关状态变化
discoveryService.on('discoveryStart', (data: mdns.DiscoveryEventInfo) => {
console.log(JSON.stringify(data));
});
discoveryService.on('discoveryStop', (data: mdns.DiscoveryEventInfo) => {
console.log(JSON.stringify(data));
});
discoveryService.on('serviceFound', (data: mdns.LocalServiceInfo) => {
console.log(JSON.stringify(data));
});
discoveryService.on('serviceLost', (data: mdns.LocalServiceInfo) => {
console.log(JSON.stringify(data));
});
// 启动搜索局域网内的MDNS服务
discoveryService.startSearchingMDNS();
// 停止搜索局域网内的MDNS服务
discoveryService.stopSearchingMDNS();
// 取消订阅的MDNS服务
discoveryService.off('discoveryStart', (data: mdns.DiscoveryEventInfo) => {
console.log(JSON.stringify(data));
});
discoveryService.off('discoveryStop', (data: mdns.DiscoveryEventInfo) => {
console.log(JSON.stringify(data));
});
discoveryService.off('serviceFound', (data: mdns.LocalServiceInfo) => {
console.log(JSON.stringify(data));
});
discoveryService.off('serviceLost', (data: mdns.LocalServiceInfo) => {
console.log(JSON.stringify(data));
});
4、错误码
我们在管理MDNS服务时,不可避免的会出现错误等异常场景,下面介绍常见的错误场景以及其错误码。
4.1 添加服务
我们调用 mdns.addLocalService时,可能会发生失败,失败时,callback函数将把error信息传递过来,示例如下(17 ~ 20行):
import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 获取context
let context = getContext(this) as Context;
let localServiceInfo: mdns.LocalServiceInfo = {
serviceType: "_print._tcp",
serviceName: "servicename",
port: 5555,
host: {
address: "10.14.**.***",
},
serviceAttribute: [{key: "111", value: [1]}]
}
mdns.addLocalService(context, localServiceInfo, (error:BusinessError, data:mdns.LocalServiceInfo) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
如果发生错误,可能出现的错误码有:
401 | 参数错误 |
2100002 | 设备连接失败 |
2100003 | 系统内部错误 |
2204003 | 重复callback注册 |
2204008 | 删除服务实例失败 |
2204010 | 发送消息失败 |
4.2 删除服务
删除服务时可能发生错误,示例如下:
import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 获取context
let context = getContext(this) as Context;
let localServiceInfo: mdns.LocalServiceInfo = {
serviceType: "_print._tcp",
serviceName: "servicename",
port: 5555,
host: {
address: "10.14.**.***",
},
serviceAttribute: [{key: "111", value: [1]}]
}
mdns.removeLocalService(context, localServiceInfo, (error: BusinessError, data: mdns.LocalServiceInfo) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
如果发生错误,可能出现的错误码有:
401 | 参数错误 |
2100002 | 设备连接失败 |
2100003 | 系统内部错误 |
2204002 | 回调callback失败 (区别于addLocalService) |
2204008 | 删除服务实例失败 |
2204010 | 发送消息失败 |
4.3 解析服务
import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';
// 获取context
let context = getContext(this) as Context;
let localServiceInfo: mdns.LocalServiceInfo = {
serviceType: "_print._tcp",
serviceName: "servicename",
port: 5555,
host: {
address: "10.14.**.***",
},
serviceAttribute: [{key: "111", value: [1]}]
}
mdns.resolveLocalService(context, localServiceInfo, (error: BusinessError, data: mdns.LocalServiceInfo) => {
console.log(JSON.stringify(error));
console.log(JSON.stringify(data));
});
如果发生错误,可能出现的错误码有:
401 | 参数错误 |
2100002 | 设备连接失败 |
2100003 | 系统内部错误 |
2204003 | 重复callback注册 |
2204006 | 请求超时 |
2204010 | 发送消息失败 |