比nestjs更优雅的ts控制反转策略-依赖查找

news2025/1/20 18:30:43

一、Cabloy5.0内测预告

Cabloy5.0采用TS对整个全栈框架进行了脱胎换骨般的大重构，并且提供了更加优雅的ts控制反转策略，让我们的业务开发更加快捷顺畅

1. 新旧技术栈对比：

	后端	前端
旧版	js、egg2.0、mysql	js、vue2、framework7
新版	ts、egg3.0、多数据库兼容（支持mysql、postgresql）	ts、vue3、quasar

2. 框架开发两大趋势

TS化：这是显而易见的趋势，不必赘言
ESM化：从目前趋势看，前端框架已经全链路ESM化了，但是，大多数后端框架仍然是Commonjs。即便是egg3.0也仍然是Commonjs。由于egg的定位仍然是元框架，CabloyJS5.0在egg基础上仍然开发出了全量ESM化的业务模块化系统（在Commonjs之上进行ESM化的具体机制是什么，另有文章阐述）

二、比nestjs更优雅的ts控制反转策略

基于TS的后端框架一般都会提供依赖容器，实现控制反转。控制反转有两种策略：依赖注入和依赖查找。CabloyJS5.0同时支持依赖注入和依赖查找，并且通过模块范围的辅助，让依赖查找的代码更加简洁高效，下面挑几个特性举例说明:

Service服务
Config配置
多语言
错误异常

三、Service服务

1. 创建一个Service

在CabloyJS中，local bean相当于nestjs中service的概念，下面创建一个local bean

import { BeanBase, Local } from '@cabloy/core';
import { ScopeModule } from '../resource/this.js';

@Local()
export class LocalHome extends BeanBase<ScopeModule> {
  async echo({ user: _user }) {
    return `Hello World!`;
  }
}

通过@Local声明LocalHome是一个local bean
LocalHome继承自基类BeanBase

2. Service的依赖注入

接下来，在Controller中采用依赖注入的方式来使用LocalHome

import { BeanBase, Controller, Use } from '@cabloy/core';
import { ScopeModule } from '../resource/this.js';
import { LocalHome } from '../local/home.js';

@Controller()
export class ControllerHome extends BeanBase<ScopeModule> {
  @Use()
  home: LocalHome;

  async echo() {
    const res = await this.home.echo({
      user: this.ctx.state.user.op,
    });
    this.ctx.success(res);
  }
}

使用@Use注入LocalHome

3. Service的依赖查找

接下来，在Controller中采用依赖查找的方式来使用LocalHome

import { BeanBase, Controller } from '@cabloy/core';
import { ScopeModule } from '../resource/this.js';

@Controller()
export class ControllerHome extends BeanBase<ScopeModule> {
  async echo() {
    const res = await this.scope.local.home.echo({
      user: this.ctx.state.user.op,
    });
    this.ctx.success(res);
  }
}

不需要导入LocalHome，直接在代码中使用this.scope.local来访问容器中的local bean实例

看一下动画演示，提供了完整的类型智能提示：

在这里插入图片描述

四、Config配置

1. 定义Config

可以为业务模块单独定义一些Config配置，如下：

import { CabloyApplication } from '@cabloy/core';

export const config = (_app: CabloyApplication) => {
  return {
+   prompt: 'hello world',
  };
};

2. 使用Config

可以在LocalHome中直接使用刚才定义的config

import { BeanBase, Local } from '@cabloy/core';
import { ScopeModule } from '../resource/this.js';

@Local()
export class LocalHome extends BeanBase<ScopeModule> {
  async echo({ user: _user }) {
+   return this.scope.config.prompt;
-   return `Hello World!`;
  }
}

不需要导入任何类型，直接在代码中使用this.scope.config来访问当前业务模块中的config配置

看一下动画演示，提供了完整的类型智能提示：

在这里插入图片描述

五、多语言

1. 定义语言资源

可以为业务模块定义语言资源，比如，这里分别定义英文和中文两种语言资源

英文

export default {
  HelloWorld: 'Hello World',
};

中文

export default {
  HelloWorld: '您好世界',
};

2. 使用语言资源

可以在LocalHome中直接使用刚才定义的语言资源

import { BeanBase, Local } from '@cabloy/core';
import { ScopeModule } from '../resource/this.js';

@Local()
export class LocalHome extends BeanBase<ScopeModule> {
  async action({ user: _user }) {
+   // 自动判断当前语言
+   const message = this.scope.locale.HelloWorld();
+   // 强制使用英文资源
+   const message1 = this.scope.locale.HelloWorld.locale('en-us');
+   // 强制使用中文资源
+   const message2 = this.scope.locale.HelloWorld.locale('zh-cn');
+   return `${message}:${message1}:${message2}`;
-   return this.scope.config.prompt;
  }
}

不需要导入任何类型，直接在代码中使用this.scope.locale来访问当前业务模块中的语言资源

看一下动画演示，提供了完整的类型智能提示：

在这里插入图片描述

六、错误异常

1. 定义错误码

可以为业务模块定义错误码

export enum Errors {
+ Error001 = 1001,
}

这里定义了一个错误枚举类型Error001，对应的错误码是1001

2. 定义错误码对应的语言资源

可以为错误码定义语言资源，比如，这里分别定义英文和中文两种语言资源

英文

export default {
+ Error001: 'This is a test',
  HelloWorld: 'Hello World',
};

中文

export default {
+ Error001: '这是一个错误',
  HelloWorld: 'Hello World',
};

3. 抛出错误异常

可以在LocalHome中直接使用刚才定义的错误枚举值，并抛出异常

import { ScopeModule } from '../resource/this.js';

@Local()
export class LocalHome extends BeanBase<ScopeModule> {
  async action({ user: _user }) {
+   // 直接抛出异常
+   this.scope.error.Error001.throw();
-   return this.scope.config.prompt;
  }
}