`
arsenal04
  • 浏览: 1558 次
  • 性别: Icon_minigender_1
  • 来自: 厦门
最近访客 更多访客>>
社区版块
存档分类
最新评论

转: Java API 设计准则

 
阅读更多
新年将到,决定开始使用这个blog,学习其他大牛的开发水平,这里用一篇转载开始

Java API 设计准则

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

这里摘录了一些:


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

分享到:
评论

相关推荐

    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 jdk1.8中文文档

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

    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开发的 文档

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

    Java程序设计实验.pdf

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

    Spring-Boot-REST-Contact:REST API com Spring Boot e JPA

    2. **REST API**: REST是一种软件架构风格,它定义了一组准则和限制,用于创建简洁、灵活且可扩展的网络应用程序。RESTful API通常由HTTP方法(GET、POST、PUT、DELETE等)和URI(统一资源标识符)组成,以实现资源...

    java_PS2:Java课程第二期实践课

    在【标签】"Java"中,我们可以理解这门课程专注于Java编程语言的各个方面,包括但不限于语法、API使用、标准库、设计模式以及最佳实践。Java作为一门跨平台的面向对象语言,其重要性和应用广泛性不容忽视,尤其对于...

    C#.JAVA代码规范

    5. **设计模式**:Java开发者经常使用设计模式来提高代码的可重用性和可扩展性,如工厂模式、单例模式、观察者模式等。 6. **内存管理**:虽然Java有自动垃圾回收机制,但开发者仍需注意内存泄漏,避免创建过多临时...

    Java编程规范(第三版)

    《Java编程规范(第三版)》是一本针对Java程序员的重要参考书籍,旨在提供一套标准的编程准则,以提高代码质量、可读性和可维护性。本书深入探讨了Java编程的最佳实践,涵盖了命名规则、注释编写、代码组织、异常...

    Effictive Java

    这本书深入探讨了如何写出高效、可维护且设计优良的Java代码,它基于作者在实际开发中的经验和最佳实践,提供了许多实用的编程准则。以下是对其中一些核心知识点的详细解释: 1. **构造器与工厂方法**:书中强调了...

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

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

    一个程序员的经典简历

    - **GRASP原则**:通用设计职责分配原则,指导对象设计的准则。 - **OCP原则**:开闭原则,软件实体应对扩展开放,对修改关闭。 - **设计模式**:如Singleton(单例)、Factory(工厂)、Facade(门面)等,是...

    ARIMA模型销售预测JAVA版

    此外,合适的p、d、q参数选择对模型性能有很大影响,这通常通过观察自相关图和偏自相关图,或者使用自动模型选择算法如AIC或BIC准则。 总之,ARIMA模型是预测领域的一个强大工具,通过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 更...

    Effactive java(english pdf)

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

Global site tag (gtag.js) - Google Analytics