如何设计好的接口(Google分享)

本文源自Google工程师joshua bloch的经验分享,楼主进行了整理和总结。

一、好接口的特性

(1)易学

(2)易用,甚至不需要文档

(3)难于误用

(4)容易阅读与维护

(5)容易扩展

二、接口设计实现的过程

(1)分析需求

考虑是否有更佳解决方案?

这是否使我们这真想要的需求?

(2)设计小接口

这个阶段,快速敏捷迭代

小接口易于修改

小接口的实现给人自信,减少挫败感

(3)高频、提早撰写接口

实现自测用例

(4)撰写服务提供接口(SPI:service provider interface)尤为重要

如果提供一个接口,是否就不支持第二个?

如果提供两个接口,是否能够扩展,融合?

如果提供三个接口,是否足够?能否工作正常?

(5)注意“正常的”异常维护

你的接口是为了满足所有需求?

即使有异常,也不要紧

三、接口设计的基本原则

(1)只做并做好一件事

函数名自解释;

不恰当的函数名,往往是不恰当设计的征兆

(2)如果没做到(1),就将函数分解

只增加,永远不要删除函数与接口

你永远不知道这个接口被谁在使用

(3)实现永远不能影响接口

举例:不能假定函数调用者只能使用hash

不能对外暴露实现细节

(4)最小化访问

尽量使用私有化成员

注意信息隐藏

(5)文档与注释

接口不是只写给自己(即使只给自己,也应该有说明)

(6)提高性能

(7)平台无关

四、类设计

(1)最小易变性

举例:Date不宜设计成类,过于易变;可设计为TimerTask

如果可变,则要设计良好、最小化的状态子集合

(2)尽量少用继承

如果设计一个类不能被继承,则应该明确禁止

五、方法设计

(1)不要到处拷贝模板代码

模块能做的事,不用到处拷贝方法

(2)原子性应该在一个方法内保证

(3)Fail-Fast设计原则

出错尽量早点返回,交给上层处理,不要勉强抢救

(4)避免数据直接访问,而是提供访问方法

(5)谨慎重载

小心多重继承中的误重载

可以重载的情况,也慎重考虑是否应该重载

(6)注意参数与返回值类型

尽量明确类型

能不用string尽量不用

使用float的地方尽量用double,64bit

(7)不改变的参数使用const

(8)参数个数不宜太多

如果过多,就要考虑接口的合理性了

(9)避免返回值与异常的同时返回

原文发布于微信公众号 - 架构师之路(road5858)

原文发表时间:2014-11-06

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏姬小光

正则表达式是个啥

前些天有运营 MM 问小鸡君,正则表达式是个啥啊?懂技术的同学可能会想,你个运营管啥是正则表达式干啥?

1132
来自专栏静默虚空的博客

如何学习一门编程语言

前言 很多人喜欢争论什么什么编程语言好,我认为这个话题如果不限定应用范围,就毫无意义。 每种编程语言必然有其优点和缺点,这也决定了它有适合的应用场景和不适合的应...

4325
来自专栏微信公众号:Java团长

Java编程的21个常见错误

代码重复几乎是最常见的异味了。他也是Refactoring 的主要目标之一。代码重复往往来自于copy-and-paste 的编程风格。与他相对应OAOO 是...

1073
来自专栏Crossin的编程教室

【Python 第59课】 正则表达式(5)

听说有人已经开始国庆假期了,甚至还有人中秋之后就请了年假一休到底,表示羡慕嫉妒恨!今天发完这课,我也要进入休假状态,谁也别拦着我。 来说上次的习题: (021...

3298
来自专栏Android 开发者

[译] Kotlin 揭秘:理解并速记 Lambda 语法

在奥地利旅行期间,我参观了维也纳的奥地利国家图书馆。特别是国会大厅,这个令人惊叹的空间感觉就像印第安纳琼斯电影中的一些东西。房间周围的空间是这些门被装在架子上,...

890
来自专栏码洞

编程的智慧

编程是一种创造性的工作,是一门艺术。精通任何一门艺术,都需要很多的练习和领悟,所以这里提出的“智慧”,并不是号称一天瘦十斤的减肥药,它并不能代替你自己的勤奋。然...

591
来自专栏斑斓

代码诊所的第二次诊断

几年前,我有机会负责一个项目的咨询。团队很小,目标是对旧有系统的后端用Java改写,而团队的开发人员全为C程序员。我的工作职责是负责项目设计、开发,以及担任项目...

3585
来自专栏阿杜的世界

《重构》阅读笔记-代码的坏味道

开发者必须通过实践培养自己的经验和直觉,培养出自己的判断力:学会判断一个类内有多少个实例变量算是太大、学会判断一个函数内有多少行代码才算太长。

742
来自专栏维C果糖

编程思想 之「语言导论」

Java 是一门面向对象编程语言,它不仅吸收了 C++ 语言的各种优点,还摒弃了 C++ 里难以理解的多继承、指针等概念,因此 Java 语言具有功能强大和简单...

45519
来自专栏xingoo, 一个梦想做发明家的程序员

通过两个小栗子来说说Java的sleep、wait、notify、notifyAll的用法

线程是计算程序运行的最小载体,由于单个单核CPU的硬件水平发展到了一定的瓶颈期,因此就出现了多核多CPU的情况,直接就导致程序员多线程编程的复杂。由此可见线程...

2448

扫码关注云+社区

领取腾讯云代金券