原文地址：Dependency Injection in TypeScript

原文做者：Mert Türkmenoğlu

译文出自：掘金翻译计划

本文永久连接：github.com/xitu/gold-m…

译者：Usualminds

校对者：Kim Yang、PassionPenguin

TypeScript 中的依赖注入

简介

每个软件程序都有其最基础的构建模块。在面向对象的编程语言中，咱们使用类去构建复杂的体系架构。像建一幢大楼，咱们把模块之间创建的联系称之为依赖。其余的类为了支持咱们类的需求，提供复杂的封装操做。前端

一个类可能有引用其余类的字段。所以，咱们不得不问及这些问题：这些引用是怎么被建立的？是咱们去组合这些对象，仍是其余类负责实例化它们？若是要实例化的类太复杂，而且咱们想避免出现垃圾代码？全部这些问题均可以试图经过依赖注入原则来解决。node

在开始示例以前，咱们必需要去理解关于依赖注入的一些相关概念。依赖注入原则告诉咱们，一个类应该去接收而非实例化它的依赖。经过委托方式来进行对象初始化，这能够处理较为复杂的操做，从而减小在类设计上的压力。你能够移除代码中复杂的模块，并经过其余方式从新引入依赖。如何处理移除和从新引入依赖，这是依赖管理的问题。你能够手动处理全部对象的初始化和注入，可是这将会使整个系统变得复杂，咱们要尽可能避免这种状况的发生。相反，你能够将构造的职责转移到 IoC 容器。android

控制反转是经过反转整个程序的流程，以便容器对全部程序中涉及的依赖进行管理。你能够建立一个容器，整个容器负责构造对象。当一个类须要实例化对象时，IoC 容器能够提供它所须要的依赖。ios

IoC 只提供了一种方法而非具体的实现。为了使用依赖注入原则，你须要一个依赖注入框架。举例以下：git

Spring 和 Dagger是 Java 的依赖注入框架
Hilt 是 Kotlin 的依赖注入框架
Unity 是 C# 的依赖注入框架
Inversify、Nest.js 和 TypeDI 是 TypeScript 的依赖注入框架

概览和角色划分

在依赖注入原则中，咱们须要理解四种不一样的角色:github

客户端
服务端
接口
注入器

服务端是咱们对外暴露服务使用的。这些类由 IoC 容器实例化和使用。一个客户端经过 IoC 容器来使用这些服务。客户端不该该被具体细节所困扰，所以接口须要确保客户端和服务端保持协调。客户端请求所需的依赖，注入器提供实例化服务。typescript

依赖注入的类型

当咱们讨论如何在类中注入依赖时，能够经过三种不一样方式来实现：数据库

咱们能够经过属性(字段)提供依赖关系。在类上定义属性，而后将具体的对象注入到该属性中，这就是属性注入。经过对外暴露这个属性，但这样作违背了面向对象程序设计的封装原则；所以，要尽可能避免这种注入。
咱们能够经过方法提供依赖关系。对象的状态应该是私有的，当外部想要改变该状态时，它应该调用类的 getter/setter 方法。因此当你使用 setter 方法初始化类中的私有字段时，你可使用方法注入。
咱们能够经过构造函数提供依赖关系。构造函数方法由于其基本属性和对象构造高度融合在一块儿。咱们一般支持经过构造函数进行注入，由于咱们的目标和构造函数的方法很相似。

使用 TypeDI 库

一旦咱们理解了依赖注入的基本原理，使用什么框架或者库差异并不大。这篇文章里，我选择了 TypeScript 语言和 TypeDI 库来展现这些基本概念。express

初始化 Yarn 和添加 TypeScript 会花点时间。我不想使用有名气但没有足够注释的项目配置，由于这会让你感到无趣。因此我将给出初步的代码并作简要介绍。你能够从这个 Github 仓库查看和下载代码。编程

任何 TypeScript 项目均可以做为依赖注入演示的例子。但这篇文章里我选择了一个 Node/Express 应用做为示例。我假设使用 TypeScript 的开发者要么直接使用 Node/Express 服务器，要么对它们有所了解。

当你查看 package.json 文件时，你能够看到这些依赖项配置，让我简要介绍下它们：

express：Express 是编写 Node.js RESTful 服务的流行框架。
reflect-metadata：一个用于元数据反射 API 的库。它容许其余库经过装饰器使用元数据。
ts-node：Node.js 没法运行 TypeScript 文件。在代码运行前，须要将 TypeScript 编译为 JavaScript。ts-node 帮你处理了这个过程。
typedi：TypeDI 是一个 TypeScript 依赖注入库。咱们很快会看到它的示例。
typescript：咱们在这个项目中使用了 TypeScript，所以须要将它也做为一个依赖。
@types/express：Express 库的类型定义。
@types/node：Node.js 的类型定义。
ts-node-dev：这个库容许你运行 TypeScript，并观察某些文件的变化状况。

你须要留意一些重要的编译器选项配置。若是你看下 tsconfig.json，你能够看到编译过程的配置选项：

