Redux Toolkit RTK Query 发送查询参数

Question

如何使用 Redux Toolkit RTK 查询将查询参数传递给 api？

import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react';

const baseUrl = 'xxxxxxx';

export const postsApi = createApi({
  reducerPath: 'posts',
  baseQuery: fetchBaseQuery({ baseUrl }),
  endpoints: (builder) => ({
    getPostsByYear: builder.query({
      query: (start, end) => { // Why is 'end' always undefined???
        return {
          url: 'posts/',
          params: { start, end },
        };
      },
    }),
    getPosts: builder.query({
      query: () => 'posts/',
    }),

    getPostByID: builder.query({
      query: (name) => `posts/${name}`,
    }),
  }),
});

export const { useGetPostsQuery, useGetPostsByYearQuery, useGetPostByIDQuery } = postsApi;

尝试从组件传递参数时，似乎只能识别 start 值。 year 由 <PostOptions/> 组件中的 select 元素更新。它使用 useState 挂钩。该值正确更新并调用 useGetPostsByYearQuery 但 end 参数始终未定义。所以，我似乎没有正确定义 api 端点。有什么建议吗？我想让它做的就是以 http://xxx/posts?start=start&end=end.

的形式发送请求

我什至尝试过硬编码 end 参数的字符串值，例如useGetPostsByYearQuery(year, '2019')，但在 api 回调中它仍然显示为 undefined，所以我遗漏了一些更基本的东西。

const Post = () => {
 
  const year = useSelector((state) => state.postOptions.year);
  const yearPlusOne = parseInt(year, 10) + 1;
  const { data, error, isLoading } = useGetPostsByYearQuery(year, yearPlusOne);

  return (
    <SafeAreaView style={styles.container}>
      <View style={styles.content}>
        <PostHeading />
        <PostOptions></PostOptions>
      </View>
    </SafeAreaView>
  );
};

export default Post;

Answer 1

QueryArg 是泛型。

interface EndpointDefinitionWithQuery<
  QueryArg,
  BaseQuery extends BaseQueryFn,
  ResultType
> {
  query(arg: QueryArg): BaseQueryArg<BaseQuery>
}

参见 source code。

来自文档 Defining Query Endpoints:

If the query callback needs additional data to generate the URL, it should be written to take a single argument. If you need to pass in multiple parameters, pass them formatted as a single "options object".

因此您可以像这样为 builder.query 方法声明通用参数 QueryArg 类型：

import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react';

const baseUrl = 'xxxxxxx';

export const postsApi = createApi({
  reducerPath: 'posts',
  baseQuery: fetchBaseQuery({ baseUrl }),
  endpoints: (builder) => ({
    getPostsByYear: builder.query<any, { start: string; end: string }>({
      query: (arg) => {
        const { start, end } = arg;
        console.log('arg: ', arg);
        return {
          url: 'posts/',
          params: { start, end },
        };
      },
    }),
  }),
});

export const { useGetPostsByYearQuery } = postsApi;

并像这样传递查询参数：

import React from 'react';
import { useGetPostsByYearQuery } from './hooks';

export default function App() {
  const { data, error, isLoading } = useGetPostsByYearQuery({ start: '2019', end: '2021' });
  return <div>app</div>;
}

日志：

arg:  { start: '2019', end: '2021' }

版本："@reduxjs/toolkit": "^1.6.0"

Redux Toolkit RTK Query 发送查询参数

Redux Toolkit RTK Query sending query parameters

reactjs

redux

react-redux

redux-toolkit

rtk-query