org.apache.commons(commons-csv)下载CSV增加BOM头

网络说明

代码说明

依赖

<!--https://mvnrepository.com/artifact/org.apache.commons/commons-csv-->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-csv</artifactId>
            <version>1.8</version>
        </dependency>

方法

	@GetMapping("/export-csv")
    public void exportCsv(HttpServletResponse response) throws IOException {
        String [] headers = {"数据来源", "基线数据", "数据日期"};
        String fileName = "data-gee-集合.csv"; // CSV 文件名
        fileName = URLEncoder.encode(fileName, "UTF-8");
        response.setContentType("text/csv;charset=UTF-8");
        response.setHeader(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + fileName + "\"");
        response.setCharacterEncoding("UTF-8");
        OutputStream outputStream = response.getOutputStream();
        outputStream.write(new byte[]{(byte)0xEF, (byte)0xBB, (byte)0xBF});

        try (CSVPrinter printer = new CSVPrinter(new OutputStreamWriter(outputStream, "UTF-8"), CSVFormat.DEFAULT.withHeader(headers))) {
            printer.printRecord("中文", "data2", LocalDate.now());
            printer.printRecord("中文", "data5", LocalDate.now());
            printer.flush();
        };
    }

解释

这段代码用于在输出CSV文件时，向输出流中写入BOM(Byte Order Mark)头，以解决Excel打开CSV文件乱码的问题。BOM头是一个特殊的字符，它通常用于标识文本文件使用的编码方式。

在使用UTF-8编码保存CSV文件时，如果在文件头部写入BOM头，那么在Excel中打开CSV文件时，Excel会识别文件头中的BOM头信息，自动使用UTF-8的编码方式来解析CSV文件内容。因此，将BOM头写入CSV文件是解决Excel打开CSV乱码问题的常用方法之一。

代码中的new byte[]{(byte) 0xEF, (byte) 0xBB, (byte) 0xBF}就是BOM头的字节表示形式，其中0xEF, 0xBB, 0xBF分别表示BOM头的3个字节，它们对应的16进制表示为0xEFBBBF。

因此，调用outputStream.write()方法向输出流中写入BOM头时，实际就是将BOM头的字节数组写入到输出流中，告诉Excel打开这个CSV文件时使用UTF-8编码方式来读取文件内容，以解决乱码问题。