Vue編譯器源碼分析compileToFunctions作用詳解
引言
接上篇Vue編譯器源碼分析文章我們來分析:compileToFunctions的作用。
經過前面的講解,我們已經知道了 compileToFunctions 的真正來源你可能會問為什么要弄的這么復雜?為了搞清楚這個問題,我們還需要繼續(xù)接觸完整的代碼。
下面我們繼續(xù)探索compileToFunctions是如何把模板字符串template編譯成渲染函數render的。
Vue.prototype.$mount函數體
回歸到Vue.prototype.$mount函數體內。
var ref = compileToFunctions(template, {
shouldDecodeNewlines: shouldDecodeNewlines,
shouldDecodeNewlinesForHref: shouldDecodeNewlinesForHref,
delimiters: options.delimiters,
comments: options.comments
}, this);
在此傳遞給compileToFunctions的第一個參數就是模板字符串template,而第二個參數則是一個配置選項options。
先說說這些配置選項中的屬性!
shouldDecodeNewlines
源碼出處
// check whether current browser encodes a char inside attribute values
var div;
function getShouldDecode(href) {
div = div || document.createElement('div');
div.innerHTML = href ? "<a href=\"\n\"/>" : "<div a=\"\n\"/>";
return div.innerHTML.indexOf(' ') > 0
}
// #3663: IE encodes newlines inside attribute values while other browsers don't
var shouldDecodeNewlines = inBrowser ? getShouldDecode(false) : false;
// #6828: chrome encodes content in a[href]
var shouldDecodeNewlinesForHref = inBrowser ? getShouldDecode(true) : false;
這個是什么意思呢?
大致的翻譯下,在我們innerHTML獲取內容時,換行符和制表符分別被轉換成了
和	。在IE中,不僅僅是 a 標簽的 href 屬性值,任何屬性值都存在這個問題。
這就會影響Vue的編譯器在對模板進行編譯后的結果,為了避免這些問題Vue需要知道什么時候要做兼容工作,如果 shouldDecodeNewlines 為 true,意味著 Vue 在編譯模板的時候,要對屬性值中的換行符或制表符做兼容處理。而shouldDecodeNewlinesForHref為true 意味著Vue在編譯模板的時候,要對a標簽的 href 屬性值中的換行符或制表符做兼容處理。
options.delimiters & options.comments
兩者都是當前Vue實例的$options屬性,并且delimiters和comments都是 Vue 提供的選項。


