SAP UI5 的 兼容性规则 Compatibility Rules
兼容性規(guī)則官網(wǎng)鏈接
以下部分描述了 SAP 在主要(major)、次要(minor)和補(bǔ)丁(patch)版本中可以更改的內(nèi)容。 在使用 SAPUI5 或?yàn)?SAPUI5 開(kāi)發(fā)應(yīng)用程序、功能或控件時(shí),請(qǐng)始終考慮這些規(guī)則。
作為應(yīng)用開(kāi)發(fā)人員,避免在 SAP UI5 代碼中直接操作 CSS,例如:
domRef.className = "someCSSClass";切勿使用或覆蓋不屬于 API 參考的“私有”函數(shù)。 私有函數(shù)通常(但不總是)以前面的“_”為前綴。 始終仔細(xì)檢查 API 參考,那里沒(méi)有列出私有函數(shù)。
API Evolution
除非另有說(shuō)明,本節(jié)中的“API”一詞指的是“公共 API”,意思是函數(shù)、類、命名空間、控件及其聲明的屬性、聚合等。
公共 API 的唯一定義是 API 參考即 API Reference,它包含在 SAPUI5 演示工具包中。 未提及的功能不是 API 的一部分。
以下規(guī)則適用于引入新 API 或?qū)ΜF(xiàn)有 API 進(jìn)行不兼容的更改:
主要版本 (x.yy.zz 中的 x):新的主要版本可以引入新的 API 或?qū)ΜF(xiàn)有 API 進(jìn)行不兼容的更改。
次要版本 (x.yy.zz 中的 yy):新的次要版本可以引入新的 API,但不得包含對(duì)任何 API 不兼容的更改。
補(bǔ)丁發(fā)布 (x.yy.zz中的 zz):新補(bǔ)丁版本僅包含對(duì)現(xiàn)有實(shí)現(xiàn)的修復(fù),但通常不包含新功能或不兼容的 API 更改。
Compatible Changes
對(duì)現(xiàn)有 API 的以下更改是兼容的,并且可以隨時(shí)完成:
(1) 添加新的庫(kù)、控件、類、屬性、函數(shù)或命名空間
(2) 概括屬性,即在繼承層次結(jié)構(gòu)中向上移動(dòng)屬性
(3) 向枚舉類型添加新值; 這意味著在處理枚舉屬性時(shí),始終準(zhǔn)備接受新值,例如,在對(duì)枚舉值做出反應(yīng)時(shí)實(shí)現(xiàn)“默認(rèn)”或“其他”路徑。
Incompatible Changes
以下內(nèi)容不是公共 API 的一部分,也就是說(shuō)它們可能會(huì)在補(bǔ)丁和次要版本中發(fā)生變化:
-
開(kāi)源庫(kù)(參見(jiàn)第三方開(kāi)源庫(kù))
-
日志消息
以下對(duì)現(xiàn)有 API 的更改不兼容,但可以在新的主要版本中完成:
-
重命名 API(庫(kù)、命名空間、函數(shù)、屬性、控件、事件等)
-
刪除對(duì)參數(shù)的支持
-
刪除對(duì)配置條目的支持
-
降低 API 的可見(jiàn)性; 這不會(huì)破壞 JavaScript 應(yīng)用程序,但會(huì)改變契約
-
刪除或重新排序 API 簽名中的參數(shù)
-
減少可接受的值范圍,例如,函數(shù)的參數(shù)
-
擴(kuò)大返回值(或?qū)傩?#xff09;的值范圍。 例外:枚舉
-
在模塊之間移動(dòng) JavaScript 工件(命名空間、函數(shù)、類)
-
用前置條件檢查替換斷言
-
在繼承層次結(jié)構(gòu)中向下移動(dòng)屬性(等等)
-
更改枚舉值的名稱
-
更改默認(rèn)值(屬性、函數(shù)參數(shù))
-
重命名或刪除文件
Deprecation
如果可能且適當(dāng),我們會(huì)將舊工件標(biāo)記為已棄用并創(chuàng)建新工件,而不是進(jìn)行不兼容的更改。 相應(yīng) API 文檔中的棄用注釋,可能還有實(shí)現(xiàn)中的日志條目,解釋了工件被棄用的原因和時(shí)間,并包含有關(guān)如何在不使用棄用功能的情況下實(shí)現(xiàn)相同結(jié)果的提示。
Third-Party Open Source Libraries
SAPUI5 包含并使用多個(gè)第三方開(kāi)源庫(kù),例如 jQuery。 這些庫(kù)也可由應(yīng)用程序和/或自定義控件庫(kù)使用,但本文檔中描述的 SAPUI5 兼容性規(guī)則不適用于這些第三方庫(kù)。
如果要使用 SAPUI5 中包含的第三方開(kāi)源庫(kù),請(qǐng)注意以下限制:
SAP 決定提供所用庫(kù)的哪些版本和模塊。
即使在補(bǔ)丁版本中,SAP 也可以升級(jí)到所用庫(kù)的更高版本。
如果我們更改為庫(kù)的新默認(rèn)版本,我們會(huì)記錄可能對(duì) SAPUI5 應(yīng)用程序產(chǎn)生影響的發(fā)現(xiàn)(例如,請(qǐng)參閱從低于 1.20.0 的 SAPUI5 版本升級(jí))。 確保在必要時(shí)調(diào)整您的代碼!
出于安全等重要原因,SAPUI5 可以隨時(shí)停止提供庫(kù)。
第三方庫(kù)按“原樣”提供。 SAP 不執(zhí)行或提供擴(kuò)展、改編和支持。
總結(jié)
以上是生活随笔為你收集整理的SAP UI5 的 兼容性规则 Compatibility Rules的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: iPhone 14 Pro Max用户换
- 下一篇: 希捷酷狼 NAS 硬盘 1TB / 2T