詳解React 代碼共享最佳實踐方式
任何一個項目發展到一定復雜性的時候,必然會面臨邏輯復用的問題。在React
中實現邏輯復用通常有以下幾種方式:Mixin
、高階組件(HOC)
、修飾器(decorator)
、Render Props
、Hook
。本文主要就以上幾種方式的優缺點作分析,幫助開發者針對業務場景作出更適合的方式。
Mixin
這或許是剛從Vue
轉向React
的開發者第一個能夠想到的方法。Mixin
一直被廣泛用於各種面向對象的語言中,其作用是為單繼承語言創造一種類似多重繼承的效果。雖然現在React
已將其放棄中,但Mixin
的確曾是React
實現代碼共享的一種設計模式。
廣義的 mixin 方法,就是用賦值的方式將 mixin 對象中的方法都掛載到原對象上,來實現對象的混入,類似 ES6 中的 Object.assign()的作用。原理如下:
const mixin = function (obj, mixins) { const newObj = obj newObj.prototype = Object.create(obj.prototype) for (let prop in mixins) { // 遍歷mixins的屬性 if (mixins.hasOwnPrototype(prop)) { // 判斷是否為mixin的自身屬性 newObj.prototype[prop] = mixins[prop]; // 賦值 } } return newObj };
在 React 中使用 Mixin
假設在我們的項目中,多個組件都需要設置默認的name
屬性,使用mixin
可以使我們不必在不同的組件裡寫多個同樣的getDefaultProps
方法,我們可以定義一個mixin
:
const DefaultNameMixin = { getDefaultProps: function () { return { name: "Joy" } } }
為瞭使用mixin
,需要在組件中加入mixins
屬性,然後把我們寫好的mixin
包裹成一個數組,將它作為mixins
的屬性值:
const ComponentOne = React.createClass({ mixins: [DefaultNameMixin] render: function () { return <h2>Hello {this.props.name}</h2> } })
寫好的mixin
可以在其他組件裡重復使用。
由於mixins
屬性值是一個數組,意味著我們可以同一個組件裡調用多個mixin
。在上述例子中稍作更改得到:
const DefaultFriendMixin = { getDefaultProps: function () { return { friend: "Yummy" } } } const ComponentOne = React.createClass({ mixins: [DefaultNameMixin, DefaultFriendMixin] render: function () { return ( <div> <h2>Hello {this.props.name}</h2> <h2>This is my friend {this.props.friend}</h2> </div> ) } })
我們甚至可以在一個mixin
裡包含其他的mixin
。
比如寫一個新的mixin``DefaultProps
包含以上的DefaultNameMixin
和DefaultFriendMixin
:
const DefaultPropsMixin = { mixins: [DefaultNameMixin, DefaultFriendMixin] } const ComponentOne = React.createClass({ mixins: [DefaultPropsMixin] render: function () { return ( <div> <h2>Hello {this.props.name}</h2> <h2>This is my friend {this.props.friend}</h2> </div> ) } })
至此,我們可以總結出mixin
至少擁有以下優勢:
- 可以在多個組件裡使用相同的
mixin
; - 可以在同一個組件裡使用多個
mixin
; - 可以在同一個
mixin
裡嵌套多個mixin
;
但是在不同場景下,優勢也可能變成劣勢:
- 破壞原有組件的封裝,可能需要去維護新的
state
和props
等狀態; - 不同
mixin
裡的命名不可知,非常容易發生沖突; - 可能產生遞歸調用問題,增加瞭項目復雜性和維護難度;
除此之外,mixin
在狀態沖突、方法沖突、多個生命周期方法的調用順序等問題擁有自己的處理邏輯。感興趣的同學可以參考一下以下文章:
React Mixin 的使用
Mixins Considered Harmful
高階組件
由於mixin
存在上述缺陷,故React
剝離瞭mixin
,改用高階組件
來取代它。
高階組件
本質上是一個函數,它接受一個組件作為參數,返回一個新的組件。
React
官方在實現一些公共組件時,也用到瞭高階組件
,比如react-router
中的withRouter
,以及Redux
中的connect
。在這以withRouter
為例。
默認情況下,必須是經過Route
路由匹配渲染的組件才存在this.props
、才擁有路由參數
、才能使用函數式導航
的寫法執行this.props.history.push('/next')
跳轉到對應路由的頁面。高階組件
中的withRouter
作用是將一個沒有被Route
路由包裹的組件,包裹到Route
裡面,從而將react-router
的三個對象history
、location
、match
放入到該組件的props
屬性裡,因此能實現函數式導航跳轉
。
withRouter
的實現原理:
const withRouter = (Component) => { const displayName = `withRouter(${Component.displayName || Component.name})` const C = props => { const { wrappedComponentRef, ...remainingProps } = props return ( <RouterContext.Consumer> {context => { invariant( context, `You should not use <${displayName} /> outside a <Router>` ); return ( <Component {...remainingProps} {...context} ref={wrappedComponentRef} /> ) }} </RouterContext.Consumer> ) }
使用代碼:
import React, { Component } from "react" import { withRouter } from "react-router" class TopHeader extends Component { render() { return ( <div> 導航欄 {/* 點擊跳轉login */} <button onClick={this.exit}>退出</button> </div> ) } exit = () => { // 經過withRouter高階函數包裹,就可以使用this.props進行跳轉操作 this.props.history.push("/login") } } // 使用withRouter包裹組件,返回history,location等 export default withRouter(TopHeader)
由於高階組件
的本質是獲取組件並且返回新組件的方法
,所以理論上它也可以像mixin
一樣實現多重嵌套。
例如:
寫一個賦能唱歌的高階函數
import React, { Component } from 'react' const widthSinging = WrappedComponent => { return class HOC extends Component { constructor () { super(...arguments) this.singing = this.singing.bind(this) } singing = () => { console.log('i am singing!') } render() { return <WrappedComponent /> } } }
寫一個賦能跳舞的高階函數
import React, { Component } from 'react' const widthDancing = WrappedComponent => { return class HOC extends Component { constructor () { super(...arguments) this.dancing = this.dancing.bind(this) } dancing = () => { console.log('i am dancing!') } render() { return <WrappedComponent /> } } }
使用以上高階組件
import React, { Component } from "react" import { widthSing, widthDancing } from "hocs" class Joy extends Component { render() { return <div>Joy</div> } } // 給Joy賦能唱歌和跳舞的特長 export default widthSinging(withDancing(Joy))
由上可見,隻需使用高階函數進行簡單的包裹,就可以把原本單純的 Joy 變成一個既能唱歌又能跳舞的夜店小王子瞭!
使用 HOC 的約定
- 在使用
HOC
的時候,有一些墨守成規的約定: - 將不相關的 Props 傳遞給包裝組件(傳遞與其具體內容無關的 props);
- 分步組合(避免不同形式的 HOC 串聯調用);
- 包含顯示的 displayName 方便調試(每個 HOC 都應該符合規則的顯示名稱);
- 不要在
render
函數中使用高階組件(每次 render,高階都返回新組件,影響 diff 性能); - 靜態方法必須被拷貝(經過高階返回的新組件,並不會包含原始組件的靜態方法);
- 避免使用 ref(ref 不會被傳遞);
HOC 的優缺點
至此我們可以總結一下高階組件(HOC)
的優點:
HOC
是一個純函數,便於使用和維護;- 同樣由於
HOC
是一個純函數,支持傳入多個參數,增強其適用范圍; HOC
返回的是一個組件,可組合嵌套,靈活性強;
當然HOC
也會存在一些問題:
- 當多個
HOC
嵌套使用時,無法直接判斷子組件的props
是從哪個HOC
負責傳遞的; - 當父子組件有同名
props
,會導致父組件覆蓋子組件同名props
的問題,且react
不會報錯,開發者感知性低; - 每一個
HOC
都返回一個新組件,從而產生瞭很多無用組件,同時加深瞭組件層級,不便於排查問題;
修飾器
和高階組件
屬於同一模式,在此不展開討論。
Render Props
Render Props
是一種非常靈活復用性非常高的模式,它可以把特定行為或功能封裝成一個組件,提供給其他組件使用讓其他組件擁有這樣的能力。
The term “render prop” refers to a technique for sharing code between React components using a prop whose value is a function.
這是React
官方對於Render Props
的定義,翻譯成大白話即:“Render Props
是實現React Components
之間代碼共享的一種技術,組件的props
裡邊包含有一個function
類型的屬性,組件可以調用該props
屬性來實現組件內部渲染邏輯”。
官方示例:
<DataProvider render={(data) => <h1>Hello {data.target}</h1>} />
如上,DataProvider
組件擁有一個叫做render
(也可以叫做其他名字)的props
屬性,該屬性是一個函數,並且這個函數返回瞭一個React Element
,在組件內部通過調用該函數來完成渲染,那麼這個組件就用到瞭render props
技術。
讀者或許會疑惑,“我們為什麼需要調用props
屬性來實現組件內部渲染,而不直接在組件內完成渲染”?借用React
官方的答復,render props
並非每個React
開發者需要去掌握的技能,甚至你或許永遠都不會用到這個方法,但它的存在的確為開發者在思考組件代碼共享的問題時,提供瞭多一種選擇。
Render Props
使用場景
我們在項目開發中可能需要頻繁的用到彈窗,彈窗 UI 可以千變萬化,但是功能卻是類似的,即打開
和關閉
。以antd
為例:
import { Modal, Button } from "antd" class App extends React.Component { state = { visible: false } // 控制彈窗顯示隱藏 toggleModal = (visible) => { this.setState({ visible }) }; handleOk = (e) => { // 做點什麼 this.setState({ visible: false }) } render() { const { visible } = this.state return ( <div> <Button onClick={this.toggleModal.bind(this, true)}>Open</Button> <Modal title="Basic Modal" visible={visible} onOk={this.handleOk} onCancel={this.toggleModal.bind(this, false)} > <p>Some contents...</p> </Modal> </div> ) } }
以上是最簡單的Model
使用實例,即便是簡單的使用,我們仍需要關註它的顯示狀態,實現它的切換方法。但是開發者其實隻想關註與業務邏輯相關的onOk
,理想的使用方式應該是這樣的:
<MyModal> <Button>Open</Button> <Modal title="Basic Modal" onOk={this.handleOk}> <p>Some contents...</p> </Modal> </MyModal>
可以通過render props
實現以上使用方式:
import { Modal, Button } from "antd" class MyModal extends React.Component { state = { on: false } toggle = () => { this.setState({ on: !this.state.on }) } renderButton = (props) => <Button {...props} onClick={this.toggle} /> renderModal = ({ onOK, ...rest }) => ( <Modal {...rest} visible={this.state.on} onOk={() => { onOK && onOK() this.toggle() }} onCancel={this.toggle} /> ) render() { return this.props.children({ Button: this.renderButton, Modal: this.renderModal }) } }
這樣我們就完成瞭一個具備狀態和基礎功能的Modal
,我們在其他頁面使用該Modal
時,隻需要關註特定的業務邏輯即可。
以上可以看出,render props
是一個真正的React
組件,而不是像HOC
一樣隻是一個可以返回組件的函數,這也意味著使用render props
不會像HOC
一樣產生組件層級嵌套的問題,也不用擔心props
命名沖突產生的覆蓋問題。
render props
使用限制
在render props
中應該避免使用箭頭函數
,因為這會造成性能影響。
比如:
// 不好的示例 class MouseTracker extends React.Component { render() { return ( <Mouse render={mouse => ( <Cat mouse={mouse} /> )}/> ) } }
這樣寫是不好的,因為render
方法是有可能多次渲染的,使用箭頭函數
,會導致每次渲染的時候,傳入render
的值都會不一樣,而實際上並沒有差別,這樣會導致性能問題。
所以更好的寫法應該是將傳入render
裡的函數定義為實例方法,這樣即便我們多次渲染,但是綁定的始終是同一個函數。
// 好的示例 class MouseTracker extends React.Component { renderCat(mouse) { return <Cat mouse={mouse} /> } render() { return ( <Mouse render={this.renderTheCat} /> ) } }
render props
的優缺點
優點
- props 命名可修改,不存在相互覆蓋;
- 清楚 props 來源;
- 不會出現組件多層嵌套;
缺點
- 寫法繁瑣;
- 無法在
return
語句外訪問數據; - 容易產生函數回調嵌套;
如下代碼:
const MyComponent = () => { return ( <Mouse> {({ x, y }) => ( <Page> {({ x: pageX, y: pageY }) => ( <Connection> {({ api }) => { // yikes }} </Connection> )} </Page> )} </Mouse> ) }
Hook
React
的核心是組件,因此,React
一直致力於優化和完善聲明組件的方式。從最早的類組件
,再到函數組件
,各有優缺點。類組件
可以給我們提供一個完整的生命周期和狀態(state),但是在寫法上卻十分笨重,而函數組件
雖然寫法非常簡潔輕便,但其限制是必須是純函數,不能包含狀態,也不支持生命周期,因此類組件
並不能取代函數組件
。
而React
團隊覺得組件的最佳寫法應該是函數,而不是類,由此產生瞭React Hooks
。
React Hooks 的設計目的,就是加強版函數組件,完全不使用”類”,就能寫出一個全功能的組件。
為什麼說類組件
“笨重”,借用React
官方的例子說明:
import React, { Component } from "react" export default class Button extends Component { constructor() { super() this.state = { buttonText: "Click me, please" } this.handleClick = this.handleClick.bind(this) } handleClick() { this.setState(() => { return { buttonText: "Thanks, been clicked!" } }) } render() { const { buttonText } = this.state return <button onClick={this.handleClick}>{buttonText}</button> } }
以上是一個簡單的按鈕組件,包含最基礎的狀態和點擊方法,點擊按鈕後狀態發生改變。
本是很簡單的功能組件,但是卻需要大量的代碼去實現。由於函數組件
不包含狀態,所以我們並不能用函數組件
來聲明一個具備如上功能的組件。但是我們可以用Hook
來實現:
import React, { useState } from "react" export default function Button() { const [buttonText, setButtonText] = useState("Click me, please") function handleClick() { return setButtonText("Thanks, been clicked!") } return <button onClick={handleClick}>{buttonText}</button> }
相較而言,Hook
顯得更輕量,在貼近函數組件
的同時,保留瞭自己的狀態。
在上述例子中引入瞭第一個鉤子useState()
,除此之外,React
官方還提供瞭useEffect()
、useContext()
、useReducer()
等鉤子。具體鉤子及其用法詳情請見官方。
Hook
的靈活之處還在於,除瞭官方提供的基礎鉤子之外,我們還可以利用這些基礎鉤子來封裝和自定義鉤子,從而實現更容易的代碼復用。
Hook 優缺點
優點
- 更容易復用代碼;
- 清爽的代碼風格;
- 代碼量更少;
缺點
- 狀態不同步(函數獨立運行,每個函數都有一份獨立的作用域)
- 需要更合理的使用
useEffect
- 顆粒度小,對於復雜邏輯需要抽象出很多
hook
總結
除瞭Mixin
因為自身的明顯缺陷而稍顯落後之外,對於高階組件
、render props
、react hook
而言,並沒有哪種方式可稱為最佳方案
,它們都是優勢與劣勢並存的。哪怕是最為最熱門的react hook
,雖然每一個hook
看起來都是那麼的簡短和清爽,但是在實際業務中,通常都是一個業務功能對應多個hook
,這就意味著當業務改變時,需要去維護多個hook
的變更,相對於維護一個class
而言,心智負擔或許要增加許多。隻有切合自身業務的方式,才是最佳方案
。
參考文檔:
React Mixin 的使用
Mixins Considered Harmful
Higher-Order Components
Render Props
React 拾遺:Render Props 及其使用場景
Hook 簡介
到此這篇關於React 代碼共享最佳實踐方式的文章就介紹到這瞭,更多相關React 代碼共享內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!