JimuReport报表导出文件名自动添加时间戳的实现方案

背景介绍

在报表系统的日常使用中，用户经常需要导出报表文件进行存档或分发。JimuReport作为一款优秀的报表工具，默认导出的文件名是固定的报表名称，这在实际使用中会带来一些问题：当用户多次导出同一报表时，浏览器会自动在文件名后添加(1)、(2)等序号，导致文件名混乱，不利于版本管理和文件归档。

问题分析

通过分析JimuReport的源码和运行机制，我们发现报表导出文件名主要由两个关键点决定：

1. 前端在调用导出接口时，会先请求/jmreport/show接口获取报表的基本信息，其中包含报表名称
2. 实际导出时，前端会根据获取到的报表名称作为默认文件名

技术实现方案

方案一：后端拦截修改（推荐）

在后端通过Spring的ResponseBodyAdvice拦截器对/jmreport/show接口的响应进行修改，自动为报表名称添加时间戳后缀：

@RestControllerAdvice
public class ReportFileNameAdvice implements ResponseBodyAdvice<Result> {

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        // 只拦截jmreport/show接口
        return Optional.ofNullable(RequestContextHolder.getRequestAttributes())
                .map(ServletRequestAttributes.class::cast)
                .map(ServletRequestAttributes::getRequest)
                .map(HttpServletRequest::getRequestURI)
                .map(uri -> uri.contains("jmreport/show"))
                .orElse(false);
    }

    @Override
    public Result<?> beforeBodyWrite(Result result, MethodParameter methodParameter, 
                                   MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass,
                                   ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        // 修改报表名称，添加时间戳
        if (result.getResult() instanceof JSONObject) {
            JSONObject json = (JSONObject) result.getResult();
            String reportName = json.getStr("name");
            if (StringUtils.isNotBlank(reportName)) {
                String timestamp = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd_HHmmss"));
                json.set("name", reportName + "_" + timestamp);
                result.setResult(json);
            }
        }
        return result;
    }
}

方案二：前端修改（备选）

如果无法修改后端代码，也可以在前端导出逻辑中修改文件名：

// 在导出方法中修改文件名
function exportReport() {
    // 获取报表信息
    getReportInfo().then(res => {
        const originalName = res.result.name;
        const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
        const exportName = `${originalName}_${timestamp}`;
        
        // 使用修改后的文件名进行导出
        exportWithName(exportName);
    });
}

实现效果

实现后，导出的报表文件名将自动包含导出时间，例如：

• 原文件名：销售报表.xlsx
• 修改后：销售报表_2024-08-21_151023.xlsx

注意事项

1. 时间戳格式可以根据实际需求调整，建议使用文件系统友好的格式（避免使用冒号等特殊字符）
2. 如果是集群部署，需要考虑各服务器时间同步问题
3. 对于高频导出的场景，可以在时间戳中增加毫秒级精度

最佳实践建议

1. 时间戳格式统一采用yyyy-MM-dd_HHmmss格式，既清晰又避免特殊字符
2. 对于需要国际化的系统，可以考虑使用UTC时间
3. 可以在系统配置中增加开关，允许用户自定义是否添加时间戳
4. 对于定时导出的报表，可以考虑在文件名中加入导出批次标识

通过这种实现方式，可以显著提升报表文件管理的便利性，特别是在需要长期存档或多人协作的场景下。