溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務條款》

Java中如何利用POI優(yōu)雅的導出Excel文件

發(fā)布時間:2020-07-23 11:03:42 來源:億速云 閱讀:281 作者:小豬 欄目:編程語言

這篇文章主要講解了Java中如何利用POI優(yōu)雅的導出Excel文件,內(nèi)容清晰明了,對此有興趣的小伙伴可以學習一下,相信大家閱讀完之后會有幫助。

前言

故事是這樣開始的: 公司給排了幾天的工期,讓完成 2 個功能模塊的開發(fā)。其中有一個場景是這樣的,從 Excel 導入數(shù)據(jù),要求數(shù)據(jù)不能重復。用戶可以下載導入失敗的 Excel 文件。

這樣就有 2 種實現(xiàn)

  • 將失敗數(shù)據(jù)存儲數(shù)據(jù)庫,需要下載時生成 Excel 下載即可
  • 將失敗數(shù)據(jù)生成 Excel 文件存儲文件服務器,然后返回下載鏈接

老大要求按方案二進行。好吧,導出 Excel 是再常見不過的功能了,然而總是覺得以前寫的不夠優(yōu)雅,所以決定進行簡單的封裝,以適應簡單場景的 Excel 導出。

實現(xiàn)

Excel 導出的數(shù)據(jù)源一般是數(shù)據(jù)庫中查詢的數(shù)據(jù)。在 Java 開發(fā)這種面向?qū)ο蟮脑O計中,數(shù)據(jù)一般都是以對象為載體,填充在集合中的。所以入?yún)⒅槐阍O計為 Collection 集合類。

導出的 Excel 一般需要表頭說明每列數(shù)據(jù)的含義,這里計劃用注解+反射來進行定義。Excel 無論是通過 HttpServletResponse 還是 File 存儲,本質(zhì)上都是 IO 流操作。

具體實現(xiàn)如下:

pom.xml

  <dependency>
   <groupId>org.apache.poi</groupId>
   <artifactId>poi-ooxml</artifactId>
   <version>4.1.2</version>
  </dependency>

注解定義

該注解添加在字段上,標識哪些字段需要導出到 Excel,并且添加表頭說明。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExcelHeader {

 /**
  * 表頭
  * @return
  */
 String value() default "";

 /**
  * 列索引
  * @return
  */
 int columnIndex() default 0;
}

實體類

以下實體類中根據(jù)注解可知,age 字段不需要導出到 Excel。

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {

 @ExcelHeader(value = "賬號")
 private String username;

 @ExcelHeader(value = "密碼")
 private String password;

 @ExcelHeader(value = "生日")
 @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
 @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
 private LocalDateTime birthday;

 // 該字段沒有添加注解, Excel不導出
 private Integer age;

 public User(String username, String password, LocalDateTime birthday) {
  this.username = username;
  this.password = password;
  this.birthday = birthday;
 }
}

單元測試

注釋已經(jīng)足夠清晰,這里不再過多復述。

@Slf4j
class IdcPoiApplicationTests {

 @Test
 void contextLoads() throws NoSuchFieldException, IllegalAccessException, IOException {
  // 創(chuàng)建模擬數(shù)據(jù)
  User user1 = new User("admin", "123456", LocalDateTime.now());
  User user2 = new User("test", "123456", LocalDateTime.now());
  List<User> users = Arrays.asList(user1, user2);

  // 文件路徑
  String basePath = "/Users/cuishiying/Documents/spring-cloud-learning/idc-poi/oss/";
  String fileName = new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()).toString() +".xls";

  // 將Excel寫入文件
  HSSFWorkbook workbook = exportExcel(users, User.class);
  workbook.setSheetName(0,"sheetName");//設置sheet的Name

  // 無論是通過HttpServletResponse導出還是導出到本地磁盤,本質(zhì)都是IO操作,所以這里將IO操作提取到外層。
  workbook.write(new File(basePath + File.separator + fileName));
 }

 /**
  *
  * @param data 需要導出的數(shù)據(jù)
  * @param clz 數(shù)據(jù)對應的實體類
  * @param <T> 泛型
  * @return Excel文件
  * @throws NoSuchFieldException
  * @throws IllegalAccessException
  */
 public <T> HSSFWorkbook exportExcel(List<T> data, Class<T> clz) throws NoSuchFieldException, IllegalAccessException {

  Field[] fields = clz.getDeclaredFields();
  List<String> headers = new LinkedList<>();
  List<String> variables = new LinkedList<>();

  // 創(chuàng)建工作薄對象
  HSSFWorkbook workbook=new HSSFWorkbook();//這里也可以設置sheet的Name
  // 創(chuàng)建工作表對象
  HSSFSheet sheet = workbook.createSheet();
  // 創(chuàng)建表頭
  Row rowHeader = sheet.createRow(0);

  // 表頭處理
  for (int h = 0; h < fields.length; h++) {
   Field field = fields[h];
   if (field.isAnnotationPresent(ExcelHeader.class)) {
    // 表頭
    ExcelHeader annotation = field.getAnnotation(ExcelHeader.class);
    headers.add(annotation.value());
    rowHeader.createCell(h).setCellValue(annotation.value());

    // 字段
    variables.add(field.getName());
   }
  }

  // 數(shù)據(jù)處理
  for (int i = 0; i < data.size() ; i++) {

   //創(chuàng)建工作表的行(表頭占用1行, 這里從第二行開始)
   HSSFRow row = sheet.createRow(i + 1);
   // 獲取一行數(shù)據(jù)
   T t = data.get(i);
   Class<&#63;> aClass = t.getClass();
   // 填充列數(shù)據(jù)
   for (int j = 0; j < variables.size(); j++) {

    Field declaredField = aClass.getDeclaredField(variables.get(j));
    declaredField.setAccessible(true);

    String key = declaredField.getName();
    Object value = declaredField.get(t);

    row.createCell(j).setCellValue(value.toString());
   }
  }
  log.info("Excel文件創(chuàng)建成功");
  return workbook;
 }
}

看完上述內(nèi)容,是不是對Java中如何利用POI優(yōu)雅的導出Excel文件有進一步的了解,如果還想學習更多內(nèi)容,歡迎關(guān)注億速云行業(yè)資訊頻道。

向AI問一下細節(jié)

免責聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI