org.shoulder.batch.service.ExportService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shoulder-batch Show documentation

Shoulder 扩展-批处理模块，提供批量数据导入、导出、异步校验、导入历史记录管理等能力。

There is a newer version: 1.0.0-M4

package org.shoulder.batch.service;

import org.shoulder.batch.enums.ProcessStatusEnum;
import org.shoulder.core.context.AppInfo;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URLEncoder;
import java.util.List;
import java.util.Map;
import java.util.function.Supplier;

/**
 * 导出业务
 *
 * @author lym
 */
public interface ExportService {

    /**
     * 导出数据列表
     *
     * @param outputStream  输出流
     * @param exportType    导出方式：CSV / EXCEL
     * @param exportData    要导出的数据（支持分片，渐进式导出，避免内存过大）
     * @param templateId 导出模板标识，如 user_batch_add、user_batch_update
     * @throws IOException io异常
     */
    void export(OutputStream outputStream, String exportType, List>>> exportData,
                String templateId)
        throws IOException;

    /**
     * 导出 批处理详情列表
     *
     * @param outputStream  输出流
     * @param exportType    导出方式，如 CSV、EXCEL
     * @param templateId 导出数据标识
     * @param taskId        记录标识
     * @param resultTypes   执行结果
     * @throws IOException io异常
     */
    void exportBatchDetail(OutputStream outputStream, String exportType, String templateId,
                           String taskId, List resultTypes) throws IOException;


    /**
     * 给导出的文件命名
     *
     * @param response http 响应
     * @param fileName 导出文件名
     * @deprecated 不要在这里做
     */
    default void setExportFileName(HttpServletResponse response, String fileName) {
        response.setHeader("Content-Disposition", "attachment; filename=" +
            URLEncoder.encode(fileName, AppInfo.charset()));
        response.setHeader("Content-Type", "application/octet-stream");
    }

}