MDNS即多播DNS(Multicast DNS),提供局域网内的本地服务添加、移除、发现、解析等能力。

说明

本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import { mdns } from '@kit.NetworkKit';

mdns.addLocalService

addLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback): void

添加一个mDNS服务,使用callback方式作为异步方法。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
contextContext是应用的上下文。FA模型的应用Context定义见[Context]。Stage模型的应用Context定义见[Context]。
serviceInfo[LocalServiceInfo]是mDNS服务的信息。
callbackAsyncCallback<[LocalServiceInfo]>是回调函数。成功添加error为undefined,data为添加到本地的mdns服务信息。

错误码:

错误码ID错误信息
401Parameter error.
2100002Failed to connect to the service.
2100003System internal error.
2204003Callback duplicated.
2204008Failed to delete the service instance.
2204010Failed to send the message.

示例:

Stage模型示例:

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

mdns.addLocalService

addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise

添加一个mDNS服务,使用Promise方式作为异步方法。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
contextContext是应用的上下文。FA模型的应用Context定义见[Context]。Stage模型的应用Context定义见[Context]。
serviceInfo[LocalServiceInfo]是mDNS服务的信息。

返回值:

类型说明
Promise<[LocalServiceInfo]>以Promise形式返回添加的mdns服务信息。

错误码:

错误码ID错误信息
401Parameter error.
2100002Failed to connect to the service.
2100003System internal error.
2204003Callback duplicated.
2204008Failed to delete the service instance.
2204010Failed to send the message.

示例:

Stage模型示例:

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).then((data: mdns.LocalServiceInfo) => {
  console.log(JSON.stringify(data));
});

mdns.removeLocalService

removeLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback): void

移除一个mDNS服务,使用callback方式作为异步方法。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Communication.NetManager.MDNS

参数

参数名类型必填说明
contextContext是应用的上下文。FA模型的应用Context定义见[Context]。Stage模型的应用Context定义见[Context]。
serviceInfo[LocalServiceInfo]是mDNS服务的信息。
callbackAsyncCallback<[LocalServiceInfo]>是回调函数。成功移除error为undefined,data为移除本地的mdns服务信息。

错误码:

错误码ID错误信息
401Parameter error.
2100002Failed to connect to the service.
2100003System internal error.
2204002Callback not found.
2204008Failed to delete the service instance.
2204010Failed to send the message.

示例:

Stage模型示例:

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).then((data: mdns.LocalServiceInfo) => {
  console.log(JSON.stringify(data));
});

mdns.removeLocalService

removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise

移除一个mDNS服务. 使用Promise方式作为异步方法。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Communication.NetManager.MDNS

参数

参数名类型必填说明
contextContext是应用的上下文。FA模型的应用Context定义见[Context]。Stage模型的应用Context定义见[Context]。
serviceInfo[LocalServiceInfo]是mDNS服务的信息。

返回值:

类型说明
Promise<[LocalServiceInfo]>以Promise形式返回移除的mdns服务信息。

错误码:

错误码ID错误信息
401Parameter error.
2100002Failed to connect to the service.
2100003System internal error.
2204002Callback not found.
2204008Failed to delete the service instance.
2204010Failed to send the message.

示例:

Stage模型示例:

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

mdns.createDiscoveryService

createDiscoveryService(context: Context, serviceType: string): DiscoveryService

返回一个DiscoveryService对象,该对象用于发现指定服务类型的mDNS服务。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
contextContext是应用的上下文。FA模型的应用Context定义见[Context]。Stage模型的应用Context定义见[Context]。
serviceTypestring是需要发现的mDNS服务类型。

返回值:

TypeDescription
DiscoveryService基于指定serviceType和Context的发现服务对象。

错误码:

错误码ID错误信息
401Parameter error.

示例

Stage模型示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

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).then((data: mdns.LocalServiceInfo) => {
  console.log(JSON.stringify(data));
});

mdns.resolveLocalService

resolveLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback): void

解析一个mDNS服务,使用callback方式作为异步方法。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
contextContext是应用的上下文。FA模型的应用Context定义见[Context]。Stage模型的应用Context定义见[Context]。
serviceInfo[LocalServiceInfo]是mDNS服务的信息。
callbackAsyncCallback<[LocalServiceInfo]>是回调函数。成功移除error为undefined,data为解析的mdns服务信息。

错误码:

错误码ID错误信息
401Parameter error.
2100002Failed to connect to the service.
2100003System internal error.
2204003Callback duplicated.
2204006Request timeout.
2204010Failed to send the message.

示例:

Stage模型示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 获取context
let context = getContext(this) as Context;

let serviceType = "_print._tcp";
let discoveryService : Object = mdns.createDiscoveryService(context, serviceType);

mdns.resolveLocalService

resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise

解析一个mDNS服务,使用Promise方式作为异步方法。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
contextContext是应用的上下文。FA模型的应用Context定义见[Context]。Stage模型的应用Context定义见[Context]。
serviceInfo[LocalServiceInfo]是mDNS服务的信息。

返回值:

类型说明
Promise<[LocalServiceInfo]>以Promise形式返回解析的mDNS服务信息。

