@glimmer/di

中文文档
0.2.1发布于 2018/08/22MITTypeScriptESM + CJS零依赖近 30 天下载 54.3万

Glimmer应用的依赖性注射支持.

中文使用文档
文档目录7 节
  1. 依赖注射是什么?
  2. 集装箱和登记处
  3. 单数
  4. 注射剂
  5. 解析器: 映射到文件系统
  6. 鸣谢
  7. 许可证

闪光-di Build Status

格利默应用的依赖性注射.

依赖注射是什么?

依赖性注射是一种增加灵活性,可测试性的模式 和代码的一致性.

三个主要想法是:

  1. 对象的依赖性(即它需要完成任务的其他对象) 应在对象创建时向其提供,而不是硬编码.
  2. 依赖可能具有多种执行方式,只要 执行遵循商定的接口.
  3. 使用依赖对象不应该在文件系统上在乎 依赖来自.

让我们看看一个简短的例子 没有 使用依赖性注射。 我们会 写入一个假设服务器, 当收到 HTML 文档时将生成一个简短的 HTML 文档 收到请求:

import HTTPServer from "./servers/http";

export default class HelloWorldServer {
  constructor() {
    let server = new HTTPServer({
      port: 80
    });

    server.on('request', req => {
      req.write("<html><body>Hello, world!</body></html>");
    });
  }
}

这是伟大的,但有一个问题。 如你所见,我们Hello World服务器 正在直接导入 HTTP 库。 如果我们想支持HTTP和 HTTP/2(甚至像WebSocket之类的东西),这个代码是不可再使用的.

我们要么重复这个代码,要么添加一些配置选项 ,以便让用户告诉我们他们想要使用的协议。 当然,那会 今天的工作,但如果我们想 支持HTTP/3 在将来,我们不得不来 返回并添加每个新协议的新配置选项.

如果,不是告诉服务器使用什么协议, 我们可以代替 给它一个包罗所有这些关切的物体?

而不是拥有我们的 HelloWorldServer 导入和即时 HTTPServer 直接地,我们可以提供它的一个对象 我们保证执行相同的 接口。 在这种情况下,这意味着任何物体发出一个 'request' 事件 ,并支持与 on() 方法.

让我们看看这个更新的例子可能是什么样子:

export default class HelloWorldServer {
  constructor(server) {
    server.on('request', req => {
      req.write("<html><body>Hello, world!</body></html>");
    });
  }
}

现在我们不再关注 即时和配置一个HTTP服务器. 我们只需要知道 不管什么物体被传给我们的班级 on() 方法,让我们添加一个事件倾听器.

现在,让我们看看几个不同的方法 我们可以使用我们的新改进 你好 世界服务器.

import HelloWorldServer from "./hello-world-server";
import HTTPServer from "./servers/http";
import HTTP2Server from "./servers/http2";
import WebSocketServer from "./servers/web-socket";

// HTTP 1
let httpServer = new HTTPServer({
  port: 80
});
new HelloWorldServer(httpServer);

// HTTP 2
let http2Server = new HTTP2Server({
  port: 4200
});
new HelloWorldServer(http2Server);

// WebSocket
let wsServer = new WebSocketServer();
new HelloWorldServer(wsServer);

有了这个小改变,我们大大提高了可重复性 hello World服务器的灵活性。 它现在可以处理任何协议,即使是协议 写作时并不存在的 只要它们可以适应 我们定义的简单界面.

这个想法可能看起来很简单,但对管理联合国 随着应用程序的增长,代码的复杂性。 这意味着你可以 根据环境的不同,可以轻而易举地以不同的代码进行互换.

例如,在单位测试中,我们可能想要在一些分贝对象中互换来验证 一些行为。 依赖性注射使注射变得容易并避免必须超过 全球价值.

我们还可以在节点J和节点J运行同样的应用程序 浏览器,在您有完整的 DOM 时,通过一个框架代码的交换 执行和另一个执行 当你不执行.

