Java将List对象导入Excel文件

1
2
3
4
5
6
 <dependency>
      <groupId>org.apache.poi</groupId>
      <artifactId>poi-ooxml</artifactId>
      <version>3.17</version>
    </dependency>

1
2
3
4
5
6
7
8
/**
 * excel标题头注解，当Java属性没有使用此注解，则默认使用Java属性作为标题。
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ExcelTitle {
  String value();
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
import com.sc.ops.annotations.ExcelTitle;
import com.sc.ops.annotations.Order;
import lombok.extern.slf4j.Slf4j;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.*;
import java.util.stream.Collectors;
/**
 * 对象转excel工具类
 */
@Slf4j
public class ExcelWriterUtil{

    private static ThreadLocal<ExcelValueFormatter> valueFormatter = ThreadLocal
            .withInitial(() -> new DateValueFormatter("yyyy-MM-dd"));

    public static void setExcelValueFormatter(ExcelValueFormatter excelValueFormatter) {
        valueFormatter.set(excelValueFormatter);
    }

    public static <E> void writeToExcel(List<E> list, Class<E> clazz, String fileName)
            throws InvocationTargetException, IllegalAccessException {
        @SuppressWarnings("MismatchedQueryAndUpdateOfCollection")
        List<Object[]> dataList = new ArrayList<>();
        Field[] fields = getAllFields(clazz);
        Map<String, Method> fieldMethodMap = buildFieldMethodMap(clazz);
        sortMethodMap(fields, fieldMethodMap);
        Map<String, String> fieldTitleMap = buildFieldTitleMap(clazz, fieldMethodMap);
        List<Map.Entry<String, Method>> methodEntrySet = new ArrayList<>(fieldMethodMap.entrySet());
        int addMark = 0;
        int itemSize = fieldTitleMap.size();
        String[] titleArr = new String[itemSize];
        for (E obj : list) {
            Object[] item = new Object[itemSize];
            for (int i = 0; i < methodEntrySet.size(); i++) {
                Map.Entry<String, Method> methodEntry = methodEntrySet.get(i);
                String field = methodEntry.getKey();
                if (addMark < itemSize) {
                    titleArr[addMark] = fieldTitleMap.get(field);
                    addMark++;
                }
                Method method = methodEntry.getValue();
                Object value = formatValue(method, obj, valueFormatter.get());
                if (value != null) {
                    item[i] = value;
                }
            }
            dataList.add(item);
        }
        writeObjectToExcel(dataList, titleArr, fileName);
    }

    private static Object formatValue(Method method, Object obj,
                                      ExcelValueFormatter excelValueFormatter)
            throws InvocationTargetException, IllegalAccessException {
        Object value = method.invoke(obj);
        if (value == null) {
            return null;
        }
        if(excelValueFormatter == null) {
            return value;
        }
        Class<?> returnType = method.getReturnType();
        return excelValueFormatter.formatValue(returnType, value);
    }

    private static <E> Map<String, Method> buildFieldMethodMap(Class<E> clazz) {
        List<Method> getMethods = Arrays.stream(clazz.getMethods())
                .filter(
                        method -> method.getName().startsWith("get") && !method.getName().equals("getClass"))
                .collect(
                        Collectors.toList());
        Map<String, Method> fieldMethodMap = new LinkedHashMap<>();
        for (Method getMethod : getMethods) {
            String m = getMethod.getName().replace("get", "");
            String field = m.substring(0, 1).toLowerCase() + m.substring(1);
            fieldMethodMap.put(field, getMethod);
        }
        return fieldMethodMap;
    }

    public static <E> Field[] getAllFields(Class<E> clazz){
        List<Field> fieldList = new ArrayList<>();
        while (clazz != null){
            fieldList.addAll(new ArrayList<>(Arrays.asList(clazz.getDeclaredFields())));
            clazz = (Class<E>) clazz.getSuperclass();
        }
        Field[] fields = new Field[fieldList.size()];
        fieldList.toArray(fields);
        return fields;
    }

    private static <E> Map<String, String> buildFieldTitleMap(Class<E> clazz,
                                                              Map<String, Method> fieldMethodMap) {
        Map<String, String> fieldTitleMap = new LinkedHashMap<>();
        Field[] fields = getAllFields(clazz);
        Arrays.stream(fields).forEach(field -> {
            if (fieldMethodMap.containsKey(field.getName())) {
                ExcelTitle excelTitle = field.getAnnotation(ExcelTitle.class);
                String title = excelTitle == null ? field.getName() : excelTitle.value();
                fieldTitleMap.put(field.getName(), title);
            }
        });
        return fieldTitleMap;
    }

    private static void writeObjectToExcel(List<Object[]> list, String[]
            excelTitle, String fileName) {
        //在内存中创建Excel文件
        Workbook workbook;
        if (fileName.endsWith("xls")) {
            workbook = new HSSFWorkbook();
        } else if (fileName.endsWith("xlsx")) {
            workbook = new XSSFWorkbook();
        } else {
            throw new IllegalArgumentException("fileName not legal");
        }
        Sheet sheet = workbook.createSheet();
        //标题行
        Row titleRow = sheet.createRow(0);
        for (int i = 0; i < excelTitle.length; i++) {
            titleRow.createCell(i).setCellValue(excelTitle[i]);
        }
        //创建数据行并写入值
        for (Object[] dataArr : list) {
            int lastRowNum = sheet.getLastRowNum();
            Row dataRow = sheet.createRow(lastRowNum + 1);
            for (int i = 0; i < dataArr.length; i++) {
                Cell cell = dataRow.createCell(i);
                Object cellValue = dataArr[i];
                if(cellValue != null) {
                    setCellValue(cellValue, cell);
                }
            }
        }
        //创建输出流对象
        FileOutputStream outputStream = null;
        try {
            outputStream = new FileOutputStream(new File(fileName));
        } catch (FileNotFoundException e) {
            log.error("file not found", e);
        }
        try {
            workbook.write(outputStream);
        } catch (IOException e) {
            log.error("write to file failed", e);
        } finally {
            if (outputStream != null) {
                try {
                    outputStream.close();
                } catch (IOException ignore) {
                }
            }
        }
    }

