java - 第一次在 Java 中创建 API

Question

我的任务是设计一个 API 列表，供我必须开发的 GUI 使用，以便与外部应用程序通信。考虑到应用程序刚刚设计并且我有它的初始类图，我应该:

1- 只需列出此应用程序类图中 GUI 与应用程序通信所需的字段和方法

或

2- 创建 GUI 与应用程序开发人员应创建的应用程序通信所需的全新字段和方法的列表

提前致谢!!!

Answer 1

我读过的最好的 API 设计指南之一是“The Little Manual of API Design”(PDF)，其中有一些关于如何为应用程序或服务。它提供的一些最重要的指导是:

• 在开始编写 API 本身之前创建用例；
• 在编写代码之前获取 API 设计的同行评审；
• 针对 API 编写示例以测试其稳健性。

恕我直言，第一个提示是最好的；当您的所有用例只需要世界的一小部分时，它会阻止您编写提供世界的 API。它还会迫使您考虑如何使用它，并根据这些用途而不是抽象地做出设计决策。