kinkahuang

2个月前
  • 777

    浏览
  • 0

    评论
  • 0

    收藏

基于vue.js的渐进式组件尝试

本文作者:imweb kinkahuang 原文出处:imweb社区 未经同意,禁止转载

我们有个内部运营系统,是基于keenthemes的一个主题进行开发的,而这个主题就是基于jQuery+bootstrap+jQueryPlugins 进行的定制主题,用于显示各种图表和曲线。所以,这个系统的特点就是,加载了一堆js和css进行堆砌组合,以及内容被一层层的标签和样式包围。长这个样子:

混乱重复的演示 混乱重复的演示 混乱重复的演示

这种写多了确实就是体力活,一般的开发过程也就是复制粘贴,而且为了不出意外的问题,有用的没用的js script和css link都是直接复制的,反正放内部用一般忽略加载的延迟。

所以,有没有办法把各种标签打包成一个新的标签,css和js的依赖也打包在一块呢?就像html提供的基础标签一样,放个图片,那放个img就可以了。

这个肯定是有的,痛的人那么多,所以现在已经web components草案在讨论中,chrome等现代浏览器也相继地提供了shadow DOM, custom Elements的特性支持,google还推出了polymer项目。不过说实话,要是一个项目从头开始折腾,还是可以考虑的,但是一想到又要用npm安装一堆依赖,也是头大。

我需要的方案是,在已有的项目上,门槛低点,依赖很少的东西,还能包容已有的开发模式。比如说,我就把一堆标签用一个新的标签替代,然后解析页面的执行js脚本还原回来,这是最基本的一步。

在我有限的认知里,vue.js就是最简单的满足需求的选择。为什么不用react?一出来就令人惊呼的jsx,我还是嫌依赖太多。我就想要一种old school的方式,引用一个js,然后马上写,随便写。而且,vue.js提供的双向绑定功能也很适合,不用满个页面里写id然后脚本里再去各种引用。还有一点,运营系统天生以页面为模块划分,引入的js只充当controller的角色就可以了。

以datepicker的jQuery插件为例,下面代码放components.js里:

Vue.component('datepicker', {
    template: '\
        <div class="input-group input-small date" data-date-format="yyyy-mm-dd" :data-date-end-date="enddate">\
            <input type="text" class="form-control" readonly="">\
            <span class="input-group-btn">\
                <button class="btn default" type="button">\
                    <i class="fa fa-calendar"></i>\
                </button>\
            </span>\
        </div>\
    '
})

先假设页面上已经加载了需要的css和js,那么在页面上就可以直接使用

<datepicker></datepicker>

而我们除了需要加载components.js和vue.js之外,其它照旧。当然就是包含datepicker标签的元素需要加载到一个Vue实例中。

然后,再加强对这个标签的控制,比如说传入值,获取值以及对于datepicker事件的处理等,使得它功能更加完整。

Vue.component('datepicker', {
    props: ['value'],
    template: '\
        <div ref="picker" class="input-group input-small date" data-date-format="yyyy-mm-dd">\
            <input type="text" class="form-control" readonly="" :value="value">\
            <span class="input-group-btn">\
                <button class="btn default" type="button">\
                    <i class="fa fa-calendar"></i>\
                </button>\
            </span>\
        </div>\
    ',
    mounted: function() {
            var self = this;
            $(this.$refs.picker).datepicker({orientation: "right top", autoclose: true});
            $(this.$refs.picker).on('changeDate', function(e) {
                self.$emit('input', e.format('yyyy-mm-dd'));
            })
        }
})

以上示例代码中,模板新加入ref属性,就可以通用this.$refs引用原始的DOM节点,而props数据value的传入以及input事件的触发,则是为了实现神奇的 v-model,看:

<datepicker v-model='selectedDate'></datepicker>

如此一来就对datepicker父组件的 selectedDate 实现了双向绑定。其实v-model也只是个语法糖,展开来,其实就是:

<datepicker :value='selectedDate' @input='selectedDate=arguments[0]'></datepicker>

另外,示例代码中是在Vue实例的生命周期的mounted阶段(DOM节点挂载完成)进行了事件绑定,这是为了确保编译后节点的已经正常存在。

然后,到这里,仍然是基于页面上已经手动加载了依赖的css和js,这个组件其实还不算完整。事实上,我们还希望能够只要引用这个组件,依赖也要自然地满足。而这个,无非就是在合适的时候把依赖的css和js动态加载进来。这个“合适的时候”我仍然选择的是"mounted"阶段,为什么?感觉自然而然呀。

