快捷導(dǎo)航

Java實(shí)現(xiàn)對(duì)象列表導(dǎo)出為excel表格的實(shí)用工具類

更新時(shí)間：2023年12月29日 08:19:28 作者：funfan0517

這篇文章主要為大家詳細(xì)介紹了Java如何實(shí)現(xiàn)對(duì)象列表導(dǎo)出為excel表格的實(shí)用工具類,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下

1.POI工具介紹

Excel的文件的組織形式，一個(gè)Excel文件對(duì)應(yīng)于一個(gè)workbook(HSSFWorkbook)，一個(gè)workbook可以有多個(gè)sheet（HSSFSheet）組成，一個(gè)sheet是由多個(gè)row（HSSFRow）組成，一個(gè)row是由多個(gè)cell（HSSFCell）組成。

基本操作步驟：

1、用HSSFWorkbook打開或者創(chuàng)建“Excel文件對(duì)象”

2、用HSSFWorkbook對(duì)象返回或者創(chuàng)建Sheet對(duì)象

3、用Sheet對(duì)象返回行對(duì)象，用行對(duì)象得到Cell對(duì)象

4、對(duì)Cell對(duì)象讀寫。

以上只能導(dǎo)入xls的文件不能導(dǎo)入xlsx的。導(dǎo)入xlsx需要用XSSFWorkFont，基本上都一樣。

2.添加maven依賴

<!--Apache POI提供API給Java程式對(duì)Microsoft Office（Excel、WORD、PowerPoint、Visio等）格式檔案讀和寫的功能-->
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>3.17</version>
</dependency>
<!--導(dǎo)出excel文件-->
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>3.17</version>
</dependency>

3.Excel操作工具類

import lombok.extern.slf4j.Slf4j;
import org.apache.poi.hpsf.DocumentSummaryInformation;
import org.apache.poi.hpsf.SummaryInformation;
import org.apache.poi.hssf.usermodel.*;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.streaming.SXSSFWorkbook;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.nio.charset.StandardCharsets;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;

/**
 * @Author: funfan0517
 * @CreateTime: 2022-11-07  14:36
 * @Description: Excel操作工具類
 */
@Slf4j
public class PoiUtils {

