JavaScript 中的依赖注入

发表于 1年以前  | 总阅读数:343 次

依赖注入 DI (Dependency Injection) 是编程领域中一个非常常见的设计模式,它指的是将应用程序所需的依赖关系(如服务或其他组件)通过构造函数参数或属性自动注入的过程。这样做的好处是可以减少组件之间的耦合,更容易测试和维护。

我们先举个简单的例子,我们有两个简单的 A 类和 B 类,在 B 类中依赖了 A 类,我们在 B 类中对它进行实例化,并调用它的方法:

class A {
  constructor(name) {
    this.name = name;
  }
  log() {
    console.log("name: ", this.name);
  }
}

class B {
  a = new A("ConardLi");

  start() {
    this.a.log();
  }
}

const b = new B();
b.start();

但是这种写法是非常不灵活的, A 类作为一个依赖项,它的初始化的逻辑被硬编码到了 B 类中,如果我们想添加或修改其他的依赖项,必须要不断修改 B 类。

借助依赖注入的设计思想,我们可以将代码改写成下面这样:

class A {
  constructor(name) {
    this.name = name;
  }
  log() {
    console.log("name: ", this.name);
  }
}

class B {
  constructor(a) {
    this.a = a;
  }

  start() {
    this.a.log();
  }
}

const a = new A();
const b = new B(a);
b.start();

代码只做了很小的改动,最核心的变化就是我们将 A 类和 B 的实现完全分离开来了,他们无需再关心依赖的实例化,因为我们将依赖的注入提到的最外侧。

这也就是为什么我们常常将依赖注入和控制反转 IoC (Inversion of Control) 放在一起讲,控制反转即将创建对象的控制权进行转移,以前创建对象的主动权和创建时机是由自己把控的,而现在这种权力转移到第三方。

可能在这样简单的代码中我们还看不出来什么好处,但是在大型的代码库中,这种设计可以显着帮助我们减少样板代码,创建和连接依赖项的工作由一段程序统一处理,我们无需担心创建特定类所需的类的实例。

JavaScript 的各大框架中,依赖注入的设计模式也发挥着非常重要的作用,在 Angular、Vue.js、Next.js 等框架中都用到了依赖注入的设计模式。

JavaScript 框架中的依赖注入

Angular

Angular 中大量应用了依赖注入的设计思想。Angular 使用依赖注入来管理应用的各个部分之间的依赖关系,以及如何将这些依赖关系注入到应用中,例如你可以使用依赖注入来注入服务、组件、指令、管道等。

比如我们现在有个日志打点的工具类,我们可以使用 Injectable 将其指定为可注入对象。

// logger.service.ts
import { Injectable } from '@angular/core';

@Injectable({providedIn: 'root'})
export class Logger {
  writeCount(count: number) {
    console.warn(count);
  }
}

然后在组件中使用时,无需进行实例化,直接在 constructor 的参数中就可以取出自动注入好的对象:

// hello-world-di.component.ts
import { Component } from '@angular/core';
import { Logger } from '../logger.service';

@Component({
  selector: 'hello-world-di',
  templateUrl: './hello-world-di.component.html'
})
export class HelloWorldDependencyInjectionComponent  {
  count = 0;

  constructor(private logger: Logger) { }

  onLogMe() {
    this.logger.writeCount(this.count);
    this.count++;
  }
}

Vue.js

Vue.js 中,provideinject 其实也使用了依赖注入的设计模式。

  • provide 属性可以用来在父组件中提供一个值,这个值可以在父组件的所有子组件中注入。
export default {
  name: 'Parent',
  provide() {
    return {
      user: this.user
    };
  },
  data() {
    return {
      user: {
        name: 'John',
        age: 30
      }
    };
  }
};
  • inject 属性可以用来在子组件中注入父组件提供的值。
// 子组件
export default {
  name: 'Child',
  inject: ['user'],
  computed: {
    userName() {
      return this.user.name;
    }
  }
};

