Brandi：项目的核心功能/场景

Brandi：项目的核心功能/场景

brandi The dependency injection container powered by TypeScript. 项目地址: https://gitcode.com/gh_mirrors/br/brandi

Brandi 是一个由 TypeScript 驱动的依赖注入容器。

项目介绍

Brandi 是一个功能强大且轻量级的依赖注入容器，设计之初就考虑了性能和易用性。它不依赖任何特定的 UI 或服务器框架，使得开发者可以灵活地在各种项目中使用。Brandi 的核心特性如下：

• 框架无关：可以与任何 UI 或服务器框架配合使用。
• 轻量级且高效：体积小巧，旨在提供最大化的性能。
• 强类型：原生支持 TypeScript。
• 无需装饰器：在 tsconfig.json 和 Reflect polyfill 中无需添加额外参数。

项目技术分析

Brandi 的源代码采用 TypeScript 编写，并预编译为 CommonJS 和 ESModule 格式的 ES2018。此外，还提供了预编译为 ESNext 的版本。Brandi 的类型定义已经包含在库中，无需额外安装。

核心库

Brandi 的核心库提供了基础的依赖注入功能，可以通过 NPM 或 Yarn 进行安装。

npm install brandi
# 或
yarn add brandi

React 绑定

Brandi-React 是 Brandi 的 React 绑定层，它允许 React 组件从 Brandi 容器中获取依赖项。Brandi-React 需要与 React 16.8 或更高版本 配合使用。

npm install brandi-react
# 或
yarn add brandi-react

Brandi 没有任何外部依赖，但是需要以下全局变量：

• Symbol
• WeakMap

项目及技术应用场景

Brandi 的设计哲学是简单、灵活且高效。在以下场景中，Brandi 可以发挥其独特的优势：

1. 大型应用程序：在复杂的系统中，Brandi 可以帮助管理和组织依赖关系，提高代码的可维护性。
2. 微服务架构：在微服务架构中，Brandi 可以作为服务间的依赖注入工具，使得服务之间的耦合度降低。
3. 单元测试：Brandi 提供的快照功能可以捕获和恢复容器的状态，这对于编写单元测试非常有用。
4. 框架集成：由于 Brandi 是框架无关的，它可以在各种前端和后端框架中无缝集成。

项目特点

1. 框架无关性：Brandi 不依赖于任何特定的框架，这意味着它可以在多种技术栈中灵活使用。
2. 轻量级：Brandi 的设计注重性能和资源消耗，使其成为资源敏感型应用程序的理想选择。
3. 类型安全：得益于 TypeScript 的支持，Brandi 提供了类型安全的依赖注入。
4. 无装饰器设计：Brandi 不需要装饰器，简化了配置过程，也避免了 Reflect polyfill 的需要。

以下是 Brandi 的一些具体特点：

获取实例

Brandi 通过令牌（tokens）和绑定类型（binding types）来管理依赖关系。以下是如何使用 Brandi 获取一个实例的基本示例：

import { Container, token } from 'brandi';

class ApiService {}

const TOKENS = {
  apiService: token<ApiService>('apiService'),
};

const container = new Container();

container
  .bind(TOKENS.apiService)
  .toInstance(ApiService)
  .inTransientScope();

const apiService = container.get(TOKENS.apiService);

expect(apiService).toBeInstanceOf(ApiService);

快照功能

Brandi 的快照功能允许开发者捕获和恢复容器的当前状态，这在测试中非常有用：

import { Container, token } from 'brandi';

const TOKENS = {
  apiKey: token<string>('API Key'),
};

const container = new Container();

container
  .bind(TOKENS.apiKey)
  .toConstant('#key9428');

container.capture();

container
  .bind(TOKENS.apiKey)
  .toConstant('#testKey');

const testKey = container.get(TOKENS.apiKey);

container.restore();

const originalKey = container.get(TOKENS.apiKey);

expect(testKey).toBe('#testKey');
expect(originalKey).toBe('#key9428');

层次容器

Brandi 支持层次容器，这意味着子容器可以继承父容器的绑定：

import { Container, token } from 'brandi';

class ApiService {}

const TOKENS = {
  apiService: token<ApiService>('apiService'),
};

const parentContainer = new Container();

parentContainer
  .bind(TOKENS.apiService)
  .toInstance(ApiService)
  .inTransientScope();

const childContainer = new Container().extend(parentContainer);

const apiService = childContainer.get(TOKENS.apiService);

expect(apiService).toBeInstanceOf(ApiService);

Brandi 通过其简洁的 API 和灵活的设计，为开发者提供了一个强大的依赖注入工具。无论您是在构建一个大型的企业级应用程序，还是在开发一个微服务架构，Brandi 都能够帮助您轻松管理依赖关系，提高代码的可维护性和可测试性。快来尝试 Brandi，体验它带来的便利吧！

brandi The dependency injection container powered by TypeScript. 项目地址: https://gitcode.com/gh_mirrors/br/brandi