feat: add UTF-8 support for CSV exported files

Close #89
FlowingCode · Jan 24, 2024 · be89f0e · be89f0e
1 parent e5a3f22
commit be89f0e
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/src/main/java/com/flowingcode/vaadin/addons/gridexporter/CsvInputStreamFactory.java b/src/main/java/com/flowingcode/vaadin/addons/gridexporter/CsvInputStreamFactory.java
@@ -28,6 +28,7 @@
 import java.io.OutputStreamWriter;
 import java.io.PipedInputStream;
 import java.io.PipedOutputStream;
+import java.nio.charset.StandardCharsets;
 import java.util.List;
 import java.util.stream.Collectors;
 import org.apache.commons.io.IOUtils;
@@ -72,7 +73,14 @@ public InputStream createInputStream() {
       PipedOutputStream out = new PipedOutputStream(in);
       new Thread(
               () -> {
-                try (CSVWriter writer = new CSVWriter(new OutputStreamWriter(out))) {
+                try (
+                  OutputStreamWriter os = new OutputStreamWriter(out, exporter.getCsvCharset());
+                  CSVWriter writer = new CSVWriter(os)) {
+                  if (StandardCharsets.UTF_8.equals(exporter.getCsvCharset())) {
+                    // write BOM
+                    os.write(0xfeff);
+                  }
+
                   writer.writeNext(headers);
                   writer.writeAll(data);
                   if (footers.length > 0) {

diff --git a/src/main/java/com/flowingcode/vaadin/addons/gridexporter/GridExporter.java b/src/main/java/com/flowingcode/vaadin/addons/gridexporter/GridExporter.java
@@ -39,6 +39,7 @@
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import java.nio.charset.Charset;
 import java.text.DateFormat;
 import java.text.DecimalFormat;
 import java.util.Comparator;
@@ -102,6 +103,8 @@ public class GridExporter<T> implements Serializable {
 
   private List<FooterToolbarItem> footerToolbarItems;
 
+  private String csvCharsetName;
+
   private GridExporter(Grid<T> grid) {
     this.grid = grid;
   }
@@ -554,4 +557,17 @@ public void setFooterToolbarItems(List<FooterToolbarItem> footerToolbarItems) {
     this.footerToolbarItems = footerToolbarItems;
   }
 
+  /**
+   * Charset to use when exporting the CSV file.
+   * 
+   * @return CSV file charset or default one.
+   */
+  public Charset getCsvCharset() {
+    return csvCharsetName == null ? Charset.defaultCharset() : Charset.forName(csvCharsetName);
+  }
+
+  public void setCsvCharset(Charset charset) {
+    this.csvCharsetName = charset.name();
+  }
+
 }
diff --git a/src/test/java/com/flowingcode/vaadin/addons/gridexporter/GridExporterDemo.java b/src/test/java/com/flowingcode/vaadin/addons/gridexporter/GridExporterDemo.java
@@ -35,6 +35,7 @@
 import com.vaadin.flow.router.Route;
 import java.io.IOException;
 import java.math.BigDecimal;
+import java.nio.charset.StandardCharsets;
 import java.text.SimpleDateFormat;
 import java.util.Calendar;
 import java.util.List;
@@ -81,6 +82,7 @@ public GridExporterDemo() throws EncryptedDocumentException, IOException {
     exporter.setTitle("People information");
     exporter.setFileName(
         "GridExport" + new SimpleDateFormat("yyyyddMM").format(Calendar.getInstance().getTime()));
+    exporter.setCsvCharset(StandardCharsets.UTF_8);
 
     TextField filterField = new TextField();
     filterField.setPlaceholder("Filter by");