虽然依赖性注射只是一种简单的模式,但它有助于拥有 形式化为规范。 这正是这个图书馆要做的: 执行 令人难以置信的轻量级依赖性注射, 有一些公用事业 帮助我们清理我们自己 当我们结束运行应用程序.

集装箱和登记处

Glimmer DI系统的两个核心部分是 Registry 编辑 Container。 。 。 .

如何记住每个角色:

  1. 这个 Registry 你在这里 注册 代码(即JavaScript类).
  2. 这个 Container 包含 对象,是您请求实例 注册班级.

如果这听起来令人困惑, 让我们看看一个应该使它 更清楚一点.

假设我有一个课程 一个UI组件,我想提供给 系统。 我要做的第一件事就是创造一个新的 Registry 实例和告诉 关于我的课.

import { Registry } from '@glimmer/di';
import ProfileComponent from './components/profile';

let registry = new Registry();
registry.register('component:profile', ProfileComponent);

你可能注意到了我们将要传递到 register 方法 : 'component:profile'这就是我们所谓的 规格,这是独一无二的 类的标识符。 它们的形式是 ${type}:${name}在这种情况下, 我们有一个UI组件叫做 Profile 因此,它的描述是 'component:profile'如果我们有一个博客的帖子模型,它的描述者可能 为: 'model:blog-post'。 。 。 .

现在我们已经告诉 Registry 关于我们的组件。 举个例子 现在这个部分。 要做到这一点,我们需要创造一个新的 Container告诉它 关于我们的注册,然后要求它为我们希望的组件:

import { Container } from '@glimmer/di';

// Create the container and pass in the registry we previously created.
let container = new Container(registry);
let component = container.lookup('component:profile');

现在我们 component 变量包含一个以前注册的实例 配置组件.

单数

需要注意的一件事是, (默认情况下)你每次打电话 lookup 方法,您将获得组件的相同实例:

let component1 = container.lookup('component:profile');
let component2 = container.lookup('component:profile');

component1 === component2; // => true

但这不是我们希望的行为: 在应用程序中,你需要能够创建 同一组成部分的许多实例.

在这种情况下,我们要改变默认行为,并告诉注册人 我们应该一直得到一个 新设 我们打电话的时候 lookup('component:profile')数字 :

registry.registerOption('component:profile', 'singleton', false);

在这里,我们已经设置 singleton 选项到 false 用于本构成部分。 我们可以 当我们初始注册组件时, 也配置了此设置 :

registry.register('component:profile', ProfileComponent, {
  singleton: false
});

现在,如果我们寻找多个组件, 我们会得到一个不同的实例 每次:

let component3 = container.lookup('component:profile');
let component4 = container.lookup('component:profile');

component3 === component4; // => false

注射剂

到目前为止,这似乎没有任何好处 仅仅通过即兴演奏 每当我们需要新的实例时,我们都会学习 让我们看看凶手之一 特征:注射.

一个 注射 是指示容器自动给出一个对象的规则 进入另一个.

比如,让我们想象我们有一个集中的数据存储 我们想要制作 我们所有组件都可以使用,这样他们就可以在 腾讯网. 我们不担心如何在我们的框架内创建组件 只想说,"每当一个新的组件被即时化, 确保它已经 进入数据库。"

我们可以用注射器自动设置这个 首先,让我们注册 与登记册保存数据:

import DataStore from "./data/store";

registry.register('store:main', DataStore);

因为我们想要组件共享一个存储实例,注意我们没有 禁用默认 singleton 设置。 对于整个应用程序, 将会有正义 一个商店.

(如果应用程序中只有一个特定类型的例子,我们常常称之为 main。在这种情况下,因为有一个商店 它是一个单通,它的 规格为 store:main。虽然这个名字没什么特别的 只是一个共同的公约。 )

