ページ分割されたリスト取得APIの全結果取得をGo言語でクラス化したい

Question

前提

nextTokenとrequest/responceにpageSizeをrequestのオブジェクトに持つ別の「部分取得」メソッドがありさえすれば「全件取得」ができるようにする方法を探しています。
また、この投稿はマルチポストになります。他の投稿は以下になります。

• https://stackoverflow.com/questions/74782804
• https://ja.stackoverflow.com/questions/92728

実現したいこと

以下のようなrequest/responceオブジェクトを持つページ分割されたリスト取得メソッド(=ListSomething)があったとき、
その全結果を取得するためのクラスを作成したいです。

// request リクエストオブジェクト
type request struct {
	nextToken *string
	pageSize  int
}

// responce レスポンスオブジェクト
type responce struct {
	nextToken *string
	rows      []interface{}
}

// MAX ページ分割されたリストの最大値
var MAX = 20

// ListSomething ページ分割されたリスト取得のサンプルメソッド
// 指定したpageSize分の数列(0~)を最大20まで出力する
func ListSomething(request request) responce {
	var rows []interface{}
	var nextToken *string

	offset, _ := strconv.Atoi(*request.nextToken)
	limit := offset + request.pageSize
	if limit > MAX {
		limit = MAX
		nextToken = nil
	} else {
		limitStr := strconv.Itoa(limit)
		nextToken = &limitStr
	}
	for i := offset; i < limit; i++ {
		rows = append(rows, i)
	}
	return responce{
		rows:      rows,
		nextToken: nextToken,
	}
}

発生している問題・エラーメッセージ

クラスのイメージとしては以下のイメージを持っていますが、メソッドやrequest/responceオブジェクトの上手い抽象化の方法が思い浮かびません。

// Looper ページ分割されたリスト取得に関するクラス
type Looper struct {
    // 抽象化されたメソッドやrequest/responceオブジェクト
}

// NewLooper Looperコンストラクタ
func NewLooper(/*抽象化されたメソッドやrequest/responceオブジェクト*/) *Looper{
    return &Looper{
        // 抽象化されたメソッドやrequest/responceオブジェクト
    }
}

// Loop responce.nextToken == nilまでループして全結果を返却する
func (l *Looper) Loop() []interface{} {
	firstToken := "0"
	nextToken := &firstToken
	var ans []interface{}

	for {
		responce := 抽象化されたメソッド(
			/*抽象化されたリクエスト*/
		)
		ans = append(ans, responce.rows...)
		if responce.nextToken == nil {
			break
		}
		nextToken = responce.nextToken
	}
	return ans
}

以下のようなListSomethingA, ListSomethingBが部分取得取得のメソッドでが抽象化の対象になり、共通点はrequestA/requestBにnextTokenとpageSize、responseA/responseBがnextTokenとrowsのメンバ変数を持つことになります。

• ListSomethingA(request requestA) responseA
• ListSomethingB(request requestB) responseB

json.Unmarshalのような引数にポインタを入れてそこに結果を格納する形でも良いのですがそれでも良い方法がわかりません。
先の例の場合は以下のように実行すると全結果取得ができるイメージです。

fmt.Println(NewLooper(/*ListSomethingAやresponseAやrequestA*/).Loop())
// 出力結果: [0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19]
fmt.Println(NewLooper(/*ListSomethingBやresponceBやrequestB*/).Loop())
// 出力結果: [0 1 2 3 4 5 6 7 8 9 10]

補足情報（FW/ツールのバージョンなど）

Go 1.19

Comments

[nobonobo]

「上手い抽象化」を考えるには具体例を複数用意すべきです。
Ａというパターン、Ｂというパターンがあり、それらを共通の操作でどうしたいのかを具体的に書き出す必要があると思います。

または抽象化対象の可変部分がどこなのかを明記してほしい。
例えば『「任意の型」データで「部分取得」実装がありさえすれば
「全件取得」ができるようにする方法を探している。』とか？

