`
snoopy7713
  • 浏览: 1140569 次
  • 性别: Icon_minigender_2
  • 来自: 火星郊区
博客专栏
Group-logo
OSGi
浏览量:0
社区版块
存档分类
最新评论

Java API 设计准则

阅读更多

在Java API设计中有着许多的各种规则与折衷考量,和其他所有复杂任务一样,它考验着我们的记忆力及脑力。这里我找到了一个对正在设计Java API的软件开发人员而言非常不错的准则列表 ,其中介绍的一些准则可能是很明显的,又或者不那么显眼,但确实非常不错,希望你会喜欢。

这里摘录了一些:

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

完整的准则列表点击这里 查看。

分享到:
评论

相关推荐

    Pro JPA 2 Mastering the Java Persistence API 2009.pdf

    ### Pro JPA 2: Mastering the Java Persistence API #### 关键知识点概览: 1. **JPA(Java Persistence API)概述与发展历程** 2. **JPA 2.0 新特性介绍** - 对象关系映射增强 - 对象建模灵活性提升 - 类型...

    JAVA jdk1.8中文文档

    4. **《阿里巴巴Java开发手册》(终极版).pdf**: 这是阿里巴巴公司发布的Java开发手册的最新版本,包含了其内部的编程规范、设计原则、代码风格等,对于遵循企业级开发标准非常有帮助。 **相关知识点** 1. **Java 8...

    Java程序设计实验.pdf

    - JDK(Java Development Kit)是Java开发工具包,包含了编译器、Java运行环境以及各种API,是进行Java编程的基础。 - 配置JDK环境主要包括设置`JAVA_HOME`、`PATH`和`CLASSPATH`等环境变量,确保系统能找到Java的...

    jdk20-java-remote-method-invocation-api-guide.pdf

    jdk20-java-remote-method-invocation-api-guide Java Platform, Standard Edition 的 Java Remote Method Invocation API Guide 介绍了 Java Remote Method Invocation(Java RMI)的概念和应用。Java RMI 是一种...

    java开发的 文档

    2. **设计规范**:Java开发中的设计规范包括命名规范、代码结构、注释规范等,这些都是保证代码质量的基本准则。例如,类名应使用名词,变量名描述明确,注释清晰易懂,遵循SOLID原则等。 3. **API文档**:Java项目...

    Java本地方法教程

    Java本地方法是Java编程语言中的一种特性,允许Java代码调用非Java编写的功能,通常是C或C++的本地代码。这种技术主要应用于需要高效能计算、访问硬件资源或利用已有的C/C++库的情况。在本文档中,我们探讨了如何在...

    java 编程入门思考

    13.17 Java 1.1 UI API 13.17.1 桌面颜色 13.17.2 打印 13.17.3 剪贴板 13.18 可视编程和Beans 13.18.1 什么是Bean 13.18.2 用Introspector提取BeanInfo 13.18.3 一个更复杂的Bean 13.18.4 Bean的封装 13.18.5 更...

    Thinking in Java 中文第四版+习题答案

    15.7.3 JDBC API为何如何复杂 15.8 远程方法 15.8.1 远程接口概念 15.8.2 远程接口的实施 15.8.3 创建根与干 15.8.4 使用远程对象 15.8.5 RMI的替选方案 15.9 总结 15.10 练习 第16章 设计范式 16.1 范式的概念 ...

    Java编程规范(第三版)

    《Java编程规范(第三版)》是一本针对Java程序员的重要参考书籍,旨在提供一套标准的编程准则,以提高代码质量、可读性和可维护性。本书深入探讨了编写高效、清晰且易于理解的Java代码的最佳实践。以下是根据该书...

    Java初学者入门教学

    13.17 Java 1.1 UI API 13.17.1 桌面颜色 13.17.2 打印 13.17.3 剪贴板 13.18 可视编程和Beans 13.18.1 什么是Bean 13.18.2 用Introspector提取BeanInfo 13.18.3 一个更复杂的Bean 13.18.4 Bean的封装 13.18.5 更...

    java联想(中文)

    13.17 Java 1.1 UI API 13.17.1 桌面颜色 13.17.2 打印 13.17.3 剪贴板 13.18 可视编程和Beans 13.18.1 什么是Bean 13.18.2 用Introspector提取BeanInfo 13.18.3 一个更复杂的Bean 13.18.4 Bean的封装 13.18.5 更...

    爬虫爬取网易汽车车型库【Java代码】

    Java提供了多种文件操作API,如FileInputStream和FileOutputStream,可以用来读写文件。同时,为了保证效率,可能需要考虑多线程下载或者异步处理。图片通常会被按照品牌和车系分类存储,便于后续分析和使用。 4. ...

    azure-docs-sdk-java:Azure适用于Java API的Azure SDK文档存储库。 这里的内容大部分是自动生成的

    :hot_beverage: Azure SDK for Java API文档Microsoft开源行为准则该项目采用了。 有关更多信息,请参见或与联系,并提出其他任何问题或意见。如何在仓库中更新YAML内容克隆 创建一个code2yaml.json配置文件以指定您...

    长虹智能电视应用开发TVOS第三方API规范_V1.0借鉴.pdf

    - 该规范明确了TVOS系统中第三方应用程序接口(API)的设计、使用和管理准则,涵盖了多媒体播放、用户交互、网络通信、系统资源管理等多个方面。 - 适用于所有基于长虹TVOS平台开发的应用程序,无论是本地应用还是...

    JavaEE程序设计与应用开发5.6作业答案

    9. **JTA(Java Transaction API)**:JavaEE支持分布式事务处理,JTA提供了一套标准接口来管理事务的开始、提交、回滚等操作,确保数据的一致性。 10. **Filter和Listener**:在JavaEE Web应用中,Filter用于拦截...

    Effactive java(english pdf)

    《Effective Java》是Java开发领域的一本经典著作,...这些仅是《Effective Java》中众多知识点的冰山一角,书中还涵盖了更多关于设计模式、多线程、集合框架、序列化等方面的深度讨论,对提升Java编程技能非常有帮助。

    JAVA_Thinking in Java

    13.17 Java 1.1 UI API 13.17.1 桌面颜色 13.17.2 打印 13.17.3 剪贴板 13.18 可视编程和Beans 13.18.1 什么是Bean 13.18.2 用Introspector提取BeanInfo 13.18.3 一个更复杂的Bean 13.18.4 Bean的封装 13.18.5 更...

Global site tag (gtag.js) - Google Analytics