hooks-api
Last updated
Last updated
如果你之前对于Hooks没有了解，那么你可能需要看下概述部分。你或许也可以在一些常见的问题中找到有用的信息。
const [state, setState] = useState(initialState);返回有状态值，以及更新这个状态值的函数。
在初始渲染的时候，返回的状态(state)与作为第一个参数(initialState)传递的值相同。
setState函数用于更新state。setState接受一个新的状态值，并将组件的重新渲染排入队列。
setState(newState);在后续重新渲染期间，useState返回的第一个值将始终是应用更新后的最新状态。
如果更新状态需要用到前面的状态，那可以传递一个函数给setXxxx,类似于类组件中的setState。这个函数可以接收先前的值，然后返回更新之后的值。
function Counter({initialCount}) {
const [count, setCount] = useState(initialCount);
return (
<>
Count: {count}
<button onClick={() => setCount(0)}>Reset</button>
<button onClick={() => setCount(prevCount => prevCount + 1)}>+</button>
<button onClick={() => setCount(prevCount => prevCount - 1)}>-</button>
</>
);
}就像这样，给setCount传递一个函数，这个函数接收一个参数(上一个状态值)，最后返回新的状态值用以setCount。
注意： 与类组件中的
setState方法不同，useState不会自动合并更新对象。 但是你可以自己做到这点：setXxxx(prevState => { // Object.assign would also work return {...prevState, ...updatedValues}; });另一个选项是使用
useReducer，它更适合管理包含多个子值的状态对象。
initialState参数是初始渲染期间使用的状态。在随后的渲染中，它被忽略了。如果初始状态是复杂计算的结果，则可以改为提供函数，该函数仅在初始渲染时执行：
const [state, setState] = useState(() => {
const initialState = someExpensiveComputation(props);
return initialState;
});useEffect(didUpdate);接受包含命令式，可能有副作用代码的函数。
函数组件的主体内部不允许发生改变，订阅，计时器，日志记录和其他副作用（称为React的渲染阶段）。这样做会导致UI中的错误和不一致性混乱。
相反，使用useEffect。传递给useEffect的函数将在渲染结束后运行。将效果(副作用)视为从React的纯函数进入命令式的逃脱舱。
默认情况下，效果在每次完成渲染后运行，但是你可以选择仅在某些值发生更改时触发它。前面介绍effect hook时有提到，本文下面仍然会详细介绍。
通常，效果会创建一些在组件卸载时需要清理的资源，例如订阅或计时器ID。为此，传递给useEffect的函数可能会返回一个清理函数。例如，要创建订阅：
useEffect(() => {
const subscription = props.source.subscribe();
return () => {
// Clean up the subscription
subscription.unsubscribe();
};
});返回的清除函数在从UI中卸载组件之前运行，以防止内存泄漏。此外，如果组件呈现多次（通常如此），则在执行下一个效果之前会清除先前的效果。 在我们的示例中，这意味着每次更新都会创建一个新订阅。要避免在每次更新时触发效果，请继续往下看。
与componentDidMount和componentDidUpdate不同，传递给useEffect的函数在延迟事件期间在布局和绘制后触发。这使得它适用于许多常见的副作用，例如设置订阅和事件处理程序，因为大多数类型的工作不应阻止浏览器更新屏幕。
但是，并非所有效果都可以推迟。例如，用户可见的DOM改变必须在下一次绘制之前同步触发，以便用户不会感觉到视觉上的不一致。对于这些类型的效果，React提供了两个额外的Hook：useMutationEffect和useLayoutEffect。这些Hook与useEffect具有相同的api，并且仅在触发时有所不同。
虽然useEffect会延迟到浏览器绘制完成之后，但它保证在任何新渲染之前触发，也就是说在开始新的更新之前，React将始终刷新先前渲染的效果。
效果的默认行为是在每次完成渲染后触发效果。这样，如果其中一个输入发生变化，则始终会重新创建效果。
但是，在某些情况下，这可能是不需要的，例如上一节中的订阅示例。仅当source prop已更改时，我们无需在每次更新时创建新订阅。
要实现此功能，请将第二个参数传递给useEffect，它是效果所依赖的值数组。我们更新的示例现在看起来像这样：
useEffect(
() => {
const subscription = props.source.subscribe();
return () => {
subscription.unsubscribe();
};
},
[props.source],
);现在只有在 props.source更改时才会重新创建订阅。传入一个空数组[]输入告诉React你的效果不依赖于组件中的任何值，因此该效果仅在mount和unmount上运行，从不在更新时运行。
注意 输入数组不作为参数传递给效果函数。 但从概念上讲，这就是它们所代表的内容：效果函数中引用的每个值也应出现在输入数组中，这样才有意义。并且从之前可以得知，只要数组里的内容有一个不同，那就会再次调用这个效果。
const context = useContext(Context);接受上下文对象（从React.createContext返回的值）并返回当前上下文值，由给定上下文的最近上下文提供程序给出。
当提供程序更新时，此Hook将使用最新的上下文值触发重新呈现。
以下钩子可以是上一节中基本钩子的变体，也可以仅用于特定边缘情况。不强调预先学习它们。
const [state, dispatch] = useReducer(reducer, initialState);useState的替代方案。接受类型为(state，action) => newState的reducer，并返回与dispatch方法配对的当前状态。 （如果熟悉Redux，你已经知道它是如何工作的。）
这是useState部分的计数器示例，用reducer重写：
const initialState = {count: 0};
function reducer(state, action) {
switch (action.type) {
case 'reset':
return initialState;
case 'increment':
return {count: state.count + 1};
case 'decrement':
return {count: state.count - 1};
}
}
function Counter({initialCount}) {
const [state, dispatch] = useReducer(reducer, initialState);
return (
<>
Count: {state.count}
<button onClick={() => dispatch({type: 'reset'})}>
Reset
</button>
<button onClick={() => dispatch({type: 'increment'})}>+</button>
<button onClick={() => dispatch({type: 'decrement'})}>-</button>
</>
);
}useReducer接受可选的第三个参数initialAction。如果提供，则在初始渲染期间应用初始操作。这对于计算包含通过props传递的值的初始状态非常有用：
const initialState = {count: 0};
function reducer(state, action) {
switch (action.type) {
case 'reset':
return {count: action.payload};
case 'increment':
return {count: state.count + 1};
case 'decrement':
return {count: state.count - 1};
}
}
function Counter({initialCount}) {
const [state, dispatch] = useReducer(
reducer,
initialState,
{type: 'reset', payload: initialCount},
);
return (
<>
Count: {state.count}
<button
onClick={() => dispatch({type: 'reset', payload: initialCount})}>
Reset
</button>
<button onClick={() => dispatch({type: 'increment'})}>+</button>
<button onClick={() => dispatch({type: 'decrement'})}>-</button>
</>
);
}当你具有涉及多个子值的复杂状态逻辑时，useReducer通常优于useState。它还允许你优化触发深度更新的组件的性能，因为你可以传递调度而不是回调。
const memoizedCallback = useCallback(
() => {
doSomething(a, b);
},
[a, b],
);返回一个memoized回调。
传递内联回调和一组输入。 useCallback将返回一个回忆的memoized版本，该版本仅在其中一个输入发生更改时才会更改。当将回调传递给依赖于引用相等性的优化子组件以防止不必要的渲染（例如，shouldComponentUpdate）时，这非常有用。
useCallback(fn，inputs) 等效 useMemo(() => fn，inputs)。
注意 输入数组不作为参数传递给回调。但从概念上讲，这就是它们所代表的内容：回调中引用的每个值也应出现在输入数组中。将来，一个足够先进的编译器可以自动创建这个数组。类似于上面提到的
effect第二个参数。
const memoizedValue = useMemo(() => computeExpensiveValue(a, b), [a, b]);返回一个memoized值。
传递“创建”功能和输入数组。 useMemo只会在其中一个输入发生更改时重新计算memoized值。此优化有助于避免在每个渲染上进行昂贵的计算。
如果未提供数组，则只要将新函数实例作为第一个参数传递，就会计算新值。 （使用内联函数，在每个渲染上。）
注意： 输入数组不作为参数传递给函数。但从概念上讲，这就是它们所代表的内容：函数内部引用的每个值也应出现在输入数组中。
const refContainer = useRef(initialValue);useRef返回一个可变的ref对象，其.current属性被初始化为传递的参数（initialValue）。返回的对象将持续整个组件的生命周期。
一个常见的用例是强制访问child：
function TextInputWithFocusButton() {
const inputEl = useRef(null);
const onButtonClick = () => {
// `current` points to the mounted text input element
inputEl.current.focus();
};
return (
<>
<input ref={inputEl} type="text" />
<button onClick={onButtonClick}>Focus the input</button>
</>
);
}请注意，useRef比ref属性更有用。保持任何可变值的方式类似于在类中使用实例字段的方法。
useImperativeMethods(ref, createInstance, [inputs])useImperativeMethods自定义使用ref时公开给父组件的实例值。与往常一样，在大多数情况下应避免使用refs的命令式代码。 useImperativeMethods应与forwardRef一起使用：
function FancyInput(props, ref) {
const inputRef = useRef();
useImperativeMethods(ref, () => ({
focus: () => {
inputRef.current.focus();
}
}));
return <input ref={inputRef} ... />;
}
FancyInput = forwardRef(FancyInput);在此示例中，呈现<FancyInput ref = {fancyInputRef} />的父组件将能够调用fancyInputRef.current.focus()。
api与useEffect相同，但在更新兄弟组件之前，它在React执行其DOM改变的同一阶段同步触发。使用它来执行自定义DOM改变。
在可能的情况下首选标准useEffect以阻止可见的更新。
注意 避免在
useMutationEffect中读取DOM。在读取计算样式或布局信息时，useLayoutEffect更合适。
api与useEffect相同，但在所有DOM改变后同步触发。使用它来从DOM读取布局并同步重新渲染。在浏览器有机会绘制之前，将在useLayoutEffect内部计划的更新将同步刷新。
在可能的情况下首选标准useEffect以阻止视觉更新。
提示 如果你正在从类组件迁移代码，则
useLayoutEffect会在与componentDidMount和componentDidUpdate相同的阶段触发，因此如果你不确定Hook要使用哪种效果，则他可能风险最小。