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```ts
48// 从@kit.NetworkKit中导入mdns命名空间
49import { mdns } from '@kit.NetworkKit';
50import { BusinessError } from '@kit.BasicServicesKit';
51import { featureAbility } from '@kit.AbilityKit';
52
53let context = getContext(this) as Context;
54
55class ServiceAttribute {
56  key: string = "111"
57  value: Array<number> = [1]
58}
59
60// 建立LocalService对象
61let localServiceInfo: mdns.LocalServiceInfo = {
62  serviceType: "_print._tcp",
63  serviceName: "servicename",
64  port: 5555,
65  host: {
66    address: "10.14.**.***"
67  },
68  serviceAttribute: [{key: "111", value: [1]}]
69}
70
71// addLocalService添加本地服务
72mdns.addLocalService(context, localServiceInfo).then((data: mdns.LocalServiceInfo) => {
73  console.log(JSON.stringify(data));
74});
75
76// resolveLocalService解析本地服务对象（非必要，根据需求使用）
77mdns.resolveLocalService(context, localServiceInfo).then((data: mdns.LocalServiceInfo) => {
78  console.log(JSON.stringify(data));
79});
80
81// removeLocalService移除本地服务
82mdns.removeLocalService(context, localServiceInfo).then((data: mdns.LocalServiceInfo) => {
83  console.log(JSON.stringify(data));
84});
85```
86
87## 发现本地服务
88
891. 设备连接WiFi。
902. 从@kit.NetworkKit里导入mdns的命名空间。
913. 创建DiscoveryService对象，用于发现指定服务类型的MDNS服务。
924. 订阅MDNS服务发现相关状态变化。
935. 启动搜索局域网内的MDNS服务。
946. 停止搜索局域网内的MDNS服务。
957. 取消订阅的MDNS服务。
96
97```ts
98// 从@kit.NetworkKit中导入mdns命名空间
99import { common, featureAbility, UIAbility } from '@kit.AbilityKit';
100import { mdns } from '@kit.NetworkKit';
101import { BusinessError } from '@kit.BasicServicesKit';
102import { window } from '@kit.ArkUI';
103
104// 构造单例对象
105export class GlobalContext {
106  private constructor() {}
107  private static instance: GlobalContext;
108  private _objects = new Map<string, Object>();
109
110  public static getContext(): GlobalContext {
111    if (!GlobalContext.instance) {
112      GlobalContext.instance = new GlobalContext();
113    }
114    return GlobalContext.instance;
115  }
116
117  getObject(value: string): Object | undefined {
118    return this._objects.get(value);
119  }
120
121  setObject(key: string, objectClass: Object): void {
122    this._objects.set(key, objectClass);
123  }
124}
125
126// Stage模型获取context
127class EntryAbility extends UIAbility {
128  value:number = 0;
129  onWindowStageCreate(windowStage: window.WindowStage): void{
130    GlobalContext.getContext().setObject("value", this.value);
131  }
132}
133
134let context = GlobalContext.getContext().getObject("value") as common.UIAbilityContext;
135
136// 创建DiscoveryService对象，用于发现指定服务类型的MDNS服务
137let serviceType = "_print._tcp";
138let discoveryService = mdns.createDiscoveryService(context, serviceType);
139
140// 订阅MDNS服务发现相关状态变化
141discoveryService.on('discoveryStart', (data: mdns.DiscoveryEventInfo) => {
142  console.log(JSON.stringify(data));
143});
144discoveryService.on('discoveryStop', (data: mdns.DiscoveryEventInfo) => {
145  console.log(JSON.stringify(data));
146});
147discoveryService.on('serviceFound', (data: mdns.LocalServiceInfo) => {
148  console.log(JSON.stringify(data));
149});
150discoveryService.on('serviceLost', (data: mdns.LocalServiceInfo) => {
151  console.log(JSON.stringify(data));
152});
153
154// 启动搜索局域网内的MDNS服务
155discoveryService.startSearchingMDNS();
156
157// 停止搜索局域网内的MDNS服务
158discoveryService.stopSearchingMDNS();
159
160// 取消订阅的MDNS服务
161discoveryService.off('discoveryStart', (data: mdns.DiscoveryEventInfo) => {
162  console.log(JSON.stringify(data));
163});
164discoveryService.off('discoveryStop', (data: mdns.DiscoveryEventInfo) => {
165  console.log(JSON.stringify(data));
166});
167discoveryService.off('serviceFound', (data: mdns.LocalServiceInfo) => {
168  console.log(JSON.stringify(data));
169});
170discoveryService.off('serviceLost', (data: mdns.LocalServiceInfo) => {
171  console.log(JSON.stringify(data));
172});
173```
174