使用JAVA反射，实现数据库表导出为Excel万能导出类——笔记

本来是在公众号看到的，想自己试试。在网上一查资料，转载的太多了，分不清谁是原创了，就不@原文作者了。

源代码使用效果挺好的，但是出现了字段名和字段不对应的情况。将toMap方法中的HashMap改为LinkedHasnMap问题解决，笔记记录下。

依赖：

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>3.15</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-scratchpad</artifactId>
    <version>3.15</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.69</version>
</dependency>
<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.5</version>
</dependency>

工具类：

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.IOUtils;
 
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.text.SimpleDateFormat;
import java.util.*;
@Slf4j
public class MyCsvFileUtil {
            public static final String FILE_SUFFIX = ".csv";
            public static final String CSV_DELIMITER = ",";
            public static final String CSV_TAIL = "\r\n";
            protected static final String DATE_STR_FILE_NAME = "yyyyMMddHHmmssSSS";
         
            /**
      * 将字符串转成csv文件
      */
            public static void createCsvFile(String savePath, String contextStr) throws IOException {
         
                File file = new File(savePath);
        //创建文件
                file.createNewFile();
        //创建文件输出流
                FileOutputStream fileOutputStream = new FileOutputStream(file);
        //将指定字节写入此文件输出流
                fileOutputStream.write(contextStr.getBytes("gbk"));
                fileOutputStream.flush();
        fileOutputStream.close();
    }
         
            /**
      * 写文件
      *
      * @param fileName
      * @param content
      */
            public static void writeFile(String fileName, String content) {
                FileOutputStream fos = null;
                OutputStreamWriter writer = null;
                try {
                    fos = new FileOutputStream(fileName, true);
            writer = new OutputStreamWriter(fos, "GBK");
            writer.write(content);
            writer.flush();
        } catch (Exception e) {
                    log.error("写文件异常|{}", e);
        } finally {
                    if (fos != null) {
                        IOUtils.closeQuietly(fos);
            }
                    if (writer != null) {
                        IOUtils.closeQuietly(writer);
            }
                }
            }
         
            /**
      * 构建文件名称
      * @param dataList
      * @return
      */
            public static String buildCsvFileFileName(List dataList) {
                return dataList.get(0).getClass().getSimpleName() + new SimpleDateFormat(DATE_STR_FILE_NAME).format(new Date()) + FILE_SUFFIX;
    }
         
            /**
      * 构建excel 标题行名
      * @param dataList
      * @return
      */
            public static String buildCsvFileTableNames(List dataList) {
                Map<String, Object> map = toMap(dataList.get(0));
                StringBuilder tableNames = new StringBuilder();
        for (String key : map.keySet()) {
                    tableNames.append(key).append(MyCsvFileUtil.CSV_DELIMITER);
        }
                return tableNames.append(MyCsvFileUtil.CSV_TAIL).toString();
    }


            /**
      * 构建excel内容
      * @param dataLists
      * @return
      */
            public static String buildCsvFileBodyMap(List dataLists) {
                List<Map<String, Object>> mapList = new ArrayList<>();
                String[] tableNames = MyCsvFileUtil.buildCsvFileTableNames(dataLists).split(",");
                for (Object o : dataLists) {
                        // 将 Object 转换为 Map<String, Object>
                    mapList.add(toMap(o));
                    System.out.println(mapList);
                }
                Class<?> clazz = dataLists.get(0).getClass(); // 获取第一个对象的类
                Field[] fields = clazz.getDeclaredFields(); // 获取所有字段
                System.out.println(fields);

                StringBuilder lineBuilder = new StringBuilder();
        for (Map<String, Object> rowData : mapList) {
//                    for (String key : tableNames) {
                    for (String key : rowData.keySet()) {
                            System.out.println(key);
                            Object value = rowData.get(key);
                            System.out.println(value);
                            if (Objects.nonNull(value)) {
                                lineBuilder.append(value).append(MyCsvFileUtil.CSV_DELIMITER);
                            } else {
                                lineBuilder.append("--").append(MyCsvFileUtil.CSV_DELIMITER);
                            }

                    }
//            for (String key : rowData.keySet()) {
//                System.out.println(key);
//            }
                    lineBuilder.append(MyCsvFileUtil.CSV_TAIL);
        }
                return lineBuilder.toString();
    }