接下来,我们将制定一条规则,告诉注册人,新的组件应该是 数据存储实例:

registry.registerInjection('component', 'store', 'store:main');

让我们看看每一个这些论点 registerInjection。每个帮助定义部分 注射规则。 在这种情况下,这意味着:

  1. 每一个新的 component 创建,
  2. 设定其 store 属性改为
  3. 实例 store:main

换句话说,每次 container.lookup('component:profile') 被调用, 像这样的事情正在引擎盖下发生:

let store = container.lookup('store:main');
return ProfileComponent.create({ store });

注射的好东西是,我们可以 制定规则一次,不用担心 详细描述实例的创建地点和方式。 这个 将关切分开可以减少繁琐的代码.

你们现在也看到了为什么 描述者包含关于名字和名字的信息 类型。 注射式注射让我们具体说明适用于所有情况的规则 组成部分,例如,不必对 系统.

解析器: 映射到文件系统

到目前为止,我们总是不得不告诉 Registry 我们还没上完课 以获得实例 Container但是,如果我们是好的开发者 组织好我们的代码 和一致的我们的命名, 不应该我们的应用 能自动找到我们的课吗?

就是这样 Resolver 帮助我们做。 有了决心,我们可以定义 用于映射描述符的规则( 如 component:profile放在模块名称( 如 app/components/profile.js) (中文(简体) ).

很简单 Resolver 采用单一方法, retrieve(),则需要 指定并返回关联类.

让我们写一个解析器, 使用 CommonJS 来装入组件类, 而不是 需要热切地在应用程序中注册每个组件:

class Resolver {
  retrieve(specifier) {
    let [type, name] = specifier.split(':');

    if (type !== 'component') { throw new Error("Unsupported type"); }
    return require(`./app/${type}s/${name}.js`);
  }
}

let registry = new Registry();
let resolver = new Resolver();
let container2 = new Container(registry, resolver);

// Make sure components aren't singletons
registry.registerOption('component', 'singleton', false);

// Requires and instantiates `./app/components/admin-page.js`:
let adminPage = container2.lookup('component:admin-page');

请注意: retrieve() 必须 同步返回。 因此你的舱载器 必须同步返回,如同它在此共同JS实例中所做的那样。 如果你使用一个 同步模块加载器, 您需要先确保模块加载 启动即时对象.

一般情况下,这个软件包的设计是同步实现最大 操作;您有责任确保代码在操作前准备好 需要帮助.

最后一件事,你可能注意到 这个例子中的容器有两种 登记和解决者。 集装箱会找两个课,但 登记总是优先。 如果登记册为空,容器将 回到求解者帮助.

鸣谢

感谢 单行本 财务报告和审定财务报表 切里布里斯语Name (b) 为初步制定《公约》提供资金 图书馆.

许可证

MIT许可证.

版本与发布记录

@glimmer/di 共发布 14 个版本,首次发布于 2017/01/13;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.2.1latest2018/08/228 年前
0.2.02017/03/199 年前
0.1.112017/03/179 年前
0.1.102017/03/139 年前
0.1.92017/03/109 年前
0.1.82017/02/039 年前

关于 @glimmer/di 的常见问题

@glimmer/di 是什么?

Glimmer应用的依赖性注射支持.

如何安装 @glimmer/di?

在项目目录运行 npm install @glimmer/di,或使用 pnpm add / yarn add / bun add。

@glimmer/di 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@glimmer/di 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@glimmer/di 可以商用吗?

@glimmer/di 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@glimmer/di 的下载量有多少?

根据 npm 官方下载统计,@glimmer/di 在 2026/10/17 – 2026/11/15 这 30 天内被下载 542,751 次,日均约 18,092 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@glimmer/di 还在维护吗?

最新版本 0.2.1 发布于 2018/08/22(8 年前);至今共发布 14 个版本,其中过去 12 个月发布了 0 个;首次发布于 2017/01/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。