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

本文详细列举了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. (一级)包名以公司(或者组织)的根命名空间来命名

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

一杯甜酒

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

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

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

打赏作者

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

抵扣说明:

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

余额充值