TypeDI 依赖注入框架基础使用指南

TypeDI 依赖注入框架基础使用指南

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

前言

在现代前端开发中，依赖注入(Dependency Injection)已经成为构建可维护、可测试应用的重要模式。TypeDI 是一个基于 TypeScript 的强大依赖注入容器，它通过装饰器语法提供了优雅的依赖管理解决方案。本文将详细介绍 TypeDI 的基本使用方法，帮助开发者快速掌握这一工具。

核心概念

在使用 TypeDI 之前，需要理解几个核心概念：

1. 容器(Container)：管理所有依赖项的中央存储库
2. 服务(Service)：通过装饰器标记的可注入类
3. 令牌(Token)：用于标识非类依赖的唯一标识符

依赖注册的三种方式

1. 使用 @Service 装饰器

这是最常用的方式，适用于类依赖项的注册：

import { Service } from 'typedi';

@Service()
class UserService {
  // 类实现
}

2. 使用 Token 注册

适合注册非类依赖项，如配置值、常量等：

import { Container, Token } from 'typedi';

const API_URL = new Token('API_ENDPOINT');
Container.set(API_URL, 'https://api.example.com');

3. 使用字符串标识符注册

与 Token 类似，但使用字符串作为键名：

Container.set('MAX_RETRIES', 3);

依赖注入的三种方式

1. 构造函数注入（推荐方式）

TypeDI 会自动解析构造函数参数：

@Service()
class AuthService {
  constructor(private userService: UserService) {}
}

2. 属性注入

使用 @Inject 装饰器标记需要注入的属性：

@Service()
class OrderService {
  @Inject()
  private paymentService: PaymentService;
}

3. 直接容器获取

在需要的地方直接从容器获取实例：

const userService = Container.get(UserService);
const apiUrl = Container.get(API_URL);

单例与瞬态作用域

TypeDI 默认以单例模式管理服务：

const instance1 = Container.get(MyService);
const instance2 = Container.get(MyService);
// instance1 === instance2

如需每次获取新实例，可设置为瞬态作用域：

@Service({ scope: 'transient' })
class TransientService {}

最佳实践建议

1. 保持构造函数简洁：只注入必要的依赖
2. 优先使用接口：通过 Token 绑定接口与实现
3. 合理使用作用域：默认单例，有状态服务考虑瞬态
4. 集中管理Token：创建专门的 tokens.ts 文件管理所有 Token

常见问题解答

Q: 为什么我的依赖没有被正确注入？ A: 请确保：

• 类已添加 @Service() 装饰器
• 已正确导入 reflect-metadata
• 没有循环依赖

Q: 如何注入第三方库？ A: 可以通过 Token 或字符串标识符注册：

Container.set('axios', axiosInstance);

总结

TypeDI 提供了灵活而强大的依赖注入能力，通过本文介绍的基础用法，开发者已经可以开始在项目中应用这一工具。合理使用依赖注入可以显著提高代码的可测试性和可维护性，是现代化 TypeScript 项目架构的重要组成部分。

后续我们将深入探讨 TypeDI 的高级特性，包括自定义解析器、条件注入等更复杂的应用场景。

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