LoopBack框架本地运行Cron任务及类注入调用方法咨询

1. 在LoopBack框架中本地运行Cron任务 #

• 安装依赖

  npm install node-cron
  

• 将LiveUpdate定义为可注入服务
  给类添加@injectable()装饰器，让LoopBack可以管理它的实例：

  import {injectable} from '@loopback/core';
  import {CronController} from "../CronController";
  import cron from "node-cron";
  
  @injectable()
  export class LiveUpdate {
    constructor(protected cronController: CronController) {} 
  
    async start(){
      this.cronJob();
    }
  
    private async cronJob(){
      cron.schedule("59 23 * * *", async () => {
        // 在这里调用业务方法，例如 this.cronController.executeTask();
        console.log('Cron任务执行中');
      });
    }
  }
  

• 启动Cron任务
  有两种常用方式触发任务启动：
  • 方式一：在应用启动脚本中手动启动
    修改application.ts的main函数：

    import {ApplicationConfig, MyApplication} from './application';
    import {LiveUpdate} from './path/to/live-update';
    
    export async function main(options: ApplicationConfig = {}) {
      const app = new MyApplication(options);
      await app.boot();
      await app.start();
    
      // 获取LiveUpdate实例并启动任务
      const liveUpdate = await app.get(LiveUpdate);
      await liveUpdate.start();
    
      const url = app.restServer.url;
      console.log(`Server is running at ${url}`);
      return app;
    }
    

  • 方式二：用生命周期观察者自动启动
    创建观察者类监听应用启动事件：

    import {lifeCycleObserver, LifeCycleObserver, inject} from '@loopback/core';
    import {LiveUpdate} from './path/to/live-update';
    
    @lifeCycleObserver('start')
    export class CronStartupObserver implements LifeCycleObserver {
      constructor(@inject(LiveUpdate) private liveUpdate: LiveUpdate) {}
    
      async start() {
        await this.liveUpdate.start();
        console.log('Cron任务已自动启动');
      }
    }
    

    然后在application.ts中注册观察者：

    this.lifeCycleObserver(CronStartupObserver);
    

2. 在MyService中注入LiveUpdate并调用start方法 #

• 确保LiveUpdate已添加@injectable()装饰器（参考上面的代码）
• 在MyService中通过构造函数注入LiveUpdate

  import {injectable, inject} from '@loopback/core';
  import {LiveUpdate} from './path/to/live-update';
  
  @injectable()
  export class MyService {
    // 注入LiveUpdate实例
    constructor(@inject(LiveUpdate) private liveUpdate: LiveUpdate) {}
  
    // 在需要的业务方法中调用start
    async triggerCronStart() {
      await this.liveUpdate.start();
      console.log('通过MyService启动Cron任务');
    }
  }
  

• 调用MyService的方法
  比如在控制器中使用MyService：

  import {get, inject} from '@loopback/rest';
  import {MyService} from './path/to/my-service';
  
  export class CronController {
    constructor(@inject(MyService) private myService: MyService) {}
  
    @get('/init-cron')
    async initCronTask() {
      await this.myService.triggerCronStart();
      return {status: 'success', message: 'Cron任务已启动'};
    }
  }
  

内容的提问来源于stack exchange，提问作者Naveen Kumar