包怎么分层,看的是依赖的方向

包怎么分层,看的是依赖的方向
隔壁老康难度 ★★★☆☆ · 前置:recover 只在 defer 里管用,别的地方都不行 | 一句话结论:依赖的箭头永远从调用者指向被调用者,而接口反过来长在调用它的那一侧,方向捋顺之后,换掉底下的存储用不着动业务代码。
先摆一个坏结构,我写过,这几年在别人的仓库里也见过不少。
所有接口集中放在一个 interfaces 包里,service 引它,repo 也引它,要加一个方法,先改 interfaces,再改实现,两边各编不过一次,改完编译通过,看着挺齐整。
那时候觉得挺对。坏的地方不在目录名。这个包谁都要引,于是接口只能越写越宽,service 只用得上三个方法,repo 那边要五个,凑在一个 interface 里,最后变成谁都够用、谁都不精确的契约。接口宽到这个地步,业务包照样知道存储层能干什么,只是换了个文件知道。
(那时我管这叫统一管理,还在组里推过一轮,现在想起来脸还有点热。)更早的一回更丢人。一个服务把业务逻辑、SQL 拼接、HTTP 处理全塞在同一个包里,改一处逻辑要先把几个文件从头读到尾。有个周末我把 SQL 那部分挪进了一个新包,为了省事,业务包照样 import 存储包,只是原来那个文件换了个体面些的名字。
编译通过,我挺满意,第二天补单元测试,问题立刻冒出来了。那个测试要跑起来,得先起一个真库,因为业务函数里写死了对存储包的调用,没有它连分支都进不去。我盯着那几行 import 看了很久才想明白,我做的只是搬家,包与包之间谁压着谁,一行都没动过。
目录确实好看了,耦合还是原来那个耦合,只是从文件内部挪到了包与包之间,更难发现了。那次改动我回滚了。重做的时候我先干了一件事,把 controller、service、repo 这些目录名全盖住,顺着 import 的箭头走一遍。
箭头指的是编译期的依赖,谁 import 谁,谁就欠着谁,跟目录有几层、名字起得漂不漂亮没有半点关系。repo 里改一个类型,import 它的 service 当天就编不过(这条线是硬的),编译器每天都替你提醒一遍。反过来,如果 repo 包 import 的是 service 包,依赖就掉了个头,service 不再关心底下用什么存,它只管说清自己要什么,谁来满足是启动那一层的事。
箭头是单向的,画在纸上是一条线,落在编译期就绕不过去。
现在业务包里只出现结构体、方法和接口,看不到驱动的名字,也看不到一句 SQL,它声明自己需要什么,剩下的交给外面去凑。
依赖的方向只有一个判据
同一个依赖,两种放法,方向是反的:
| 接口长在哪 | 谁 import 谁 | 换存储时要动几处 |
|---|---|---|
| 存储包 | 业务包 import 存储包 | 存储包改一次,业务包跟着看一遍 |
| 业务包(调用侧) | 存储包 import 业务包 | 只动新实现和启动那一行 |
拿用户注册举例。业务包声明一个很窄的接口,里面只放它真用到的那两三个方法,少了不够用,多了就等于把存储层的细节又搬了回来。接口一旦宽到这个地步,业务包和存储包又黏在一起了,存储包反过来 import 业务包,把自己的类型挂到那个接口上,业务包从头到尾不知道它存在。
谁在启动的时候把它塞进去,业务包并不关心,也不需要关心。我照着这个形状把老项目改完之后,换存储那一次一共动了两个地方,一个是新写的实现,一个是启动时把实现传进去的那一行,业务包里的函数签名一个字没改,测试也一个没动。那次之后我才算真正理解接口为什么该长在调用侧,因为只有调用侧才知道自己要用哪几个方法,别的地方猜都不准,猜宽了等于没抽。测试里的差别更直接。业务包的测试塞一个内存实现进去,篇幅很短,不连库也不写盘,跑起来就是纯函数,失败信息也不会被连接超时搅成一团,改坏了哪一行一眼就能看出来。
1 | package user |
1 | package mysqlstore |
反过来的那一半,是存储层去实现接口
Go 和不少语言在这一点上不一样,别人的接口通常长在实现那一侧,谁提供能力谁定义契约,用到的人去引用它。Go 里接口可以长在调用它的这一侧,实现方连自己实现的是谁都不一定知道,一个 MySQL 存储类型可以同时满足两个包各自定义的小接口,彼此不认识,也不打架。我一开始没觉得这有什么好,后来慢慢发现好在两处:
- 实现方不必为了某个调用者提前抽一层,接口够不够窄是调用方自己的事,它只对能看见的东西负责。
- 不用再一上来就建一个
interfaces包,那种包最后一定变成所有包的公共祖先,人人都 import 它,它却谁都不能 import,改名一次全仓库跟着抖。这两点合起来,我现在的做法很简单,接口跟着用它的代码走,用几次就定义几次,宁可多定义一个小接口,也不去建那个大家共用的抽象层。
我删过两个这样的包。这也解释了我为什么不再提前抽接口。
手上只有一个实现的时候,接口长什么样全靠想象,等第二个实现真的出现,形状往往跟当初想的完全不是一回事,改起来比从头写一遍还麻烦。
两个包互相 import,编译直接不过
Go 把循环依赖这条路在编译期就封了,两个包互相 import,连编译都过不去,没有警告可以关掉,整个包直接编不出来。我头一次撞上去还想着绕,把公共类型挪进第三个包,结果那个包被两边都 import,环只是换了个位置,编译照样过不去。真正管用的办法只有一个,把两边都要用的那部分抽到更下面一层,让依赖变成单向的,然后由其中一边定义接口,另一边去实现。抽的时候有个前提,新抽出去的那个包不能反过来 import 原来任何一边,否则循环只是被推远了一层,表面上通过了,下一次改动还会绕回来。我后来养成一个习惯,抽之前先问自己,新包会不会又需要认识旧的谁,答案是会的话,说明还没抽到底,得再往下挖一层。
我把那个公共包删了。判断有没有推远,看那个新包就行。
它应该是一个谁都不认识、谁都可以用的叶子,一旦它也 import 了业务包或者存储包,说明这次抽的只是壳,环还在,只是暂时没露出来。
1 | app/ |
internal 那道墙是编译器砌的
包路径里只要带一段 internal,规则就换一套,这一层目录树里的东西只有和它同一个父目录下面的代码能 import,父目录以外的一律被拒绝,守这道墙的是编译器,不是文档,也不是谁的记性。我第一次在小项目里用它,是把 dao 关进去,外面只留一层公开的 service,结果有个同事从别的模块直接 import 那个 dao,编译当场把他拦下来了。他过来问我是不是配错了,我把路径里那一段指给他看,他才明白这不是配置问题,是规则本身,改配置也绕不开,只能把代码挪到该在的位置上。那一下我印象很深,因为同样的规则如果只是写在文档里,他大概率不会读,读了也未必记得住,等到报错找上门来,人早就从别的地方绕过去了。
从那以后我几乎每个项目都会先铺一层 internal,把不想让别人碰的实现全放进去。
这不靠人自觉,赶进度的人再急,编译器也不放行。
顺手说一句,模块路径里还有 /v2 那一套版本规则,跟 internal 是两码事,那篇里再细讲,先记着。
1 | app/ |
包名越短越好,别叫 util
包名这件事我改得最晚,也最肉疼。Go 的包名会出现在每一个调用点上,user.Name 读起来顺不顺,取决于前面那个词而不是后面的类型名,所以短、小写、不带下划线这件事,图的不是整齐,图的是每个调用点读起来像一句正常的话。
我自己刚入行那阵子写过一个叫 commonhelper 的包,当时觉得这样很整齐,所有零碎都有地方放,后来它涨到十几个函数,谁都不敢删里面任何一个,因为说不清还有谁在用,连我自己动它之前都要先 grep 一遍。
util 和 common 这两个名字,基本等于承认这个包没有主题。
这件事之后我改了个做法,宁可多建几个小包,也不建一个大包,小包的名字能说清自己是什么,删起来也敢删,因为删了会立刻编不过。
包名起得越具体,读代码的人越省事,他不用先翻进去看这个包到底在干什么。
没有主题就什么都能往里塞,塞进去之后没人说得清它该不该删,最后它变成整个仓库里最不敢动的一块,动它比动核心逻辑还让人心虚。
那个 commonhelper 包我最后没敢删。叫 util 的包为什么最后一定会变成垃圾桶?因为它没有对外的承诺,什么都往里塞都不算违约。
导出就是承诺,字段也算
那段代码我写了两版。
导出这两个字的分量,我是在一次改字段名的时候认识到的。我把一个结构体里某个字段改成了更准确的名字,编译在别的模块里当场炸了,我才意识到,导出就是一份承诺,别人会调用你导出的函数,也会读写你导出的字段,你没有权利单方面改主意。所以结构体现在只导出真该给外面的那几个字段,其余的留在包里,外面要读就开一个方法,方法有签名,签名可以慢慢演进,裸字段一改就是全仓库的事。构造也一样,与其导出一个空结构体让别人自己往里填,不如给一个构造函数,把能省的字段在包里省掉,省掉的那些以后再改,也用不着惊动外面。承诺这件事跟目录名不一样,目录名改了只是看着变,签名改了是别人家的代码编不过,所以凡是要写进签名的东西,我都要先想清楚以后会不会后悔。
方向相反的另半边我也照着做,参数收接口,返回值给具体类型。
返回值一旦收窄成接口,外面想读它别的方法就只能再加一层断言,而返回具体类型的时候,外面拿到什么就是什么,看得清清楚楚。
一个包一件事,拆的标准不是行数
一个包只做一件事,这句话听着像口号,落到手上其实有个能操作的标准。行数只是提醒,超过几百行我会停下来看看,但真让我决定拆包的,是这两坨代码有没有从来不同时被改。如果每次改订单状态都要顺手改库存同步,它们待在一个包里其实没毛病,硬拆开反而要来回跳,跳多了就会漏。反过来,一个文件里两段代码各自安静地待着,一个季度都没在同一次提交里出现过,那它们就该分开,哪怕加起来没多少行,也不必为了整齐硬凑在一起。这个标准比数行数费脑子,因为它要翻提交记录,可翻完之后心里有底,不像按行数劈,劈完自己都说不清这两包为什么分开。
我翻了两个包的提交记录。
拆完还得回头看依赖,新包不能把原来那个包整个 import 回去,否则只是把文件切碎了,耦合一点没少。
git log 比注释诚实,谁跟谁总是一起出现,翻一翻就看得见。有一种情况我到现在也没判断清楚。
两个包确实总被同一次提交改到,但那可能是它们真属于一件事,也可能只是改代码的人图省事,顺手一起动了,翻 git log 翻不出这个区别,我没有第二个仓库可以对照。
日志难读,说明分层切错了位置
最后一个判据是我后来才用上的,翻日志。线上出问题的时候,我顺着一条请求往下读,如果一条链路要跨五六个包才看得明白,中间还来回跳,那多半是分层切错了位置,跟日志写得好不好关系不大。切得好的结构,一条链路的日志读起来像一句话,谁收的、谁转的、谁最后落库,顺序是清楚的,出了问题顺着往下走就行。
要来回读几遍才对上号,说明每次跨越都丢了一点上下文,而那些上下文只能靠人脑补,补出来的东西通常不可靠,补错了就多修一次。
倒着看又是另一回事。
我把那条链路从头读到底。我现在翻日志基本能看出结构长什么样,哪一层在替另一层兜事,哪一层只是转手,看得挺清楚,因为转手的那一层几乎留不下什么有用的信息,全是原样搬运。
所以我现在判断要不要动结构,就用这个笨办法,先读一遍日志,再决定改哪里。改目录几乎不花什么成本,改依赖方向才要命,因为那要动的是调用关系,牵连到每一处使用。
开头那个 interfaces 包(我后来还是拆了),接口搬回各自的调用方,第一次拆完全仓库红了半天,一个一个改过来也就好了。
回到最开始那个问题,包该怎么分层,我也说不上有什么一步到位的答案,但至少可以先去看 import 那一行。
把箭头捋顺,把接口放到调用它的那一侧,剩下的命名、文件数、目录深浅,都是可以慢慢磨的事情,磨错了也不至于伤筋动骨。