咱们为 reflect-metadata 和 node 指定了类型。
咱们必须将 mitDecoratorMetadata 和 experimentalDecorators 设置为 true。

全部的源码都在 src 文件夹下。src/index.ts 是咱们项目的入口文件。这个文件包含了服务器的全部引导步骤：

import 'reflect-metadata';

import express from 'express';
import Container from 'typedi';
import UserController from './controllers/UserController';

const main = async () => {
  const app = express();

  const userController = Container.get(UserController);

  app.get('/users', (req, res) => userController.getAllUsers(req, res));

  app.listen(3000, () => {
    console.log('Server started');
  });
}

main().catch(err => {
  console.error(err);
});
复制代码

这段代码是一个只有一个端口的小型 Express 服务器。当你向 /users 路由发送一个 GET 请求时，它会返回一个用户列表。main 函数的核心是 Container.get 方法。注意咱们并无使用 new 关键字或者实例化对象。咱们只是调用 IoC 容器返回的一个 UserController 实例方法。而后绑定了路由和控制器方法。

咱们的应用程序是一个虚拟的 RESTful 服务器，但我不想让它没有一点意义。我添加了四个不一样的文件夹表明一个完备后端服务的基本部分。它们是 controllers、models、repositories 和 services。如今让我一个个介绍下它们：

Controllers 文件夹包含咱们的 REST 控制器。它们负责协调客户端和服务器之间的通讯。它们接收请求并返回响应。
Models 文件夹包含咱们的数据库实体类。咱们没有数据库链接，也不须要，但创建一个合适的项目结构对于学习该项目有很大的帮助。咱们假设它是真是的数据库实体并继续咱们的项目。
Services 文件夹包含咱们的服务。它们经过访问不一样的存储库，负责为 REST 控制器提供所需服务。
Repositories 文件夹包含咱们数据库链接类。咱们使用 Data Mapper 模式来执行数据库操做。该模式中咱们使用实体类来访问数据库并进行相关操做。

咱们不会把全部的东西都放到一个类中。请求和响应之间还有不少层级。这就是所谓的分层架构。经过类之间的依赖共享，咱们能够更容易地进行依赖注入。

import { Request, Response } from "express";
import { Service } from "typedi";
import UserService from "../services/UserService";

@Service()
class UserController {
  constructor(private readonly userService: UserService) { }
  async getAllUsers(_req: Request, res: Response) {
    const result = await this.userService.getAllUsers();
    return res.json(result);
  }
}

export default UserController;
复制代码

UserController 只有一个方法。getAllUsers 方法负责从用户服务中获取结果并进行传输。咱们给 UserController 添加类一个 Service 装饰器，由于咱们但愿这个类由 IoC 容器进行管理。在构造函数方法内部，咱们能够看到这个类须要一个 UserService 实例。一样，咱们不须要控制这个依赖关系。由于 TypeDI 容器为 UserService 建立了一个实例，当它生成 UserController 实例时，它将注入到 UserService 中。

import { Service } from "typedi";
import User from "../models/User";
import UserRepository from "../repositories/UserRepository";

@Service()
class UserService {
  constructor(private readonly userRepository: UserRepository) { }
  async getAllUsers(): Promise<User[]> {
    const result = await this.userRepository.getAllUsers();
    return result;
  }
}

export default UserService;
复制代码

UserService 和 UserController 很相似。咱们向类添加一个 Service 装饰器，并在构造函数方法中指定它们想要的依赖项。

import { Service } from "typedi";
import User from "../models/User";

@Service()
class UserRepository {
  private readonly users: User[] = [
    { name: 'Emily' },
    { name: 'John' },
    { name: 'Jane' },
  ];

  async getAllUsers(): Promise<User[]> {
    return this.users;
  }
}

export default UserRepository;
复制代码

UserRepository 是咱们的最后一步。咱们用 Service 来注解这个类，可是咱们没有任何依赖关系。由于没有数据库链接，因此我只是将已硬编码过的用户列表做为私有属性添加到类中。

结论

依赖注入是管理复杂对象初始化的有力工具。手动进行依赖注入总比什么都不作要好，可是使用 TypeDI 更简单可行。当你要开始作一个新项目时，你应该明确地考虑下依赖注入原则并给予适当尝试。

你能够在这个 GitHub 分支找到本文的代码。

你能够在 GitHub、LinkedIn 和 Twitter 找到我。

感谢阅读，祝你快乐。

引用

若是发现译文存在错误或其余须要改进的地方，欢迎到掘金翻译计划对译文进行修改并 PR，也可得到相应奖励积分。文章开头的 本文永久连接 即为本文在 GitHub 上的 MarkDown 连接。

掘金翻译计划是一个翻译优质互联网技术文章的社区，文章来源为掘金上的英文分享文章。内容覆盖 Android、iOS、前端、后端、区块链、产品、设计、人工智能等领域，想要查看更多优质译文请持续关注掘金翻译计划、官方微博、知乎专栏。