如何实现类似Vue中watch
功能的useWatch
自定义Hook,以下是几种常见的实现方式和特点:
1. 基础实现
import { useEffect, useRef } from 'react';
function useWatch<T>(value: T, callback: (prev?: T) => void) {
const prev = useRef<T>();
useEffect(() => {
callback(prev.current);
prev.current = value;
}, [value]);
}
- 特点:简单直接,监听值变化并执行回调,同时提供旧值。
- 使用场景:适用于大多数基本的监听需求。
2. 增加immediate
选项
import { useEffect, useRef } from 'react';
type Config = {
immediate: boolean;
};
function useWatch<T>(value: T, callback: (prev?: T) => void, config: Config = { immediate: false }) {
const { immediate } = config;
const prev = useRef<T>();
const inited = useRef(false);
useEffect(() => {
const execute = () => callback(prev.current);
if (!inited.current) {
inited.current = true;
if (immediate) {
execute();
}
} else {
execute();
}
prev.current = value;
}, [value]);
}
- 特点:增加了
immediate
选项,允许在组件初始化时立即执行回调。 - 使用场景:当需要在组件加载时立即执行监听逻辑时非常有用。
3. 增加停止监听功能
import { useEffect, useRef } from 'react';
type Config = {
immediate: boolean;
};
function useWatch<T>(value: T, callback: (prev?: T) => void, config: Config = { immediate: false }) {
const { immediate } = config;
const prev = useRef<T>();
const inited = useRef(false);
const stop = useRef(false);
useEffect(() => {
const execute = () => callback(prev.current);
if (!stop.current) {
if (!inited.current) {
inited.current = true;
if (immediate) {
execute();
}
} else {
execute();
}
prev.current = value;
}
}, [value]);
return () => {
stop.current = true;
};
}
- 特点:增加了停止监听的功能,允许动态控制监听的开启和关闭。
- 使用场景:适用于需要在某些条件下动态停止监听的场景。
4. 使用lodash
进行深度比较
import { useEffect, useRef } from 'react';
import { isEqual } from 'lodash';
function useWatch<T>(value: T, callback: (prev?: T) => void, config: Config = { immediate: false }) {
const { immediate } = config;
const prev = useRef<T>();
const inited = useRef(false);
useEffect(() => {
const execute = () => {
if (!isEqual(prev.current, value)) {
callback(prev.current);
}
};
if (!inited.current) {
inited.current = true;
if (immediate) {
execute();
}
} else {
execute();
}
prev.current = value;
}, [value]);
}
- 特点:使用
lodash
的isEqual
方法进行深度比较,确保监听的值是真正发生变化时才执行回调。 - 使用场景:适用于监听复杂数据结构(如对象或数组)的变化。
使用示例
import React, { useState } from 'react';
import { useWatch } from './useWatch';
function App() {
const [count, setCount] = useState(0);
useWatch(count, (oldCount) => {
console.log(`count changed from ${oldCount} to ${count}`);
}, { immediate: true });
return (
<div>
<p>Count: {count}</p>
<button onClick={() => setCount(count + 1)}>Increment</button>
</div>
);
}
export default App;
总结
这些实现方式各有特点,可以根据具体需求选择合适的版本。如果需要简单的监听功能,基础实现就足够了;如果需要更复杂的控制,如立即执行或停止监听,则可以选择带有immediate
和停止功能的版本。