- Java 双重比较
- java - 比较器与 Apache BeanComparator
- Objective-C 完成 block 导致额外的方法调用?
- database - RESTful URI 是否应该公开数据库主键?
用多种方法实现相同结果的 API 设计是否令人困惑?例如,我有自己的 Date
库(它是 Java Date
/Calendar
类的简单包装器,用于区分 年份-month-day,Date
,来自 instant-in-time,Instant
并提供在两者之间转换的机制) .我从一种创建 Date
实例的方法开始:
Date.valueOfYearMonthDay(int year, int month, int day);
但后来我发现使用 API 生成的代码可读性不是很好。所以我补充说:
Date.yearMonthDay(int year, int month, int day)
Date.ymd(int year, int month, int day)
Date.date(int year, int month, int day)
然后我开始变得流利:
Date.january().the(int day).in(int year);
(我发现 fluent 版本对于进行可读测试非常有用)。所有这些方法都做同样的事情并且有准确的 JavaDoc。我想我已经读到,perl
的一个优点是每个程序员都可以准确地选择他/她喜欢用哪种方法来解决问题。 Java
的一个优点是通常只有一种做事的方式:-)
人们的意见是什么?
最佳答案
在过去的 10 年里,我一直在研究与 Java API 可用性有关的不同问题。
我可以告诉您,关于在 Java 中有一种做事方式的说法是相当不正确的。在 Java 中通常很多方法可以做同样的事情。不幸的是,它们通常不一致或没有记录。
使用便捷方法使类的接口(interface)膨胀的一个问题是,您会让人更难理解该类以及如何使用它。您的选择越多,事情就会变得越复杂。
在对一些开源库的分析中,我发现了冗余功能的实例,它们是由不同的人使用不同的术语添加的。显然是个坏主意。
更大的问题是名字所承载的信息已经没有意义了。例如,swing 中的 putLayer 与 setLayer 之类的东西,其中一个只更新层,另一个也刷新(猜猜哪个?)是一个问题。同样,getComponentAt 和 findComponentAt。在其他方面,做某事的方法越多,您就越能混淆其他所有内容并减少现有功能的“熵”。
这是一个很好的例子。假设您希望在 Java 中用另一个字符串替换字符串中的子字符串。您可以使用 String.replace(CharSequence, CharSequence) ,它可以像您期望的那样完美工作,字面意思。现在假设您想进行正则表达式替换。您可以使用 Java 的 Matcher 并进行基于正则表达式的替换,任何维护人员都会理解您所做的事情。但是,您可以只编写 String.replaceAll(String, String),它调用 Matcher 版本。但是,您的许多维护人员可能不熟悉这一点,也没有意识到后果,包括替换字符串不能包含“$”的事实。因此,用“$”符号替换“USD”在 replace() 中效果很好,但在 replaceAll() 中会导致疯狂的事情。
然而,也许最大的问题是“做同样的事情”很少是使用相同方法的问题。在 Java API 的许多地方(我相信在其他语言中也是如此),您会找到做“几乎相同的事情”的方法,但在性能、同步、状态更改、异常处理等方面有所不同。例如,一个调用会直接工作,而另一个会建立锁,另一个会更改异常类型,等等。这会带来麻烦。
所以底线:做同一件事的多种方法不是一个好主意,除非它们是明确的并且非常简单,并且您非常小心以确保一致性。
关于java - 人们是否提供多种机制来在 API 中做同样的事情?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/551500/
我已经设置了 Azure API 管理服务,并在自定义域上配置了它。在 Azure 门户中 API 管理服务的配置部分下,我设置了以下内容: 因为这是一个客户端系统,我必须屏蔽细节,但以下是基础知识:
我是一名习惯 React Native 的新程序员。我最近开始学习 Fetch API 及其工作原理。我的问题是,我找不到人们使用 API key 在他们的获取语句中访问信息的示例(我很难清楚地表达有
这里有很多关于 API 是什么的东西,但是我找不到我需要的关于插件 API 和类库 API 之间的区别。反正我不明白。 在 Documenting APIs 一书中,我读到:插件 API 和类库 AP
关闭。这个问题不满足Stack Overflow guidelines .它目前不接受答案。 想改善这个问题吗?更新问题,使其成为 on-topic对于堆栈溢出。 7年前关闭。 Improve thi
我正在尝试找出设计以下场景的最佳方法。 假设我已经有了一个 REST API 实现,它将从不同的供应商那里获取书籍并将它们返回给我自己的客户端。 每个供应商都提供单独的 API 来向其消费者提供图书。
请有人向我解释如何使用 api key 以及它有什么用处。 我对此进行了很多搜索,但得到了不同且相互矛盾的答案。有人说 API key 是保密的,它从不作为通信的一部分发送,而其他人则将它发送给客户端
关闭。这个问题是opinion-based .它目前不接受答案。 想改进这个问题?更新问题,以便 editing this post 可以用事实和引用来回答它. 4年前关闭。 Improve this
谁能告诉我为什么 WSo2 API 管理器不进行身份验证?我已经设置了两个 WSo2 API Manager 1.8.0 实例并创建了一个 api。它作为原型(prototype) api 工作正常。
我在学习 DSL 的过程中遇到了 Fluent API。 我在流利的 API 上搜索了很多……我可以得出的基本结论是,流利的 API 使用方法链来使代码流利。 但我无法理解——在面向对象的语言中,我们
基本上,我感兴趣的是在多个区域设置 WSO2 API 管理器;例如亚洲、美国和欧洲。一些 API 将部署在每个区域的数据中心内,而其他 API 将仅部署在特定区域内。 理想情况下,我想要的是一个单一的
我正在构建自己的 API,供以下用户使用: 1) 安卓应用 2) 桌面应用 我的网址之一是:http://api.chatapp.info/order_api/files/getbeers.php我的
我需要向所有用户显示我的站点的分析,但使用 OAuth 它显示为登录用户配置的站点的分析。如何使用嵌入 API 实现仪表板但仅显示我的网站分析? 我能想到的最好的可能性是使用 API key 而不是客
我正在研究大公司如何管理其公共(public) API。我想到的是拥有成熟 API 的公司,例如 Google、Facebook、Twitter 和 Amazon。 这些公司向公众公开了许多不同的 A
在定义客户可访问的 API 时,以下是首选的行业惯例: a) 定义一组显式 API 方法,每个方法都有非常狭窄和特定的目的,例如: SetUserName SetUserAge Se
这在本地 deserver 和部署时都会发生。我成功地能够通过留言簿教程使用 API 资源管理器,但现在我已经创建了自己的项目并尝试访问我编写的第一个 API,它从未出现过。搜索栏旁边的黄色“正在加载
我正在尝试使用 http://ip-api.com/ api通过我的ip地址获取经度和纬度。当我访问 http://ip-api.com/json从我的浏览器或使用 curl,它以 json 格式返回
这里的典型示例是 Twitter 的 API。我从概念上理解 REST API 的工作原理,本质上它只是针对您的特定请求向他们的服务器查询,然后您会在其中收到响应(JSON、XML 等),很棒。 但是
我能想到的最好的标题,但要澄清的是,情况是这样的: 我正在开发一种类似短 url 的服务,该服务允许用户使用他们的 Twitter 帐户“登录”并发布内容。现在这项服务可以包含在 Tweetdeck
我正在设计用于管理评论和讨论线程的 API 方案。我想有一个点 /discussions/:discussionId 当您GET 时,它会返回一组评论和一些元数据。评论也许可以单独访问 /discus
关闭。这个问题需要更多focused .它目前不接受答案。 想改进这个问题吗? 更新问题,使其只关注一个问题 editing this post . 关闭去年。 Improve this quest
我是一名优秀的程序员,十分优秀!