Go语言中如何为go-client外部包类型实现自定义Marshalable接口

解决方案 #

你原来的思路不可行的核心原因是Go语言不允许为非本地包的类型定义扩展方法，下面是3种可落地的实现方案：

方案1：直接复用k8s官方通用接口（推荐）

所有go-client内置资源类型都默认实现了k8s.io/apimachinery/pkg/runtime包下的Object接口，不需要你自定义空接口做约束，直接用这个接口就行：

package kubernetes

import (
    "gopkg.in/yaml.v2"
    "k8s.io/apimachinery/pkg/runtime"
)

func marshal(obj runtime.Object) string {
    y, err := yaml.Marshal(obj)
    if err != nil {
        panic(err)
    }
    return string(y)
}

这个方案的优势是无需额外适配，所有标准k8s资源、CRD生成的资源都默认满足runtime.Object约束，直接传参调用即可。

方案2：Go1.18+ 用泛型实现无依赖约束

如果不想依赖k8s.io/apimachinery包的接口，可以用泛型实现通用序列化，支持任意可被yaml序列化的类型：

package kubernetes

import (
    "gopkg.in/yaml.v2"
    v1 "k8s.io/api/core/v1"
)

func marshal[T any](obj T) string {
    y, err := yaml.Marshal(obj)
    if err != nil {
        panic(err)
    }
    return string(y)
}

// 调用示例
// ns := &v1.Namespace{}
// yamlStr := marshal(ns)
// pod := &v1.Pod{}
// yamlStr2 := marshal(pod)

方案3：自定义包装类型适配接口

如果你确实需要用自定义的Marshalable接口做约束，可以通过本地包装类型嵌套外部资源的方式实现接口适配：

package kubernetes

import (
    "gopkg.in/yaml.v2"
    v1 "k8s.io/api/core/v1"
)

type Marshalable interface {
    Marshal() []byte
}

// 包装Namespace
type NamespaceWrap struct {
    *v1.Namespace
}

func (w NamespaceWrap) Marshal() []byte {
    y, err := yaml.Marshal(w.Namespace)
    if err != nil {
        panic(err)
    }
    return y
}

// 包装Pod
type PodWrap struct {
    *v1.Pod
}

func (w PodWrap) Marshal() []byte {
    y, err := yaml.Marshal(w.Pod)
    if err != nil {
        panic(err)
    }
    return y
}

// 统一序列化函数
func marshal(obj Marshalable) string {
    return string(obj.Marshal())
}

// 调用示例
// ns := &v1.Namespace{}
// yamlStr := marshal(NamespaceWrap{ns})

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