基于controller-runtime的Go代码方法复用方案咨询

核心思路是利用Go的接口抽象，将两个Reconciler和资源Kind的共性方法提取为接口，让通用逻辑依赖接口而非具体类型，从而实现代码复用。以下是具体实现步骤：

1. 定义通用接口 #

先梳理两个Reconciler和两种Kind的共用方法，分别抽象为接口：

抽象Reconciler接口

假设两个Reconciler都具备Client()（返回K8s客户端）、Log()（返回日志实例）等通用方法，定义接口：

type CommonReconciler interface {
    Client() client.Client
    Log() logr.Logger
    // 补充两个Reconciler共有的其他方法
}

抽象资源Kind接口

两种Kind作为K8s自定义资源，必然实现了client.Object接口，再加上它们的自定义共性方法：

type CommonKind interface {
    client.Object
    // 补充两种Kind共有的自定义方法，例如状态更新、字段获取等
}

Go是隐式实现接口，只要你的MyKindReconciler/MyOtherKindReconciler、myKind/myOtherKind的方法匹配上述接口，就会自动实现对应接口。

2. 编写通用辅助函数 #

将原myFunc的逻辑迁移到辅助函数中，参数替换为上述接口：

func commonMyFunc(ctx context.Context, r CommonReconciler, obj CommonKind) (ctrl.Result, error) {
    // 直接复用原函数体逻辑，调用接口方法即可
    log := r.Log().WithValues("resource", obj.GetName())
    log.Info("开始处理资源")

    // 示例操作：获取资源详情
    if err := r.Client().Get(ctx, client.ObjectKeyFromObject(obj), obj); err != nil {
        return ctrl.Result{}, client.IgnoreNotFound(err)
    }

    // 其他原有业务逻辑...

    return ctrl.Result{}, nil
}

3. 在原控制器中调用辅助函数 #

原来的两个控制器函数可以直接调用通用辅助函数，传入具体实例：

// 第一个控制器的函数
func myFunc(ctx context.Context, r *MyKindReconciler, myKind *myApiVersion.myKind) (ctrl.Result, error) {
    return commonMyFunc(ctx, r, myKind)
}

// 第二个控制器的函数
func myFunc(ctx context.Context, r *MyOtherKindReconciler, myOtherKind *myApiVersion.myOtherKind) (ctrl.Result, error) {
    return commonMyFunc(ctx, r, myOtherKind)
}

如果觉得这层包装函数多余，也可以直接在Reconcile逻辑里调用commonMyFunc，省去中间层。

可选：泛型实现方案（Go 1.18+） #

如果更倾向于用泛型实现，也可以定义带类型参数的通用函数：

func genericMyFunc[T client.Object, R interface{
    Client() client.Client
    Log() logr.Logger
}](ctx context.Context, r R, obj T) (ctrl.Result, error) {
    // 逻辑与接口版本完全一致
    log := r.Log().WithValues("resource", obj.GetName())
    log.Info("开始处理资源")

    if err := r.Client().Get(ctx, client.ObjectKeyFromObject(obj), obj); err != nil {
        return ctrl.Result{}, client.IgnoreNotFound(err)
    }

    // 其他业务逻辑...

    return ctrl.Result{}, nil
}

调用时直接传入具体类型：

return genericMyFunc(ctx, r, myKind)

不过在Operator开发场景下，接口方式的可读性和兼容性通常更优。

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