轻松实现javascript数据双向绑定

作者:纸飞机时间:2026-10-29 16:38:49浏览:416

本文解析JavaScript数据双向绑定的核心原理,即通过发布订阅模式同步对象属性与UI元素。文章提供了基于jQuery和纯JavaScript两种实现方案,详细讲解如何利用data属性建立绑定关系,并通过自定义PubSub对象监控变化与广播事件,仅需少量代码即可实现高效的数据同步。

数据双向绑定原理

双向数据绑定是指当数据对象的属性值发生改变时,对应的用户界面(UI)元素能自动更新显示新值;反之,若用户在UI界面上修改了数据,底层数据对象的属性也会随之同步更新。以user对象为例,若其拥有name属性,当代码中修改user.name的值时,UI界面上展示该属性的部分会立即反映这一变化;同样,若UI中包含用于编辑用户名字的输入框,用户在该输入框中输入新值,也会导致user对象的name属性发生相应改变。

许多流行的JavaScript框架,如Ember.js、Angular.js或KnockoutJS,都将双向数据绑定作为核心特性进行宣传。但这并不意味着从零开始实现这一功能非常困难,也不代表在需要此功能时只能依赖这些框架。其背后的核心思想其实相当基础,实现这一功能可以归纳为以下三个关键点:

  • 首先需要确定一种机制,用于标识哪些UI元素与数据对象的哪些属性建立了绑定关系。
  • 其次,需要建立监控机制,实时跟踪数据属性值的变化以及UI界面上用户操作带来的变化。
  • 最后,需要设计一种机制,将所有绑定关系中的对象属性变化与UI元素变化进行传播和广播,确保两端数据的一致性。

尽管实现上述三点有多种方式,但采用发布订阅者模式是一种简单且高效的方案。具体做法是:在HTML元素上使用定制的data属性来指定需要绑定的数据属性。所有参与绑定的JavaScript对象和DOM元素都订阅同一个发布订阅(PubSub)对象。当检测到JavaScript对象属性变化或HTML input元素内容变化时,将事件代理传递给PubSub对象,由该对象负责将变化信息广播给所有相关的绑定对象和元素。

jQuery实现方案

一个用jQuery实现的简单例子

利用jQuery实现上述逻辑相对直观,因为作为一个广泛使用的库,它能够方便地订阅和发布DOM事件,同时我们也可以在此基础上定制自己的PubSub机制:


function DataBinder(object_id){
  // Use a jQuery object as simple PubSub
  var pubSub=jQuery({});

  // We expect a `data` element specifying the binding
  // in the form:data-bind-<object_id>="<property_name>"
  var data_attr="bind-"+object_id,
    message=object_id+":change";

  // Listen to chagne events on elements with data-binding attribute and proxy
  // then to the PubSub, so that the change is "broadcasted" to all connected objects
  jQuery(document).on("change","[data-]"+data_attr+"]",function(eve){
    var $input=jQuery(this);

    pubSub.trigger(message,[$input.data(data_attr),$input.val()]);
  });

  // PubSub propagates chagnes to all bound elemetns,setting value of
  // input tags or HTML content of other tags
  pubSub.on(message,function(evt,prop_name,new_val){
    jQuery("[data-"+data_attr+"="+prop_name+"]").each(function(){
      var $bound=jQuery(this);

      if($bound.is("")){
        $bound.val(new_val);
      }else{
        $bound.html(new_val);
      }
    });
  });
  return pubSub;
}

对于JavaScript对象,以下是一个最小化的user数据模型实现示例:


function User(uid){
  var binder=new DataBinder(uid),
    
    user={
      attributes:{},
      // The attribute setter publish changes using the DataBinder PubSub
      set:function(attr_name,val){
        this.attributes[attr_name]=val;
        binder.trigger(uid+":change",[attr_name,val,this]);
      },

      get:function(attr_name){
        return this.attributes[attr_name];
      },
    
      _binder:binder
    };

  // Subscribe to PubSub
  binder.on(uid+":change",function(evt,attr_name,new_val,initiator){
    if(initiator!==user){
      user.set(attr_name,new_val);
    }
  });

  return user;
}

现在,每当我们需要将一个对象的属性绑定到UI界面上时,只需在对应的HTML元素上设置合适的data属性即可。


// javascript 
var user=new User(123);
user.set("name","Wolfgang");

// html
<input type="number" data-bind-123="name" />

input输入框中值的变化会自动映射到user对象的name属性,反之亦然。至此,双向绑定的基本功能即告完成。

纯JavaScript实现方案

不需要jQuery的实现方式

目前大多数项目中通常已经引入了jQuery,因此上述基于jQuery的例子是完全可接受的。但如果项目要求完全不依赖jQuery,该如何实现呢?事实上,这并不困难(特别是当我们将IE支持限定为IE8及以上版本时)。核心思路依然是通过发布订阅者模式来观察和处理DOM事件。


function DataBinder( object_id ) {
 // Create a simple PubSub object
 var pubSub = {
  callbacks: {},

  on: function( msg, callback ) {
   this.callbacks[ msg ] = this.callbacks[ msg ] || [];
   this.callbacks[ msg ].push( callback );
  },

  publish: function( msg ) {
   this.callbacks[ msg ] = this.callbacks[ msg ] || []
   for ( var i = 0, len = this.callbacks[ msg ].length; i < len; i++ ) {
    this.callbacks[ msg ][ i ].apply( this, arguments );
   }
  }
 },

 data_attr = "data-bind-" + object_id,
 message = object_id + ":change",

 changeHandler = function( evt ) {
  var target = evt.target || evt.srcElement, // IE8 compatibility
    prop_name = target.getAttribute( data_attr );

  if ( prop_name && prop_name !== "" ) {
   pubSub.publish( message, prop_name, target.value );
  }
 };

 // Listen to change events and proxy to PubSub
 if ( document.addEventListener ) {
  document.addEventListener( "change", changeHandler, false );
 } else {
  // IE8 uses attachEvent instead of addEventListener
  document.attachEvent( "onchange", changeHandler );
 }

 // PubSub propagates changes to all bound elements
 pubSub.on( message, function( evt, prop_name, new_val ) {
var elements = document.querySelectorAll("[" + data_attr + "=" + prop_name + "]"),
  tag_name;

for ( var i = 0, len = elements.length; i < len; i++ ) {
 tag_name = elements[ i ].tagName.toLowerCase();

 if ( tag_name === "input" || tag_name === "textarea" || tag_name === "select" ) {
  elements[ i ].value = new_val;
 } else {
  elements[ i ].innerHTML = new_val;
 }
}
 });

 return pubSub;
}

数据模型可以保持基本不变,区别仅在于setter方法中不再调用jQuery的trigger方法,而是改用我们在PubSub中自定义的publish方法。


// In the model's setter:
function User( uid ) {
 // ...

 user = {
  // ...
  set: function( attr_name, val ) {
     this.attributes[ attr_name ] = val;
     // Use the `publish` method
     binder.publish( uid + ":change", attr_name, val, this );
  }
 }

 // ...
}

通过实例讲解,我们再次展示了如何仅用不到一百行的可维护纯JavaScript代码实现预期的双向绑定功能,希望对大家在实现JavaScript数据双向绑定方面有所帮助。

作者最新文章