現在我們已經搞清楚了這些配置選項是什么意思,那接下來我們把目光放在《Vue編譯器源碼分析(二)》針對compileToFunctions函數逐行分析。
compileToFunctions函數逐行分析
function createCompileToFunctionFn(compile) {
var cache = Object.create(null);
return function compileToFunctions(
template,
options,
vm
) {
options = extend({}, options);
var warn$$1 = options.warn || warn;
delete options.warn;
/* istanbul ignore if */
{
// detect possible CSP restriction
try {
new Function('return 1');
} catch (e) {
if (e.toString().match(/unsafe-eval|CSP/)) {
warn$$1(
'It seems you are using the standalone build of Vue.js in an ' +
'environment with Content Security Policy that prohibits unsafe-eval. ' +
'The template compiler cannot work in this environment. Consider ' +
'relaxing the policy to allow unsafe-eval or pre-compiling your ' +
'templates into render functions.'
);
}
}
}
// check cache
var key = options.delimiters ?
String(options.delimiters) + template :
template;
if (cache[key]) {
return cache[key]
}
// compile
var compiled = compile(template, options);
// check compilation errors/tips
{
if (compiled.errors && compiled.errors.length) {
warn$$1(
"Error compiling template:\n\n" + template + "\n\n" +
compiled.errors.map(function(e) {
return ("- " + e);
}).join('\n') + '\n',
vm
);
}
if (compiled.tips && compiled.tips.length) {
compiled.tips.forEach(function(msg) {
return tip(msg, vm);
});
}
}
// turn code into functions
var res = {};
var fnGenErrors = [];
res.render = createFunction(compiled.render, fnGenErrors);
res.staticRenderFns = compiled.staticRenderFns.map(function(code) {
return createFunction(code, fnGenErrors)
});
// check function generation errors.
// this should only happen if there is a bug in the compiler itself.
// mostly for codegen development use
/* istanbul ignore if */
{
if ((!compiled.errors || !compiled.errors.length) && fnGenErrors.length) {
warn$$1(
"Failed to generate render function:\n\n" +
fnGenErrors.map(function(ref) {
var err = ref.err;
var code = ref.code;
return ((err.toString()) + " in\n\n" + code + "\n");
}).join('\n'),
vm
);
}
}
return (cache[key] = res)
}
}
注意compileToFunctions函數是接收三個參數的,第三個參數是當前Vue實例。
首先:
options = extend({}, options);
var warn$$1 = options.warn || warn;
delete options.warn;
通過extend 把 options 配置對象上的屬性擴展一份到新對象上,定義warn$$1變量。warn是一個錯誤信息提示的函數。
接下來:
// detect possible CSP restriction
try {
new Function('return 1');
} catch (e) {
if (e.toString().match(/unsafe-eval|CSP/)) {
warn$$1(
'It seems you are using the standalone build of Vue.js in an ' +
'environment with Content Security Policy that prohibits unsafe-eval. ' +
'The template compiler cannot work in this environment. Consider ' +
'relaxing the policy to allow unsafe-eval or pre-compiling your ' +
'templates into render functions.'
);
}
}
這段代碼使用 try catch 語句塊對 new Function('return 1') 這句代碼進行錯誤捕獲,如果有錯誤發(fā)生且錯誤的內容中包含如 'unsafe-eval' 或者 'CSP' 這些字樣的信息時就會給出一個警告。
CSP全稱Content Security Policy ,可以直接翻譯為內容安全策略,說白了,就是為了頁面內容安全而制定的一系列防護策略. 通過CSP所約束的的規(guī)責指定可信的內容來源(這里的內容可以指腳本、圖片、iframe、fton、style等等可能的遠程的資源)。通過CSP協(xié)定,讓WEB處于一個安全的運行環(huán)境中。
如果你的策略比較嚴格,那么 new Function() 將會受到影響,從而不能夠使用。但是將模板字符串編譯成渲染函數又依賴 new Function(),所以解決方案有兩個:
- 1、放寬你的CSP策略
- 2、預編譯
這段代碼的作用就是檢測 new Function() 是否可用,并在某些極端情況下給你一個有用的提示。
接下來是:
var key = options.delimiters ?
String(options.delimiters) + template :
template;
if (cache[key]) {
return cache[key]
}
options.delimiters這個選項是改變純文本插入分隔符,如果options.delimiters存在,則使用String 方法將其轉換成字符串并與 template 拼接作為 key 的值,否則直接使用 template 字符串作為 key 的值,然后判斷 cache[key] 是否存在,如果存在直接返回cache[key]。
這么做的目的是緩存字符串模板的編譯結果,防止重復編譯,提升性能,我們再看一下compileToFunctions函數的最后一句代碼:
return (cache[key] = res)
這句代碼在返回編譯結果的同時,將結果緩存,這樣下一次發(fā)現如果 cache 中存在相同的 key則不需要再次編譯,直接使用緩存的結果就可以了。
接下來:
// compile
var compiled = compile(template, options);
// check compilation errors/tips
if (compiled.errors && compiled.errors.length) {
warn$$1(
"Error compiling template:\n\n" + template + "\n\n" +
compiled.errors.map(function(e) {
return ("- " + e);
}).join('\n') + '\n',
vm
);
}
if (compiled.tips && compiled.tips.length) {
compiled.tips.forEach(function(msg) {
return tip(msg, vm);
});
}
}
compile 是引用了來自 createCompileToFunctionFn 函數的形參稍后會重點來介紹它。
在使用 compile 函數對模板進行編譯后會返回一個結果 compiled,返回結果 compiled 是一個對象且這個對象可能包含兩個屬性 errors 和 tips 。這兩個屬性分別包含了編譯過程中的錯誤和提示信息。所以上面那段代碼的作用就是用來檢查使用 compile 對模板進行編譯的過程中是否存在錯誤和提示的,如果存在那么需要將其打印出來。
接下來:
// turn code into functions
var res = {};
var fnGenErrors = [];
res.render = createFunction(compiled.render, fnGenErrors);
res.staticRenderFns = compiled.staticRenderFns.map(function(code) {
return createFunction(code, fnGenErrors)
});
res 是一個空對象且它是最終的返回值,fnGenErrors 是一個空數組。
在 res 對象上添加一個 render 屬性,這個 render 屬性,就是最終生成的渲染函數,它的值是通過 createFunction 創(chuàng)建出來的。
createFunction 函數源碼
function createFunction(code, errors) {
try {
return new Function(code)
} catch (err) {
errors.push({
err: err,
code: code
});
return noop
}
}
createFunction 函數接收兩個參數,第一個參數 code 為函數體字符串,該字符串將通過new Function(code) 的方式創(chuàng)建為函數。
第二個參數 errors 是一個數組,作用是當采用 new Function(code) 創(chuàng)建函數發(fā)生錯誤時用來收集錯誤的。
已知,傳遞給 createFunction 函數的第一個參數是 compiled.render,所以 compiled.render 應該是一個函數體字符串,且我們知道 compiled 是 compile 函數的返回值,這說明:compile函數編譯模板字符串后所得到的是字符串形式的函數體。
傳遞給 createFunction 函數的第二個參數是之前聲明的 fnGenErrors 常量,也就是說當創(chuàng)建函數出錯時的錯誤信息被 push 到這個數組里了。
在這句代碼之后,又在 res 對象上添加了 staticRenderFns 屬性:
res.staticRenderFns = compiled.staticRenderFns.map(function(code) {
return createFunction(code, fnGenErrors)
});
由這段代碼可知 res.staticRenderFns 是一個函數數組,是通過對compiled.staticRenderFns遍歷生成的,這說明:compiled 除了包含 render 字符串外,還包含一個字符串數組staticRenderFns ,且這個字符串數組最終也通過 createFunction 轉為函數。staticRenderFns 的主要作用是渲染優(yōu)化,我們后面詳細講解。
最后的代碼:
// check function generation errors.
// this should only happen if there is a bug in the compiler itself.
// mostly for codegen development use
/* istanbul ignore if */
if ((!compiled.errors || !compiled.errors.length) && fnGenErrors.length) {
warn$$1(
"Failed to generate render function:\n\n" +
fnGenErrors.map(function(ref) {
var err = ref.err;
var code = ref.code;
return ((err.toString()) + " in\n\n" + code + "\n");
}).join('\n'),
vm
);
}
return (cache[key] = res)
這段代碼主要的作用是用來打印在生成渲染函數過程中的錯誤,返回結果的同時將結果緩存,接下來我們講講compile 的作用。
以上就是Vue編譯器源碼分析compileToFunctions作用詳解的詳細內容,更多關于Vue編譯器compileToFunctions的資料請關注腳本之家其它相關文章!
相關文章
詳解基于element的區(qū)間選擇組件校驗(交易金額)
這篇文章主要介紹了詳解基于element的區(qū)間選擇組件校驗(交易金額),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2021-01-01

