ReactContext循环更新怎么解决

文章小白一枚，正在不断学习积累知识，现将学习到的知识记录一下，也是将我的所得分享给大家！而今天这篇文章《React Context无限循环怎么解决》带大家来了解一下##content_title##，希望对大家的知识积累有所帮助，从而弥补自己的不足，助力实战开发！

本文旨在深入探讨React Context组件中因不当状态管理和副作用处理导致的无限循环问题。我们将分析在组件渲染阶段直接调用setState与useEffect依赖项结合如何触发循环，并提供一个健壮的解决方案，通过将初始状态同步逻辑移至useEffect钩子，有效防止不必要的重渲染，确保应用性能与稳定性。

理解React Context中的无限循环成因

在React应用中，特别是使用Context进行全局状态管理时，如果不正确地处理状态更新和副作用，很容易导致组件进入无限重渲染的循环。这种循环不仅会消耗大量资源，还会导致应用崩溃或无响应。

问题的核心在于React的渲染生命周期和useEffect钩子的工作机制。当组件的状态发生变化时，React会触发重新渲染。useEffect钩子则允许我们在组件渲染后执行副作用，并且可以通过其依赖项数组来控制何时重新运行这些副作用。

考虑以下常见的错误模式，它会导致无限循环：

1. 在组件的顶层（渲染阶段）直接调用setState： 当setState在组件函数体（即渲染阶段）中被直接调用，而不是在事件处理函数或useEffect等副作用钩子中时，每次组件渲染都会触发状态更新。状态更新又会导致组件重新渲染，从而形成一个立即的无限循环。

2. useEffect的依赖项与渲染阶段的setState形成闭环： 如果useEffect的依赖项中包含一个在渲染阶段被setState更新的状态，那么：

   • 渲染阶段的setState触发重渲染。
   • 重渲染后，useEffect检测到其依赖项（被更新的状态）发生变化，从而执行其内部逻辑。
   • useEffect内部可能又包含另一个setState调用（例如，根据获取到的数据更新systemUser）。
   • 这个内部的setState再次触发重渲染，重新开始整个循环。

在提供的AuthProvider组件示例中，问题的症结在于以下代码段：

// AuthProvider.tsx
// ...
const [accessToken, setAccessToken] = useState<string | null>(null)
const { 'nextauth-token': token } = parseCookies()

// 问题代码段：在组件的渲染阶段直接调用 setAccessToken
if ((!accessToken && token) || accessToken !== token) {
    setAccessToken(token) // 每次渲染时，如果条件满足，都会尝试更新 accessToken 状态
    Api.defaults.headers.authorization = token
}

console.log('a') // 此处会无限打印 'a'
// ...
useEffect(() => {
    async function retrieveUserInformation(): Promise<void> {
        const response = await fecthSystemUserInfo()

        if (response.isRight()) {
            const user = response.value
            // await setSystemUser(user) // 当此行被启用时，循环会进一步加剧
        }
    }

    if (!systemUser && accessToken) {
        retrieveUserInformation()
    }

    if (systemUser && !accessToken) {
        setSystemUser(null)
    }
}, [accessToken]) // useEffect 依赖于 accessToken
// ...

具体分析此处的循环机制：

1. 首次渲染或token发生变化时：
   • 组件顶层的if条件(!accessToken && token) || accessToken !== token可能会为真。
   • setAccessToken(token)被调用。这会触发组件的重新渲染。
2. 重渲染发生：
   • 组件再次执行其函数体。
   • console.log('a')被打印。
   • if条件再次被评估。即使accessToken现在与token匹配，如果token本身是从外部（如cookie）获取的，并且在每次渲染时都重新获取，或者存在其他微妙的时序问题，setAccessToken(token)仍可能被再次触发，导致无限循环。
   • 更关键的是，即使setAccessToken不再被触发，accessToken作为useEffect的依赖项，其值在上次渲染后可能发生了变化（从null到某个值）。
3. useEffect执行：
   • 因为accessToken是useEffect的依赖项，并且其值可能已发生变化，useEffect内部的逻辑（包括retrieveUserInformation）会被执行。
   • 如果setSystemUser(user)这行代码被启用，并且user是一个新创建的对象（即使内容相同，但引用不同），setSystemUser会再次触发组件的重新渲染。
4. 循环往复：
   • setSystemUser导致的重渲染又会回到第1步，再次执行组件顶层的代码，包括那个if语句，以及console.log('a')。
   • 这样，setAccessToken（可能）-> useEffect -> setSystemUser -> 重渲染 -> setAccessToken (可能) 的循环就形成了。