    private static void setCellValue(Object cellValue, Cell cell) {
        if (cellValue instanceof Boolean) {
            cell.setCellValue((boolean) cellValue);
        } else if (cellValue instanceof String) {
            cell.setCellValue(cellValue.toString());
        } else if (cellValue instanceof Double || cellValue instanceof Integer
                || cellValue instanceof Long) {
            cell.setCellValue(Double.valueOf(cellValue.toString()));
        } else if (cellValue instanceof Date) {
            cell.setCellValue((Date) cellValue);
        } else if (cellValue instanceof Calendar) {
            cell.setCellValue((Calendar) cellValue);
        } else if (cellValue instanceof RichTextString) {
            cell.setCellValue((RichTextString) cellValue);
        } else {
            cell.setCellValue(cellValue.toString());
        }
    }


    private static void sortMethodMap(Field[] fields, Map<String, Method> fieldMethodMap) {
        Set<String> fieldSet = fieldMethodMap.keySet();
        List<Field> fieldList = Arrays.stream(fields).filter(e -> fieldSet.contains(e.getName()))
                .collect(Collectors.toList());
        fields = fieldList.toArray(new Field[]{});
        Arrays.sort(fields, (o1, o2) -> {
            Order order1 = o1.getAnnotation(Order.class);
            Order order2 = o2.getAnnotation(Order.class);
            if (order1 == null && order2 == null) { //均不含注解时不排序
                return 0;
            }
            if (order1 == null) { //order1 == null && order2 != null 仅有一个含有注解时，默认排到不含注解的后面
                return -1;
            }
            if (order2 == null) { //order1 != null && order2 == null 仅有一个含有注解时，默认排到不含注解的后面
                return 1;
            }
            return order1.value() - order2.value();//均含有注解时，按照注解值从小到大排序
        });
        Map<String, Method> sortedMethodMap = new LinkedHashMap<>();
        Arrays.stream(fields).forEach(e -> {
            String key = e.getName();
            sortedMethodMap.put(key, fieldMethodMap.get(key));
        });
        fieldMethodMap.clear();
        fieldMethodMap.putAll(sortedMethodMap);
    }
}

1
2
3
public interface ExcelValueFormatter {
  Object formatValue(Class<?> returnType, Object value);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
@Data
@AllArgsConstructor
public class DateValueFormatter implements ExcelValueFormatter {
 
  private String dateFormat;
 
  @Override
  public Object formatValue(Class<?> returnType, Object value) {
    if (returnType.equals(Date.class)) {
      return DateTimeFormatter.ofPattern(dateFormat)
          .format(toLocalDateTime((Date) value));
    } else {
      return value;
    }
  }
 
  private static LocalDateTime toLocalDateTime(Date date) {
    Instant instant = date.toInstant();
    ZoneId zoneId = ZoneId.systemDefault();
    return instant.atZone(zoneId).toLocalDateTime();
  }
}

1
2
3
4
5
6
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Order {
 
    int value();
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
  private static void sortMethodMap(Field[] fields, Map<String, Method> fieldMethodMap) {
    Set<String> fieldSet = fieldMethodMap.keySet();
    List<Field> fieldList = Arrays.stream(fields).filter(e -> fieldSet.contains(e.getName()))
            .collect(Collectors.toList());
    fields = fieldList.toArray(new Field[]{});
    Arrays.sort(fields, (o1, o2) -> {
      Order order1 = o1.getAnnotation(Order.class);
      Order order2 = o2.getAnnotation(Order.class);
      if (order1 == null && order2 == null) { //均不含注解时不排序
        return 0;
      }
      if (order1 == null) { //order1 == null && order2 != null 仅有一个含有注解时，默认排到不含注解的后面
        return -1;
      }
      if (order2 == null) { //order1 != null && order2 == null 仅有一个含有注解时，默认排到不含注解的后面
        return 1;
      }
      return order1.value() - order2.value();//均含有注解时，按照注解值从小到大排序
    });
    Map<String, Method> sortedMethodMap = new LinkedHashMap<>();
    Arrays.stream(fields).forEach(e -> {
      String key = e.getName();
      sortedMethodMap.put(key, fieldMethodMap.get(key));
    });
    fieldMethodMap.clear();
    fieldMethodMap.putAll(sortedMethodMap);
  }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
    @Data
    @AllArgsConstructor
    public static class Student {
        @ExcelTitle("id")
        @Order(1)
        private Integer id;
 
        @ExcelTitle("姓名")
        @Order(2)
        private String name;
 
        @ExcelTitle("薪水")
        @Order(4)
        private Double salary;
 
        @ExcelTitle("生日")
        @Order(3)
        private Date birthDay;
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
    public static void main(String[] args) {
        try {
            List<Student> students = new ArrayList<>();
            for (int i = 0; i < 100; i++) {
                students.add(new Student(i, "member" + i, i * 55D, new Date()));
            }
            ExcelWriter.writeToExcel(students, Student.class, "/Users/Downloads/test.xlsx");
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
 
    @Data
    @AllArgsConstructor
    public static class Student {
        @ExcelTitle("id")
        private Integer id;
 
        @ExcelTitle("姓名")
        private String name;
 
        @ExcelTitle("薪水")
        private Double salary;
 
        @ExcelTitle("生日")
        private Date birthDay;
    }