社区首页 >专栏 >【每周小结】2023-Week2

【每周小结】2023-Week2

junedayday

发布于 2023-02-18 08:36:59

27600

代码可运行

文章被收录于专栏：Go编程点滴Go编程点滴

运行总次数：0

代码可运行

作为一名年龄30+程序员，随着2023年的到来，我的工作和生活正在逐步变化。

本系列会以周维度为周期，记录我对如下三块内容的思考，大家挑选各自感兴趣的内容阅读即可：

Go技巧 - Go开发者作为重点阅读的群体，不忘初心
编程思考 - 面向所有开发者，从系统设计等高层维度进行分享
工作生活 - 以更贴近生活的视角，分享时间管理、职业发展、焦虑感的一些心得

Go技巧 - 用接口`interface`提高模块间协作效率

本周要分享的一个技巧是 - 用接口interface提高模块间协作效率。

我们在协作开发时，在划分清边界后，就需要协同开发。而这个边界，如果能结合interface特性，就会大幅提升效率。从边界功能的角色来看，主要包括2个：提供方与调用方。

从下图来看：

我们以一个具体工作内容为例：我们要开发一个Book的CRUD的工作，但时间紧迫，所以计划分为两块：

A同学 - HTTP API部分
B同学 - MySQL数据库部分

而由于数据库部分的工作比较少，所以计划让B同学来主导接口这块工作，即B是提供方，A是使用方。接下来的三块工作内容如下：

1 - 设计接口

B同学给出一版接口：

// 核心接口定义
type BookDao interface {
  Create(book *Book) error
  Delete(bookId int64) error
  List(pageNumber,pageSize int) ([]*Book, error)
  Update(bookId int64, bookName string) error
}

// 实例化，新建
func NewBookDao() BookDao {
}

type Book struct {
  // 具体实现
}

这里并没有真正的代码实现。代码重点包括3个部分：

interface的定义：核心内容，方便使用者阅读
实例化：interface怎么创建
数据结构：interface涉及的结构体

这一块，非常考验B同学的代码设计能力：怎么样让使用者快速了解你的设计？注释固然是一个不错的方式，但更好的方式是通过函数名、参数名等，详情可参考《 Effective Go》、《代码整洁之道》等资料。

2 - 审核接口

在B同学完成初步设计后，就需要A同学进行审核。审核主要的目标：发掘信息差，保证最终功能的正确性。

信息差来源于不同模块的上下文差异。比如说，数据库同学更关注底层的数据存储，而API层的同学更关注用户的使用场景。所以，通过评审，A同学可以发现与B同学的信息差，并对接口提出意见、希望B同学加以改进。

从上面的示例来看，可能存在如下问题，我用注释的方式加以说明（往往结合Code Review）：

type BookDao interface {
  // 需求点1：提供批量创建的能力
  Create(book *Book) error
  // 需求点2：能否支持软删除
  Delete(bookId int64) error
  // 需求点3：查询能否支持一些字段的模糊查询，如bookName
  // 需求点4：需要查询满足条件的Book总数，支持分页功能
  List(pageNumber,pageSize int) ([]*Book, error)
  // 需求点5：需要修改其余字段，如作者author
  Update(bookId int64, bookName string) error
}

// 需求点6：字段缺失：如出版商、出版时间
type Book struct {
}