可是,动态加载CSS和JS的难点其实是,如何判断已经资源加载完成?兼容性仍然是个问题。所以,我又假设了,我们就只使用chrome吧~~ 理想的情况是,加载的资源并行请求,然后渲染执行的时候则按先后顺序,这明显没那么完美的事情。所以,对于CSS文件,我仍然并行加载,那么依赖先后顺序的样式有可能有问题,要保证顺序只能串行化,而且由于浏览器缓存的存在,在我有限的测试次数中,肉眼上还没有看出问题。而js的话就不得不优先考虑加载顺序的问题了,所以最后选择串行加载,而且是忽略了失败的情况。

解决依赖这种事情,是很个组件都需要的功能,所以采用了mixin, 可以大大地减少重复代码,看起来就像是声明了一个接口,有依赖的组件只要按需实现即可:

Vue.component('datepicker', {
    mixins: [DepMixins],
    props: ['value'],
    template: '\
        <div ref="picker" class="input-group input-small date" data-date-format="yyyy-mm-dd">\
            <input type="text" class="form-control" readonly="" :value="value">\
            <span class="input-group-btn">\
                <button class="btn default" type="button">\
                    <i class="fa fa-calendar"></i>\
                </button>\
            </span>\
        </div>\
    ',
    methods: {
        needDeps: function() {
            var deps = ['/assets/global/plugins/bootstrap-datepicker/css/bootstrap-datepicker3.min.css',
                        '/assets/global/plugins/bootstrap-datepicker/js/bootstrap-datepicker.min.js'];
            return deps;
        },
        loadedDeps: function() {
            var self = this;
            $(this.$refs.picker).datepicker({orientation: "right top", autoclose: true});
            $(this.$refs.picker).on('changeDate', function(e) {
                self.$emit('input', e.format('yyyy-mm-dd'));
            })
        }
    }
})

而DepMixins长这样子:

var DepMixins = {
    mounted: function() {
        if (!this.needDeps) return;
        var deps = this.needDeps();
        if (!deps) return;

        var cb = this.loadedDeps;
        var compName = Vue.util.formatComponentName(this);
        if (typeof DepMixins.comps[compName] === 'undefined')
            DepMixins.comps[compName] = [cb];
        else if (DepMixins.comps[compName] === 'loaded')
            return cb && cb();
        else
            return DepMixins.comps[compName].push(cb);

        // 假设css都在前面,而js是按照依赖顺序排列在后面
        for (var i=0; i<deps.length; i++) {
            var dep = deps[i];
            if (dep.endsWith('.css')) {
                visd.loadCSS(dep);
                continue;
            }

            next(i);
            break;
        }

        function next(i) {
            var dep = deps[i];
            if (!dep) return clearQueue();

            visd.cachedScript(dep).then(function() {
                return next(i+1);
            });
        }
        // will only called once
        function clearQueue() {
            var list = DepMixins.comps[compName];
            // if (list === 'loaded') return;
            for (var i=0; i<list.length; i++)
                list[i] && list[i]();
            DepMixins.comps[compName] = 'loaded';
        }
    }
}
DepMixins.comps = {};

可以看到,我又偷了懒,只完成了核心功能,连css和js的样式都只是自己约定了一下。visd.loadCSS和visd.cachedScript分别只是普通的加载CSS和JS的函数包装。

visd.loadCSS = function(src) {
    $("<link>").attr({rel: 'stylesheet', type: 'text/css', href: src}).appendTo(document.head);
}
visd.cachedScript= function(url, options) {
  // allow user to set any option except for dataType, cache, and url
  options = $.extend(options || {}, {
    dataType: "script",
    cache: true,
    url: url
  });

  // Use $.ajax() since it is more flexible than $.getScript
  // Return the jqXHR object so we can chain callbacks
  return jQuery.ajax(options);
};

最后,这个datepicker组件就算完成了。只需要新增加一个vue.js的依赖,而且还减少了页面上其它不明所以的资源文件引用,其它照旧,就算来个后台同学来看html代码,相信都能看懂,能手写。原有的开发环境也不需要任何更新,只用文本编辑器也照样敲代码。

再来两个经典例子:

watch演示

watch字段的经典在于,模板中并没有引用到rows这个变量,那么vue实例也就不会把它加入watch列表,当父组件传入的rows变化的时候,data-table组件什么都不知道也就不会更新了,所以需要手动添加到watch列表中。

slot演示

kee-modal中使用 了slot 标签,叫做内容分发,是web components spec的一个proposal(不会翻译),用于组件中的组合,也就是说我可以这样子用keen-modal:

<keen-modal>
    <div>想放点什么?</div>
    <datepicker></datepicker>
</keen-modal>

果然很方便!

0 条评论