TypeDI 依赖注入框架入门指南

TypeDI 依赖注入框架入门指南

typedi Simple yet powerful dependency injection tool for JavaScript and TypeScript. 项目地址: https://gitcode.com/gh_mirrors/ty/typedi

什么是 TypeDI

TypeDI 是一个专为 TypeScript 和 JavaScript 设计的轻量级依赖注入(DI)框架。依赖注入是一种设计模式，它允许将对象的创建和绑定从使用它们的代码中分离出来，从而提高代码的可测试性、可维护性和可扩展性。

环境准备

安装依赖

首先需要通过 npm 安装 TypeDI 及其依赖：

npm install typedi reflect-metadata

配置 TypeScript

TypeDI 依赖 TypeScript 的装饰器特性，需要在 tsconfig.json 中启用以下配置：

{
  "compilerOptions": {
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true
  }
}

初始化反射元数据

在应用的入口文件最顶部导入 reflect-metadata：

import 'reflect-metadata';
// 其他导入和初始化代码

这个包是 TypeDI 实现依赖注入的基础，必须在其他代码之前导入。

核心概念

服务(Service)

在 TypeDI 中，任何可注入的类都被称为"服务"。通过 @Service() 装饰器标记一个类，TypeDI 就能管理它的生命周期和依赖关系。

容器(Container)

容器是 TypeDI 的核心，负责存储和管理所有服务实例。通过 Container.get() 方法可以获取服务实例。

基础使用示例

让我们通过一个完整示例来理解 TypeDI 的基本用法：

import { Container, Service } from 'typedi';

// 定义一个可注入的服务
@Service()
class LoggerService {
  log(message: string) {
    console.log(`[LOG] ${message}`);
  }
}

// 定义另一个服务，它依赖 LoggerService
@Service()
class UserService {
  constructor(
    // TypeDI 会自动注入 LoggerService 实例
    private readonly logger: LoggerService
  ) {}

  getUser(id: number) {
    this.logger.log(`Fetching user with id ${id}`);
    // 实际业务逻辑...
    return { id, name: 'John Doe' };
  }
}

// 从容器获取 UserService 实例
const userService = Container.get(UserService);
const user = userService.getUser(1);

在这个例子中：

1. 我们定义了两个服务：LoggerService 和 UserService
2. UserService 依赖于 LoggerService
3. 通过 @Service() 装饰器，TypeDI 会自动管理这些服务的生命周期
4. 当获取 UserService 时，TypeDI 会自动注入 LoggerService 实例

依赖注入的优势

使用 TypeDI 进行依赖注入带来了以下好处：

1. 解耦：服务之间不直接依赖具体实现，而是依赖抽象
2. 可测试性：可以轻松替换依赖项进行单元测试
3. 可维护性：依赖关系清晰，易于理解和修改
4. 代码复用：服务可以在多个地方共享使用
5. 生命周期管理：TypeDI 自动管理服务的创建和销毁

最佳实践

1. 总是将服务类标记为 @Service()
2. 避免在构造函数中直接实例化依赖项，而是通过依赖注入
3. 对于全局配置或单例服务，考虑使用容器设置
4. 合理组织服务层次结构，避免循环依赖

总结

TypeDI 为 TypeScript 应用提供了一个简单而强大的依赖注入解决方案。通过本文的介绍，你应该已经掌握了 TypeDI 的基本使用方法。在实际项目中，合理使用依赖注入可以显著提高代码质量和开发效率。

typedi Simple yet powerful dependency injection tool for JavaScript and TypeScript. 项目地址: https://gitcode.com/gh_mirrors/ty/typedi