Go接口设计原则：接受接口，返回结构体 #

译文 - 原文：Accept Interfaces, Return Structs

核心概念 #

“接受接口，返回结构体"是Go语言中一个重要的设计原则，涉及生产者包和消费者包之间的交互：

生产者包：提供服务的包
消费者包：使用服务的包

1. 接受接口（Accept Interfaces） #

核心思想 #

让消费者定义自己需要的接口，而不是依赖生产者提供的接口。

示例代码 #

生产者包（db.go）：

package db

type Store struct {
   db *sql.DB
}

func NewDB() *Store { ... }

func (s *Store) Insert(item interface{}) error { ... }
func (s *Store) Get(id int) error { ... }

消费者包（user.go）：

package user

// 消费者定义自己需要的接口
type UserStore interface {
   Insert(item interface{}) error
   Get(id int) error
}

type UserService struct {
   store UserStore  // 接受接口作为依赖
}

// 接受接口参数
func NewUserService(s UserStore) *UserService {
   return &UserService{
      store: s,
   }
}

func (u *UserService) CreateUser() { ... }
func (u *UserService) RetrieveUser(id int) User { ... }

优势 #

松耦合，更灵活
- 消费者不依赖具体实现
- 可以轻松更换不同的存储实现（MySQL→PostgreSQL）
- 只要满足接口即可
更易测试
- 可以使用内存mock实现
- 无需启动真实数据库
- 测试更快更简单

// 测试示例
func TestCreateUser(t *testing.T) {
   s := new(inMemStore) // 使用内存存储
   service := NewUserService(s)
   // ...测试 CreateUser() 函数
}

2. 返回结构体（Return Structs） #

核心思想 #

生产者应该返回具体类型而不是接口。

原因 #

调用者通常需要具体类型的方法
- 如果返回接口，调用者需要手动类型转换
- 违背了返回接口的初衷
便于扩展
- 可以为实现添加新方法而无需大量重构

示例 #

// 正确：返回具体类型
func NewDB() *Store { ... }

// 错误：返回接口
func NewDB() StoreInterface { ... }

反模式：预先定义接口 #

错误做法 #

// 生产者包定义接口
package db

type Store interface {
   Insert(item interface{}) error
   Get(id int) error
}

func InitDB() Store { ... }  // 返回接口

// 消费者使用生产者的接口
package user

type UserService struct {
   store db.Store  // 使用生产者的接口
}

问题 #

过早抽象：没有真实使用场景就定义接口
测试困难：接口变更会破坏现有的mock
紧耦合：消费者被绑定到生产者的抽象

实践指南 #

何时定义接口 #

有真实的使用需求时
需要多种实现时
为了测试方便时

接口设计原则 #

保持接口小而专注
遵循单一职责原则
使用”-er"后缀命名（如Reader、Writer）

包设计建议 #

消费者包：定义需要的接口
生产者包：实现具体功能，返回结构体

总结 #

“接受接口，返回结构体"这一原则可以简化为两个核心概念：

让消费者定义它们使用的接口
生产者应该返回具体类型

这种设计模式充分利用了Go语言隐式接口的特性，实现了松耦合、易测试、可扩展的代码架构。

扩展阅读 #

注：本文是对Bryan F Tan原文的整理翻译，保留了核心概念和示例代码