什么是 SAP Spartacus UI 的 code deprecation-阿里云开发者社区

开发者社区> -开发者助手-> 正文

什么是 SAP Spartacus UI 的 code deprecation

简介: 什么是 SAP Spartacus UI 的 code deprecation
+关注继续查看

对于复杂且快速发展的库,在改进现有功能的同时保持向后兼容性可能具有挑战性。 代码弃用允许您正确标记过时的代码,并通过警告用户,帮助他们过渡到更好的替代方案。

要将函数、类、方法或属性标记为已弃用,请使用 @deprecated 标记。 下面是一个例子:image.png根据实际的弃用政策,此类代码将成为下一个主要版本之一中删除的候选代码。


Marking Deprecated Logic

通常,为了适应向后兼容性,一些间接相关的代码需要包含额外的逻辑,当相关的弃用功能被删除时,这些逻辑应该被删除。 当不清楚应该删除哪些附加逻辑时,确保删除过时代码的最佳方法是用正确的 TODO 注释标记它,最好链接到带有附加详细信息的 GitHub 问题。 应正确标记这些票证(例如,具有 deprecated-1.x 的标签),以便将来更容易将其作为删除的候选对象引用。


以下是 TODO 注释的示例:

image.pngFeature Flags

每个新的次要版本都会发布新功能。 有时,新功能被添加到客户已经可以使用的现有组件中,这使得这些更改成为破坏性更改,因为添加到 DOM 或因为不同的行为。 为了避免破坏客户的代码,并在不需要过于频繁地发布新的主要版本的情况下灵活地改进现有组件的功能,Spartacus 使用了功能标志。


功能标志允许我们执行以下操作:


根据功能级别区分功能,对应小版本号

基于显式特征标志区分特征

注意:显式功能标志可以链接到功能级别,这意味着默认情况下为该特定级别启用它们。


Deciding If You Need a Feature Flag

如果不需要,最好避免创建新的功能标志。这有助于保持我们的配置干净并使最终的维护更容易。


以下指南可以帮助您决定应该使用哪个功能标志(如果有):


(1) 如果可能,尽量避免使用功能标志。


相反,将您的功能实现为一个单独的模块,可以由客户选择导入。


(2) 如果您的功能已经有单独的配置,请确定以下哪个更方便:


a. 在模块配置中创建一个新选项(对于一般功能,使它们可切换具有实际价值)。

b. 使用功能标志(特别是当标志的唯一原因是向后兼容时)。


如果可能,尽量避免创建明确的功能标志。相反,尝试启用特定功能级别的功能,例如次要版本。

如果要创建显式功能标志,请确保这样做的原因是合理的(例如,该功能非常重要,可以显式禁用或启用)。


Detecting the Feature Level

如果您的服务或组件已经注入了全局配置,您可以使用一个简单的实用程序函数来检查功能级别,如以下示例所示:

image.png通过这种方式,您还可以在标志中添加描述,如果需要,甚至可以添加弃用注释。


Linking the Feature Flag to the Feature Level

通过将您的功能标志链接到功能级别,默认情况下将为该功能级别和所有更高级别启用您的标志。 为此,请将功能标志的默认值作为表示功能级别的字符串提供。 您可以将此配置添加到您的模块配置中,如以下示例所示:

image.png在此示例中,如果功能级别设置为至少“1.1”,则默认情况下启用寄售跟踪功能。

Disabling a Feature for a Specific Feature Level

您可以通过包含感叹号来禁用特定功能级别的功能! 在版本号之前。 下面是一个例子:image.png

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
阿里云服务器怎么设置密码?怎么停机?怎么重启服务器?
如果在创建实例时没有设置密码,或者密码丢失,您可以在控制台上重新设置实例的登录密码。本文仅描述如何在 ECS 管理控制台上修改实例登录密码。
10084 0
使用SSH远程登录阿里云ECS服务器
远程连接服务器以及配置环境
2511 0
windows server 2008阿里云ECS服务器安全设置
最近我们Sinesafe安全公司在为客户使用阿里云ecs服务器做安全的过程中,发现服务器基础安全性都没有做。为了为站长们提供更加有效的安全基础解决方案,我们Sinesafe将对阿里云服务器win2008 系统进行基础安全部署实战过程! 比较重要的几部分 1.
9161 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,阿里云优惠总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系.
13889 0
阿里云ECS云服务器初始化设置教程方法
阿里云ECS云服务器初始化是指将云服务器系统恢复到最初状态的过程,阿里云的服务器初始化是通过更换系统盘来实现的,是免费的,阿里云百科网分享服务器初始化教程: 服务器初始化教程方法 本文的服务器初始化是指将ECS云服务器系统恢复到最初状态,服务器中的数据也会被清空,所以初始化之前一定要先备份好。
7365 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,云吞铺子总结大概有三种登录方式: 登录到ECS云服务器控制台 在ECS云服务器控制台用户可以更改密码、更换系统盘、创建快照、配置安全组等操作如何登录ECS云服务器控制台? 1、先登录到阿里云ECS服务器控制台 2、点击顶部的“控制台” 3、通过左侧栏,切换到“云服务器ECS”即可,如下图所示 通过ECS控制台的远程连接来登录到云服务器 阿里云ECS云服务器自带远程连接功能,使用该功能可以登录到云服务器,简单且方便,如下图:点击“远程连接”,第一次连接会自动生成6位数字密码,输入密码即可登录到云服务器上。
22403 0
阿里云服务器ECS登录用户名是什么?系统不同默认账号也不同
阿里云服务器Windows系统默认用户名administrator,Linux镜像服务器用户名root
4505 0
2450
文章
0
问答
来源圈子
更多
+ 订阅
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载