Java基础学习总结（138）——Java API 设计规范整理

最新推荐文章于 2025-05-18 21:51:46 发布
最新推荐文章于 2025-05-18 21:51:46 发布
阅读量1.1k 收藏 1
点赞数 1
CC 4.0 BY-SA版权
分类专栏： Java 文章标签： Java API 设计规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/u012562943/article/details/85136502
本文详细列举了Java API设计规范，包括包设计、命名、文档等方面的指导原则，旨在帮助开发者创建清晰、稳定和易用的API。内容涵盖了包的组织结构、命名规范、文档编写、类和接口设计、异常处理、方法设计等多个方面，强调了API的可维护性和一致性。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

1. 包设计清单

1.1. 共通

▲1.1.1. 建议把API和实现放入不同的包

▲1.1.2. 建议把API放进上层包，而把实现放进下层包

▲1.1.3. strong>考虑把一组大型的API分拆进不同的包

▲1.1.4. 考虑把API和实现打包进不同的jar包

▲1.1.5. 避免API的实现类之间的内部依赖

▲1.1.6. 避免把API分拆了太细

▲1.1.7. 避免把公共实现类放到API的包中

▲1.1.8. 不要在调用者和实现类之间建立依赖

▲1.1.9. 不要把没有关系的API放进同一个包

▲1.1.10. 不要把API和SPI（service provider interface）放进一个包（注：两者不同可以查看这个页面http://stackoverflow.com/questions/2954372/difference-between-spi-and-api）

▲1.1.11. 不要移动或者重命名一个已经发布的公共API

1.2. 命名

▲1.2.1. （一级）包名以公司（或者组织）的根命名空间来命名