即使setAccessToken在后续渲染中不再被直接触发，useEffect中setSystemUser的调用（如果user每次都是新对象）也会导致无限循环，因为它依赖于accessToken，而accessToken的初始设置本身就触发了useEffect。

解决方案：利用useEffect进行初始状态同步

解决这类无限循环的关键在于，将那些只应该在组件挂载时或特定条件满足时执行一次的副作用（例如从cookie读取并设置初始状态）放到useEffect钩子中，并合理管理其依赖项。

对于从cookie读取token并设置accessToken这种操作，它通常只需要在组件首次挂载时执行一次。因此，应该将其放在一个带有空依赖项数组[]的useEffect中。

修正后的AuthProvider组件：

'use client'

import { AxiosError } from 'axios'
import { useRouter } from 'next/router'
import { destroyCookie, parseCookies, setCookie } from 'nookies'
import {
    ReactNode,
    createContext,
    useCallback,
    useEffect,
    useMemo,
    useState
} from 'react'

import { Either, left, right } from '@core/logic/Either'
import { accessLevel, controllers, endpoints } from '@routes/backend'
import { Api } from '@services/api/Axios'
import { fetchLogin } from '@services/api/FetchLogIn'

export type TSystemUser = {
    name: string
    role: string
} | null

export type TLoginParams = {
    phoneNumber: string
    password: string
}

export type TLoginResponse = Either<unknown, unknown>

type TAuthContext = {
    systemUser: TSystemUser
    login: (data: TLoginParams) => Promise<Either<unknown, unknown>>
    logout: () => void
}

export const AuthContext = createContext({} as TAuthContext)

export function AuthProvider({ children }: { ReactNode }) {
    const [systemUser, setSystemUser] = useState<TSystemUser>(null)
    const [accessToken, setAccessToken] = useState<string | null>(null)
    const { 'nextauth-token': token } = parseCookies()

    // 修正方案：将初始 accessToken 的设置移动到 useEffect 中
    // 这个 useEffect 只在组件挂载时运行一次，或者在 token 变化时运行（如果将其作为依赖）
    // 对于从 cookie 读取并设置初始值，通常只需要在挂载时执行一次。
    useEffect(() => {
        if (token) {
            setAccessToken(token)
            Api.defaults.headers.authorization = token // 设置 Axios 默认头
        } else if (accessToken) {
            // 如果 token 不存在但 accessToken 状态中还有值，清除它
            setAccessToken(null)
            Api.defaults.headers.authorization = null
            destroyCookie(undefined, 'nextauth-token')
        }
    }, [token]) // 依赖于 token，确保当 cookie 中的 token 变化时更新

    // console.log('a') // 现在这里不会无限打印 'a'

    const fecthSystemUserInfo = useCallback(async (): Promise<
        Either<AxiosError<TSystemUser>, TSystemUser>
    > => {
        try {
            const response = await Api.get<TSystemUser>(
                accessLevel.session +
                    controllers.withSession +
                    endpoints.RetrieveUserInformation
            )

            return right(response.data)
        } catch (err) {
            const error = err as AxiosError<TSystemUser>

            switch (error.status) {
                default:
                    return left(error)
            }
        }
    }, [accessToken]) // 此处依赖 accessToken 是合理的，当 accessToken 变化时重新获取用户信息

    useEffect(() => {
        async function retrieveUserInformation(): Promise<void> {
            const response = await fecthSystemUserInfo()

            if (response.isRight()) {
                const user = response.value
                console.log(user) // { name: 'User', role: 'Admin' }
                setSystemUser(user) // 现在可以安全地启用此行，不会导致无限循环
                console.log(systemUser) // 仍然是 null，因为状态更新是异步的，此处打印的是旧值
            }

            console.log(response.value)
        }

        if (!systemUser && accessToken) {
            retrieveUserInformation()
        }

        if (systemUser && !accessToken) {
            setSystemUser(null)
        }

        console.log(systemUser)
    }, [accessToken, systemUser, fecthSystemUserInfo]) // 依赖项需要完整，包括 fecthSystemUserInfo

    const login = useCallback(
        async ({
            phoneNumber,
            password
        }: TLoginParams): Promise<TLoginResponse> => {
            try {
                if (systemUser) {
                    return right(null)
                }

                const response = await fetchLogin({ phoneNumber, password })

                if (response.isLeft()) {
                    return left(response.value)
                }

                const { accessToken: newAccessToken, user } = response.value

                setSystemUser(user)

                setCookie(undefined, 'nextauth-token', newAccessToken.token, {
                    expires: new Date(newAccessToken.expiresIn)
                })
                // 注意：这里更新了 cookie，会导致上面的 `useEffect(() => {}, [token])` 重新运行，
                // 从而更新 `accessToken` 状态，这是预期的行为。
                // setAccessToken(newAccessToken.token); // 如果想立即更新内部状态，也可以在这里调用
                // 但由于依赖于 `token` 的 useEffect 会处理，通常不需要手动调用

                return right(null)
            } catch (error) {
                console.log(error)

                return left(JSON.stringify(error, null, 2))
            }
        },
        [systemUser] // 依赖 systemUser，因为在函数内部使用了它
    )

    const logout = useCallback((): void => {
        const router = useRouter()

        destroyCookie(null, 'nextauth-token')
        Api.defaults.headers.authorization = null
        setSystemUser(null)
        setAccessToken(null) // 清除 accessToken 状态

        router.push('/')
    }, []) // 依赖项为空，因为 useRouter 是一个 Hook，其返回值是稳定的，其他操作不依赖外部状态

    const contextValue = useMemo(
        () => ({ systemUser, login, logout }),
        [systemUser, login, logout] // 依赖项应包含所有用到的状态和函数
    )

    return (
        <AuthContext.Provider value={contextValue}>
            {children}
        </AuthContext.Provider>
    )
}

