Bonjour纯JavaScript实现技术文档

Bonjour纯JavaScript实现技术文档

bonjour A Bonjour/Zeroconf protocol implementation in JavaScript 项目地址: https://gitcode.com/gh_mirrors/bo/bonjour

安装指南

要安装此Bonjour库，您需要Node.js环境。通过终端或命令提示符，执行以下命令来添加这个库到您的项目：

npm install bonjour

这将下载并安装bonjour包及其依赖项。

项目使用说明

该库允许您在本地网络上发布和发现服务，利用了多播DNS（mDNS）技术。

发布服务示例：

假设您有一个运行在3000端口上的HTTP服务器，可以这样发布服务：

const bonjour = require('bonjour')();

// 发布HTTP服务
bonjour.publish({
    name: '我的Web服务器',
    type: 'http',
    port: 3000
});

console.log('服务已发布');

发现服务示例：

要查找所有HTTP服务，您可以这样做：

bonjour.find({ type: 'http' }, (service) => {
    console.log('找到HTTP服务器:', service);
});

项目API使用文档

• 初始化

  const bonjour = require('bonjour')([选项]);
  

  其中，选项是可选的，用于初始化底层的多播DNS服务器配置。

• 发布服务

  使用publish()方法发布新服务，详细选项包括服务名、主机名、端口、类型等。

• 取消发布所有服务

  调用unpublishAll([回调函数])取消发布所有服务，并可提供一个回调函数当服务全部取消发布后被调用。

• 销毁实例

  使用destroy()销毁mdns实例并关闭UDP套接字。

• 服务浏览器

  可以通过find()、findOne()等方法监听并发现网络中的服务，支持事件监听如up（服务上线）、down（服务下线），并可以通过浏览器对象操作找到的服务信息。

项目安装方式已涵盖于安装指南部分。

注意事项

• 确保Node.js版本兼容此库。
• IANA维护的服务类型和端口号列表是官方推荐使用的标准。
• 在浏览器环境中不适用，仅适用于Node.js服务器端。

许可证

本项目遵循MIT许可证条款。

以上即是使用bonjour库进行零配置网络服务发布的完整指南，通过简单的API调用，即可轻松地实现服务的网络发现和发布功能。

bonjour A Bonjour/Zeroconf protocol implementation in JavaScript 项目地址: https://gitcode.com/gh_mirrors/bo/bonjour