错误码:

错误码ID错误信息
401Parameter error.
2100002Failed to connect to the service.
2100003System internal error.
2204003Callback duplicated.
2204006Request timeout.
2204010Failed to send the message.

示例:

Stage模型示例:

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).then((data: mdns.LocalServiceInfo) => {
  console.log(JSON.stringify(data));
});

DiscoveryService

指定服务类型的发现服务对象。

startSearchingMDNS

startSearchingMDNS(): void

开始搜索局域网内的mDNS服务。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

示例:

Stage模型示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 获取context
let context = getContext(this) as Context;
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();

stopSearchingMDNS

stopSearchingMDNS(): void

停止搜索局域网内的mDNS服务。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

示例:

Stage模型示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 获取context
let context = getContext(this) as Context;
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.stopSearchingMDNS();

on(‘discoveryStart’)

on(type: ‘discoveryStart’, callback: Callback): void

订阅开启监听mDNS服务的通知。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
typestring是订阅事件,固定为’discoveryStart’。discoveryStart:开始搜索局域网内的mDNS服务事件。
callbackCallback是mDNS服务的信息和事件错误信息。

示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 参考mdns.createDiscoveryService
let context = getContext(this) as Context;
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();

discoveryService.on('discoveryStart', (data: mdns.DiscoveryEventInfo) => {
  console.log(JSON.stringify(data));
});

discoveryService.stopSearchingMDNS();

off(‘discoveryStart’)

off(type: ‘discoveryStart’, callback?: Callback): void

取消开启监听mDNS服务的通知。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
typestring是取消订阅的事件,固定为’discoveryStart’。discoveryStart:开始搜索局域网内的mDNS服务事件。
callbackCallback否mDNS服务的信息和事件错误信息。

示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 参考mdns.createDiscoveryService
let context = getContext(this) as Context;
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();

discoveryService.on('discoveryStart', (data: mdns.DiscoveryEventInfo) => {
  console.log(JSON.stringify(data));
});

discoveryService.stopSearchingMDNS();

discoveryService.off('discoveryStart', (data: mdns.DiscoveryEventInfo) => {
  console.log(JSON.stringify(data));
});

on(‘discoveryStop’)

on(type: ‘discoveryStop’, callback: Callback): void

订阅停止监听mDNS服务的通知。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
typestring是订阅事件,固定为’discoveryStop’。discoveryStop:停止搜索局域网内的mDNS服务事件。
callbackCallback是mDNS服务的信息和事件错误信息。

示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 参考mdns.createDiscoveryService
let context = getContext(this) as Context;
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();

discoveryService.on('discoveryStop', (data: mdns.DiscoveryEventInfo) => {
  console.log(JSON.stringify(data));
});

discoveryService.stopSearchingMDNS();

off(‘discoveryStop’)

off(type: ‘discoveryStop’, callback?: Callback): void

取消订阅停止监听mDNS服务的通知。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
typestring是取消订阅的事件’discoveryStop’。discoveryStop:停止搜索局域网内的mDNS服务事件。
callbackCallback否mDNS服务的信息和事件错误信息。

示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 参考mdns.createDiscoveryService
let context = getContext(this) as Context;
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();

discoveryService.on('discoveryStop', (data: mdns.DiscoveryEventInfo) => {
  console.log(JSON.stringify(data));
});

discoveryService.stopSearchingMDNS();

discoveryService.off('discoveryStop', (data: mdns.DiscoveryEventInfo) => {
  console.log(JSON.stringify(data));
});

on(‘serviceFound’)

on(type: ‘serviceFound’, callback: Callback): void

订阅发现mDNS服务的通知。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
typestring是订阅事件,固定为’serviceFound’。serviceFound:发现mDNS服务事件。
callbackCallback<[LocalServiceInfo]>是mDNS服务的信息,需调用resolveLocalService解析这个mDNS服务信息。

示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 参考mdns.createDiscoveryService
let context = getContext(this) as Context;
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();

discoveryService.on('serviceFound', (data: mdns.LocalServiceInfo) => {
  console.info('serviceFound', JSON.stringify(data));
  mdns.resolveLocalService(context, data, (error: BusinessError, resolveData: mdns.LocalServiceInfo) =>  {
    console.info('serviceFound', JSON.stringify(resolveData));
  });
});

discoveryService.stopSearchingMDNS();

off(‘serviceFound’)

off(type: ‘serviceFound’, callback?: Callback): void

取消订阅发现mDNS服务的通知。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
typestring是取消订阅的事件,固定为’serviceFound’。serviceFound:发现mDNS服务事件。
callbackCallback<[LocalServiceInfo]>否mDNS服务的信息。

示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 参考mdns.createDiscoveryService
let context = getContext(this) as Context;
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();

discoveryService.on('serviceFound', (data: mdns.LocalServiceInfo) => {
  console.info('serviceFound', JSON.stringify(data));
  mdns.resolveLocalService(context, data, (error: BusinessError, resolveData: mdns.LocalServiceInfo) =>  {
    console.info('serviceFound', JSON.stringify(resolveData));
  });
});

discoveryService.stopSearchingMDNS();