    /**
     * 將對(duì)象集合導(dǎo)出到excel
     * @param list
     * @param <T>
     * @return
     */
    public static <T> ResponseEntity<byte[]> exportToExcel(List<T> list,String excelName) {
        if(list.isEmpty()) return null;//列表為空直接返回null
        // 1、創(chuàng)建一個(gè)excel文檔
        HSSFWorkbook workbook = new HSSFWorkbook();
        // 2、創(chuàng)建文檔摘要
        workbook.createInformationProperties();
        // 3、獲取并配置文檔摘要信息
        DocumentSummaryInformation docInfo = workbook.getDocumentSummaryInformation();
        // 文檔類別
        docInfo.setCategory("導(dǎo)出文檔");
        // 文檔管理員
        docInfo.setManager("UT");
        // 設(shè)置公司信息
        docInfo.setCompany("www.ut.com.cn");
        // 4、獲取文檔摘要信息
        SummaryInformation summaryInformation = workbook.getSummaryInformation();
        // 文檔標(biāo)題
        summaryInformation.setTitle("導(dǎo)出文檔");
        // 文檔作者
        summaryInformation.setAuthor("UT");
        // 備注信息
        summaryInformation.setComments("本文檔由 優(yōu)特科技 提供");
        // 5、創(chuàng)建樣式
        // 創(chuàng)建標(biāo)題行的樣式
        HSSFCellStyle headerStyle = workbook.createCellStyle();
        headerStyle.setFillForegroundColor(IndexedColors.GREEN.getIndex()); // 背景顏色
        headerStyle.setFillPattern(FillPatternType.SOLID_FOREGROUND); // 填充模式
        HSSFSheet sheet = workbook.createSheet();// 不傳name 默認(rèn)為sheet1
        // 6、創(chuàng)建標(biāo)題行 第一行數(shù)據(jù)
        // 只循環(huán)一次目的是將對(duì)象名寫入到excel標(biāo)題上
        for (T t : list) {
            HSSFRow row = sheet.createRow(0);
            String[] fieldNames = getFiledNames(t);
            for (int i = 0; i < fieldNames.length; i++) {
                HSSFCell cell = row.createCell(i);
                cell.setCellValue(fieldNames[i]);
                cell.setCellStyle(headerStyle);
            }
            break;
        }
        // 7、創(chuàng)建后面行
        for (int j = 0; j < list.size(); j++) {
            T t = list.get(j);
            String[] fieldValues = getFieldValues(t);
            // 由于第一行已經(jīng)寫入了標(biāo)題，所以這里從第二行開始寫
            HSSFRow rows = sheet.createRow(j + 1);
            for (int i = 0; i < fieldValues.length; i++) {
                rows.createCell(i).setCellValue(fieldValues[i]);
            }
        }
        HttpHeaders headers = new HttpHeaders();
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
//        FileOutputStream baos = null;
        try {
//            baos = new FileOutputStream("D:\\data\\test.xls");
            // 防止亂碼
            headers.setContentDispositionFormData("attachment", new String(excelName.getBytes(StandardCharsets.UTF_8), "ISO-8859-1"));//ISO-8859-1

            headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
            workbook.write(baos);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return new ResponseEntity<>(baos.toByteArray(), headers, HttpStatus.CREATED);//null;//
    }

    /**
     * 獲取所有對(duì)象屬性名稱
     * @param o
     * @return
     */
    public static String[] getFiledNames(Object o) {
        Field[] fields=o.getClass().getDeclaredFields();
        String[] fieldNames=new String[fields.length];
        for(int i=0;i<fields.length;i++){
            fieldNames[i]=fields[i].getName();
        }
        return fieldNames;
    }

    /**
     * 獲取對(duì)象屬性值
     * @param o
     * @return
     * @throws NoSuchMethodException
     * @throws InvocationTargetException
     * @throws IllegalAccessException
     */
    private static String[] getFieldValues(Object o) {
        Field[] fields=o.getClass().getDeclaredFields();
        String[] fieldNames=new String[fields.length];
        String[] fieldValues = new String[fieldNames.length];
        for(int i=0;i<fields.length;i++){
            fieldNames[i]=fields[i].getName();
        }
        try {
            for (int i=0; i<fieldNames.length; i++) {
                String fieldName = fieldNames[i];
                Object invoke = o.getClass().getMethod("get" + returnFirstCapital(fieldName)).invoke(o);
                String field = invoke == null? null:invoke.toString();//數(shù)據(jù)為null時(shí)做特殊處理
                if(invoke instanceof Date) {
                    field = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(invoke);
                }
                fieldValues[i] = field;
            }
        } catch(Exception e) {
            log.error("獲取實(shí)體類對(duì)象屬性異常：", e);
        }
        return fieldValues;
    }

    /**
     * 判斷字符串首字母是否為大寫，如果不是轉(zhuǎn)化為大寫
     * @param str
     * @return
     */
    public static String returnFirstCapital(String str) {
        if (str.charAt(0) >= 'A' && str.charAt(0) <= 'Z') {
            return str;
        }
        char[] ch = str.toCharArray();
        ch[0] -= 32;
        return String.valueOf(ch);
    }



    /**
     * 將對(duì)象集合導(dǎo)出到excel
     */
    public static <T> String exportToExcelFile(List<T> list, String excelName) {
        if(list.isEmpty()) return null;//列表為空直接返回null
        // 1、創(chuàng)建一個(gè)excel文檔
        HSSFWorkbook workbook = new HSSFWorkbook();
        // 2、創(chuàng)建文檔摘要
        workbook.createInformationProperties();
        // 3、獲取并配置文檔摘要信息
        DocumentSummaryInformation docInfo = workbook.getDocumentSummaryInformation();
        // 文檔類別
        docInfo.setCategory("導(dǎo)出文檔");
        // 文檔管理員
        docInfo.setManager("UT");
        // 設(shè)置公司信息
        docInfo.setCompany("www.ut.com.cn");
        // 4、獲取文檔摘要信息
        SummaryInformation summaryInformation = workbook.getSummaryInformation();
        // 文檔標(biāo)題
        summaryInformation.setTitle("導(dǎo)出文檔");
        // 文檔作者
        summaryInformation.setAuthor("UT");
        // 備注信息
        summaryInformation.setComments("本文檔由 優(yōu)特科技 提供");
        // 5、創(chuàng)建樣式
        // 創(chuàng)建標(biāo)題行的樣式
        HSSFCellStyle headerStyle = workbook.createCellStyle();
        headerStyle.setFillForegroundColor(IndexedColors.GREEN.getIndex()); // 背景顏色
        headerStyle.setFillPattern(FillPatternType.SOLID_FOREGROUND); // 填充模式
        HSSFSheet sheet = workbook.createSheet();// 不傳name 默認(rèn)為sheet1
        // 6、創(chuàng)建標(biāo)題行 第一行數(shù)據(jù)
        // 只循環(huán)一次目的是將對(duì)象名寫入到excel標(biāo)題上
        for (T t : list) {
            HSSFRow row = sheet.createRow(0);
            String[] fieldNames = getFiledNames(t);
            for (int i = 0; i < fieldNames.length; i++) {
                HSSFCell cell = row.createCell(i);
                cell.setCellValue(fieldNames[i]);
                cell.setCellStyle(headerStyle);
            }
            break;
        }
        // 7、創(chuàng)建后面行
        for (int j = 0; j < list.size(); j++) {
            T t = list.get(j);
            String[] fieldValues = getFieldValues(t);
            // 由于第一行已經(jīng)寫入了標(biāo)題，所以這里從第二行開始寫
            HSSFRow rows = sheet.createRow(j + 1);
            for (int i = 0; i < fieldValues.length; i++) {
                rows.createCell(i).setCellValue(fieldValues[i]);
            }
        }
        File file=new File("D:\\"+excelName+".xls");
        FileOutputStream baos = null;
        try {
            baos = new FileOutputStream(file);
            workbook.write(baos);
        } catch (IOException e) {
            e.printStackTrace();
        }
        String absolutePath = file.getAbsolutePath();
        return "導(dǎo)出文件存放路徑為："+absolutePath;
    }

    /**
     * 將對(duì)象集合導(dǎo)出到excel
     * SXSSFWorkbook對(duì)于大型excel的創(chuàng)建且不會(huì)內(nèi)存溢出的，就只有SXSSFWorkbook了。它的原理很簡(jiǎn)單，用硬盤空間換內(nèi)存（就像hash map用空間換時(shí)間一樣）
     * @param list
     * @param <T>
     * @reurn
     */
    public static <T> void exportExcel(HttpServletRequest request, HttpServletResponse response, List<T> list, String sheetName) {
        // 1、創(chuàng)建一個(gè)excel文檔
        SXSSFWorkbook workbook = new SXSSFWorkbook();

        // 5、創(chuàng)建樣式
        // 創(chuàng)建標(biāo)題行的樣式
        CellStyle headerStyle = workbook.createCellStyle();
        headerStyle.setFillForegroundColor(IndexedColors.GREEN.getIndex()); // 背景顏色
        headerStyle.setFillPattern(FillPatternType.SOLID_FOREGROUND); // 填充模式
        Sheet sheet = workbook.createSheet();// 不傳name 默認(rèn)為sheet1
        // 6、創(chuàng)建標(biāo)題行 第一行數(shù)據(jù)
        // 只循環(huán)一次目的是將對(duì)象名寫入到excel標(biāo)題上
        for (T t : list) {
            Row row = sheet.createRow(0);
            String[] fieldNames = getFiledNames(t);
            for (int i = 0; i < fieldNames.length; i++) {
                Cell  cell = row.createCell(i);
                cell.setCellValue(fieldNames[i]);
                cell.setCellStyle(headerStyle);
            }
            break;
        }
        // 7、創(chuàng)建后面行
        for (int j = 0; j < list.size(); j++) {
            T t = list.get(j);
            String[] fieldValues = getFieldValues(t);
            // 由于第一行已經(jīng)寫入了標(biāo)題，所以這里從第二行開始寫
            Row rows = sheet.createRow(j + 1);
            for (int i = 0; i < fieldValues.length; i++) {
                rows.createCell(i).setCellValue(fieldValues[i]);
            }
        }
        //聲明輸出流
        OutputStream outputStream = null;
        //響應(yīng)到客戶端
        try {
            //表格文件名稱
            String codedFileName = java.net.URLEncoder.encode(sheetName, "UTF-8");
            //設(shè)置響應(yīng)頭
            response.setContentType("application/vnd.ms-excel");
            String agent = request.getHeader("USER-AGENT").toLowerCase();
            if (agent.contains("firefox")) {
                response.setCharacterEncoding("utf-8");
                response.setHeader("content-disposition", "attachment;filename=" + new String(sheetName.getBytes(), "ISO8859-1") + ".xlsx");
            } else {
                response.setHeader("content-disposition", "attachment;filename=" + codedFileName + ".xlsx");
            }
            //獲取輸出流
            outputStream = response.getOutputStream();

            //用文檔寫輸出流
            workbook.write(outputStream);

            //刷新輸出流
            outputStream.flush();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            //關(guān)閉輸出流
            if (outputStream != null) {
                try {
                    outputStream.close();
                    workbook.dispose();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

參考文章：java使用POI實(shí)現(xiàn)excel文件的導(dǎo)入和導(dǎo)出(通用方法)

到此這篇關(guān)于Java實(shí)現(xiàn)對(duì)象列表導(dǎo)出為excel表格的實(shí)用工具類的文章就介紹到這了,更多相關(guān)Java列表導(dǎo)出為excel內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: