当前位置: 首页 > Web前端 > HTML5

SAPUI5兼容性规则的兼容性规则

时间:2023-04-05 20:11:02 HTML5

CompatibilityRules官方网站链接以下部分描述了SAP在主要版本、次要版本和补丁版本中可以更改的内容。在使用或开发SAPUI5的应用程序、功能或控件时,请始终考虑这些规则。作为应用程序开发人员,应避免在SAPUI5代码中直接操作CSS,例如:domRef.className="someCSSClass";切勿使用或覆盖不属于API参考的“私有”函数。私有函数通常(但不总是)以前面的“_”为前缀。始终仔细检查API参考,那里没有列出私有函数。API演进除非另有说明,本节中的术语“API”指的是“公共API”,意思是函数、类、命名空间、控件及其声明的属性、聚合等。公共API的唯一定义是APIReference,它包含在SAPUI5演示套件中。未提及的功能不是API的一部分。以下规则适用于引入新的API或对现有API进行不兼容的更改:主要版本(x.yy.zz中的x):新的主要版本可以引入新的API或对现有的API进行不兼容的更改。次要版本(x.yy.zz中的yy):新的次要版本可能会引入新的API,但不得包含对任何API的不兼容更改。补丁发布(x.yy.zz中的zz):新补丁发布仅包含对现有实现的修复,但通常没有新功能或不兼容的API更改。兼容更改对现有API的以下更改是兼容的,并且可以随时完成:(1)添加新的库、控件、类、属性、函数或名称空间(2)泛化属性,即在继承层次结构中向上移动属性(3)向枚举类型添加新值;这意味着在处理枚举属性时,始终准备好接受新值,例如在对枚举值作出反应时实施“默认”或“其他”路径。不兼容的更改以下不是公共API的一部分,即它们可能会在补丁和次要版本中更改:开源库(请参阅第3方开源库)日志消息在新的主要版本中完成:重命名API(库、命名空间、函数,property,control,event,etc.)移除对参数的支持移除对配置条目的支持降低API可见性;这不会破坏JavaScript应用程序,但会更改契约移除或重新排序API签名中的参数减少可接受值的范围,例如,扩大函数的参数返回值(或属性)的取值范围。异常:枚举在模块(命名空间、函数、类)之间移动JavaScript工件用前提条件检查替换断言将属性向下移动继承层次结构(以及其他)更改枚举值的名称更改默认值(属性、函数参数)重命名或删除文件弃用在可能和适当的情况下,我们将旧工件标记为已弃用并创建新工件,而不是进行不兼容的更改。相应API文档中的弃用说明,可能还有实现中的日志条目,解释了工件被弃用的原因和时间,并包含有关如何在不使用弃用功能的情况下获得相同结果的提示。第三方开源库SAPUI5包含并使用了多个第三方开源库,例如jQuery。这些库也可以被应用程序和/或自定义控件库使用,但本文档中描述的SAPUI5兼容性规则不适用于这些第三方库。如果您想使用SAPUI5中包含的第三方开源库,请注意以下限制:SAP决定所用库的版本和模块可用。即使在补丁版本中,SAP也可以升级到所用库的更高版本。如果我们更改为库的新默认版本,我们会记录可能对SAPUI5应用程序有影响的发现(例如,请参阅从低于1.20.0的SAPUI5版本升级)。确保在必要时调整您的代码!出于安全等重要原因,SAPUI5可以随时停止提供库。第三方库“按原样”提供。SAP不执行或提供扩展、改编和支持。