discoveryService.off('serviceFound', (data: mdns.LocalServiceInfo) => {
  console.log(JSON.stringify(data));
});

on(‘serviceLost’)

on(type: ‘serviceLost’, callback: Callback): void

订阅移除mDNS服务的通知。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
typestring是订阅事件,固定为’serviceLost’。serviceLost:移除mDNS服务事件。
callbackCallback<[LocalServiceInfo]>是mDNS服务的信息。

示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 参考mdns.createDiscoveryService
let context = getContext(this) as Context;
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();

discoveryService.on('serviceLost', (data: mdns.LocalServiceInfo) => {
  console.log(JSON.stringify(data));
});

discoveryService.stopSearchingMDNS();

off(‘serviceLost’)

off(type: ‘serviceLost’, callback?: Callback): void

取消订阅移除mDNS服务的通知。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

参数:

参数名类型必填说明
typestring是取消订阅的事件,固定为’serviceLost’。serviceLost:移除mDNS服务事件。
callbackCallback<[LocalServiceInfo]>否mDNS服务的信息。

示例:

import { mdns } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

// 参考mdns.createDiscoveryService
let context = getContext(this) as Context;
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
discoveryService.startSearchingMDNS();

discoveryService.on('serviceLost', (data: mdns.LocalServiceInfo) => {
  console.log(JSON.stringify(data));
});

discoveryService.stopSearchingMDNS();

discoveryService.off('serviceLost', (data: mdns.LocalServiceInfo) => {
  console.log(JSON.stringify(data));
});

LocalServiceInfo

mDNS服务信息

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

名称类型必填说明
serviceTypestring是mDNS服务的类型。格式_.<_tcp/_udp>,name长度小于63字符并且不能包含字符’.'。
serviceNamestring是mDNS服务的名字。
portnumber否mDNS服务的端口号。
host[NetAddress]否mDNS服务设备的IP地址。采用设备的IP,添加服务和移除服务时候不生效。
serviceAttributeArray<[ServiceAttribute]>否mDNS服务属性信息。

ServiceAttribute

mDNS服务属性信息

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

名称类型必填说明
keystring是mDNS服务属性键值,键值长度应该小于9个字符。
valueArray是mDNS服务属性值。

DiscoveryEventInfo11+

监听到的mDNS服务事件信息

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

名称类型必填说明
serviceInfoLocalServiceInfo是mDNS服务信息。
errorCodeMdnsError否mDNS错误信息。

MdnsError

mDNS错误信息。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.MDNS

名称值说明
INTERNAL_ERROR0内部错误导致操作失败。
ALREADY_ACTIVE1服务已经存在导致操作失败。
MAX_LIMIT2请求超过最大限制导致操作失败。

NetAddress

type NetAddress = connection.NetAddress

获取网络地址。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

系统能力:SystemCapability.Communication.NetManager.Core

类型说明
connection.NetAddress定义网络地址。

最后呢

很多开发朋友不知道需要学习那些鸿蒙技术?鸿蒙开发岗位需要掌握那些核心技术点?为此鸿蒙的开发学习必须要系统性的进行。

而网上有关鸿蒙的开发资料非常的少,假如你想学好鸿蒙的应用开发与系统底层开发。你可以参考这份资料,少走很多弯路,节省没必要的麻烦。由两位前阿里高级研发工程师联合打造的《鸿蒙NEXT星河版OpenHarmony开发文档》里面内容包含了(ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、Harmony南向开发、鸿蒙项目实战等等)鸿蒙(Harmony NEXT)技术知识点

如果你是一名Android、Java、前端等等开发人员,想要转入鸿蒙方向发展。可以直接领取这份资料辅助你的学习。下面是鸿蒙开发的学习路线图。

在这里插入图片描述

针对鸿蒙成长路线打造的鸿蒙学习文档。话不多说,我们直接看详细鸿蒙(OpenHarmony )手册(共计1236页)与鸿蒙(OpenHarmony )开发入门视频,帮助大家在技术的道路上更进一步。

  • 《鸿蒙 (OpenHarmony)开发学习视频》
  • 《鸿蒙生态应用开发V2.0白皮书》
  • 《鸿蒙 (OpenHarmony)开发基础到实战手册》
  • OpenHarmony北向、南向开发环境搭建
  • 《鸿蒙开发基础》
  • 《鸿蒙开发进阶》
  • 《鸿蒙开发实战》

在这里插入图片描述

总结

鸿蒙—作为国家主力推送的国产操作系统。部分的高校已经取消了安卓课程,从而开设鸿蒙课程;企业纷纷跟进启动了鸿蒙研发。

并且鸿蒙是完全具备无与伦比的机遇和潜力的;预计到年底将有 5,000 款的应用完成原生鸿蒙开发,未来将会支持 50 万款的应用。那么这么多的应用需要开发,也就意味着需要有更多的鸿蒙人才。鸿蒙开发工程师也将会迎来爆发式的增长,学习鸿蒙势在必行! 自↓↓↓拿
1

Logo

讨论HarmonyOS开发技术,专注于API与组件、DevEco Studio、测试、元服务和应用上架分发等。

更多推荐