读书笔记 - 软件框架设计的艺术

理论概述

  • cluelessness(无绪)
软件开发并不需要了解每一个API背后的实现原理,只要知道它是怎么用的就可以了。这是大型软件协作开发的理论基础。
  • API的范围
API不仅仅是接口,类,方法,API可以是程序中任意暴露给使用者的事物。可以是文件结构,也可以是通信协议,还可以是模块组件。
  • 一个好的API应该有的特性
1)可理解性;API是程序员之间的沟通方式,容易看懂使用是最重要的。
2)一致性;同一类API风格一致降低学习成本,不同版本的API功能要一致。
3)可见性;统一醒目的入口介绍API,最好有demo。
4)简单;给API分门别类,互不相关的API不要杂糅在一起。
5)向后兼容;新版尽可能不要修改或删除API的定义,也不要调整API的结构。

只公开必要的

  • 工厂方法优于构造函数的原因
1)可以构造子类对象返回,调用方无需关注子类类型。
2)可以返回缓存单例,而并不是每次都new一个新对象。
3)返回值可以是定义为带泛型的,构造函数不支持。
4)可以在对象构造前后做一些额外的事情。
  • Java实现友元访问
1)Java原生只有public, protected, private, default四种访问级别,没有提供友元关键字来实现友元访问。
2)default访问级别为包级别访问,即同一个package之下的类能够互相访问。
3)如果要对类 C 实现友元访问,则 C 的所有方法都应该设置为default级别;然后在同一个包内定义一个 C 的代理类 DelegateC ,由 DelegateC 对外提供public的接口,内部调用 C 的方法来执行逻辑。

模块化架构

  • 采用模块化架构的原因
1)模块化架构是把复杂的单个应用程序分拆成互相之间有清晰依赖关系的模块,有利于软件的进化。
2)即使一个最简单的WEB应用,也可以拆成dal, biz, web三个模块,dal负责数据访问,biz负责业务逻辑,web负责请求控制与显示。每个模块都只公开必要的接口给外部模块访问,这样即使一个模块内部烂到骨子里,也不会腐蚀另一个干净的模块。
  • 服务注册发现的几个方案
1)使用一个启动类,将被用到的模块中的服务类,实例化对象注册进来。缺点:硬编码方式不容易扩展。
2)依赖注入,采用配置文件或者注解的方式装配服务对象,如spring。缺点:除了需要用户主动装配外,基本完美。
3)Java标准的ServiceLoader机制。缺点:未提供完整的对象生命周期管理。
4) Netbeans 的Lookup。本质上是增强版的ServiceLoader,比如监听功能。

API 和 SPI

  • 主要区别
1)API主要是给外部客户调用的,一般会以代理的方式实现;SPI主要是给服务提供者扩展的,一般会以继承的方式实现。
2)新版本演进时,给API增加方法并不影响原有功能,而删减会;给SPI删减方法并不影响服务,而增加会;
  • 最佳实践
1)不管是API还是SPI,最好区分核心还是非核心,方便90%的用户能够不受干扰,快速找到自己想要的。
2)设计时,识别API和SPI,放在不同的包内,区分对待更容易新版本的演进。

测试先行

  • 为每一个API提供单元测试
1)用户使用API的方式千奇百怪,只有对每一个API提供单元测试,才能放心地变更API的内部实现。
2)单元测试不同于集成测试,如果遇到需要调用外部接口的情况,能mock尽量mock。
  • 测试用例的演进
1)每一次的bug修复,都先补相应的测试用例来重现,再修复后验证。

API设计

  • 极端的建议有害无益,做好平衡
1)API必须是漂亮的;首先得是正确的。
2)API必须是正确的:只需要在可期的时间规模内是正确的即可。
3)API必须是简单的;不能以牺牲功能为代价。
4)API必须是高性能的;优化性能万恶之源,跟其他所有特性相违背。
5)API必须是完全兼容的;评估完全兼容的代价,平衡资源。
  • API的开发和维护
1)API第一版本发布是最需要谨慎的,一旦发布即做出了向后兼容的承诺;
2)API的维护成本高昂,每一次升级都尽可能小心。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容