[ponyo877]

> 「上手い抽象化」を考えるには具体例を複数用意すべきです。
Ａというパターン、Ｂというパターンがあり、それらを共通の操作でどうしたいのかを具体的に書き出す必要があると思います。

こちら`発生している問題・エラーメッセージ`にListSomething1とListSomething2の例を加えやりたいことの説明としました!

> または抽象化対象の可変部分がどこなのかを明記してほしい。
例えば『「任意の型」データで「部分取得」実装がありさえすれば
「全件取得」ができるようにする方法を探している。』とか？

nobonoboさんのほぼおっしゃる通りだったので`前提`に追加しました。
ただし任意の型データの部分を「nextTokenとrequest/responceにpageSizeをrequestのオブジェクトに持つ」に変更しています!

Answer 1

以下のようなメソッドを持つ型を共通に操作をするには。

• SomethingA.List(request) response
• SomethingB.List(request) response

Goのインターフェースを使うのが一番向いてそうに思います。

type Lister interface {
    List(request) response
}

func ListAll(l Lister) []interface{} {
	firstToken := "0"
	nextToken := &firstToken
	var ans []interface{}

	for {
		req := reqest{nextToken:nextToken, pageSize: 10}
		responce := l.List(req)
		ans = append(ans, responce.rows...)
		if responce.nextToken == nil {
			break
		}
		nextToken = responce.nextToken
	}
	return ans
}

requestを渡したあとLoopを呼ぶ二段構えにする意義が現時点でよくわからないので、いったんListAll関数として記述してみました。

Comments

[ponyo877]

回答ありがとうございます!
ただ、抽象化したいメソッドは特定の共通クラスのメンバーメソッドでなく純粋なメソッドになりますl
なので以下のようなListSomethingA, ListSomethingBが部分取得取得のメソッドでが抽象化の対象になり、共通点はrequestA/requestBにnextTokenとpageSize、responseA/responseBがnextTokenとrowsのメンバ変数を持つことになります。
- ListSomethingA(request requestA) responseA
- ListSomethingB(request requestB) responseB

わかりにくくすみません...

[nobonobo]

requestが異なる型なのは必須ですか？

[nobonobo]

おそらく、対象もreqもresも異なる型ということであれば部分取得メソッドが追加パラメータ「all bool」がtrueの場合に全件返す様にするのが無難に見えます。

[ponyo877]

> おそらく、対象もreqもresも異なる型ということであれば部分取得メソッドが追加パラメータ「all bool」がtrueの場合に全件返す様にするのが無難に見えます。

確かにall_boolのようなパラメータがあるのが良い気がします。
ただ、今回は部分取得のみしかできない外部のサービスがあるという前提で考えていただけると幸いです!

[nobonobo]

共通項のないものは誰かが共通に扱える実装を愚直に書くしかありません。

[ponyo877]

nobonoboさんのおっしゃる共通項というのは抽象化対象の何か共通点ということでしょうか?
であれば共通点は以下になります!
> 以下のようなListSomethingA, ListSomethingBが部分取得取得のメソッドでが抽象化の対象になり、共通点はrequestA/requestBにnextTokenとpageSize、responseA/responseBがnextTokenとrowsのメンバ変数を持つことになります。

[nobonobo]

「ListSomethingA(requestA) responseA」「ListSomethingB(requestB) responseB」という全く型一致点のないシグネチャを持つメソッドをそれぞれを同じ「ListAll(何らかの引数) []interface{}」にて全件取得したいという解釈でよろしいでしょうか？これは発想を変えないとどうやってもうまい抽象化にはならない気がします。愚直にそれぞれの全件取得を書くほうがコード量も少なくなりそうです。

[nobonobo]

https://go.dev/play/p/gAgMNBfLNRl
ここに参考コードを示します。
もっとプリミティブに要素を取り出せる抽象化を行っておき、それを部分取得に使ったり、全件取得に使ったりしつつ、req/res実装は要件別に個別に書くのがおすすめです。