    /**
     * 将一个实体对象转换为 Map。
     *
     * @param entity 要转换的实体对象
     * @return 包含实体对象属性和值的 Map
     */
    public static <T> Map<String, Object> toMap(T entity) {
        // 获取实体对象的类类型
        Class<? extends Object> bean = entity.getClass();
        // 获取类的所有声明字段
        Field[] fields = bean.getDeclaredFields();
        // 初始化一个 HashMap，大小为字段数量
        Map<String, Object> map = new LinkedHashMap<>(fields.length);

        // 遍历所有字段
        for (Field field : fields) {
            try {
                // 忽略 serialVersionUID 字段
                if (!"serialVersionUID".equals(field.getName())) {
                    // 构造 getter 方法名
                    String methodName = "get" + field.getName().substring(0, 1).toUpperCase() + field.getName().substring(1);
                    // 获取对应的 getter 方法
                    Method method = bean.getDeclaredMethod(methodName);
                    // 调用 getter 方法获取字段值
                    Object fieldValue = method.invoke(entity);
                    // 将字段名和值存入 Map
                    map.put(field.getName(), fieldValue);
                }
            } catch (Exception e) {
                // 日志记录异常信息
                log.warn("toMap() Exception={}", e.getMessage());
            }
        }

        // 返回填充好的 Map
        return map;
    }
//传入实体对象列表，输出excel
    public static void myCsvFileUtil(List districts) {
        //存放地址&文件名
        String fileName = "D:\\mycsv\\"+MyCsvFileUtil.buildCsvFileFileName(districts);
        //创建表格行标题
//        String tableNames = MyCsvFileUtil.buildCsvFileTableNames(districts);
        String tableNames=MyCsvFileUtil.buildCsvFileTableNamesNew(MyCsvFileUtil.resolveExcelTableName(districts.get(0)));
        //创建文件
        MyCsvFileUtil.writeFile(fileName, tableNames);
        //写入数据
        String contentBody = MyCsvFileUtil.buildCsvFileBodyMap(districts);
        //调用方法生成
        MyCsvFileUtil.writeFile(fileName,contentBody);
    }


    //字段属性注解值函数
    public  static  <T>  List<String>  resolveExcelTableName(T  entity)  {
        List<String>  tableNamesList  =  new  ArrayList<>();
        Class<?  extends  Object>  bean  =  entity.getClass();
        Field[]  fields  =  bean.getDeclaredFields();
        Map<String,  Object>  map  =  new  HashMap<>(fields.length);
        for  (Field  field  :  fields)  {
                try  {
                        if  (!"serialVersionUID".equals(field.getName()))  {
                                String  tableTitleName  =  field.getName();
                                JcExcelName  myFieldAnn  =  field.getAnnotation(JcExcelName.class);
                                String  annName  =  myFieldAnn.name();
                                if  (StringUtils.hasLength(annName))  {
                                        tableTitleName  =  annName;
                                }
                                tableNamesList.add(tableTitleName);
                        }
                }  catch  (Exception  e)  {
                        log.warn("toMap()  Exception={}",  e.getMessage());
                }
        }
        
        return  tableNamesList;
    }

    public static String buildCsvFileTableNamesNew(List<String> dataList) {
    StringBuilder tableNames = new StringBuilder();
    for (String name : dataList) {
        tableNames.append(name).append(MyCsvFileUtil.CSV_DELIMITER);
    }
    
        return tableNames.append(MyCsvFileUtil.CSV_TAIL).toString();
    }
    



    


}

自定义注解：

用于自定义表头名称

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface JcExcelName {
         
            String name() default "";
         
        }

测试：

@RestController
@RequestMapping("try")
public class UserController {
    @Resource
    private UserService userService;
    
    @PostMapping("/createCsvFileJcTest")
    public  void createCsvFileJcTest() {
        List<User> districts = userService.findAll();
        MyCsvFileUtil.myCsvFileUtil(districts);
    }
}

效果：