配置节点

某些节点需要共享配置。例如,MQTT输入和MQTT输出节点共享MQTT代理的配置,使它们能够共用连接。默认情况下,配置节点是全局作用域的,这意味着状态将在不同流之间共享。

定义配置节点

配置节点的定义方式与其他节点相同。主要有两个关键区别:

  1. category 属性设置为 config
  2. 编辑模板元素的ID为node-config-input-

remote-server.html

<script type="text/javascript">
    RED.nodes.registerType('remote-server',{
        category: 'config',
        defaults: {
            host: {value:"localhost",required:true},
            port: {value:1234,required:true,validate:RED.validators.number()},
        },
        label: function() {
            return this.host+":"+this.port;
        }
    });
</script>

<script type="text/html" data-template-name="remote-server">
    <div class="form-row">
        <label for="node-config-input-host"><i class="fa fa-bookmark"></i> Host</label>
        <input type="text" id="node-config-input-host">
    </div>
    <div class="form-row">
        <label for="node-config-input-port"><i class="fa fa-bookmark"></i> Port</label>
        <input type="text" id="node-config-input-port">
    </div>
</script>

remote-server.js

module.exports = function(RED) {
    function RemoteServerNode(n) {
        RED.nodes.createNode(this,n);
        this.host = n.host;
        this.port = n.port;
    }
    RED.nodes.registerType("remote-server",RemoteServerNode);
}

在这个示例中,该节点仅作为配置的简单容器 - 它实际上没有运行时行为。

配置节点的一个常见用途是表示与远程系统的共享连接。在这种情况下,配置节点可能还负责创建连接,并将其提供给使用该配置节点的节点使用。在此类情况下,配置节点还应处理close事件,以便在节点停止时断开连接。

使用配置节点

节点通过在defaults数组中添加一个属性来注册其对配置节点的使用,该属性的type属性设置为配置节点的类型。

defaults: {
   server: {value:"", type:"remote-server"},
},

与其他属性类似,编辑器会在编辑模板中查找一个id为node-input-元素。不同之处在于,编辑器会将该元素替换为一个下拉框,其中填充了可用配置节点的实例,并附带一个用于打开配置节点编辑对话框的按钮。

节点随后可以使用此属性在运行时访问配置节点。

module.exports = function(RED) {
    function MyNode(config) {
        RED.nodes.createNode(this,config);

        // Retrieve the config node
        this.server = RED.nodes.getNode(config.server);

        if (this.server) {
            // Do something with:
            //  this.server.host
            //  this.server.port
        } else {
            // No config node configured
        }
    }
    RED.nodes.registerType("my-node",MyNode);
}