β

Java API 设计清单

齐码代码 136 阅读

原文地址:http://theamiableapi.com/2012/01/16/java-api-design-checklist/

在设计Java API的时候总是有很多不同的规范和考量。与任何复杂的事物一样,这项工作往往就是在考验我们思考的缜密程度。就像飞行员起飞前的检查清单,这张清单将帮助软件设计者在设计Java API的过程中回忆起那些明确的或者不明确的规范。本文也可以看作为“API设计指南”这篇文章的附录。

我们还准备了一些前后比对的例子来展示这个列表如何帮助你理清设计需求,找出错误,识别糟糕的设计实践以及如何寻找改进的时机。

这个清单使用了如下的语言规范:

要 – 表示必要的设计

建议 – 表示在几个最好的设计中选择一个

考虑 – 表示一个可能的设计上的改进

避免 – 表示一个设计上的缺陷

不要 – 表示一个设计上的错误

1. 包设计清单

1.1. 共通

1.2. 命名

1.3. 文档

2. 类型设计清单(这里的“类型”个人理解为一组Api)

2.1. 共通

2.2. 命名

2.3. 类

2.4. 接口

2.5. 枚举

2.6. 异常

2.7. 文档

3. 方法设计清单

3.1. 共通

3.2. 命名

3.3. 参数

3.4. 异常处理

3.5. 重写

3.6. 构造方法

3.7. Setters和getters

3.8. 回调

3.9. 文档

作者:齐码代码
记录我的程序员之路
原文地址:Java API 设计清单, 感谢原作者分享。

发表评论