node-rdpjs 技术文档

node-rdpjs 技术文档

node-rdpjs Remote Desktop Protocol for Node.js 项目地址: https://gitcode.com/gh_mirrors/no/node-rdpjs

欢迎来到 node-rdpjs 的详细技术指南。本指南将引导您完成从安装到使用的全过程，以及如何利用此库实现一个简单的远程桌面客户端功能。

安装指南

最新版本安装

通过 npm，您可以轻松安装 node-rdpjs 的稳定版本：

npm install node-rdpjs

开发分支安装

若要获取最新开发中的特性，可以通过 Git 克隆仓库并切换到 dev 分支：

git clone https://github.com/citronneur/node-rdpjs.git
cd node-rdpjs
npm install

项目使用说明

创建 RDP 客户端

使用以下代码片段来实例化一个 RDP 客户端：

const rdp = require('node-rdpjs');
const client = rdp.createClient({
    domain: '您的域',
    userName: '用户名',
    password: '密码',
    enablePerf: true, // 启用性能优化（如禁用壁纸）
    autoLogin: true, // 自动登录
    decompress: false, // 不使用 RLE 算法解压缩位图以提升性能
    screen: { width: 800, height: 600 }, // 屏幕大小
    locale: 'en', // 键盘布局，例如英文布局
    logLevel: 'INFO' // 设置日志级别
});

// 绑定事件处理器
client.on('connect', () => {/* 连接成功处理逻辑 */});
client.on('close', () => {/* 断开连接处理逻辑 */});
client.on('error', err => {/* 错误处理逻辑 */});
client.on('bitmap', bitmap => {/* 处理收到的位图更新 */});

// 连接到远程服务器
client.connect('服务器IP地址', 3389);

参数详解

每个参数都可以根据需要进行调整，以适应不同的连接需求和用户体验。

客户端事件

• connect: 成功建立RDP连接时触发。
• close: 干净地关闭连接时触发。
• error: 协议错误发生时触发。
• bitmap: 收到位图刷新命令时触发，提供位图数据以便在客户端渲染。

用户输入操作

鼠标事件

client.sendPointerEvent(x, y, button, isPressed);

键盘事件

// 使用 Scancode 发送按键事件
client.sendKeyEventScancode(scancode, isPressed);

// 使用 Unicode 字符发送按键事件
client.sendKeyEventUnicode(unicodeChar, isPressed);

API使用文档简述

虽然直接在 README 中未给出详尽API列表，上述示例涵盖了客户端的主要交互方法。实际应用中，需关注每一个事件处理和客户端设置参数的具体作用，灵活配置以满足不同场景下的远程桌面访问需求。

项目安装方式回顾

本部分已涵盖两种主要安装方式：通过npm安装稳定版，以及克隆源码安装开发版。选择适合您项目开发阶段的方式进行部署。

---

本文档为 node-rdpjs 的基础入门和技术简介，深入使用时，建议参考项目源码和进一步的开发者社区讨论。祝您使用愉快！

node-rdpjs Remote Desktop Protocol for Node.js 项目地址: https://gitcode.com/gh_mirrors/no/node-rdpjs