资讯频道 → 编程语言
阅读更多

10顶
2踩

编程语言

翻译新闻 Java API 设计准则

2012-01-19 11:55 by 资深编辑 luiang1018 评论(17) 有12369人浏览
Java API设计 准则
在Java API设计中有着许多的各种规则与折衷考量，和其他所有复杂任务一样，它考验着我们的记忆力及脑力。这里我找到了一个对正在设计Java API的软件开发人员而言非常不错的准则列表，其中介绍的一些准则可能是很明显的，又或者不那么显眼，但确实非常不错，希望你会喜欢。

这里摘录了一些：

  • 优先将API与其实现置于不同的包中。
  • 优先将API放入高层包中，实现则可放在低层包。
  • 考虑将大型API拆分成若干包。
  • 考虑将API与其实现包归置到不同的Java文档中。
  • 避免对API中实现类的内部依赖。
  • 避免出现不必要的API碎裂（fragmentation）情况。
  • 不要将公共实现类放在API包中。
  • 不要在调用及实现类间创建依赖。
  • 不要将不相关的API放在同一个包中。
  • 不要将API与SPI（Service Provider Interface，服务提供者接口）放在同一个包中。
  • 不要移动及重命名已发布的公共API包。
完整的准则列表点击这里查看。

来自: lukaseder
10
顶
2
踩
评论 共 17 条 请登录后发表评论
17 楼 zhengjie_dna 2012-01-29 11:01
yang888111 写道
yang81 写道
[ote="luiang1018"]
jared 写道
•不要将不相关的API放在不同的包中。


——如何理解？[/quoe]
sorry，写错了。是同一个包中。


再测试


发布
16 楼 yang888111 2012-01-29 09:42
yang81 写道
[ote="luiang1018"]
jared 写道
•不要将不相关的API放在不同的包中。


——如何理解？[/quoe]
sorry，写错了。是同一个包中。


再测试

15 楼 ixu 2012-01-29 09:39
好文！
14 楼 yang888111 2012-01-29 09:29
[ote="luiang1018"]
jared 写道
•不要将不相关的API放在不同的包中。


——如何理解？[/quoe]
sorry，写错了。是同一个包中。


再测试
13 楼 yang888111 2012-01-29 09:28
[ote="tenderuser"]
jared 写道
•不要将不相关的API放在不同的包中。


——如何理解？
按包划分模块？


测试
12 楼 xsbird 2012-01-29 09:16
补充一点愚见,在设计接口参数的时候，尽量将参数传足，一般建议用封装的实体传递数据。
11 楼 xiaol601 2012-01-26 23:52
有压力！！！
10 楼 zhaoxuhui97 2012-01-21 20:06
flashing 写道
我觉得这文章最有趣的地方在于，懂的一看就懂，不懂的看了还是不懂。。。


+1
9 楼 flashing 2012-01-21 09:09
我觉得这文章最有趣的地方在于，懂的一看就懂，不懂的看了还是不懂。。。
8 楼 tkhwork 2012-01-20 14:20
7 楼 qianye 2012-01-20 13:56
资深编辑?
6 楼 luiang1018 2012-01-19 22:33
jared 写道
•不要将不相关的API放在不同的包中。


——如何理解？

sorry，写错了。是同一个包中。
5 楼 tenderuser 2012-01-19 16:25
jared 写道
•不要将不相关的API放在不同的包中。


——如何理解？

按包划分模块？
4 楼 yoyo837 2012-01-19 16:18
     
3 楼 jared 2012-01-19 15:59
•不要将不相关的API放在不同的包中。


——如何理解？
2 楼 iamyuyingqiang 2012-01-19 15:17
没看懂
1 楼 xiaomogui 2012-01-19 14:23
    

发表评论

您还没有登录,请您登录后再发表评论

