`
snoopy7713
  • 浏览: 1167133 次
  • 性别: 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包。

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

分享到:
评论

相关推荐

    RESTful API设计规范.pdf

    RESTful架构的设计概念和准则包括: 1. 网络上的所有事物都可以被抽象为资源(resource); 2. 每个资源都有唯一个资源标识(resource identifier),对资源的操作不会改变这些标识; 3. 所有的操作都是无状态的; ...

    基于JavaMail API的简化邮件发送API设计源码

    本文档所述的“基于JavaMail API的简化邮件发送API设计源码”正是为满足这一需求而设计开发的。 JavaMail API是Java平台的标准扩展之一,提供了一套发送电子邮件的通用接口。它支持各种邮件传输协议如SMTP、IMAP和...

    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操作hadoop_hdfs_api的用法,mapreduce基本用法、编码规范,自定义数据

    Java操作Hadoop HDFS API的用法涉及到使用Java语言与Hadoop分布式文件系统进行交互的基本操作。HDFS是Hadoop的核心组件之一,它是一个高度容错的系统,适合在廉价硬件上运行。Java API是与HDFS交互的主要方式之一,...

    基于Java和多种前端语言的nacos微服务配置中心设计源码

    本文档是一个基于Java语言和多种前端技术栈构建的微服务配置中心设计的源代码项目。项目设计以Nacos作为微服务配置中心的核心组件,Nacos是一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。整个...

    java开发的 文档

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

    基于Java核心技术的Apollo开源框架设计源码分析

    Java源文件是Apollo框架最核心的部分,它们定义了框架的行为,封装了业务逻辑,并提供了丰富的API供开发者使用。此外,项目还包括大量的资源文件,如PNG图片、JavaScript、SQL、XML、YAML、属性文件、HTML和Markdown...

    ARIMA模型销售预测JAVA版

    此外,合适的p、d、q参数选择对模型性能有很大影响,这通常通过观察自相关图和偏自相关图,或者使用自动模型选择算法如AIC或BIC准则。 总之,ARIMA模型是预测领域的一个强大工具,通过JAVA实现,可以让开发者在各种...

    Java本地方法教程

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

    学生综合成绩测评系统 JAVA毕业设计 源码+数据库+论文 Vue.js+SpringBoot+MySQL.zip

    系统设计者在设计该系统时,很可能遵循了软件工程的一些基本准则,比如模块化设计、代码复用、面向对象等,使得系统的代码结构清晰,易于维护和扩展。论文部分则可能详细介绍了系统的需求分析、系统设计、功能实现...

    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核心技术的Apollo开源配置中心设计源码分析

    Java的特性,如面向对象、跨平台、丰富API和成熟的生态系统,使其成为构建复杂企业级应用的首选。Java源文件数量多达735个,表明Apollo配置中心的后端逻辑复杂且功能强大。 除了Java源文件,Apollo配置中心的源码还...

    阿里java开发手册1.4.0

    - **接口设计**:接口的设计准则,如RESTful API的设计原则等。 - **服务拆分**:服务拆分的原则和方法,如微服务架构的设计思路等。 综上所述,《阿里巴巴Java开发手册1.4.0》不仅涵盖了基本的编程规范,还包括了...

Global site tag (gtag.js) - Google Analytics