翻譯自:https://github.com/dojo/framework/blob/master/docs/en/middleware/introduction.md
Dojo 的中間件系統能以響應式的方式管理異步或命令式 API,以及影響基於函數的組合部件或其他中間件的行爲與屬性 API。
框架已提供了幾個核心中間件和可選中間件,應用程序開發人員也可以輕鬆編寫自己的中間件。
功能 | 描述 |
---|---|
響應式 DOM 訪問 | 藉助中間件,基於函數的部件可以處理和使用輸出節點對應的 DOM 部分的具體信息和 API。 |
控制部件渲染的生命週期 | 對任何組合部件,中間件可以控制 Dojo 渲染管道的各個部分,如當需要更新渲染時讓部件失效。也可以暫停和繼續部件的渲染,在等待關鍵信息可以使用時,短路渲染結果。 |
框架提供了一些中間件 | Dojo 提供了一些中間件,能讓部件實現很多功能,如響應和控制焦點、簡單的緩存值、響應元素的交叉事件和大小變化事件、CSS 主題、國際化和構建時渲染等。 |
易於組合和複用 | 中間件的設計是與基於函數的部件緊密結合的,中間件能組合到部件的層次結構中,並且在開發自定義中間件時也可複用中間件 |
基本用法
創建中間件
- 定義基於函數部件的
create()
也可以用於定義中間件 - 定義一個屬性接口(可選),以擴充使用了此中間件的部件的屬性接口。當創建組合部件實例時傳入這些屬性值
- 返回一個簡單的函數引用,該函數定義了中間件的 API,供其他組合部件或中間件使用
src/middleware/myMiddleware.ts
import { create } from '@dojo/framework/core/vdom';
const factory = create().properties<{ middlewareProp?: boolean }>();
export const myMiddleware = factory(({ properties }) => {
return () => {
return properties().middlewareProp ? 'Conditional is true' : 'Conditional is false';
};
});
export default myMiddleware;
組合中間件
- 組合中間件並返回一個對象以公開更復雜的 API
- 使用核心的
invalidator
中間件將組合部件標記爲需要重新渲染
src/middleware/myComposingMiddleware.ts
import { create, invalidator } from '@dojo/framework/core/vdom';
import myMiddleware from './myMiddleware';
const factory = create({ myMiddleware, invalidator });
export const myComposingMiddleware = factory(({ middleware: { myMiddleware, invalidator } }) => {
return {
get() {
return myMiddleware();
},
set() {
invalidator();
}
};
});
export default myComposingMiddleware;
部件內使用中間件
- 用中間件使用的附加屬性來擴充部件的屬性接口
- 使用中間件組合成的部件時,傳入中間件的屬性
src/widgets/MyWidget.tsx
import { create, tsx } from '@dojo/framework/core/vdom';
import myComposingMiddleware from '../middleware/myComposingMiddleware';
const factory = create({ myComposingMiddleware });
export default factory(function MyWidget({ properties, middleware: { myComposingMiddleware } }) {
return (
<virtual>
<div>{`Middleware property value: ${properties.middlewareProp}`}</div>
<div>{`Middleware usage: ${myComposingMiddleware.get()}`}</div>
</virtual>
);
});
src/main.tsx
import renderer, { tsx } from '@dojo/framework/core/vdom';
import MyWidget from './widgets/MyWidget';
const r = renderer(() => <MyWidget middlewareProp={true} />);
r.mount();