Java Spring 返回以带 BOM 的 UTF-8 编码的 CSV 文件

Question

显然 excel 要很好地打开 CSV 文件，它的开头应该有字节顺序标记。 CSV 的下载是通过在控制器中写入 HttpServletResponse 的输出流来实现的，因为数据是在请求期间生成的。当我尝试写入 BOM 字节时出现异常 - java.io.CharConversionException: Not an ISO 8859-1 character: []（即使我指定的编码是 UTF-8）。

有问题的控制器方法

@RequestMapping("/monthly/list")
public List<MonthlyDetailsItem> queryDetailsItems(
        MonthlyDetailsItemQuery query,
        @RequestParam(value = "format", required = false) String format,
        @RequestParam(value = "attachment", required = false, defaultValue="false") Boolean attachment,
        HttpServletResponse response) throws Exception 
{   
    // load item list
    List<MonthlyDetailsItem> list = detailsSvc.queryMonthlyDetailsForList(query);
    // adjust format
    format = format != null ? format.toLowerCase() : "json";
    if (!Arrays.asList("json", "csv").contains(format)) format = "json";

    // modify common response headers
    response.setCharacterEncoding("UTF-8");
    if (attachment)
        response.setHeader("Content-Disposition", "attachment;filename=duomenys." + format);

    // build csv
    if ("csv".equals(format)) {
        response.setContentType("text/csv; charset=UTF-8");
        response.getOutputStream().print("\ufeff");
        response.getOutputStream().write(buildMonthlyDetailsItemCsv(list).getBytes("UTF-8"));
        return null;
    }

    return list;
}

Answer 1

没什么意义：BOM是针对UTF-16的； UTF-8 没有字节顺序。您使用 setCharacterEncoding 设置的编码用于 getWriter，而不用于 getOutputStream。

更新：

好的，试试这个：

if ("csv".equals(format)) {
    response.setContentType("text/csv; charset=UTF-8");
    PrintWriter out = response.getWriter();
    out.print("\uFEFF");
    out.print(buildMonthlyDetailsItemCsv(list));
    return null;
}

我假设该方法 buildMonthlyDetailsItemCsv returns 是一个字符串。

Answer 2

我刚遇到，同样的问题。对我有用的解决方案是从响应对象获取输出流并按如下方式写入它

    // first create an array for the Byte Order Mark
    final byte[] bom = new byte[] { (byte) 239, (byte) 187, (byte) 191 }; 
    try (OutputStream os = response.getOutputStream()) {
        os.write(bom);

        final PrintWriter w = new PrintWriter(new OutputStreamWriter(os, "UTF-8"));
        w.print(data);
        w.flush();
        w.close();
    } catch (IOException e) {
        // logit
    }

因此在 OutputStreamWriter 上指定了 UTF-8。

作为对此的补充，我应该补充一点，同一个应用程序需要允许用户上传文件，这些文件可能有也可能没有 BOM。这可以通过使用 class org.apache.commons.io.input.BOMInputStream 来处理，然后使用它来构建 org.apache.commons.csv.CSVParser。 BOMInputStream 包含一个方法 hasBOM() 来检测文件是否有 BOM。我第一次陷入的一个问题是 hasBOM() 方法从底层流中读取（ 显然！），所以处理这个问题的方法是首先标记流，然后在测试后如果它没有 BOM，则重置流。我为此使用的代码如下所示：

try (InputStream is = uploadFile.getInputStream();
        BufferedInputStream buffIs = new BufferedInputStream(is);
        BOMInputStream bomIn = new BOMInputStream(buffIs);) {
      buffIs.mark(LOOKAHEAD_LENGTH);
      // this should allow us to deal with csv's with or without BOMs
      final boolean hasBOM = bomIn.hasBOM();
      final BufferedReader buffReadr = new BufferedReader(
          new InputStreamReader(hasBOM ? bomIn : buffIs, StandardCharsets.UTF_8));

      // if this stream does not have a BOM, then we must reset the stream as the test
      // for a BOM will have consumed some bytes
      if (!hasBOM) {
        buffIs.reset();
      }

      // collect the validated entity details
      final CSVParser parser = CSVParser.parse(buffReadr,
          CSVFormat.DEFAULT.withFirstRecordAsHeader());
      // Do stuff with the parser
      ...
  // Catch and clean up

希望这对某人有所帮助。

Java Spring 返回以带 BOM 的 UTF-8 编码的 CSV 文件

Java Spring returning CSV file encoded in UTF-8 with BOM

java

spring

byte-order-mark

utf-8