深入解析与解决React Context中的无限循环问题

// 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
// ...

'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>
    )
}