springboot项目中导出接口实现

最新推荐文章于 2025-08-21 17:00:18 发布

原创最新推荐文章于 2025-08-21 17:00:18 发布 · 1.4k 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#spring boot #java #spring

本文介绍了一个SpringBoot项目中的Excel导出功能实现方法。通过自定义的状态枚举类、结果对象封装及实用工具类，实现了对数据进行限制检查、导出到客户端的功能。文章详细展示了如何设置响应头以便正确下载Excel文件。

springboot项目中导出接口实现

返回结果对象

/**
 * @Description 返回结果对象封装
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ResultInfo<T> implements Serializable {
    private static final long serialVersionUID = -3986667778876817461L;
    private String code;
    private String msg;
    private T data;

    public ResultInfo(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

状态枚举类

/**
 * 状态枚举类
 */
public enum ResponseStatusEnum {
    SUCCESS("000000", "成功"),
    FAILED("000001", "失败");
    private String code;
    private String msg;
    ResponseStatusEnum(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public String getCode() {
        return code;
    }
    public String getMsg() {
        return msg;
    }
}

导出结果工具类封装

import com.cmbchina.riskcontroll.controller.RiskController;
import com.cmbchina.riskcontroll.statusenum.ResponseStatusEnum;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletResponse;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.nio.charset.StandardCharsets;

/**
 * 封装导出结果类
 */
@Component
public class ExportUtils {

    private static final Logger logger = LoggerFactory.getLogger(RiskController.class);

    //创建HSSFWorkbook并相应到客户端
    public static void createHSSFWorkbook(FileInfo fileInfo,HttpServletResponse response){
        //创建HSSFWorkbook
        HSSFWorkbook wb = ExcelUtils.getHssfWorkbook(fileInfo.getSheetName(), fileInfo.getTitle(), fileInfo.getContent(), null);
        //响应到客户端
        try {
            ExportUtils.setResponseHeader(response, fileInfo.getFileName());
            OutputStream os = response.getOutputStream();
            wb.write(os);
            os.flush();
            os.close();
        } catch (Exception e) {
            logger.error("导出excel异常", e);
        }
    }

    /**
     * 发送响应流方法
     */
    public static void setResponseHeader(HttpServletResponse response, String fileName) {
        try {
            fileName = new String(fileName.getBytes(), StandardCharsets.ISO_8859_1.name());
        } catch (UnsupportedEncodingException e) {
            logger.error("编码转换异常", e);
        }
        try {
            response.setHeader("Content-Disposition", "attachment;filename=" + fileName);
            response.setContentType("application/vnd.ms-excel;charset=UTF-8");
            response.addHeader("Pargam", "no-cache");
            response.addHeader("Cache-Control", "no-cache");
        } catch (Exception ex) {
            logger.error("设置响应流方法异常", ex);
        }
    }

    public static ResultInfo checkExportCount(ResultInfo resultInfo, int count,int limitCount) {
        //        判断数据是否大于10000条，如果大于10000条给出提示需要设置筛选条件
        if (count > limitCount) {
            resultInfo.setCode(ResponseStatusEnum.FAILED.getCode());
            resultInfo.setMsg("导出数据结果集不能够超出"+limitCount+"条，请缩小导出范围");
        }
        return resultInfo;
    }
}

具体接口

    @RequestMapping("/exportList")
    public ResultInfo export(@RequestBody Object object, HttpServletResponse response){
        ResultInfo resultInfo=ResultUtil.getSuccessResult();
        int count =userService.getCount(object);
        resultInfo= ExportUtils.checkExportCount(resultInfo,count,limitCount);
        if (!ResponseStatusEnum.SUCCESS.getCode().equals(resultInfo.getCode())){
            return resultInfo;
        }
        object.setPageSize(limitCount);
        object.setCurrentPage(1);
        List<Object > list=userService.getList(object);
        // 对应字段中文解释
        String[] title={"aa","bb","cc","dd","ee"};
        FileInfo fileInfo=new FileInfo();
        fileInfo.setTitle(title);
        fileInfo.setFileName("文件名"+System.currentTimeMillis()+".xls");
        fileInfo.setSheetName("sheet名");
        String[][] content= new String[list.size()][title.length];
        SimpleDateFormat sdf=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        for (int i=0;i<list.size();i++) {
            content[i] = new String[title.length];
            Object obj=list.get(i);
            Timestamp aa=obj.getAa();
            if (aa!=null){
                content[i][0]=sdf.format(aa);
            } else {
                content[i][0]="";
            }
            content[i][1]=obj.getBb();
            content[i][2]=obj.getCc();
            content[i][3]=obj.getDd();
            content[i][4]=obj.getEe();
        }
        fileInfo.setContent(content);
        ExportUtils.createHSSFWorkbook(fileInfo,response);
        return null;
    }