相关推荐

  • amex-api-java-client-core:用于通过发布到Amex for Developers门户的API进行身份验证的库

    amex-api-java-client-core 该库封装了创建标头所必需的标头创建，这些标头必须通过发布到门户的API进行身份验证。 用法 代码样例 已为可通过此库调用的每个API提供了。 伪像 工件即将到达JCenter。 敬请关注！ ...

  • 转： Java API 设计准则

    新年将到，决定开始使用这个blog，学习其他大...这里我找到了一个对正在设计Java API的软件开发人员而言非常不错的准则列表，其中介绍的一些准则可能是很明显的，又或者不那么显眼，但确实非常不错，希望你会喜欢。 ...

  • Java学习路线总结，搬砖工逆袭Java架构师

    定期分享Java硬核技术干货、分享Java学习路线、分享Java经典面试题

  • REST API URI 设计的七准则

    点击上方Java后端，选择设为星标优质文章，及时送达在了解 REST API URI 设计的规则之前，让我们快速过一下我们将要讨论的一些术语。URIREST API 使用统一资源标识...

  • java7 uri,REST API URI 设计 7 准则，

    REST API URI 设计 7 准则，在了解REST API URI设计的规则之前，让我们快速过一下我们将要讨论的一些术语。URIREST API使用统一资源标识符(URI)来寻址资源。在今天的网站上，URI 设计范围从可以清楚地传达API的资源...

  • 什么是 RESTful API 和 如何设计RESTful API 及 RESTful 的准则

    设计概念和准则 所有事物抽象为资源(resource)，资源对应唯一的标识(identifier)。标识符在网站上的表现形式就是URI。 资源通过接口进行操作实现状态转移，操作本身是无状态的。因为HTTP协议本身就是一个无状态的...

  • RESTfulAPI设计的原则，如何设计出符合 RESTful 标准的 API

    统一接口：RESTful API 使用 HTTP 协议提供统一的接口，使得客户端能够跨平台访问服务器端的资源。使用 HTTP 协议的各种方法（如 GET、POST、PUT、DELETE 等）来定义 API 的功能。尽量使用 JSON 格式来表示资源，并...

  • Qt API设计指导准则

     此文为Qt 官网上的API设计(for C++)指导准则，其中有不少原则具有普遍适用性，整个篇幅中有很多示例，是Qt在API设计上的实践。　 正文： 　  Qt 一致、易掌握、强大的API是它的众多著名的优点之一。此文...

  • REST API URI 设计 7 准则

    在了解REST API URI设计的规则之前，让我们快速过一下我们将要讨论的一些术语。 URI REST API使用统一资源标识符（URI）来寻址资源。在今天的网站上，URI 设计范围从可以清楚地传达API的资源模型，如： ...

  • API设计原则

    原文链接：API Design Principles – Qt Wiki 基于Gary的影响力上 Gary Gao ...此文既是Qt官网上的API设计指导准则，也是Qt在API设计上的实践总结。虽然Qt用的是C++，但其中设计原则和思考是具有普适性的（如果

  • Java七大设计原则

    4、依赖倒转原则是基于这样的设计理念：相对于细节的多变性，抽象的东西要稳定的多。也就是说，对于被依赖的类不管多么复杂，都尽量将逻辑封装在类的内部，对外除了提供public方法之外，不对外泄露任何信息。指的是...

  • java接口设计原则_设计java中的接口需要遵循哪些原则

    设计java接口的规范性建议：1.职责原则在设计接口时，必须明确接口的职责，即接口类型，接口应解决什么业务问题等2.单一性原则在明确接口职责的条件下，尽量做到接口单一，即一个接口只做一件事，而非两件以上。很多...

  • Java基础知识总结（2021版）

    大家好，我是素小暖，2012年毕业，2016年通过培训转行java开发，今天2021年1月9日，转行之路跌跌绊绊，蓦然回首，已经满满的4年工作经验了？但感觉知识还是相当的匮乏，没自信，也许是努力程度还不够吧。很感谢CSDN...

  • RESTful API接口设计标准及规范；

    RESTful发展背景及简介 网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板...RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。 REST（Representational Stat...

  • java设计模式之观察者模式

    需要设计开放型API，便于其他第三方也能接入气象站获取数据。 提供温度、气压和湿度的接口 测量数据更新时，要能实时的通知给第三方 普通方案 通过getXxx方法，可以让第三方接入，并得到相关信息. 当数据有更新时...

  • RESTful API设计规范

    二、设计概念和准则三、为什么要使用RESTful API？四、协议五、域名六、版本七、http请求⽅式八、路由（路径）九、过滤信息（url中?后⾯的参数）使用过滤信息的原因：十、状态码十一、 其它 RESTful API设计规范 ⼀...

  • Google Cloud API设计指南

    本设计指南的目标是帮助开发者设计简单、一致且易用的网络 API。同时，它还有助于将 RPC API（基于套接字）与 REST API（基于 HTTP）的设计融合起来。 RPC API 通常根据接口和方法设计。随着时间的推移，接口和方法...

  • 基于net的超市管理系统源代码（完整前后端+sqlserver+说明文档+LW）.zip

    功能说明： 环境说明： 开发软件：VS 2017 （版本2017以上即可，不能低于2017） 数据库：SqlServer2008r2（数据库版本无限制，都可以导入） 开发模式：mvc。。。

Global site tag (gtag.js) - Google Analytics