Bitwarden 贡献文档
⮐ Bitwarden Contributing Documentation我的博客联系我
  • 关于
  • 入门
    • 概述
    • 工具
    • 服务器
      • 设置指南
      • 高级服务器设置
      • 数据库
        • MSSQL
        • 实体框架
      • 事件日志
      • Ingress 隧道
      • SCIM
      • 自托管指南
      • 系统管理门户
      • 单点登录 (SSO)
        • 本地 IdP
        • Okta
      • 故障排除
      • 用户机密
      • 公共 API
    • 网页客户端
      • 网页密码库
        • WebAuthn
      • 浏览器端
        • 生物识别解锁
        • Firefox 隐私模式
      • 桌面端
        • Mac App Store Dev
        • Microsoft Store
        • Native Messaging Test Runner
        • 更新测试
      • CLI
      • 故障排除
    • 移动端
      • Android
        • F-Droid
      • iOS
      • .NET MAUI (legacy)
        • Android
        • iOS
        • watchOS
    • SDK
      • 内部 SDK
      • Secrets Manager
        • Integrations
          • Kubernetes
    • 业务 App
      • 目录连接器
        • JumpCloud
        • OpenLDAP Docker 服务器
      • Key Connector
      • Splunk App
  • 贡献
    • 贡献
    • 代码样式
      • =Android & Kotlin
      • Angular & TypeScript
      • C#
      • =Rust
      • T-SQL
      • =Swift
      • Tailwind
    • 数据库迁移
      • 进化数据库设计
    • 提交签名
    • 拉取请求
      • =贡献审查程序
      • 分支
      • 代码审查
      • UI 审查 - Chromatic
    • 无障碍
    • 依赖管理
    • 功能标记
    • 模板存储库
    • 测试
      • =数据库集成测试
      • 负载测试
      • 单元测试
        • 命名约定
        • 测试结构
    • 修改用户机密
  • 架构
    • 架构
    • 架构决策记录 (ADR)
      • 0001 - Angular Reactive Forms
      • 0002 - Public API for modules
      • 0003 - Adopt Observable Data Services for Angular
      • 0004 - Refactor State Service
      • 0005 - Refactor Api Service
      • 0006 - Clients: Use Jest Mocks
      • 0007 - Manifest V3 sync Observables
      • 0008 - Server: Adopt CQRS
      • 0009 - Composition over inheritance
      • 0010 - Angular Modules
      • 0011 - Scalable Angular Clients folder structure
      • 0012 - Angular Filename convention
      • 0013 - Avoid layered folder structure for request/response models
      • 0014 - Adopt Typescript Strict flag
      • 0015 - Short Lived Browser Services
      • 0016 - Move Decryption and Encryption to Views
      • 0017 - Use Swift to build watchOS app
      • 0018 - Feature management
      • 0019 - Adoption of Web Push
      • 0020 - Observability with OpenTelemetry
      • 0021 - Logging to Standard Output
      • =0022 - Authorization
      • =0023 - Identifying Integrated Clients
    • 移动客户端架构
      • =Android
      • =iOS
        • =推送通知故障排除提示
      • =.NET MAUI (legacy)
        • =概述
        • watchOS
    • =SDK 架构
      • =数据模型
      • =依赖
      • Password Manager
        • Web
          • =互操作性
      • =Secrets Manager
      • =服务器绑定
      • =版本控制和破坏性更改
    • 网络客户端架构
      • 概述
      • 数据模型
      • 表示层
        • Angular
        • CLI
      • =依赖注入
      • 服务层
        • Vision
        • 实现
    • 服务器架构
    • 深度剖析
      • 身份验证
        • 双重身份验证
      • =授权
      • =浏览器自动填充
        • 收集页面详细信息
        • 生成并执行填充脚本
        • 表单提交检测
        • Shadow DOM
        • =内联自动填充菜单
      • Captcha
      • =只读数据库副本
      • 事件日志
      • =FIDO2 和通行密钥
        • =凭据
        • =操作
        • =命名惯例
        • =实现
          • =提供程序
            • =浏览器扩展
          • =依赖方
            • =用于解密的通行密钥
        • =术语表
      • 推送通知
        • 移动端推送通知
        • 其他客户端推送通知
      • =SSH 密钥和代理
        • =SSH 代理
      • =状态提供程序框架
        • =派生状态
    • =安全
      • =定义
      • =原则
        • =P01 - 锁定的密码库是安全的
        • =P02 - 半受损设备密码库的有限安全性
        • =P03 - 完全损坏的系统没有安全性
        • =P04 - 控制密码库数据的访问权限
        • =P05 - 将安全漏洞的影响降至最低
      • =要求
由 GitBook 提供支持
在本页
  • 背景和问题陈述​
  • 考虑的方案​
  • 决策结果​
  • 积极的后果​
  • 消极的后果​
  • 指南​
  • 实施
  1. 架构
  2. 架构决策记录 (ADR)

0010 - Angular Modules

上一页0009 - Composition over inheritance下一页0011 - Scalable Angular Clients folder structure

最后更新于1年前

对应的

ID:
ADR-0010

状态:

进行中

发表于:

2022-07-25

背景和问题陈述​

NgModule 是一个内聚代码块的容器,专用于某个应用程序域、工作流程或密切相关的功能集。它们可以包含组件、服务提供商和其他代码文件,其范围由包含的 NgModule 定义。它们可以导入从其他 NgModule 导出的功能,并导出选定的功能以供其他 NgModule 使用。

--

在 ADR ,我们决定开始使用桶形文件,并限制从其他“模块”导入。这解决了我们遇到的一些痛点,但由于所有组件都需要在 Angular 模块中定义,因此它们仍在桶形文件中导出。这就限制了桶形文件的实用性。

Angular 鼓励创建许多小型 NgModule,人们提倡每个功能一个模块,或者甚至每个组件定义一个模块。在 Angular v14 中,由于引入了,这变得更加容易。

考虑的方案​

  • 什么都不做 -- 维持现状,在单一模块中定义大多数组件。这意味着每个组件本质上仍然是全局的。

  • -- 在我们的桶形文件旁边添加 NgModules。这样可以对内部组件进行适当的封装。

  • -- 提供 NgModule 的优点,而无需大部分额外的样板。目前仍处于预览阶段,因此依赖它有一定风险。

决策结果​

选择的方案:Angular 模块。

积极的后果​

  • 内部组件不能在功能之外重复使用。

  • 需要模块来支持延迟加载。

  • 模块结构与独立组件类似,如果认为有必要,将来可以轻松迁移。

消极的后果​

  • Angular 对 NgModules 的错误处理非常糟糕,提供了难以调试的隐含错误。

  • 额外的样板。

指南​

  • 旨在导出尽可能少的组件。在许多情况下,您根本不需要导出任何组件,而是可以将路由封装在该模块中,这样就可以在认为有用的情况下延迟加载它。

  • 需要在所有模块之间共享的功能应放置在 Shared 功能中。

  • 如果需要在个人密码库和组织密码库等模块之间共享附加功能,请考虑创建 feature/shared 模块。

实施

功能模块的一个例子是报告。我们知道报告既可用于个人用户,也可用于组织。

reports
  shared
    report-card.component
    report-list.component

    reports-shared.module.ts
    index.ts
  reports
    breach-report.component
    ...
  reports.module.ts -> depends on reports-shared.module.ts
  reports.component.ts
  index.ts

organizations
  reports
    organization-reports.module.ts -> depends on reports-shared.module.ts
官方页面地址
https://angular.io/guide/architecture-modules
0002 Define public module in NPM packages
独立组件
Angular 模块
独立组件