1# MDNS管理 2 3## 简介 4 5MDNS即多播DNS(Multicast DNS),提供局域网内的本地服务添加、移除、发现、解析等能力。 6- 本地服务:局域网内服务的提供方,比如打印机、扫描器等。 7 8MDNS管理的典型场景有: 9 10- 管理本地服务,通过对本地服务的创建,删除和解析等管理本地服务。 11- 发现本地服务,通过DiscoveryService对象,对指定类型的本地服务状态变化进行监听。 12 13> **说明:** 14> 为了保证应用的运行效率,大部分API调用都是异步的,对于异步调用的API均提供了callback和Promise两种方式,以下示例均采用promise函数,更多方式可以查阅[MDNS管理-API参考](../reference/apis-network-kit/js-apis-net-mdns.md)。 15 16以下分别介绍具体开发方式。 17 18## 接口说明 19 20完整的JS API说明以及实例代码请参考:[MDNS管理-API参考](../reference/apis-network-kit/js-apis-net-mdns.md)。 21 22| 接口名 | 描述 | 23| ----------------------- | ---- | 24| addLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback\<LocalServiceInfo>): void | 添加一个MDNS服务,使用callback方式作为异步方法。 | 25| removeLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback\<LocalServiceInfo>): void | 移除一个MDNS服务,使用callback方式作为异步方法。 | 26| createDiscoveryService(context: Context, serviceType: string): DiscoveryService | 返回一个DiscoveryService对象,该对象用于发现指定服务类型的MDNS服务。 | 27| resolveLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback\<LocalServiceInfo>): void | 解析一个MDNS服务,使用callback方式作为异步方法。| 28| startSearchingMDNS(): void | 开始搜索局域网内的MDNS服务。 | 29| stopSearchingMDNS(): void | 停止搜索局域网内的MDNS服务。 | 30| on(type: 'discoveryStart', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void | 订阅开启监听MDNS服务的通知。 | 31| off(type: 'discoveryStart', callback?: Callback<{ serviceInfo: LocalServiceInfo, errorCode?: MdnsError }>): void | 取消开启监听MDNS服务的通知。 | 32| on(type: 'discoveryStop', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void | 订阅停止监听MDNS服务的通知。 | 33| off(type: 'discoveryStop', callback?: Callback<{ serviceInfo: LocalServiceInfo, errorCode?: MdnsError }>): void | 取消停止监听MDNS服务的通知。 | 34| on(type: 'serviceFound', callback: Callback\<LocalServiceInfo>): void | 订阅发现MDNS服务的通知。 | 35| off(type: 'serviceFound', callback?: Callback\<LocalServiceInfo>): void | 取消发现MDNS服务的通知。 | 36| on(type: 'serviceLost', callback: Callback\<LocalServiceInfo>): void | 订阅移除MDNS服务的通知。 | 37| off(type: 'serviceLost', callback?: Callback\<LocalServiceInfo>): void | 取消移除MDNS服务的通知。 | 38 39## 管理本地服务 40 411. 设备连接WiFi。 422. 从@kit.NetworkKit里导入mdns的命名空间。 433. 调用addLocalService方法,添加本地服务。 444. 通过resolveLocalService方法,解析本地网络的IP地址(非必要,根据需求使用)。 455. 通过removeLocalService方法,移除本地服务。 46 47**注意:** 关于示例代码中this的说明:在本文档的示例中,通过this.context来获取UIAbilityContext,其中this代表继承自UIAbility的UIAbility实例。如需在页面中使用UIAbilityContext提供的能力,[请参见获取UIAbility的上下文消息](http://gitee.com/openharmony/docs/blob/222f8d93e6f0056409aac096e041df3fdd8ae5ec/zh-cn/application-dev/application-models/uiability-usage.md)。 48 49```ts 50// 从@kit.NetworkKit中导入mdns命名空间 51import { mdns } from '@kit.NetworkKit'; 52import { BusinessError } from '@kit.BasicServicesKit'; 53import { featureAbility, common } from '@kit.AbilityKit'; 54 55let context: common.UIAbilityContext = this.getUIContext().getHostContext() as common.UIAbilityContext; 56 57class ServiceAttribute { 58 key: string = "111" 59 value: Array<number> = [1] 60} 61 62// 建立LocalService对象 63let localServiceInfo: mdns.LocalServiceInfo = { 64 serviceType: "_print._tcp", 65 serviceName: "servicename", 66 port: 5555, 67 host: { 68 address: "10.14.**.***" 69 }, 70 serviceAttribute: [{key: "111", value: [1]}] 71} 72 73// addLocalService添加本地服务 74mdns.addLocalService(context, localServiceInfo).then((data: mdns.LocalServiceInfo) => { 75 console.log(JSON.stringify(data)); 76}); 77 78// resolveLocalService解析本地服务对象(非必要,根据需求使用) 79mdns.resolveLocalService(context, localServiceInfo).then((data: mdns.LocalServiceInfo) => { 80 console.log(JSON.stringify(data)); 81}); 82 83// removeLocalService移除本地服务 84mdns.removeLocalService(context, localServiceInfo).then((data: mdns.LocalServiceInfo) => { 85 console.log(JSON.stringify(data)); 86}); 87``` 88 89## 发现本地服务 90 911. 设备连接WiFi。 922. 从@kit.NetworkKit里导入mdns的命名空间。 933. 创建DiscoveryService对象,用于发现指定服务类型的MDNS服务。 944. 订阅MDNS服务发现相关状态变化。 955. 启动搜索局域网内的MDNS服务。 966. 停止搜索局域网内的MDNS服务。 977. 取消订阅的MDNS服务。 98 99```ts 100// 从@kit.NetworkKit中导入mdns命名空间 101import { common, featureAbility, UIAbility } from '@kit.AbilityKit'; 102import { mdns } from '@kit.NetworkKit'; 103import { BusinessError } from '@kit.BasicServicesKit'; 104import { window } from '@kit.ArkUI'; 105 106// 构造单例对象 107export class GlobalContext { 108 private constructor() {} 109 private static instance: GlobalContext; 110 private _objects = new Map<string, Object>(); 111 112 public static getContext(): GlobalContext { 113 if (!GlobalContext.instance) { 114 GlobalContext.instance = new GlobalContext(); 115 } 116 return GlobalContext.instance; 117 } 118 119 getObject(value: string): Object | undefined { 120 return this._objects.get(value); 121 } 122 123 setObject(key: string, objectClass: Object): void { 124 this._objects.set(key, objectClass); 125 } 126} 127 128// Stage模型获取context 129class EntryAbility extends UIAbility { 130 value:number = 0; 131 onWindowStageCreate(windowStage: window.WindowStage): void{ 132 GlobalContext.getContext().setObject("value", this.value); 133 } 134} 135 136let context = GlobalContext.getContext().getObject("value") as common.UIAbilityContext; 137 138// 创建DiscoveryService对象,用于发现指定服务类型的MDNS服务 139let serviceType = "_print._tcp"; 140let discoveryService = mdns.createDiscoveryService(context, serviceType); 141 142// 订阅MDNS服务发现相关状态变化 143discoveryService.on('discoveryStart', (data: mdns.DiscoveryEventInfo) => { 144 console.log(JSON.stringify(data)); 145}); 146discoveryService.on('discoveryStop', (data: mdns.DiscoveryEventInfo) => { 147 console.log(JSON.stringify(data)); 148}); 149discoveryService.on('serviceFound', (data: mdns.LocalServiceInfo) => { 150 console.log(JSON.stringify(data)); 151}); 152discoveryService.on('serviceLost', (data: mdns.LocalServiceInfo) => { 153 console.log(JSON.stringify(data)); 154}); 155 156// 启动搜索局域网内的MDNS服务 157discoveryService.startSearchingMDNS(); 158 159// 停止搜索局域网内的MDNS服务 160discoveryService.stopSearchingMDNS(); 161 162// 取消订阅的MDNS服务 163discoveryService.off('discoveryStart', (data: mdns.DiscoveryEventInfo) => { 164 console.log(JSON.stringify(data)); 165}); 166discoveryService.off('discoveryStop', (data: mdns.DiscoveryEventInfo) => { 167 console.log(JSON.stringify(data)); 168}); 169discoveryService.off('serviceFound', (data: mdns.LocalServiceInfo) => { 170 console.log(JSON.stringify(data)); 171}); 172discoveryService.off('serviceLost', (data: mdns.LocalServiceInfo) => { 173 console.log(JSON.stringify(data)); 174}); 175``` 176