- exportDefs 为每种导出类型声明可传筛选字段与导出列模板,前端据此动态渲染提交表单 - /api/export-tasks/types 返回类型 + 字段 schema;提交时按 schema 过滤参数(cleanFilters) - 扩充订单/商品等导出列定义与格式化规则 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
123 lines
4.2 KiB
JavaScript
123 lines
4.2 KiB
JavaScript
'use strict';
|
||
|
||
const fs = require('fs');
|
||
const { Controller } = require('egg');
|
||
const { parsePagination, buildPageResult } = require('../lib/pagination');
|
||
const { EXPORT_TYPES, cleanFilters, listExportTypeSchema } = require('../utils/exportDefs');
|
||
|
||
/**
|
||
* @controller ExportTaskController 导出任务(全局任务池)
|
||
*
|
||
* 提交导出(指定类型 + 筛选)→ 立即返回任务ID;定时任务逐个处理并生成 XLSX;
|
||
* 前端轮询进度,完成后触发浏览器下载(文件按 年/月/日 分目录存储)。
|
||
* 所有任务按主体隔离(principal_id 由 principalCheck 中间件写入 ctx.state.principalId)。
|
||
*/
|
||
class ExportTaskController extends Controller {
|
||
/**
|
||
* @summary 导出类型选项
|
||
* @description 返回全部导出类型及其可传筛选字段(前端据此动态渲染提交表单)
|
||
* @router get /api/export-tasks/types
|
||
* @apikey
|
||
* @response 200 baseResponse success
|
||
*/
|
||
async types() {
|
||
const { ctx } = this;
|
||
ctx.body = { code: 0, message: 'success', data: listExportTypeSchema() };
|
||
}
|
||
|
||
/**
|
||
* @summary 提交导出任务
|
||
* @description 仅落库一条「待处理」任务并立即返回任务ID,实际导出由定时任务异步处理
|
||
* @router post /api/export-tasks
|
||
* @apikey
|
||
* @request body createExportTaskRequest *body
|
||
* @response 200 baseResponse success
|
||
*/
|
||
async submit() {
|
||
const { ctx } = this;
|
||
const { type, filters } = ctx.request.body;
|
||
if (!EXPORT_TYPES[type]) {
|
||
ctx.status = 400;
|
||
ctx.body = { code: 400, message: '不支持的导出类型' };
|
||
return;
|
||
}
|
||
const clean = cleanFilters(type, filters);
|
||
const task = await ctx.service.exportTask.submit(type, clean, ctx.state.principalId, ctx.userId);
|
||
ctx.body = { code: 0, message: 'success', data: { id: task.id, type, status: task.status } };
|
||
}
|
||
|
||
/**
|
||
* @summary 导出任务列表(按主体隔离)
|
||
* @router get /api/export-tasks
|
||
* @apikey
|
||
* @request query integer page 页码
|
||
* @request query integer pageSize 每页条数
|
||
* @request query string type 按类型筛选
|
||
* @request query integer status 按状态筛选(0待处理 1处理中 2已完成 3失败)
|
||
* @response 200 exportTaskListResponse success
|
||
*/
|
||
async index() {
|
||
const { ctx } = this;
|
||
const { page, pageSize } = parsePagination(ctx.query);
|
||
const { list, total } = await ctx.service.exportTask.list(ctx.state.principalId, {
|
||
page,
|
||
pageSize,
|
||
type: ctx.query.type,
|
||
status: ctx.query.status,
|
||
});
|
||
ctx.body = { code: 0, message: 'success', data: buildPageResult(list, total, { page, pageSize }) };
|
||
}
|
||
|
||
/**
|
||
* @summary 导出任务进度
|
||
* @router get /api/export-tasks/:id
|
||
* @apikey
|
||
* @response 200 baseResponse success
|
||
*/
|
||
async progress() {
|
||
const { ctx } = this;
|
||
const task = await ctx.service.exportTask.progress(Number(ctx.params.id));
|
||
if (!task) {
|
||
ctx.status = 404;
|
||
ctx.body = { code: 404, message: '任务不存在' };
|
||
return;
|
||
}
|
||
ctx.body = { code: 0, message: 'success', data: task };
|
||
}
|
||
|
||
/**
|
||
* @summary 下载导出文件
|
||
* @description 仅「已完成」任务可下载;文件按 年/月/日 分目录存储,流式为 xlsx
|
||
* @router get /api/export-tasks/:id/download
|
||
* @apikey
|
||
* @response 200 baseResponse success
|
||
*/
|
||
async download() {
|
||
const { ctx } = this;
|
||
const task = await ctx.model.ExportTask.findByPk(ctx.params.id);
|
||
if (!task) {
|
||
ctx.status = 404;
|
||
ctx.body = { code: 404, message: '任务不存在' };
|
||
return;
|
||
}
|
||
if (task.status !== 2) {
|
||
ctx.status = 400;
|
||
ctx.body = { code: 400, message: '任务尚未完成,无法下载' };
|
||
return;
|
||
}
|
||
const abs = await ctx.service.exportTask.download(task);
|
||
if (!abs) {
|
||
ctx.status = 404;
|
||
ctx.body = { code: 404, message: '导出文件不存在' };
|
||
return;
|
||
}
|
||
const fallback = `export_${task.id}.xlsx`;
|
||
const name = task.file_name || fallback;
|
||
ctx.set('Content-Type', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
|
||
ctx.set('Content-Disposition', `attachment; filename="${fallback}"; filename*=UTF-8''${encodeURIComponent(name)}`);
|
||
ctx.body = fs.createReadStream(abs);
|
||
}
|
||
}
|
||
|
||
module.exports = ExportTaskController;
|