Angular Public API 接口设计-阿里云开发者社区

开发者社区> -技术小助手-> 正文

Angular Public API 接口设计

简介: Angular Public API 接口设计
+关注继续查看

按照 Angular 官方 Github repo的定义,Angular 的 semver、定时发布周期和弃用政策目前适用于这些 npm 包:


@angular/animations

@angular/core

@angular/common

@angular/elements

@angular/forms

@angular/platform-browser

@angular/platform-browser-dynamic

@angular/platform-server

@angular/upgrade

@angular/router

@angular/service-worker



此列表中有意省略的一个是 @angular/compiler,它目前被认为是低级 api,可能会进行内部更改。 这些更改不会影响使用更高级别 api(命令行界面或通过 @angular/platform-browser-dynamic 进行 JIT 编译)的任何应用程序或库。 只有非常具体的用例需要直接访问编译器 API(主要是 IDE、linter 等的工具集成)。


包 @angular/bazel 目前是一个 Angular Labs 项目,不在公共 API 保证范围内。


此外,仅涵盖了@angular/compiler-cli 的命令行使用(不是直接使用 API)。


Angular 团队开发的其他项目,如 angular-cli、Angular Material,将来随着它们的成熟,将包含在这些或类似的保证中。


在支持的软件包中,Angular 提供以下保证:


(1) 通过主入口点(例如@angular/core)和测试入口点(例如@angular/core/testing)导出的符号。 这适用于运行时 JavaScript 值和 TypeScript 类型。


(2) 通过全局命名空间 ng 导出的符号(例如 ng.core)


(3) 位于 npm 包的 bundles/ 目录中的包(例如@angular/core/bundles/core.umd.js)


以下并非 Angular public API surface:


(1) 我们包中的任何文件/导入路径,除了 /、/testing 和 /bundles/* 以及其他记录的包入口点。

(2) 可注入类(服务和指令)的构造函数 - 请使用 DI 获取这些类的实例

(3) 任何标记为私有的类成员或符号,或以下划线 (_)、禁止拉丁语 o (ɵ) 和双禁止拉丁语 o (ɵɵ) 为前缀。

(4) 扩展我们的任何类,除非 API 文档中专门记录了对此的支持

(5) Angular 编译器生成的代码的内容和 API 表面(有一个明显的例外:保证从生成的代码导出的 NgModuleFactory 实例的存在和名称)


Angular peer dependencies(例如 TypeScript、Zone.js 或 RxJS)不被视为 Angular API 表面的一部分,但它们包含在我们的 SemVer 政策中。 如果更新不会对 Angular 应用程序造成重大更改,我们可能会在次要版本中更新任何这些依赖项的所需版本。导致重大破坏性更改的对等依赖项更新必须推迟到主要的 Angular 版本。


Extending Angular classes

除非在 API 文档中明确说明,否则 Angular 公共 API 中的所有类都是 final 的(不应扩展它们)。


不支持扩展此类最终类,因为受保护的成员和内部实现可能会在主要版本之外发生变化。


Golden files

Angular 在黄金文件中跟踪公共 API 的状态,该文件由一个称为公共 API 防护的工具维护。 如果您在受支持的公共包之一中修改公共 API 的任何部分,则 PR 可能无法通过 CI 中的测试并显示一条错误消息,指示您接受黄金文件。


公共 API 守卫提供了一个 Bazel 目标,用于更新给定包的当前状态。 如果您以任何方式添加或修改公共 API,您必须使用 yarn 在您选择的终端 shell 中执行 Bazel 目标(推荐使用最新版本的 bash)。

8

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

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