🌈 A redux helper for react & hooks & typescript developers.
- 🚀简单高效：完全去除了redux冗余低效的样板代码，提供一把全自动的生产力工具。
- 🍧 类型安全：面向typescript用户，100%类型安全，同时摒弃interface类型预定义，改用infer，实现了state和dispatch类型推导，极大地减少了类型定义代码。
✈️ 目前未来：拥抱react hooks，便于typescript的类型检查和代码复用。- 🍸最佳实践：Imdux的目的不仅仅是提供一个库，更希望的是提供一个解决方案，探索一种react hooks的最佳实践。
首先，创建一个react项目：
npx create-react-app imdux-demo安装imdux，imdux依赖于 immer，redux，react-redux ：
yarn add imdux immer redux react-redux创建一个简单的项目结构：
├── package.json
├── public
│ ├── favicon.ico
│ ├── index.html
│ └── robots.txt
├── src
│ ├── App.js
│ ├── index.js
│ └── store
│ ├── counter.reducers.js
│ └── index.js
└── yarn.lock打开src/store/counter.reducers.js，输入代码：
import { createAction } from "imdux";
const initialState = {
value: 0
};
const reducers = {
increase(draft, payload) {
draft.value += payload;
},
decrease(draft, payload) {
draft.value -= payload;
}
};
export const counter = createAction({ initialState, reducers });打开src/store/index.js，创建一个store：
import { createStore } from "imdux";
import { counter } from "./counter.reducers";
export const store = createStore({ counter }, { devtool: true });
export const { Dispatch, Query } = store;打开src/App.js，创建一个App：
import React from "react";
import { useSelector } from "react-redux";
import { Dispatch } from "./store";
export function App() {
// 取出counter中的值，如果这个值改变，那么组件会自动更新
const value = useSelector(store => store.counter.value);
return (
<div style={{ padding: 20 }}>
<h1>{value}</h1>
<button onClick={() => Dispatch.counter.increase(1)}>increase</button> {/* 通过Dispatch触发状态更新 */}
<button onClick={() => Dispatch.counter.decrease(1)}>decrease</button>
</div>
);
}最后，打开src/index.js，注入redux的store：
import React from "react";
import ReactDOM from "react-dom";
import { Provider } from "react-redux";
import { App } from "./App";
import { store } from "./store";
ReactDOM.render(
<Provider store={store.redux}> {/* 注入 */}
<App />
</Provider>,
document.getElementById("root")
);enjoy it~ 很简单，对不对？
你可以在浏览器中打开这个例子： javascript typescript
打开redux的devtool，通过点击increase和decreasebutton，我们可以看到状态变更的历史记录：
上面的例子中，如果有多个counter，可以在reducers中用命名空间隔离：
import { createAction } from "imdux";
const initialState = {
first: 0,
last: 0,
};
const reducers = {
first: {
increase(draft, payload) {
draft.first += payload;
},
decrease(draft, payload) {
draft.first -= payload;
}
},
last: {
increase(draft, payload) {
draft.last += payload;
},
decrease(draft, payload) {
draft.last -= payload;
}
}
};
export const counter = createAction({ initialState, reducers });export function App() {
const first = useSelector(store => store.counter.first);
const last = useSelector(store => store.counter.last);
return (
<div style={{ padding: 20 }}>
<h1>{first}</h1>
<button onClick={() => Dispatch.counter.first.increase(1)}>increase</button>
<button onClick={() => Dispatch.counter.first.decrease(1)}>decrease</button>
<h1>{last}</h1>
<button onClick={() => Dispatch.counter.last.increase(1)}>increase</button>
<button onClick={() => Dispatch.counter.last.decrease(1)}>decrease</button>
</div>
);
}
命名空间是可以多级嵌套，应当根据项目情况自由组织，推荐把相关的状态变更放在一个命名空间下。
在redux中，某些情况下需要同步获得状态的最新值，redux提供了getState()接口来实现。
在imdux中，createStore导出的Query内置了getter，可以达到和getState()一样的效果。
例如：
import { createStore } from "imdux";
import { counter } from "./counter.reducers";
export const store = createStore({ counter }, { devtool: true });
export const { Dispatch, Query } = store;
console.log(store.redux.getState().counter); // { value: 0 }
console.log(Query.counter); // { value: 0 }
console.log(store.redux.getState().counter === Query.counter); // true在redux中实现100%的类型检查是imdux的初衷。对于typescript用户，推荐在counter.reducers.ts中带上类型：
import { createAction } from "imdux";
type State = typeof initialState; // 获得类型
type Reducers = typeof reducers; // 获得类型
const initialState = {
value: 0
};
const reducers = {
increase(draft: State, payload: number) { // draft的类型为State
draft.value += payload;
},
decrease(draft: State, payload: number) { // draft的类型为State
draft.value -= payload;
}
};
export const counter = createAction<State, Reducers>({ initialState, reducers }); // 注入类型在src/store/index.ts中，导出Query的类型，改写useSelector的函数定义：
import { createStore } from "imdux";
import { useSelector as useReduxSelector } from "react-redux";
import { counter } from "./counter.reducers";
export const store = createStore({ counter }, { devtool: true });
export const { Dispatch, Query } = store;
export type Store = typeof Query;
export function useSelector<TSelected>(
selector: (state: Store) => TSelected,
equalityFn?: (left: TSelected, right: TSelected) => boolean
) {
return useReduxSelector<Store, TSelected>(selector, equalityFn);
}在src/App.tsx中，使用改写后的useSelector，这样就可以很轻松地获得typescript的类型检查和代码提示：
你可以在浏览器中打开这个例子： javascript typescript
按住ctrl键，鼠标左键点击increase，可以准确跳转到reducers.increase：
immer是一个强大的immutable库，它可以非常直观、高效地创建immutable数据：
import produce from "immer";
const user = {
name: "Jack",
friends: [{ name: "Tom" }, { name: "Jerry" }]
};
const user2 = produce(user, draft => {
draft.name = "James";
});
console.log(user2.friends === user.friends); // true
const user3 = produce(user, draft => {
draft.friends.push({ name: "Vesper" });
});
console.log(user3.friends === user.friends); // false
console.log(user3.friends[0] === user.friends[0]); // true他的原理如图：
相对于通过扩展运算符...，Array.slice等方式来创建immutable对象，immer通过一个参数为draft的函数来修改原对象，然后将修改的过程打包生成一个新对象，原对象不变，符合人的思维直觉。
详情请参考immer文档：https://immerjs.github.io/immer/docs/introduction
其实，从名字你就可以看出端倪：imdux = im + dux = immer + redux
imdux做的事情其实很简单，就是将redux中的reducer，和immer中的draft函数合二为一：
- 利用修改draft不会影响原来对象的特性，在reducer内直接读取和修改draft
- 利用immer中的produce函数，来生成下一个immutable状态，然后提交给redux，触发状态更新
基于以上原理，imdux中的reducer必须是同步的。
imdux推荐两种异步操作解决办法：
- 基于hooks的异步方案
- 基于全局函数的异步方案
一个常见的滚动翻页代码如下：
// 定义一个名称为news的action，并使用createStore初始化
import { createAction } from "imdux";
const initialState = {
list: [],
page: 0,
isLoading: false,
isEndOfList: false
};
const reducers = {
addNews(draft, list) {
draft.list.push(...list);
},
addPage(draft) {
if (draft.isEndOfList || draft.isLoading) return;
draft.page++;
},
startLoading(draft) {
draft.isLoading = true;
},
stopLoading(draft) {
draft.isLoading = false;
},
reachEndOfList(draft) {
draft.isEndOfList = true;
}
};
export const news = createAction({ initialState, reducers });// 使用Dispatch.news.addPage更新news.page，触发request异步操作
import * as React from "react";
import { useSelector } from "react-redux";
import { Dispatch, Store } from "./store";
export default function App() {
const news = useSelector(p => p.news);
React.useEffect(() => {
request(news.page);
}, [news.page]);
const request = async (page) => {
Dispatch.news.startLoading();
try {
const response = await Api.getNewsList(page);
if (!Api.isError(response)) {
if (response.data.list.length === 0) {
Dispatch.news.reachEndOfList();
} else {
Dispatch.news.addNews(response.data.list);
}
} else {
alert(response.message);
}
} catch (e) {
alert(e.message);
} finally {
Dispatch.news.stopLoading();
}
};
return (
<div onScroll={Dispatch.news.addPage}>
{news.list.map(item =>
<h1 key={item.key}>{item.title}</h1>
)}
{news.isLoading ? "加载中" : news.isEndOfList ? "加载完毕" : ""}
</div>
);
}当一个异步方法需要在多个component中复用的时候，可以定义一个全局函数，在函数内使用Dispatch触发状态更新，使用Query获得状态的最新值，然后在需要的component中import这个函数即可。
需要注意的是，这种方案非常简单，但是会造成全局变量污染问题，请酌情使用。
// TODO
MIT