oldratlee / io-api

📐 generic API design example by I/O, the demo implementation of https://dzone.com/articles/generic-inputoutput-api-java

📐 Java的通用IO API设计

📖 English Documentation | 📖 中文文档

---

• 包的功能
• 更多信息
• API设计的进一步学习资料
  • 简单资料
  • 系统书籍

---

Java的通用I/O API（by Rickard Öberg）中给出了一个通用Java IO API设计，并且有API的Demo代码。更重要的是给出了这个API设计本身的步骤和过程，这让API设计有些条理。文中示范了从 普通简单实现 整理成 正交分解、可复用、可扩展、高性能、无错误的API设计 的过程，这个过程是很值得理解和学习！

设计偏向是艺术，一个赏心悦目的设计，尤其是API设计，旁人看来多是妙手偶得的感觉，如果能有些章可循真是一件美事。

在艺术工作中，真的艺术性工作量也只是一部分，而给出 方法 以 减少艺术工作之中艺术性工作量 的人是 大师。 ❤️

原文中只给出设计的

• 发展思路
• 关键接口
• 典型的使用方式

没有给出可运行的实现及其连接的细节，看起来可能比较费力，因为设计细致分解后抽象度高而不容易理解。

为了大家和自己更深入有效地学习，需要：

1. 给出这个通用IO API的可运行的Demo实现。
   这个工程即是本人的可运行的Demo实现。
   当然个人力荐你先自己实现练习一下，这样比直接看我的实现，在学习上会有效得多！
2. 写了一篇分析总结。
   本人的分析总结：用Java I/O API设计练习的分析和总结。这个你可以直接看，以更高效方便地理解这个API的设计。

PS：

上面2件事其实是份自学的家庭作业哦～ 😆
在阿里中间件团队的时候（2011年），@ShawnQianx 大大看到这篇文章时，给组员布置的家庭作业～

@ShawnQianx 对这篇文章及作者的评论：

设计时，一要分解好系统，二是多个组件拼回来还是系统预期的样子，二步都做好是难度所在。这个人分析和把控的功力很好！

包的功能

• 包com.oldratlee.io.core
  核心接口
• 包com.oldratlee.io.core.filter
  实现的Filter功能的类
• 包com.oldratlee.io.utils
  工具类
• 包com.oldratlee.io.demo
  Demo示例的Main类

更多信息

• 个人在组内分享时的PPT：API设计实例分析
• 本人对这篇博文的译文：【译】Java的通用I/O API
• 问题交流： https://github.com/oldratlee/io-api/issues

API设计的进一步学习资料

简单资料

• How to Design a Good API and Why it Matters(by Joshua Bloch) 【本地下载】
  http://lcsd05.cs.tamu.edu/slides/keynote.pdf
• Google Search
  http://www.google.com.hk/search?&q=api+design

系统书籍

• The Little Manual of API Design 【本地下载】
  http://chaos.troll.no/~shausman/api-design/api-design.pdf
• 《软件框架设计的艺术》 | 英文原版Practical API Design: Confessions of a Java Framework Architect
• Contributing to Eclipse中文版 | 英文原版Contributing to Eclipse : Principles, Patterns, and Plug-Ins
• .NET设计规范 : NET约定、惯用法与模式 | 英文原版Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries (2nd Edition)