Go中无法为非本地类型models.Meter定义新方法的问题排查

问题背景 #

你在共享库gitlab.com/xxx/common的models包中定义了Meter结构体：

type Meter struct {
 ID string
 OperationID string
 Type ConsoProd
 Unit string
 Timestep time.Duration
 Measures []Measure
 FetchMethod AcquisitionMethod
 Metadata interface{}
}

在外部项目通过go get导入该包后，尝试为models.Meter定义String()方法：

import "gitlab.com/xxx/common/models"

// String transparent method
func (meter models.Meter) String() string {
 var stringifyMeter string
 stringifyMeter += "Meter " + meter.ID + " is a " + meter.Type.String() + " and compute in operation #" + meter.OperationID + "."
 return stringifyMeter
}

编译时出现报错cannot define new methods on non-local type models.Meter，同时Goland无法识别这个方法。

报错原因 #

这是Go语言的类型系统规则导致的：你只能为以下类型定义方法：

• 定义在当前包中的自定义类型
• 当前包中基于外部类型创建的别名类型或嵌入结构体

models.Meter是来自外部包的类型，不属于你当前的项目包，Go不允许直接给外部包的类型添加新方法——这么设计是为了避免不同包对同一外部类型的方法定义冲突，保证类型的封装性和代码的可维护性。

解决方法 #

这里有两种常用的方案来绕过这个限制：

方案1：创建本地别名类型 #

为外部的models.Meter创建一个当前包的别名类型，然后为这个别名定义方法：

import "gitlab.com/xxx/common/models"

// 定义当前包的本地别名类型
type LocalMeter models.Meter

// 为本地别名类型实现String()方法
func (meter LocalMeter) String() string {
    return "Meter " + meter.ID + " is a " + meter.Type.String() + " and compute in operation #" + meter.OperationID + "."
}

使用时只需要把外部的models.Meter转换成本地类型即可：

// 假设externalMeter是从外部包获取的models.Meter实例
localMeter := LocalMeter(externalMeter)
fmt.Println(localMeter) // 会自动调用String()方法

方案2：创建嵌入外部类型的包装结构体 #

定义一个包含models.Meter的本地结构体（通过嵌入方式），然后为这个包装结构体实现方法：

import "gitlab.com/xxx/common/models"

// 定义包装结构体，嵌入外部类型
type MeterWrapper struct {
    models.Meter // 嵌入后可以直接访问Meter的所有字段和方法
}

// 为包装结构体实现String()方法
func (mw MeterWrapper) String() string {
    return "Meter " + mw.ID + " is a " + mw.Type.String() + " and compute in operation #" + mw.OperationID + "."
}

使用时把外部实例包装进去：

// 假设externalMeter是外部包的Meter实例
wrapper := MeterWrapper{Meter: externalMeter}
fmt.Println(wrapper) // 调用String()方法
// 同时还能直接访问原Meter的字段和方法
fmt.Println(wrapper.OperationID)

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