登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go教程

Go pkg.go.dev API 返回分页结果时怎么继续请求

来源:17golang原创

时间:2026-10-05 19:49:59 403浏览 收藏

第一次接入 pkg.go.dev API 时,最容易把分页写成 page=2、offset+=limit。这个接口真正返回的是游标:响应里的 nextPageToken 非空,就把它作为下一次请求的 token 参数继续请求;为空才表示没有下一页。原来的 limit、filter、q 等参数要保持不变。

官方地址:https://pkg.go.dev/v1/api

要点速览
  • 当前 API 文档的分页字段是 nextPageToken,续页参数名是 token。
  • 下一次请求应复用原 URL 和全部查询条件,只追加上一页返回的 token。
  • 不要用“当前页为空”作为结束条件;还要防止重复 token、HTTP 错误和无限循环。

pkg.go.dev API 的分页契约不是 page=2

官方 API 文档把分页接口统一描述为:响应包含 items、total 和 nextPageToken。total 可能是 -1,表示服务端没有计算完整总数;客户端是否继续,只看 nextPageToken 是否为空。像 /v1/versions/{path}、/v1/packages/{path}、/v1/search 都使用这套约定。

Go pkg.go.dev API 的 limit、filter、items 和 nextPageToken 静态关系说明图
图1:pkg.go.dev API 分页契约说明图,重点查看原请求参数与 nextPageToken 的关系。

因此,首个请求可以带上 limit=20 和 filter;拿到 token 后,不要重新计算偏移量,也不要替换筛选条件。文档还特别说明:即使当前页没有 items,只要 nextPageToken 非空,仍然存在下一页。

用 Go 把续页逻辑封装成可恢复循环

下面的示例读取模块版本列表。它把查询条件放入 url.Values,每页都复制一份参数,再设置 token;这样可以避免手工拼接导致的转义错误,也不会意外丢掉 limit 或 filter。

package main

import (
    "context"
    "encoding/json"
    "fmt"
    "io"
    "net/http"
    "net/url"
)

type Page struct {
    Items         []json.RawMessage `json:"items"`
    Total         int               `json:"total"`
    NextPageToken string            `json:"nextPageToken"`
}

func FetchAll(ctx context.Context, client *http.Client, endpoint string, limit int) ([]json.RawMessage, error) {
    values := url.Values{"limit": {fmt.Sprint(limit)}}
    var all []json.RawMessage
    var previousToken string

    for {
        query := values.Clone()
        if previousToken != "" {
            // 游标由服务端生成,只把它作为 token 传回,不计算 page 或 offset。
            query.Set("token", previousToken)
        }

        req, err := http.NewRequestWithContext(ctx, http.MethodGet, endpoint+"?"+query.Encode(), nil)
        if err != nil {
            return nil, fmt.Errorf("创建请求: %w", err)
        }
        resp, err := client.Do(req)
        if err != nil {
            return nil, fmt.Errorf("请求分页数据: %w", err)
        }

        if resp.StatusCode/100 != 2 {
            // 错误响应也要关闭 body,避免长分页任务耗尽连接资源。
            body, _ := io.ReadAll(io.LimitReader(resp.Body, 4096))
            resp.Body.Close()
            return nil, fmt.Errorf("HTTP %s: %s", resp.Status, string(body))
        }

        var page Page
        err = json.NewDecoder(resp.Body).Decode(&page)
        resp.Body.Close()
        if err != nil {
            return nil, fmt.Errorf("解析分页响应: %w", err)
        }
        all = append(all, page.Items...)

        if page.NextPageToken == "" {
            return all, nil
        }
        if page.NextPageToken == previousToken {
            // 服务端异常重复游标时主动退出,避免客户端无限请求。
            return nil, fmt.Errorf("服务端返回重复 nextPageToken")
        }
        previousToken = page.NextPageToken
    }
}
Go FetchAll 使用 url.Values、http.Client 和 nextPageToken 的结构关系说明图
图2:Go 分页客户端结构说明图,查看请求构造、响应解码和游标字段的边界。

示例里没有把 total 当作停止条件,因为服务端可能返回未知总数。错误响应读取最多 4096 字节只是为了保留诊断信息;正式服务还可以加入重试策略,但重试应针对 429、5xx 等明确场景,并遵守接口限流。

三个容易漏掉的边界

现象正确判断处理方式
items 为空nextPageToken 仍非空继续请求,不把空页当成结束
total 为 -1总量未知按游标循环,另设本地数量上限
token 重复分页进度没有前移记录错误并停止,避免死循环
请求参数被改写分页上下文不一致只在原参数集合上追加 token

生产代码还应给请求绑定超时的 context.Context,限制单轮最多读取多少页,并记录接口、limit、返回条数和 token 是否变化。token 本身不需要解析,也不要把它持久化成可以跨查询复用的业务游标;它只属于同一组原始请求条件。

常见问题

pkg.go.dev API 能不能用 offset 或 page 参数续页?

针对文档列出的这些分页响应,不应自行用 offset 或 page 推算下一页;应读取 nextPageToken,并用 token 请求下一页。

为什么要保留原来的 filter 和 limit?

token 是上一组查询条件生成的续取位置。改变筛选或分页大小会让游标失去原上下文,可能返回错误或得到不一致的数据。

分页循环要不要按 total 计算请求次数?

不要。total 可能未知,且最终停止信号是空的 nextPageToken;本地可以额外设置页数和总条数上限作为保护。

把判断集中到一个规则即可:先保留原查询,再读取 nextPageToken;非空就续取,空值才收尾。这样 Go 客户端既符合 pkg.go.dev API 的分页契约,也能在异常游标和网络错误出现时及时停下来。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>