关键改进点：

1. 将setAccessToken移入useEffect： 现在，从cookie读取token并据此设置accessToken和Api.defaults.headers.authorization的逻辑被封装在一个useEffect中。这个useEffect的依赖项是token。这意味着只有当token（从parseCookies()获取）实际发生变化时，这个副作用才会重新运行。在大多数情况下，这只会发生在组件首次挂载时，或者用户登录/登出导致cookie变化时，从而避免了在每次渲染时都触发setAccessToken。

2. useEffect依赖项的精确管理：

   • 第一个useEffect（用于处理token和accessToken同步）依赖于token。
   • 第二个useEffect（用于retrieveUserInformation）依赖于accessToken、systemUser和fecthSystemUserInfo。fecthSystemUserInfo本身是一个useCallback包裹的函数，它的依赖项是accessToken。这种链式依赖是合理的，确保在相关状态变化时才重新获取用户信息。

3. login和logout的依赖项：

   • login函数现在依赖于systemUser，因为它的逻辑中使用了systemUser。
   • logout函数现在依赖项为空[]，因为它不依赖于组件内部的任何可变状态或props，useRouter的返回值是稳定的。

4. useMemo的依赖项：contextValue的useMemo现在依赖于systemUser, login, 和 logout。确保当这些值发生变化时，contextValue才重新计算，避免不必要的Context消费者重渲染。

最佳实践与注意事项

• 避免在渲染阶段直接调用setState：这是导致无限循环最常见的原因。任何改变状态的操作都应该封装在事件处理函数、useEffect、useCallback或useMemo中。
• 仔细管理useEffect的依赖项：空数组[]表示只在组件挂载和卸载时运行；包含变量的数组表示当这些变量变化时运行。不正确的依赖项会导致副作用运行过于频繁或不足。
• 理解对象和数组的引用相等性：在JavaScript中，对象和数组是通过引用进行比较的。即使两个对象的属性完全相同，但如果它们是不同的引用，useEffect会认为它们是“变化的”，从而触发副作用。如果setSystemUser(user)中的user每次都是新创建的对象，即使其内容不变，也会导致systemUser被视为变化。在这种情况下，可以考虑使用useRef来存储不变的对象，或者在useEffect中进行深比较（如果性能允许）。
• 异步状态更新：setState是异步的。这意味着在调用setSystemUser(user)之后立即console.log(systemUser)，你很可能仍然看到旧的值。要获取更新后的值，应该使用useEffect来监听systemUser的变化。
• Context的性能考量：Context提供者（AuthContext.Provider）的value属性每次渲染时都会进行浅比较。如果value是一个对象，并且它的引用在每次渲染时都发生变化（即使内容不变），所有消费该Context的组件都会重新渲染。因此，使用useMemo来缓存contextValue非常重要，并确保其依赖项列表正确。

通过遵循这些原则，可以有效地避免React Context中的无限循环问题，构建出更健壮、性能更优的React应用。

到这里，我们也就讲完了《ReactContext循环更新怎么解决》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！