React.js

React.js 中,并没有直接使用依赖注入的地方,不过我们依然可以借助一些第三方库来实现, 比如我们可以通过 InversifyJS 提供的 injectable decorator 标记 class 是可被注入的。

import { injectable } from "inversify";

export interface IProvider<T> {
  provide(): T;
}

@injectable()
export class NameProvider implements IProvider<string> {
  provide() {
    return "World";
  }
}

在组件中,我们可以直接调用注入的 provide 方法,而组件内部不用关心它的实现。

import * as React from "react";
import { IProvider } from "./providers";

export class Hello extends React.Component {
  private readonly nameProvider: IProvider<string>;

  render() {
    return <h1>Hello {this.nameProvider.provide()}!</h1>;
  }
}

手动实现依赖注入

前面我们提到的 InversifyJS 实际上就是一个专门用来实现依赖注入的工具库,它主要就由 injectableinject 等几个装饰器组成的,这么神奇的功能究竟是咋实现的呢,下面我们手动来实现一下。

首先我们来明确一个需求场景,假设我们要使用 Koa 框架开发一个简单的 Node.js 服务。

Koa 中,Controller 用来处理用户请求和响应,它负责接收用户的请求,然后调用相应的服务或业务逻辑进行处理,最后将处理结果返回给用户。Service 用来封装业务逻辑和数据处理,它负责实现应用程序的核心功能。

Service 通常会被多个 Controller 所调用,它们之间是松散耦合的关系,我们希望用两装饰器来实现 Service 的自动依赖注入:

export default class UserController extends Controller {
  @Inject
  user: UserService;

  @UseService
  async list(ctx: ThriftContext): Promise<void> {
    const user = await this.user.findAll({ id: 1000 });
    console.log(1, user);
  }
}

在实现过程中我们可能会用到两个非常重要的 API,Metadata Reflection API 以及 Decorator API,我们先分别来回顾一下它们的基础知识。

Decorator API

装饰器模式是一种经典的设计模式,其目的是在不修改被装饰者(如某个函数、某个类等)源码的前提下,为被装饰者增加 / 移除某些功能。一些现代编程语言在语法层面提供了对装饰器模式的支持,并且各语言中的现代框架都大量应用了装饰器。主要用处分为两大类:

  • 收集用户定义的类/函数的信息(例如,用于生成路由表,用于实现依赖注入,等等)
  • 对用户定义的类/函数进行增强,增加额外功能

我们目前用的比较多的装饰器就是 TypeScript 的实验性装饰器,以及 ECMAScript 中还处于 legacy 阶段的 Decorator API,下面是它的用法:

装饰类的时候,装饰器方法一般会接收一个目标类作为参数,下面是一个示例,给类增加静态属性、原型方法:

const addField = target => {
  target.age = 17;
  target.prototype.speak = function () {
    console.log('xxx');
  };
};

@addField
class People {

}

console.log(People.age);
const a = new People();
a.speak();

类属性装饰器可以用在类的属性、方法、get/set 函数中,一般会接收三个参数:

  • target:被修饰的类
  • name:类成员的名字
  • descriptor:属性描述符,对象会将这个参数传给 Object.defineProperty

下面是一个示例,可以修改类属性为只读:

function readonly(target, name, descriptor) {
  descriptor.writable = false;
  return descriptor;
}

class Person {
    @readonly name = 'person'
}

const person = new Person();
person.name = 'tom'; 

Metadata Reflection API

ReflectJavaScript 中的一个内置对象,它提供了一组用于操作对象的方法。它与其他内置对象类似,但是它的目的是为了提供一组用于操作对象的通用方法。

Reflect MetadataES7 的一个提案,它主要用来在声明的时候添加和读取元数据。

Reflect.getMetadata('design:type', target, key) 可以用来获取类 target 中属性 key 的类型信息:

