Java Spring 返回以 UTF-8 和 BOM 编码的 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

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

    // 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。这可以通过使用类

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

上面的

LOOKAHEAD_LENGTH

是：
readlimit 在标记位置失效之前可以读取的最大字节数限制。 （根据 Javadocs），在我的代码中，我使用了值 20，考虑到 BOM 通常只有三个字节，这个值应该足够了。

Answer 2

这没有多大意义：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 返回一个字符串。