前言
如題，這個小玩意，就是不限制你查的是哪張表，用的是什么類，
我直接一把梭，嘎嘎給你一頓匯出，
我知道，這是很多人都想過的， 至少我就收到很多人問過我這個類似的問題，
我也跟他們說了，但是他們就是不動手，其實真的很簡單，
不動手怎么辦？ 我出手唄，
不多說開搞 ，
正文
玩法很簡單，
要實作的效果 ：
類是不確定的 ，User ？Student ? District ? 不確定，
但是呢我們封裝出來的函式，要足夠支撐不同的類，我們自動去讀取遍歷list ，然后匯出生成檔案，
核心的思路是什么 ？
其實就還是利用csv檔案的內容格式本質 ，看這兩幅圖 ：
我們要實作萬能的類匯出excel ！！！
思路是什么 ：
① 我們從不確定的類 的集合list 中，取出 里面的類，
反射一手，拿出里面的屬性名， 做第一行表格行標題名稱拼接，
②拼接內容
因為類不確定，那么我們就采取反射把類全部欄位屬性作為key丟到map里面，同時把值丟到value里面，
這樣我們拼接內容的時候只需要根據map 嘎嘎一頓遍歷拼接即可，
推薦一個開源免費的 Spring Boot 最全教程：
https://github.com/javastacks/spring-boot-best-practice
1.依賴
<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>
2. 核心的工具類，函式我都封裝好了
MyCsvFileUtil.java
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.*;
/**
* @author JCccc
* @Remark 是我
*/
@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) {
//不管你傳什么玩意，我都給你反射一手，搞成Map
List<Map<String, Object>> mapList = new ArrayList<>();
for (Object o : dataLists) {
mapList.add(toMap(o));
}
//然后利用csv格式，對著map嘎嘎一頓拼接資料
StringBuilder lineBuilder = new StringBuilder();
for (Map<String, Object> rowData : mapList) {
for (String key : rowData.keySet()) {
Object value = https://www.cnblogs.com/javastack/archive/2023/05/24/rowData.get(key);
if (Objects.nonNull(value)) {
lineBuilder.append(value).append(MyCsvFileUtil.CSV_DELIMITER);
} else {
lineBuilder.append("--").append(MyCsvFileUtil.CSV_DELIMITER);
}
}
lineBuilder.append(MyCsvFileUtil.CSV_TAIL);
}
return lineBuilder.toString();
}
/**
* 類轉map
* @param entity
* @param <T>
* @return
*/
public static<T> Map<String, Object> toMap(T entity){
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 methodName = "get"+field.getName().substring(0, 1).toUpperCase()+field.getName().substring(1);
Method method = bean.getDeclaredMethod(methodName);
Object fieldValue = https://www.cnblogs.com/javastack/archive/2023/05/24/method.invoke(entity);
map.put(field.getName(),fieldValue);
}
} catch (Exception e) {
log.warn("toMap() Exception={}",e.getMessage());
}
}
return map;
}
}
代碼注意點（各種小封裝）：
①類轉map
② 反射轉map 取欄位屬性名 拼接 標題
③ 針對list<不確定類>轉化成list<map>，然后拼接excel內容
測驗代碼：
@RequestMapping("/createCsvFileJcTest")
public void createCsvFileJcTest() {
//類不確定 隨便怎么傳都行
List<District> districts = districtService.queryByParentCodes(Arrays.asList("110100"));
//存放地址&檔案名
String fileName = "D:\\mycsv\\"+MyCsvFileUtil.buildCsvFileFileName(districts);
//創建表格行標題
String tableNames = MyCsvFileUtil.buildCsvFileTableNames(districts);
//創建檔案
MyCsvFileUtil.writeFile(fileName, tableNames);
//寫入資料
String contentBody = MyCsvFileUtil.buildCsvFileBodyMap(districts);
//呼叫方法生成
MyCsvFileUtil.writeFile(fileName, contentBody);
}
看看效果：
匯出的excel檔案內容：
接下來換個類玩玩：
然后匯出看看效果：
可以看到資料匯出也是OK的：
沒錯就是這么簡單， 當然也是拋轉引玉， 希望大家看了這篇文章，可以借鑒這些反射的函式玩法，做更多的好玩的封裝，比如加上一些自定義注解的決議，比如加上一些前后置攔截器拓展等等，
擴展
上面的示例中匯出的表頭是屬性名，如果正式的匯出通常需要自定義表頭名稱，我們這里可以使用自定義注解來完成，
JcExcelName.java
/**
* @Author : JCccc
* @CreateTime : 2020/5/14
* @Description :
**/
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface JcExcelName {
String name() default "";
}
然后在想匯出的類里面，想加看得懂的名字就加，不加就拿屬性名：
隨手再寫一個 ，新的反射決議拿欄位屬性注解值函式：
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();
}
測驗看看效果：
public static void main(String[] args) {
User user = new User();
List<String> nameList = MapUtils.resolveExcelTableName(user);
System.out.println(nameList.toString());
String tableNames = buildCsvFileTableNamesNew(nameList);
System.out.println(tableNames);
}
效果嘎嘎好：
然后反手就搞到我們前面的文章使用例子里面：
String tableNames = MyCsvFileUtil.buildCsvFileTableNamesNew( MyCsvFileUtil.resolveExcelTableName(dataList.get(0)));
執行一下示例介面，看看效果：
檔案出來了:
打開看看效果：
好了，就到這吧，非常完美，
來源：blog.csdn.net/qq_35387940/article/details/129062470
近期熱文推薦：
1.1,000+ 道 Java面試題及答案整理(2022最新版)
2.勁爆！Java 協程要來了，，，
3.Spring Boot 2.x 教程，太全了！
4.別再寫滿屏的爆爆爆炸類了，試試裝飾器模式，這才是優雅的方式！！
5.《Java開發手冊（嵩山版）》最新發布，速速下載！
覺得不錯，別忘了隨手點贊+轉發哦！
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/553275.html
標籤：其他
上一篇：springboot~mybatis-plus的DynamicTableNameInnerInterceptor實作分表
下一篇：返回列表