node-red

项目地址： https://github.com/node-red/node-red

官方文档： https://nodered.org/docs/

许可证： Apache-2.0

概述

Node-RED 是构建在 Node.js 之上的低代码事件驱动编程工具，用于把设备、API 和在线服务以「连线」的方式编排成数据流。它最初由 IBM 新兴技术团队发起，现为 OpenJS Foundation 项目，最新版本 5.0.8。运行时以「消息在节点之间传递」为核心模型：每个节点接收一个 JavaScript 对象 msg，处理后交给下一个节点。流（flow）在浏览器中的编辑器里以拖拽方式搭建，保存为 JSON（默认 flows_<hostname>.json）。

关键概念：

• 节点（node）：流的处理单元，分为输入（inject、mqtt in、http in）、处理（function、change、switch、json）、输出（debug、mqtt out、http response）三类
• 消息（msg）：在节点间传递的 JavaScript 对象，约定使用 msg.payload 承载数据，运行时自动附加 _msgid 用于追踪
• 流（flow）/ 标签页（tab）：一组连线的节点，同一标签页共享 flow 级上下文
• 子流程（subflow）：把一组节点折叠成一个可复用节点，暴露属性为环境变量
• 上下文（context）：节点级 / flow 级 / global 级三层状态存储
• 面板（dashboard）：通过 node-red-dashboard 等包把消息渲染成图表、仪表盘等 UI

---

环境准备

要求 Node.js 已安装（受支持的 LTS 版本）。

方式一：npm 全局安装

# 全局安装 Node-RED（Windows 去掉 sudo）
npm install -g --unsafe-perm node-red

# 启动，默认监听 1880 端口
node-red

方式二：Docker

# 镜像名为 nodered/node-red（1.0 起），映射 1880 端口并持久化 /data
docker run -it -p 1880:1880 -v node_red_data:/data --name mynodered nodered/node-red

docker-compose.yml 参考：

version: "3.7"

services:
  node-red:
    image: nodered/node-red:latest
    environment:
      - TZ=Asia/Shanghai
    ports:
      - "1880:1880"
    volumes:
      - node-red-data:/data

volumes:
  node-red-data:

验证

启动后浏览器访问编辑器：http://localhost:1880

默认目录与文件：用户目录 ~/.node-red，流文件 flows_<hostname>.json，配置文件 settings.js。停止服务用 Ctrl-C。

---

核心 API / 命令

消息对象 msg

属性	含义
msg.payload	节点默认操作的数据主体，可为任意 JS 类型（String/Number/Boolean/Array/Object/Buffer/Null）
msg.topic	主题标识，MQTT 节点默认用它作为发布/订阅主题
msg._msgid	运行时自动添加的消息追踪 ID
msg.parts	消息序列元数据（id/index/count），由 split、join、batch 等节点维护

对象类型属性用点路径访问，例如 payload.Phone[2].type。JSON 字符串需先用 JSON 节点解析后才能访问其内部字段。

核心节点速查

节点	类型	说明与关键属性
inject	输入	手动点击或按间隔自动触发；可设置任意消息属性，payload 支持字符串/数字/布尔/JSON/时间戳/上下文值；最大间隔 596 小时
debug	输出	在调试侧栏结构化展示消息，可切换输出到运行时日志或节点状态文本（32 字符）
function	处理	对消息执行 JavaScript 代码
change	处理	无需写代码修改消息/上下文属性；操作按 Set、Change、Move、Delete 顺序执行，值支持 JSONata 表达式
switch	处理	按规则（值、序列、JSONata、Otherwise）把消息路由到不同输出；可匹配多个输出或首个匹配即停
template	处理	用 Mustache 语法生成文本，结果若为合法 JSON/YAML 可解析为对象
mqtt in	输入	订阅主题，输出消息
mqtt out	输出	发布消息到主题
http in	输入	暴露 HTTP 端点，生成 msg.req/msg.res
http response	输出	用 msg.payload 作为响应体返回
http request	处理	主动发起 HTTP 请求