前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
社区首页 >专栏 >JavaScript 中的依赖注入

JavaScript 中的依赖注入

作者头像
ConardLi
发布于 2023-01-09 11:23:17
发布于 2023-01-09 11:23:17
2K00
代码可运行
举报
文章被收录于专栏:code秘密花园code秘密花园
运行总次数:0
代码可运行

大家好,我是 ConardLi

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

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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 类。

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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 将其指定为可注入对象。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
// logger.service.ts
import { Injectable } from '@angular/core';

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

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
// 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 属性可以用来在父组件中提供一个值,这个值可以在父组件的所有子组件中注入。
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
export default {
  name: 'Parent',
  provide() {
    return {
      user: this.user
    };
  },
  data() {
    return {
      user: {
        name: 'John',
        age: 30
      }
    };
  }
};

  • inject 属性可以用来在子组件中注入父组件提供的值。
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
// 子组件
export default {
  name: 'Child',
  inject: ['user'],
  computed: {
    userName() {
      return this.user.name;
    }
  }
};

React.js

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
import { injectable } from "inversify";

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

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

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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 的自动依赖注入:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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);
  }
}

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

Decorator API

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

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

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

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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 的类型信息:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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,并在合适的时机获取它的值,示例如下:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
function UseService(target: any, name: string, descriptor: PropertyDescriptor) {
  const value = descriptor.value;
  descriptor.value = async function (...args: any) {
    // 获取当前请求的 Context
    const [ctx] = args;
    // 取出当前 Controller 已绑定的 Service
    const serviceList = Reflect.getMetadata(META_KEY_CONTROLLER_SERVICE, target) || [];
    console.log(serviceList);

    for (let i = 0; i < serviceList.length; i++) {
      const { serviceClass, serviceName } = serviceList[i];
      // 实例化 Service 并绑定 Context
      const service = new serviceClass(ctx);
      Reflect.set(service, 'ctx', ctx);
      // 给当前 Controller 挂载 Service 实例
      Reflect.set(target, serviceName, service);
    }
    return await Promise.resolve(value.apply(this, args));
  };
  return descriptor;
}

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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);
  }
}

最后

