Go跨包结构体指针泛型应用报错：通用writeCsv函数实现问题

问题背景 #

你开发了一个多包Go程序，调用不同API服务后得到serviceone.ResponseTypeOne和servicetwo.ResponseTypeTwo两种响应结构体，希望编写通用的writeCsv函数处理这两种类型，避免重复代码。尝试用联合类型定义Response接口作为参数时，遇到报错：

Cannot use type Response outside a type constraint: interface contains type constraints

报错原因 #

Go 1.18引入的泛型中，包含|联合类型的接口属于类型约束接口，这类接口只能用于泛型函数的类型参数声明，不能直接作为普通函数的参数类型使用。你直接将Response作为writeCsv的参数类型，违反了这个规则。

解决方案 #

方案1：使用泛型函数（推荐，贴合原始思路） #

将writeCsv改为泛型函数，把Response作为类型约束绑定到泛型参数上，即可兼容两种响应类型：

package main

import (
	"encoding/csv"
	"encoding/json"
	"os"
	"path/filepath"
	"my-module/serviceone"
	"my-module/servicetwo"
)

func main() {
	respTypeOne := serviceone.GetResponseTypeOne()
	respTypeTwo := servicetwo.GetResponseTypeTwo()

	dir := "my-module/data"
	_ = WriteCsv(respTypeOne, dir)
	_ = WriteCsv(respTypeTwo, dir)
}

// 定义类型约束接口，仅用于泛型参数声明
type ResponseConstraint interface {
	*serviceone.ResponseTypeOne | *servicetwo.ResponseTypeTwo
}

// 泛型版WriteCsv函数，T绑定类型约束
func WriteCsv[T ResponseConstraint](r T, dir string) error {
	// 处理文件路径
	outPath := filepath.Join(dir, r.FileId+".csv")
	file, err := os.Create(outPath)
	if err != nil {
		return err
	}
	defer file.Close()

	w := csv.NewWriter(file)
	defer w.Flush()

	// 写入表头
	header := []string{"id", "response"}
	if err := w.Write(header); err != nil {
		return err
	}

	// 遍历数据写入行
	for _, res := range r.Data {
		payloadStr, err := json.Marshal(res.Payload)
		if err != nil {
			return err
		}
		row := []string{res.Id, string(payloadStr)}
		if err := w.Write(row); err != nil {
			return err
		}
	}
	return nil
}

方案2：基于行为的接口抽象 #

如果不想用泛型，可以定义一组行为接口，让两个响应结构体实现这些接口，通过接口多态实现通用处理：

首先在main包或公共包定义接口：

// 定义数据项的行为接口
type PayloadItem interface {
	GetId() string
	GetPayload() interface{}
}

// 定义响应的行为接口
type ApiResponse interface {
	GetFileId() string
	GetItems() []PayloadItem
}

然后修改serviceone和servicetwo的结构体，实现这些接口：

// serviceone包修改
func (p PayloadTypeOne) GetId() string {
	return p.Id
}

func (p PayloadTypeOne) GetPayload() interface{} {
	return p.Payload
}

func (r ResponseTypeOne) GetFileId() string {
	return r.FileId
}

func (r ResponseTypeOne) GetItems() []PayloadItem {
	items := make([]PayloadItem, len(r.Data))
	for i, v := range r.Data {
		items[i] = v
	}
	return items
}

// servicetwo包修改（逻辑和serviceone一致）
func (p PayloadTypeTwo) GetId() string {
	return p.Id
}

func (p PayloadTypeTwo) GetPayload() interface{} {
	return p.Payload
}

func (r ResponseTypeTwo) GetFileId() string {
	return r.FileId
}

func (r ResponseTypeTwo) GetItems() []PayloadItem {
	items := make([]PayloadItem, len(r.Data))
	for i, v := range r.Data {
		items[i] = v
	}
	return items
}

最后修改writeCsv函数，接收ApiResponse接口类型：

func WriteCsv(r ApiResponse, dir string) error {
	outPath := filepath.Join(dir, r.GetFileId()+".csv")
	file, err := os.Create(outPath)
	if err != nil {
		return err
	}
	defer file.Close()

	w := csv.NewWriter(file)
	defer w.Flush()

	header := []string{"id", "response"}
	if err := w.Write(header); err != nil {
		return err
	}

	for _, item := range r.GetItems() {
		payloadStr, err := json.Marshal(item.GetPayload())
		if err != nil {
			return err
		}
		row := []string{item.GetId(), string(payloadStr)}
		if err := w.Write(row); err != nil {
			return err
		}
	}
	return nil
}

注意事项 #

• 方案1更简洁，不需要修改原有服务包的代码，适合你的场景；
• 方案2更符合Go的接口设计哲学（基于行为而非类型），但需要修改各服务包的结构体实现接口；
• 原始代码中存在几处语法错误：w.csv.NewWriter应为csv.NewWriter(file)，err !+ nil应为err != nil，已在示例中修正。

内容的提问来源于stack exchange，提问作者Coldchain9