React實(shí)時(shí)預(yù)覽react-live源碼解析
引言
react-live 是一個(gè) react 的實(shí)時(shí)編輯器,可直接編輯 react 代碼,并實(shí)時(shí)預(yù)覽。可以看下官方的預(yù)覽圖:

src
├── components
│ ├── Editor
│ │ └── index.js
│ └── Live
│ ├── LiveContext.js
│ ├── LiveEditor.js
│ ├── LiveError.js
│ ├── LivePreview.js
│ ├── LiveProvider.js
│ └── LiveProvider.test.js
├── constants
│ └── theme.js
├── hoc
│ └── withLive.js
├── index.js
└── utils
├── test
│ ├── errorBoundary.test.js
│ ├── renderer.js
│ └── transpile.test.js
└── transpile
├── errorBoundary.js
├── evalCode.js
├── index.js
└── transform.js
源碼解讀
輸入內(nèi)容
先看下導(dǎo)出內(nèi)容,包括:
Editor:編輯器LiveProvider:實(shí)時(shí)編輯環(huán)境的Provider,Context.ProviderLiveEditor:實(shí)時(shí)編輯上下文的編輯器LiveError:實(shí)時(shí)編輯上下文的報(bào)錯(cuò)LivePreview:實(shí)時(shí)編輯上下文的預(yù)覽LiveContext:實(shí)時(shí)編輯的ContextwithLive:實(shí)時(shí)編輯上下文的HOC
文件結(jié)構(gòu)和組件拆分一目了然。
Provider
先看下 Provider,它提供了以下內(nèi)容:
element:實(shí)時(shí)編輯輸出的元素error:當(dāng)前的報(bào)錯(cuò)信息code:當(dāng)前編輯的代碼language:代碼語(yǔ)言theme:代碼編輯器主題disabled:是否禁用onError:報(bào)錯(cuò)的回調(diào)onChange:代碼編輯時(shí)的回調(diào)
Provider 用來(lái)收集代碼變更,然后通過(guò) transpileAsync 將代碼編譯生成組件實(shí)例:
function transpileAsync(newCode) {
const errorCallback = error => {
setState({ error: error.toString(), element: undefined });
};
try {
const transformResult = transformCode ? transformCode(newCode) : newCode;
return Promise.resolve(transformResult)
.then(transformedCode => {
const renderElement = element => setState({ error: undefined, element });
// Transpilation arguments
const input = {
code: transformedCode,
scope
};
if (noInline) {
setState({ error: undefined, element: null }); // Reset output for async (no inline) evaluation
renderElementAsync(input, renderElement, errorCallback);
} else {
renderElement(generateElement(input, errorCallback));
}
})
.catch(errorCallback);
} catch (e) {
errorCallback(e);
return Promise.resolve();
}
}
renderElementAsync 可以先無(wú)視,主要是用于 noInline 模式下調(diào)用 render 進(jìn)行渲染,邏輯與非 noInline 模式下類似。
generateElement
實(shí)時(shí)預(yù)覽的核心部分就在這里了,它會(huì)將代碼先進(jìn)行編譯,然后執(zhí)行代碼,取得返回值。
const generateElement = ({ code = '', scope = {} }, errorCallback) => {
// NOTE: Remove trailing semicolon to get an actual expression.
const codeTrimmed = code.trim().replace(/;$/, '');
// NOTE: Workaround for classes and arrow functions.
const transformed = transform(`return (${codeTrimmed})`).trim();
return errorBoundary(evalCode(transformed, { React, ...scope }), errorCallback);
};
代碼如上,它會(huì)先去掉頭尾空白,然后去掉結(jié)尾的分號(hào),這一步是為了下一步的 return 拼接能夠正常返回。通過(guò) return 拼接讓 react-live 能夠支持下述語(yǔ)法直接渲染:
直接寫一個(gè)匿名函數(shù):
() => <h3>So functional. Much wow!</h3>;
直接寫 jsx:
<h3>Hello World!</h3>
單 class 組件:
class Comp extends React.Component {
render() {
return <center>component</center>;
}
}
不過(guò)也導(dǎo)致了一定的學(xué)習(xí)成本,如果寫多個(gè)函數(shù),多個(gè)組件,嵌套等情況下會(huì)讓人覺(jué)得語(yǔ)法很奇怪。
transform 就是將代碼通過(guò) sucrase 進(jìn)行轉(zhuǎn)譯,處理 jsx、class 這些語(yǔ)法,可以理解為通過(guò) babel 轉(zhuǎn)譯。
早期的 react-live 通過(guò) buble 進(jìn)行轉(zhuǎn)譯,能夠支持 jsx 注釋,現(xiàn)在由于 sucrase 不支持 jsx 注釋,所以新版無(wú)法使用 jsx 注釋來(lái)控制 jsx 渲染引擎。
/** @jsx mdx */ // 新版上述注釋會(huì)失效
隨后將轉(zhuǎn)譯的代碼通過(guò) evalCode 轉(zhuǎn)換為 React element,此處會(huì)將 scope 和 React 傳入 evalCode 中。
const evalCode = (code, scope) => {
const scopeKeys = Object.keys(scope);
const scopeValues = scopeKeys.map(key => scope[key]);
return new Function(...scopeKeys, code)(...scopeValues);
};
evalCode 中使用 new Function 來(lái)構(gòu)造函數(shù),scope 就是在這里作為參數(shù)進(jìn)行注入。如果對(duì) new Function 不理解的可以看我之前一篇關(guān)于 JS 沙箱的文章。
errorBoundary 則是一個(gè)簡(jiǎn)單的 HOC,用來(lái)捕獲生成的組件運(yùn)行時(shí)的錯(cuò)誤信息,通過(guò) errorCallback 拋出。
const errorBoundary = (Element, errorCallback) => {
return class ErrorBoundary extends Component {
componentDidCatch(error) {
errorCallback(error);
}
render() {
return typeof Element === 'function' ? <Element /> : React.isValidElement(Element) ? Element : null;
}
};
};
上面就是 react-live 能夠?qū)崟r(shí)預(yù)覽的核心代碼了。下面再看下其它幾個(gè)組件,都比較簡(jiǎn)單。
其他組件
LivePreview 會(huì)接受 Provider 中的 Element,將其渲染。
LiveError 接受 Provider 中的 error 進(jìn)行渲染。
LiveEditor 則是接收 Provider 的 code、language、theme、disabled、onChange,提供編輯功能。
它的編輯器則是通過(guò) useEditable 編輯,Prism 進(jìn)行代碼高亮。
總結(jié)
上述便是 react-live 的核心代碼,內(nèi)容并不多,通過(guò) sucrase 實(shí)時(shí)編譯代碼,然后通過(guò) new Function 構(gòu)造函數(shù)注入 scope 來(lái)生成 element 實(shí)現(xiàn)實(shí)時(shí)預(yù)覽,設(shè)計(jì)上通過(guò)拆離 Editor、Error、Preview 三部分,可以讓使用者自由組合組件的位置、樣式。
以上就是React實(shí)時(shí)預(yù)覽react-live源碼解析的詳細(xì)內(nèi)容,更多關(guān)于react live實(shí)時(shí)預(yù)覽的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
React 項(xiàng)目中動(dòng)態(tài)設(shè)置環(huán)境變量
本文主要介紹了React 項(xiàng)目中動(dòng)態(tài)設(shè)置環(huán)境變量,本文將介紹兩種常用的方法,使用 dotenv 庫(kù)和通過(guò)命令行參數(shù)傳遞環(huán)境變量,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04
React使用Hooks從服務(wù)端獲取數(shù)據(jù)的完整指南
本文將從基礎(chǔ)到高級(jí)用法,詳細(xì)介紹如何在 React 項(xiàng)目中優(yōu)雅地使用 Hooks 進(jìn)行服務(wù)端數(shù)據(jù)獲取,涵蓋錯(cuò)誤處理、加載狀態(tài)、性能優(yōu)化等核心場(chǎng)景,并提供可直接復(fù)用的代碼模板,需要的朋友可以參考下2025-03-03
antd?table動(dòng)態(tài)修改表格高度的實(shí)現(xiàn)
本文主要介紹了antd?table動(dòng)態(tài)修改表格高度的實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-07-07
React實(shí)現(xiàn)點(diǎn)擊切換組件效果
這篇文章主要為大家詳細(xì)介紹了如何基于React實(shí)現(xiàn)點(diǎn)擊切換組件效果,文中的示例代碼講解詳細(xì),具有一定的借鑒價(jià)值,需要的小伙伴可以學(xué)習(xí)一下2023-08-08
react中antd Upload手動(dòng)上傳的示例
本文主要介紹了react中antd Upload手動(dòng)上傳的示例,文中通過(guò)示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-04-04
在Create React App中啟用Sass和Less的方法示例
這篇文章主要介紹了在Create React App中啟用Sass和Less的方法示例,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2019-01-01
React中的useMemo 和 useEffect 執(zhí)行順序
在 React 組件的渲染過(guò)程中,useMemo 和 useEffect 的執(zhí)行順序是不同的,本文給大家介紹React中的useMemo 和 useEffect 哪個(gè)先執(zhí)行,感興趣的朋友一起看看吧2025-01-01