如果这篇文章帮助到了你,欢迎点赞和关注。

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2022-12-19,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 code秘密花园 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
ARouter源码解析(一)前言ARouter 源码番外
之前对 ActivityRouter 的源码做了一次分析,相信大家对路由框架已经有一个大概的理解了。
俞其荣
2019/01/03
8150
Android项目解耦--路由框架ARouter源码解析
上一篇文章Android项目解耦--路由框架ARouter的使用讲述了ARouter在项目中的使用,这边文章主要对ARouter的源码进行学习和分析。
静默加载
2020/05/29
1.1K0
深入探究 ARouter
我们只关注重点,LogisticsCenter.init(mContext, executor);,executor是一个线程池。
大发明家
2022/01/15
8110
编译时注解(三)Arouter源码讲解
项目中我们有时需要跨模块startActivity,但是这样需要配置menifest,不方便。这时就需要阿里的一个路由框架Arouter Arouter的使用就不再多说了。这篇文章主要讲解他的源码
提莫队长
2019/02/21
6740
一图抵千言《ARouter简明扼要原理分析》
这段代码最终会利用当前类名和规则,拼接成KotlinTestActivity$$ARouter$$Autowired的全类名,然后利用反射传进对象。然后执行inject(this); 然后里面会初始化传输字段序列化服务,然后强转target,开始赋值数据
g小志
2022/03/29
7560
一图抵千言《ARouter简明扼要原理分析》
“终于懂了” 系列:组件化框架 ARouter 完全解析(一) 原理详解
在我之前的组件化文章《“终于懂了” 系列:Android组件化,全面掌握!》中,提到为了实现组件化要解决的几个问题点,其中 页面跳转、组件间通信 的问题是使用了 ARouter 这个框架来解决的。ARouter确实是专门用于做组件化改造,官方是这么介绍的:
胡飞洋
2022/11/08
3.2K0
“终于懂了” 系列:组件化框架 ARouter 完全解析(一) 原理详解
ARouter源码解析(四)
之前对 arouter-api 做了整个流程的分析,今天来看看 arouter-compiler 。
俞其荣
2019/02/15
7680
【Android 组件化】使用 ARoute 实现组件化 ( ARoute 初始化 及 界面跳转 源码分析 )
引入了 ARoute 的应用 , 一般会在主应用的 Application 中的 onCreate 方法中初始化 ARoute ;
韩曙亮
2023/03/29
1.1K0
【Android 组件化】使用 ARoute 实现组件化 ( ARoute 初始化 及 界面跳转 源码分析 )
“终于懂了” 系列:组件化框架 ARouter 完全解析(二)APT技术
在上一篇《“终于懂了” 系列:组件化框架 ARouter 完全解析(一) 原理详解》中,详细介绍了ARouter的核心原理。其中提到了“帮助类”的概念,也就是在运行时生成 用于帮助填充WareHouse路由元信息的类,这里就涉及到了APT技术。那么本篇就对这一技术点进行介绍,并详细分析ARouter中是如何使用APT来生成帮助类的。
胡飞洋
2022/11/08
1.7K0
“终于懂了” 系列:组件化框架 ARouter 完全解析(二)APT技术
arouter实现activity跳转原理
1. 在对应的activity上加上注解,通过apt技术来自动生成代码,代码能将 activity对应路径 和 class 添加到路由表中;
全栈程序员站长
2022/08/31
5070
ARouter源码解析(二)前言拦截器解析
前几天对 ARouter 的页面跳转源码进行了分析,趁着今天有空,就讲讲 ARouter 里面的拦截器吧。
俞其荣
2019/01/03
6960
阿里ARouter拦截器使用及源码解析(二)
关于ARouter基本跳转的用法以及源码解析在上篇文章阿里阿里ARouter使用及源码解析(一)已经有过分析,有不清楚的同学可以去看看。本篇文章主要是关于ARouter进阶用法拦截器的使用和分析。
用户3106371
2018/09/12
2.8K0
阿里ARouter拦截器使用及源码解析(二)
Android项目解耦--路由框架ARouter的使用
随着业务量的增长,客户端必然随之越来越业务和功能模块耦合越来越生,开发人员代码维护成本越来越高。 App一般都会走向组件化、插件化的道路,而组件化、插件化的前提就是解耦,那么我们首先要做的就是解耦页面之间的依赖关系。
静默加载
2020/05/29
2.2K0
ARouter路由记录
网上关于 ARouter 源码解析的文章已经不少了,这里简单总结一下自己的理解,方便以后查看和复习
木子杂志
2020/08/04
5610
ARouter路由记录
Android技术栈(二)组件化改造
国内都比较流行开发超级APP,也就是我全都要,什么功能都想加进去,这导致业务逻辑变得越来越复杂.
Android技术干货分享
2019/03/27
5290
Android技术栈(二)组件化改造
ARouter 使用教程
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/gdutxiaoxu/article/details/81036719
程序员徐公
2018/09/17
2K0
ARouter 使用教程
使用ARouter进行Android模块化开发
关于为什么要进行Android模块化开发,网上也已经讲烂了,不过归结起来,大体是可以总结为:在App开发的初期,代码量不大,业务量比较少,一个App作为一个单独的模块进行开发,往往问题不大。但随着业务的增多,代码变的越来越复杂,每个模块之间的代码耦合变得越来越严重,结构越来越臃肿,修改一处代码要编译整个工程,导致非常耗时,这时候最好的办法就是进行模块化拆分。
Android技术干货分享
2019/07/10
1.5K0
Android-ARouter
我们上一篇文章是自定义Router,没有看过的小伙伴自定义Router,但今天我们来看一看世面上主流的路由框架-由阿里推出的ARouter.。 参考资料: https://mp.weixin.qq.com/s/hUKEOp3qa4C53F6ZmPuXjQ https://mp.weixin.qq.com/s/UljVdlGQuwooVEJz_rctjw
android_薛之涛
2019/04/17
1.4K0
Android-ARouter
ARouter三问—腾讯真题
为了项目解耦,实现模块的独立化,出现了组件化,而组件化中用作模块间通信的重要使者就是ARouter,今天就一起来看看这个神奇的工具。
码上积木
2020/10/29
1.4K0
【Android 组件化】路由组件 ( 生成 Root 类记录模块中的路由表 )
注解处理器 为每个 Module 模块生成一个路由表 , 该模块下凡是被 @Route 标注的路由节点都在该路由表中维护 ;
韩曙亮
2023/03/29
2.6K0
【Android 组件化】路由组件 ( 生成 Root 类记录模块中的路由表 )
推荐阅读
相关推荐
ARouter源码解析(一)前言ARouter 源码番外
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
查看详情【社区公告】 技术创作特训营有奖征文