关于sap:SAP-UI5-的-兼容性规则-Compatibility-Rules

53次阅读

共计 1475 个字符,预计需要花费 4 分钟才能阅读完成。

兼容性规定官网链接
以下局部形容了 SAP 在次要 (major)、主要(minor) 和补丁 (patch) 版本中能够更改的内容。在应用 SAPUI5 或为 SAPUI5 开发应用程序、性能或控件时,请始终思考这些规定。

作为利用开发人员,防止在 SAP UI5 代码中间接操作 CSS,例如:

domRef.className = "someCSSClass";

切勿应用或笼罩不属于 API 参考的“公有”函数。公有函数通常(但不总是)以后面的“_”为前缀。始终仔细检查 API 参考,那里没有列出公有函数。

API Evolution

除非另有阐明,本节中的“API”一词指的是“公共 API”,意思是函数、类、命名空间、控件及其申明的属性、聚合等。

公共 API 的惟一定义是 API 参考即 API Reference,它蕴含在 SAPUI5 演示工具包中。未提及的性能不是 API 的一部分。

以下规定实用于引入新 API 或对现有 API 进行不兼容的更改:

次要版本 (x.yy.zz 中的 x):新的次要版本能够引入新的 API 或对现有 API 进行不兼容的更改。

主要版本 (x.yy.zz 中的 yy):新的主要版本能够引入新的 API,但不得蕴含对任何 API 不兼容的更改。

补丁公布 (x.yy.zz 中的 zz):新补丁版本仅蕴含对现有实现的修复,但通常不蕴含新性能或不兼容的 API 更改。

Compatible Changes

对现有 API 的以下更改是兼容的,并且能够随时实现:

(1) 增加新的库、控件、类、属性、函数或命名空间

(2) 概括属性,即在继承层次结构中向上挪动属性

(3) 向枚举类型增加新值;这意味着在解决枚举属性时,始终筹备承受新值,例如,在对枚举值做出反馈时实现“默认”或“其余”门路。

Incompatible Changes

以下内容不是公共 API 的一部分,也就是说它们可能会在补丁和主要版本中发生变化:

  • 开源库(参见第三方开源库)
  • 日志音讯

以下对现有 API 的更改不兼容,但能够在新的次要版本中实现:

  • 重命名 API(库、命名空间、函数、属性、控件、事件等)
  • 删除对参数的反对
  • 删除对配置条目标反对
  • 升高 API 的可见性;这不会毁坏 JavaScript 应用程序,但会扭转契约
  • 删除或从新排序 API 签名中的参数
  • 缩小可承受的值范畴,例如,函数的参数
  • 扩充返回值(或属性)的值范畴。例外:枚举
  • 在模块之间挪动 JavaScript 工件(命名空间、函数、类)
  • 用前置条件查看替换断言
  • 在继承层次结构中向下挪动属性(等等)
  • 更改枚举值的名称
  • 更改默认值(属性、函数参数)
  • 重命名或删除文件

Deprecation

如果可能且适当,咱们会将旧工件标记为已弃用并创立新工件,而不是进行不兼容的更改。相应 API 文档中的弃用正文,可能还有实现中的日志条目,解释了工件被弃用的起因和工夫,并蕴含无关如何在不应用弃用性能的状况下实现雷同后果的提醒。

Third-Party Open Source Libraries

SAPUI5 蕴含并应用多个第三方开源库,例如 jQuery。这些库也可由应用程序和 / 或自定义控件库应用,但本文档中形容的 SAPUI5 兼容性规定不适用于这些第三方库。

如果要应用 SAPUI5 中蕴含的第三方开源库,请留神以下限度:

SAP 决定提供所用库的哪些版本和模块。

即便在补丁版本中,SAP 也能够降级到所用库的更高版本。

如果咱们更改为库的新默认版本,咱们会记录可能对 SAPUI5 应用程序产生影响的发现(例如,请参阅从低于 1.20.0 的 SAPUI5 版本升级)。确保在必要时调整您的代码!

出于平安等重要起因,SAPUI5 能够随时进行提供库。

第三方库按“原样”提供。SAP 不执行或提供扩大、改编和反对。

正文完
 0