function Inject() {
  return function (target: any, key: string, descriptor: PropertyDescriptor) {
    const type = Reflect.getMetadata('design:type', target, key);
    console.log(type); // [class Service]
    return descriptor;
  };
}

export default class WebsiteController extends Controller {
  @Inject()
  service: Service

  // ... 
}

Reflect.getMetadata('design:paramtypes', target, key) 可以用来获取类 target 中属性 key 的函数参数类型;

Reflect.getMetadata('design:returntype', target, key) 可以用来获取类 target 中属性 key 的函数返回值类型。

除能获取固定的类型信息之外,也可以自定义 MetaData,并在合适的时机获取它的值,示例如下:

function classDecorator(): ClassDecorator {
  return target => {
    // 在类上定义元数据,key 为 `classMetaData`,value 为 `a`
    Reflect.defineMetadata('classMetaData', 'a', target);
  };
}

@classDecorator()
class SomeClass {

}

Reflect.getMetadata('classMetaData', SomeClass); // 'a'

好了,有了这些知识,我们就可以手动来实现一个依赖注入装饰器了。

实现依赖注入

再明确一下我们的需求:在不同服务的 Controller 中共用 Service,使用 Service 时可以自动获取已注入的 Service 实例,同时 Service 里可以获取到请求的 Context 信息。

首先我们来实现,Inject 装饰器:

  • Controller 中注册需要用到哪些 Service
  • 通过 design:type 获取 Service 的类型信息
  • 通过自定义 metadata 存储 Controller 中用到哪些 Service
function Inject(target: any, key: string) {
  console.log(`注册 Controller: ${target} Service: ${key}`);
  // 获取当前 Service 的类型
  const serviceClass = Reflect.getMetadata('design:type', target, key);
  // 获取当前 Controller 已经注册过的 Service List
  const serviceList = Reflect.getMetadata(META_KEY_CONTROLLER_SERVICE, target) || [];
  // 将当前 Service 进行追加
  Reflect.defineMetadata(
    META_KEY_CONTROLLER_SERVICE,
    [...serviceList, { serviceClass, serviceName: key }],
    target
  );
}

然后是 UseService 装饰器:

  • 在请求过来时取出 metadata 中存储的 ControllerService 对应信息
  • Service 实例化,并将 Context 传入 Service
function Inject(target: any, key: string) {
  console.log(`注册 Controller: ${target} Service: ${key}`);
  // 获取当前 Service 的类型
  const serviceClass = Reflect.getMetadata('design:type', target, key);
  // 获取当前 Controller 已经注册过的 Service List
  const serviceList = Reflect.getMetadata(META_KEY_CONTROLLER_SERVICE, target) || [];
  // 将当前 Service 进行追加
  Reflect.defineMetadata(
    META_KEY_CONTROLLER_SERVICE,
    [...serviceList, { serviceClass, serviceName: key }],
    target
  );
}

好了,接下来就可以愉快的使用了~

export default class UserController extends Controller {
  @Inject
  user: UserService;

  @UseService
  async list(ctx: ThriftContext): Promise<void> {
    const user = await this.user.findAll();
    console.log(1, user);
  }
}

本文由哈喽比特于1年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/bZhumjAQLBETbxrhaO5pCw

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:6月以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:6月以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:6月以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:6月以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:6月以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:6月以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:7月以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:6月以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:6月以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:6月以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:6月以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:6月以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:6月以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:6月以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:6月以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:7月以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:7月以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:7月以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:6月以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:6月以前  |  398次阅读  |  详细内容 »
 相关文章
Java 中验证时间格式的 4 种方法 1年以前  |  3216次阅读
Java经典面试题答案解析(1-80题) 3年以前  |  2496次阅读
CentOS 配置java应用开机自动启动 3年以前  |  2378次阅读
IDEA依赖冲突分析神器—Maven Helper 3年以前  |  2367次阅读
SpringBoot 控制并发登录的人数教程 4年以前  |  2087次阅读
 目录