FoalTS项目实战：如何创建与运行脚本任务-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00524/article/details/148918104

FoalTS项目实战：如何创建与运行脚本任务

foal Full-featured Node.js framework, with no complexity. 🚀 Simple and easy to use, TypeScript-based and well-documented. 项目地址: https://gitcode.com/gh_mirrors/fo/foal

前言

在开发Web应用时，我们经常需要执行一些命令行任务，比如数据库初始化、数据迁移、批量处理等。FoalTS框架提供了完善的脚本管理机制，让开发者能够轻松创建和运行这些任务脚本。本文将详细介绍如何在FoalTS项目中创建、编写和运行脚本。

什么是脚本任务

脚本任务是指那些不需要通过HTTP接口触发，而是直接在命令行执行的程序逻辑。它们通常用于：

数据库初始化与数据填充
批量数据处理
定时任务执行
系统维护操作

FoalTS的脚本系统允许我们复用项目中的业务逻辑和数据库连接，使得这些任务能够与主应用无缝集成。

创建脚本

使用命令行工具创建

FoalTS提供了便捷的命令行工具来生成脚本模板：

foal g script display-users

执行上述命令后，框架会在src/scripts目录下创建一个名为display-users.ts的新文件，其中包含基本的脚本模板。

脚本文件结构

生成的脚本文件遵循以下结构：

必须导出一个名为main的函数
可以导入项目中的其他模块和服务
可以使用异步操作(async/await)

编写脚本逻辑

让我们以一个实际的例子来说明如何编写脚本。假设我们需要查询并显示所有用户信息：

// 引入第三方依赖
import { createService } from '@foal/core';
import { createConnection } from 'typeorm';

// 引入项目内部模块
import { User } from '../app/entities';
import { Logger } from '../app/services';

export async function main() {
  // 建立数据库连接
  const connection = await createConnection();
  try {
    // 查询所有用户
    const users = await connection.getRepository(User).find();
    
    // 使用日志服务记录结果
    const logger = createService(Logger);
    logger.log(users);
  } finally {
    // 确保关闭数据库连接
    connection.close();
  }
}

脚本编写最佳实践

资源管理：确保像数据库连接这样的资源在使用后正确关闭
错误处理：使用try-catch块处理可能的异常
依赖注入：通过createService获取服务实例
模块化：将复杂逻辑拆分为多个函数或服务

构建与运行脚本

构建脚本

在运行脚本前，需要先编译TypeScript代码：

npm run build

运行脚本

构建完成后，可以通过以下命令执行脚本：

foal run display-users

或者使用完整命令：

foal run-script display-users

开发模式

在开发过程中，可以开启自动编译模式：

npm run develop

这样每次保存脚本文件时都会自动重新编译，方便快速测试。

高级用法

传递参数

脚本可以接收命令行参数：

foal run my-script param1=value1 param2='[1,2,3]'

在脚本中可以通过argv对象访问这些参数：

import { argv } from '@foal/core';

export async function main() {
  console.log(argv.param1); // "value1"
  console.log(argv.param2); // [1,2,3]
}

脚本测试

由于脚本逻辑被封装在main函数中，我们可以轻松地编写单元测试：

import { main } from './display-users';
import { expect } from 'chai';

describe('display-users script', () => {
  it('should work correctly', async () => {
    // 可以mock依赖项
    const result = await main();
    expect(result).to...
  });
});