polymer - 使用 Polymer 在同一 Web 组件的实例之间进行通信的最佳方式?

标签 polymer polymer-1.0 web-component polymer-2.x

我正在尝试在同一元素的实例之间同步我的一些 Web 组件属性,因此,如果其中一个属性发生更改,那么在所有实例中,相同的属性都会使用相应的绑定(bind)和事件进行更新。

注:我想使用 Polymer Data System Concepts用于实例之间的通信。

例子

我的元素.html

<dom-module id="my-element">
  <script>
    Polymer({
      is: 'my-element',

      properties: {
        myProp: {
          type: String,
          notify: true
      }
    });
  </script>
</dom-module>

我的其他元素.html
<dom-module id="my-other-element">
  <template>
    <my-element my-prop="{{otherProp}}"></my-element>
  </template>
  <script>
    Polymer({
      is: 'my-other-element',
      properties: {
        otherProp: {
          type: String,
          notify: true,
          readOnly: true
        }
      }
    })
  </script>
</dom-module>

我的应用程序.html
<dom-module id="my-app">
  <template>
    <my-element id="element"></my-element>
    <my-other-element id="otherElement"
      on-other-prop-changed="onPropChanged"
    ></my-other-element>
  </template>
  <script>
    Polymer({
      is: 'my-app',

      attached: function () {
        // should set 'myProp' to 'test' and trigger
        // the event 'my-prop-changed' in all my-element instances
        this.$.element.myProp = 'test'
      },

      onPropChanged: function (ev, detail) {
        console.log(detail.value); // should print 'test'
        console.log(this.$.element.myProp); // should print 'test'
        console.log(this.$.otherElement.otherProp); // should print 'test'
      }
    });
  </script>
</dom-module>

PD:使用类似标准的模式和良好实践会很好。

最佳答案

tl;博士

我创建了一个自定义行为,它同步所有具有 notify: true 的元素的属性.工作原型(prototype):JSBin .

目前,这个原型(prototype)不区分不同种类的元素,这意味着它只能同步相同自定义元素的实例——但这可以毫不费力地改变。

您还可以定制行为,以便仅同步所需的属性,而不仅仅是与 notify: true 同步。 .但是,如果您采用此路径,请注意您要同步的所有属性必须具有 notify: true , 因为行为听 <property-name>-changed事件,仅当属性具有 notify: true 时才会触发.

细节

让我们从自定义 SyncBehavior 开始行为:

(function() {
    var SyncBehaviorInstances = [];
    var SyncBehaviorLock = false;

    SyncBehavior = {
        attached: function() {
            // Add instance
            SyncBehaviorInstances.push(this);

            // Add listeners
            for(var property in this.properties) {
                if('notify' in this.properties[property] && this.properties[property].notify) {
                    // Watch all properties with notify = true
                    var eventHanler = this._eventHandlerForPropertyType(this.properties[property].type.name);
                    this.listen(this, Polymer.CaseMap.camelToDashCase(property) + '-changed', eventHanler);
                }
            }
        },

        detached: function() {
            // Remove instance
            var index = SyncBehaviorInstances.indexOf(this);
            if(index >= 0) {
                SyncBehaviorInstances.splice(index, 1);
            }

            // Remove listeners
            for(var property in this.properties) {
                if('notify' in this.properties[property] && this.properties[property].notify) {
                    // Watch all properties with notify = true
                    var eventHanler = this._eventHandlerForPropertyType(this.properties[property].type.name);
                    this.unlisten(this, Polymer.CaseMap.camelToDashCase(property) + '-changed', eventHanler);
                }
            }
        },

        _eventHandlerForPropertyType: function(propertyType) {
            switch(propertyType) {
                case 'Array':
                    return '__syncArray';
                case 'Object':
                    return '__syncObject';
                default:
                    return '__syncPrimitive';
            }
        },

        __syncArray: function(event, details) {
            if(SyncBehaviorLock) {
                return; // Prevent cycles
            }

            SyncBehaviorLock = true; // Lock

            var target = event.target;
            var prop = Polymer.CaseMap.dashToCamelCase(event.type.substr(0, event.type.length - 8));

            if(details.path === undefined) {
                // New array -> assign by reference
                SyncBehaviorInstances.forEach(function(instance) {
                    if(instance !== target) {
                        instance.set(prop, details.value);
                    }
                });
            } else if(details.path.endsWith('.splices')) {
                // Array mutation -> apply notifySplices
                var splices = details.value.indexSplices;

                // for all other instances: assign reference if not the same, otherwise call 'notifySplices'
                SyncBehaviorInstances.forEach(function(instance) {
                    if(instance !== target) {
                        var instanceReference = instance.get(prop);
                        var targetReference = target.get(prop);

                        if(instanceReference !== targetReference) {
                            instance.set(prop, targetReference);
                        } else {
                            instance.notifySplices(prop, splices);
                        }
                    }
                });
            }

            SyncBehaviorLock = false; // Unlock
        },

        __syncObject: function(event, details) {
            var target = event.target;
            var prop = Polymer.CaseMap.dashToCamelCase(event.type.substr(0, event.type.length - 8));

            if(details.path === undefined) {
                // New object -> assign by reference
                SyncBehaviorInstances.forEach(function(instance) {
                    if(instance !== target) {
                        instance.set(prop, details.value);
                    }
                });
            } else {
                // Property change -> assign by reference if not the same, otherwise call 'notifyPath'
                SyncBehaviorInstances.forEach(function(instance) {
                    if(instance !== target) {
                        var instanceReference = instance.get(prop);
                        var targetReference = target.get(prop);

                        if(instanceReference !== targetReference) {
                            instance.set(prop, targetReference);
                        } else {
                            instance.notifyPath(details.path, details.value);
                        }
                    }
                });
            }
        },

        __syncPrimitive: function(event, details) {
            var target = event.target;
            var value = details.value;
            var prop = Polymer.CaseMap.dashToCamelCase(event.type.substr(0, event.type.length - 8));

            SyncBehaviorInstances.forEach(function(instance) {
                if(instance !== target) {
                    instance.set(prop, value);
                }
            });
        },
    };
})();

请注意,我使用 IIFE 模式隐藏了包含自定义元素 my-element 的所有实例的变量。 .这是必不可少的,所以不要改变它。

如您所见,该行为由六个函数组成,即:
  • attached ,它将当前实例添加到实例列表中,并为具有 notify: true 的所有属性注册监听器.
  • detached ,从实例列表中删除当前实例并删除所有属性的监听器 notify: true .
  • _eventHandlerForPropertyType ,它返回函数 4-6 之一的名称,具体取决于属性类型。
  • __syncArray ,它在实例之间同步 Array 类型属性。请注意,我忽略了当前目标并实现了一个简单的锁定机制以避免循环。该方法处理两种情况:分配一个新的数组和改变一个现有的数组。
  • __syncObject ,它在实例之间同步对象类型属性。请注意,我忽略了当前目标并实现了一个简单的锁定机制以避免循环。该方法处理两种情况:分配新对象和更改现有对象的属性。
  • __syncPrimitive ,它在实例之间同步属性的原始值。请注意,我忽略了当前目标以避免循环。

  • 为了测试我的新行为,我创建了一个示例自定义元素:
    <dom-module id="my-element">
        <template>
            <style>
                :host {
                    display: block;
                }
            </style>
    
            <h2>Hello [[id]]</h2>
            <ul>
                <li>propString: [[propString]]</li>
                <li>
                    propArray:
                    <ol>
                        <template is="dom-repeat" items="[[propArray]]">
                            <li>[[item]]</li>
                        </template>
                    </ol>
                </li>
                <li>
                    propObject:
                    <ul>
                        <li>name: [[propObject.name]]</li>
                        <li>surname: [[propObject.surname]]</li>
                    </ul>
                </li>
            </ul>
        </template>
    
        <script>
            Polymer({
                is: 'my-element',
                behaviors: [
                    SyncBehavior,
                ],
                properties: {
                    id: {
                        type: String,
                    },
                    propString: {
                        type: String,
                        notify: true,
                        value: 'default value',
                    },
                    propArray: {
                        type: Array,
                        notify: true,
                        value: function() {
                            return ['a', 'b', 'c'];
                        },
                    },
                    propObject: {
                        type: Object,
                        notify: true,
                        value: function() {
                            return {'name': 'John', 'surname': 'Doe'};
                        },
                    },
                },
                pushToArray: function(item) {
                    this.push('propArray', item);
                },
                pushToNewArray: function(item) {
                    this.set('propArray', [item]);
                },
                popFromArray: function() {
                    this.pop('propArray');
                },
                setObjectName: function(name) {
                    this.set('propObject.name', name);
                },
                setNewObjectName: function(name) {
                    this.set('propObject', {'name': name, 'surname': 'unknown'});
                },
            });
        </script>
    </dom-module>
    

    它具有一个 String 属性、一个 Array 属性和一个 Object 属性;全部与 notify: true .自定义元素还实现了 SyncBehavior行为。

    要将以上所有内容组合到一个工作原型(prototype)中,您只需执行以下操作:
    <template is="dom-bind">
        <h4>Primitive type</h4>
        propString: <input type="text" value="{{propString::input}}" />
    
        <h4>Array type</h4>
        Push to propArray: <input type="text" id="propArrayItem" /> <button onclick="_propArrayItem()">Push</button> <button onclick="_propNewArrayItem()">Push to NEW array</button> <button onclick="_propPopArrayItem()">Delete last element</button>
    
        <h4>Object type</h4>
        Set 'name' of propObject: <input type="text" id="propObjectName" /> <button onclick="_propObjectName()">Set</button> <button onclick="_propNewObjectName()">Set to NEW object</button> <br />
    
        <script>
            function _propArrayItem() {
                one.pushToArray(propArrayItem.value);
            }
    
            function _propNewArrayItem() {
                one.pushToNewArray(propArrayItem.value);
            }
    
            function _propPopArrayItem() {
                one.popFromArray();
            }
    
            function _propObjectName() {
                one.setObjectName(propObjectName.value);
            }
    
            function _propNewObjectName() {
                one.setNewObjectName(propObjectName.value);
            }
        </script>
    
        <my-element id="one" prop-string="{{propString}}"></my-element>
        <my-element id="two"></my-element>
        <my-element id="three"></my-element>
        <my-element id="four"></my-element>
    </template>
    

    在这个原型(prototype)中,我创建了 my-element 的四个实例。 .一个有propString绑定(bind)到输入,而其他则根本没有任何绑定(bind)。我创建了一个简单的表单,涵盖了我能想到的所有场景:
  • 更改原始值。
  • 将项目推送到数组。
  • 创建一个新数组(带有一项)。
  • 从数组中删除一个项目。
  • 设置对象属性。
  • 创建一个新对象。


  • 编辑

    为了解决以下问题,我更新了我的帖子和原型(prototype):
  • 同步非原始值,即数组和对象。
  • 正确地将属性名称从 Dash 大小写转换为 Camel 大小写(反之亦然)。
  • 关于polymer - 使用 Polymer 在同一 Web 组件的实例之间进行通信的最佳方式?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/42011092/

    相关文章:

    javascript - polymer 类绑定(bind)问题

    polymer - 将 Angular 2 模型绑定(bind)到 polymer 下拉列表

    javascript - 将输入的值属性绑定(bind)到属性

    javascript - 如何使 HTML 表单验证自定义 HtmlInputElement?

    javascript - 是否可以将 Polymer 3 组件拆分为单独的 JavaScript、HTML 和 CSS 文件?

    css - polymer 造型子组件

    javascript - Polymer JS POST JSON 格式

    javascript - Polymer 2.0 中的纸张工具栏

    google-sheets - 在 Polymer 1.0 图表元素中实现谷歌电子表格数据

    javascript - HTML 在 Internet Explorer 中导入加载顺序