深入解析Vue 组件命名那些事
there are only two things in computer sciences: cache invalidation and naming things.
—— phil karlton
诚如上述所言,编程中变量命名确实令人很头疼。我们模糊地知道,vue 组件的名称最好不要和原生 html 标签相同。为了避免重名,通常会在组件名称前面加上一个前缀,如 el-button、el-input、el-date-picker。这通常不会有什么问题,但有时候你的模板中混杂了原生 html 标签和组件标签,要想区分它们并不是很容易。
当我看到 ant.design 的 react 组件是下面这样的时候,我感觉到一种*的味道。首先,组件名可以使用原生 html 标签名,意味着再也不用较劲脑汁去规避原生 html 标签了。另外,这些组件都使用了首字母大写标签名,使它们很容易地与原生小写的 html 标签区分。
reactdom.render( <div> <button type="primary">primary</button> <input placeholder="basic usage" /> <select defaultvalue=".com" style={{ width: 70 }}> <option value=".com">.com</option> <option value=".jp">.jp</option> <option value=".cn">.cn</option> <option value=".org">.org</option> </select> </div>, mountnode );
受 ant.design 的启发,我思考 vue 组件命名能不能达到同样的效果呢?要找到答案,必须摸清楚 vue 组件命名到底有什么限制。下面将分别从 vue 1.0 和 vue 2.0 来谈谈组件命名的机制:
vue 1.0 组件命名机制
组件注册
我们以一个最简单的例子来研究 vue 组件的注册过程:
vue.component('mycomponent', { template: '<div>hello, world</div>' })
通过跟踪代码的执行过程,发现对组件的名称有两处检查。
检查名称是否与 html 元素或者 vue 保留标签重名,不区分大小写。可以发现,只检查了常用的 html 元素,还有很多元素没有检查,例如 button、main。
if (type === 'component' && (commontagre.test(id) || reservedtagre.test(id))) { warn('do not use built-in or reserved html elements as component ' + 'id: ' + id); } // var commontagre = /^(div|p|span|img|a|b|i|br|ul|ol|li|h1|h2|h3|h4|h5|h6|code|pre|table|th|td|tr|form|label|input|select|option|nav|article|section|header|footer)$/i; // var reservedtagre = /^(slot|partial|component)$/i;
检查组件名称是否以字母开头,后面跟字母、数值或下划线。
if (!/^[a-za-z][\w-]*$/.test(name)) { warn('invalid component name: "' + name + '". component names ' + 'can only contain alphanumeric characaters and the hyphen.'); }
基于以上两点,可以总结出组件的命名规则为:组件名以字母开头,后面跟字母、数值或下划线,并且不与 html 元素或 vue 保留标签重名。
然而我们注意到,在上面的检查中,不符合规则的组件名称是 warn 而不是 error,意味着检查并不是强制的。实际上,vue 组件注册的名称是没有限制的。你可以用任何 javascript 能够表示的字符串,不管是数字、特殊符号、甚至汉字,都可以成功注册。
模板解析
虽然 vue 组件没有命名限制,但是我们终究是要在模板中引用的,不合理的组件名可能会导致我们无法引用它。
为了弄清楚 vue 是如何将模板中的标签对应到自定义组件的,我们以一段简单的代码说明:
new vue({ el: '#app', template: '<my-component></my-component>' })
总体来说,模板解析分为两个过程:
首先,vue 会将 template 中的内容插到 dom 中,以方便解析标签。由于 html 标签不区分大小写,所以在生成的标签名都会转换为小写。例如,当你的 template 为 <mycomponent></mycomponent> 时,插入 dom 后会被转换为 <mycomponent></mycomponent>。
然后,通过标签名寻找对应的自定义组件。**匹配的优先顺序从高到低为:原标签名、camelcase化的标签名、pascalcase化的标签名。**例如 <my-component> 会依次匹配 my-component、mycomponent、mycomponent。camelcase 和 pascalcase 的代码如下:
var camelizere = /-(\w)/g; function camelize(str) { return str.replace(camelizere, toupper); } function toupper(_, c) { return c ? c.touppercase() : ''; } function pascalize(str) { var camelcase = camelize(str); return camelcase.charat(0).touppercase() + camelcase.slice(1) }
对于一个 vue 新手,经常对以下示例代码不能正常运行感到非常疑惑:
vue.component('mycomponent', { template: '<div>hello, world</div>' }) new vue({ el: '#app', template: '<mycomponent></mycomponent>' })
如果我们按照模板解析的过程推理,就很好解释了。模板 <mycomponent></mycomponent> 插入到 dom 后会变成 <mycomponent></mycomponent>。标签 mycomponent 匹配的组件依次为 mycomponent(原标签名)、mycomponent(camelcase形式)、mycomponent(pascalcase形式),并没有匹配到注册的组件名 mycomponent,所以会报找不到组件 <mycomponent> 的警告。
命名限制
通过分析组件注册和模板解析的过程,发现 vue 组件命名限制并没有我们想象得多。大家可以尝试一下各种命名,我试过 <a_=-*%按钮></a_=-*%按钮> 都可正常运行。
但是,并不意味着完全没有限制。由于在模板需要插入到 dom 中,所以模板中的标签名必须能够被 dom 正确地解析。主要有三种情况:一是完全不合法的标签名,例如 </>;二是与 html 元素重名会产生不确定的行为,例如使用 input 做组件名不会解析到自定义组件,使用 button 在 chrome 上正常但在 ie 上不正常;三是与 vue 保留的 slot、partial、component 重名,因为会优先以本身的意义解析,从而产生非预期的结果。
上述命名限制存在的根本原因,在于模板解析的过程依赖了 dom。能不能对模板解析过程改进一下,使其不依赖于 dom 呢?实际上,这正是 vue 2.0 的主要改进,将模板解析过程使用 virtual dom 实现,使得组件命名更加灵活。
vue 2.0 组件命名机制
组件注册
vue 2.0 的组件注册过程与 vue 1.0 基本相同,只是 html 标签和 vue 保留标签范围有些不同:
// 区分大小写 var ishtmltag = makemap( 'html,body,base,head,link,meta,style,title,' + 'address,article,aside,footer,header,h1,h2,h3,h4,h5,h6,hgroup,nav,section,' + 'div,dd,dl,dt,figcaption,figure,hr,img,li,main,ol,p,pre,ul,' + 'a,b,abbr,bdi,bdo,br,cite,code,data,dfn,em,i,kbd,mark,q,rp,rt,rtc,ruby,' + 's,samp,small,span,strong,sub,sup,time,u,var,wbr,area,audio,map,track,video,' + 'embed,object,param,source,canvas,script,noscript,del,ins,' + 'caption,col,colgroup,table,thead,tbody,td,th,tr,' + 'button,datalist,fieldset,form,input,label,legend,meter,optgroup,option,' + 'output,progress,select,textarea,' + 'details,dialog,menu,menuitem,summary,' + 'content,element,shadow,template' ); // 不区分大小写 var issvg = makemap( 'svg,animate,circle,clippath,cursor,defs,desc,ellipse,filter,font,' + 'font-face,g,glyph,image,line,marker,mask,missing-glyph,path,pattern,' + 'polygon,polyline,rect,switch,symbol,text,textpath,tspan,use,view', true ); var isreservedtag = function (tag) { return ishtmltag(tag) || issvg(tag) }; // 区分大小写 var isbuiltintag = makemap('slot,component', true);
虽然 html 元素重名警告的标签数大大增加了,但重要的是重名区分大小写,所以我们可以愉快地使用 input、select、option 等而不用担心重名。这个功劳属于 vue 2.0 引入的 virtual dom。
模板解析
前面提到,vue 2.0 相对于 1.0 的最大改进就是引入了 virtual dom,使模板的解析不依赖于 dom。
使用 virtual dom 解析模板时,不必像 dom 方式那样将模板中的标签名转成小写,而是原汁原味地保留原始标签名。然后,使用原始的标签名进行匹配组件。例如,<mycomponent></mycomponent> 不会转为为小写形式,直接以 mycomponent 为基础开始匹配。当然,匹配的规则与 1.0 是一样的,即依次匹配:原标签名、camelcase化的标签名、pascalcase化的标签名。
之前在 1.0 不能正常运行的示例代码,在 2.0 中可以正常运行了:
vue.component('mycomponent', { template: '<div>hello, world</div>' }) new vue({ el: '#app', template: '<mycomponent></mycomponent>' })
在 vue 1.0 和 2.0 中还有一种定义组件模板的方式,即使用 dom 元素。在这种情况下,解析模板时仍然会将标签转为小写形式。所以下面的代码,在 1.0 和 2.0 均不能正常运行。
// index.html <div id="app"> <mycomponent></mycomponent> </div> // main.js vue.component('mycomponent', { template: '<div>hello, world</div>' }) new vue({ el: '#app' })
命名限制
vue 2.0 中组件的命名限制与 1.0 的最大区别在于区分了大小写。总结一下就是:一是不使用非法的标签字符;二是不与 html 元素(区分大小写)或 svg 元素(不区分大小写)重名;三是不使用 vue 保留的 slot 和 component(区分大小写)。
除了以上三条,由于 vue 2.0 内置了 keepalive、transition、transitiongroup 三个组件,所以尽量避免与这三个组件重名。但从另一方面讲,你也可以故意重名来实现一些特殊的功能。例如,keep-alive 的匹配顺序为 keep-alive、keepalive、keepalive,所以我们可以注册一个 keep-alive 组件来拦截 keepalive 匹配。
总结
到这里,我们可以知道 vue 2.0 完全可以像 react 那样使用 pascalcase 形式的组件标签。对于 vue 1.0,想以 pascalcase 形态写模板,尽量以全小写或者仅首字母大写形式注册组件,例如 <inputnumber> 组件,可以注册为 inputnumber 或者 inputnumber。但是,如果你想在 1.0 中使用 input、select 这类与 html 元素重名的标签名,基本上是无解的,所以是时候尝试下 vue 2.0 了。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。