当发送特殊事件（套接字 IO 消息）时，如何使所有 Redux RTK 查询无效？

Question

我想为所有用户（多个选项卡，多个用户）同步 SPA React 应用程序。我编写了一个简单的反应钩子，它监听特定的套接字 IO 消息并根据名为 useGetAllEmployeesQuery 的消息更新状态变量：

import { useEffect, useState } from 'react'

export function useRefetchOnMessage (messageType) {
  const [needRefetch, setNeedRefetch] = useState()

  if (!window.io.socket) {
    return
  }

  function handleMessage (e) {
    setNeedRefetch(Date.now())
  }

  useEffect(() => {
    window.io.socket.on(messageType, handleMessage)

    return () => {
      window.io.socket.off(messageType, handleMessage)
    }
  }, [])

  return needRefetch
}

当调度此事件时，我只需调用 RTK refetch() 方法。

const employees = useGetAllEmployeesQuery(officeId)

const needRefreshEmployees = useRefetchOnMessage('employees changed')

useEffect(() => {
  if (!needRefreshEmployees) return

  employees.refetch()
}, [needRefreshEmployees])

因此我们需要在应用程序中的任何地方调用它，假设我们有 5 个使用员工查询的组件，我们需要在所有组件中调用 refetch 。许多查询只要运行一次就足够了，就可以运行。 （一次无效）

是否可以在 Redux RTK 查询配置中订阅任何类型的此类事件？

Answer 1

您可以通过使标记无效来触发订阅的查询重新查询。

请参阅invalidateTags：Redux 操作创建器，可用于手动使 的缓存标签失效自动重新获取。

假设 getAllEmployees 端点提供了一个标签，例如“employees”，您可以调度一个操作来使该标记无效并触发 useGetAllEmployeesQuery 挂钩来重新获取数据。

const api = createApi({
  ...
  endpoints: builder => ({
    ...
    getAllEmployees: builder.query({
      query: ......,
      ...
      providesTags: ["employees"],
    }),
    ...
  }),
});

import { useEffect } from 'react';
import { useDispatch } from 'react-redux';
import api from '../path/to/apiSlice';

export function useRefetchOnMessage (messageType = "", tags = []) {
  const dispatch = useDispatch();

  useEffect(() => {
    const handleMessage = () => {
      dispatch(api.util.invalidateTags(tags));
    };

    window.io?.socket?.on(messageType, handleMessage);

    return () => {
      window.io?.socket?.off(messageType, handleMessage);
    }
  }, [messageType, tags]);
}

UI 代码只需调用挂钩，将 "employees" 标记传递给 useRefetchOnMessage 挂钩。

const employees = useGetAllEmployeesQuery(officeId);
useRefetchOnMessage('employees changed', ["employees"]);