了解本专栏 订阅专栏 解锁全文 超级会员免费看
提示工程架构师实战：Agentic AI健康管理API设计
AI天才研究院
07-31 865
Agentic AI感知环境：通过API接收健康数据、用户输入等信息制定计划：将健康目标分解为可执行步骤执行行动：调用工具和服务完成健康管理任务反思结果：评估行动效果并调整策略持续学习：从长期互动中改进健康管理能力与传统AI系统相比，Agentic AI的关键区别在于"自主性"和"连续性"。它不是简单地执行单次任务，而是持续追求用户的健康目标。
StarRocks实战——表设计规范与监控体系
爱吃辣条的博客
02-27 2558
StarRocks实战——表设计规范与监控体系
java API设计
03-06
博文链接：https://handmu.iteye.com/blog/38870
Java API 设计清单
02-06 701
原文地址：http://theamiableapi.com/2012/01/16/java-api-design-checklist/ 在设计Java API的时候总是有很多不同的规范和考量。与任何复杂的事物一样，这项工作往往就是在考验我们思考的缜密程度。就像飞行员起飞前的检查清单，这张清单将帮助软件设计者在设计Java API的过程中回忆起那些明确的或者不明确的规范。本文也可以
Java API学习笔记
最新发布
m0_61193877的博客
05-18 597
String对象创建后不可修改，每次操作返回新对象可变字符串：适合频繁修改字符串的场景区别：StringBuilder（非线程安全，性能高）StringBuffer（线程安全，性能低）基本类型 → 对象：Integer、Double、Boolean等。
Java API设计指南
猪笨笨
11-06 228
文章的最后是本文PDF版的下载，看起来会舒服一些! 作者： Eamonn McManus 原文地址： http://www.artima.com/weblogs/viewpost.jsp?thread=142428 译者： 王磊 电子邮件： wl_95421@yahoo.com.cn （该译文可以随便转载，但请保留前面的声明，谢谢） 前言： 市场上关于如何设计和...
Java经典面试题Java基础
weixin_59755109的博客
05-13 1055
1.JDK和JRE有什么区别? JDk：Java Development Kit 的简称，Java开发工具包，提供了Java的开发环境和运行环境。 JRE：Java Runtime Environment 的简称，Java运行环境，为Java的运行提供了所需环境。 具体来说 JDK 其实包含了 JRE ，同时还包含了编译Java 源码的编译器 Javac，还包含了很多Java程序调试和分析的工具。简单来说：如果你需要运行Java程序，只需要安装JRE就可以了，如果你需要编写Java程序，需要安装JDK
2022Java基础、语法最全面试题，为秋招做好准备
a6636656的博客
07-07 979
1.Java跨平台原理（字节码文件、虚拟机）C/C++语言都直接编译成针对特定平台机器码。如果要跨平台，需要使用相应的编译器重新编译。Java源程序（.java）要先编译成与平台无关的字节码文件(.class)，然后字节码文件再解释成机器码运行。解释是通过Java虚拟机来执行的。字节码文件不面向任何具体平台，只面向虚拟机。Java虚拟机是可运行Java字节码文件的虚拟计算机。不同平台的虚拟机是不同的，但它们都提供了相同的接口。Java语言具有一次编译，到处运行的特点。就是说编译后的.class可以跨平台运行
java api接口规范
07-20
java api开发接口规范 包括增删改查 下载 上传等传参 返回方式等
Api设计规范
08-25
Java API Design Checklist，如何设计api，设计api规范
如何设计一个API接口
qq_35821588的博客
10-07 4938
在日常开发中，总会接触到各种接口。前后端数据传输接口，第三方业务平台接口。一个平台的前后端数据传输接口一般都会在内网环境下通信，而且会使用安全框架，所以安全性可以得到很好的保护。这篇文章重点讨论一下提供给第三方平台的业务接口应当如何设计？我们应该考虑哪些问题？ 主要从以上三个方面来设计一个安全的API接口。 一 安全性问题 安全性问题是一个接口必须要保证的规范。如果接口保证不了安全性，那么你的接口相当于直接暴露在公网环境中任人蹂躏。 1.1 调用接口的先决条件-token 获取token一般会涉及到几个参
Java API 设计指南
lsblsb的专栏
11-20 929
作者: Eamonn McManus 原文地址: http://www.artima.com/weblogs/viewpost.jsp?thread=142428译者: 王磊 电子邮件: wl_95421@yahoo.com.cn(该译文可以随便转载,但请保留前面的声明,谢谢) 前言: 市场上关于如何设计和编写优秀 Java代码的书如此之多,可能要用汗牛充椟来形容, 但是想找到
java api 设计_Java API设计实践
weixin_42545292的博客
02-12 260
使你的API在模块化和非模块化Java环境中都可用在优锐课的java学习分享中，对微服务有了更深层次的新概念。关于API设计实践一点就通了。介绍了解设计Java API时应应用的一些API设计实践。通常，这些做法很有用，可确保在OSGi和Java平台模块系统(JPMS)等模块化环境中可以正确使用API。有些做法是规定性的，有些是规定性的。当然，其他良好的API设计规范也适用。OSGi环境使用Jav...
Java API设计指南（一）
leagle
02-13 5653
　　作者： Eamonn McManus　　原文地址： http://www.artima.com/weblogs/viewpost.jsp?thread=142428　　译文地址： http://gocom.primeton.com/modules/newbb/forumtopic4585_4075_40.htm　　译者： 王磊　　电子邮件： wl_95421@yahoo.com.cn 
JAVA api设计的一些原则
每天积累一点，一年后你会发现，自己变化很大
12-19 1307
1，将api与其实现置于不同的包中 2，将api放入高层包中，实现可以放在底层包中 3，考虑将大型api拆分成若干个小包 4，考虑将api与其实现包归置到不同的java文档中 5，避免api与实现类内部依赖 6，避免不必要的api碎片 7，不要将公共实现类放在api包中 8，不要在调用和实现类之间创建依赖 9，不要将不相关的api放在同一个包中 10，不要将api与spi（服务提
java api设计_Java 8的API设计原则
weixin_35133182的博客
02-15 183
Java 8的API设计原则掌握的Java API 8设计，才能确保客户端代码可以使用lambda表达式访问API。 一个好的API的设计需要仔细思考和大量的经验。因为一旦一个API公布，从一开始就贯彻坚定的承诺是非常重要。公共API，就像钻石，永远留传。你只有一次得到它的机会，所以给她最好的。API结合平衡了两个世界：坚定的和精确的承诺；以及具有高度的灵活性。下面是清单：如果一个值缺了不要返回...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

一杯甜酒

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值