快捷導(dǎo)航

利用反射實現(xiàn)Excel和CSV 轉(zhuǎn)換為Java對象功能

更新時間：2023年11月05日 09:18:48 作者：it鍵盤俠

將Excel或CSV文件轉(zhuǎn)換為Java對象(POJO)以及將Java對象轉(zhuǎn)換為Excel或CSV文件可能是一個復(fù)雜的過程,但如果使用正確的工具和技術(shù),這個過程就會變得十分簡單,在本文中,我們將了解如何利用一個Java反射的庫來實現(xiàn)這個功能,需要的朋友可以參考下

了解 POJO 類

在深入研究該庫之前，讓我們仔細(xì)看看作為數(shù)據(jù)模型的 Java 示例類：

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@SheetDefinition(datePattern = "dd/MM/yyyy")
public class Product {

    @CellDefinition(0)
    private String name;

    @CellDefinition(1)
    private long price;

    @CellDefinition(2)
    @CellBoolean(trueValue = "yes",falseValue = "no")
    private boolean active;

    @CellDefinition(value = 3, title = "Promo price")
    private double promoPrice;

    // Additional fields...

    @CellEnum(enumsMapperMethod = "categoryMap")
    @CellDefinition(10)
    private Category category;

    @CellDefinition(11)
    private LocalDateTime localDateTime;

    private Map<Category,String> categoryMap(){
        return Map.of(Category.A,"Formatted A",
                      Category.B,"Formatted B");
    }
}

該類Product帶有各種注釋，這些注釋在轉(zhuǎn)換過程中起著至關(guān)重要的作用。每個字段都帶有注釋@CellDefinition，指示其在Excel 或 CSV 文件中的位置。

我們還可以定義單元格的標(biāo)題，默認(rèn)情況下，它會將字段的駝峰式名稱轉(zhuǎn)換為帶空格的名稱（例如：firstName=>First name）

該@SheetDefinition注釋提供了附加信息，例如將在日期字段類型轉(zhuǎn)換期間使用的日期格式化模式。

枚舉注釋：@CellEnum(enumsMapperMethod = “categoryMap”)

在Product類中，我們使用@CellEnum枚舉 Category 字段中的注釋。enumsMapperMethod 參數(shù)允許我們定義方法名稱；此方法應(yīng)返回一個映射，該映射定義枚舉常量與 Excel/CSV 單元格中的格式化值之間的映射（轉(zhuǎn)換）（默認(rèn)情況下，將使用枚舉常量），請注意，方法名稱必須與 enumsMapperMethod 參數(shù)值相同。

[布爾注解：@CellBoolean(trueValue = “yes”,falseValue = “no”)]

在我們需要使用Boolean類型的字段中使用 @CellBoolean 注釋，它有兩個參數(shù)代表我們要在 Excel/CSV 字段中使用的格式值。

現(xiàn)在，讓我們介紹 POJO 類的更新版本ProductV2：

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@SheetDefinition(includeAllFields = true,titles={"Name","Category","Date"})
public class ProductV2 {

    private String name;

    // Additional fields...

    private Category category;

    @IgnoreCell
    private LocalDateTime localDateTime;
}

@SheetDefinition通過類中提供的注釋將字段映射到 Excel 文件中的相應(yīng)單元格，將 Excel 文件轉(zhuǎn)換為 POJO 變得更加簡單。

當(dāng) includeAllFields 參數(shù)設(shè)置為 true 時，字段將根據(jù)其聲明的順序自動包含并映射到單元格中，并忽略使用 @IgnoreCell 注釋進行注釋的字段。

我們可以在標(biāo)題參數(shù)中定義標(biāo)題，條件是它們必須與字段的順序一致。

將 Excel/CSV 轉(zhuǎn)換為 POJO

@RestController
@RequestMapping("excel/products")
public class ExcelFieldsController {
    private final ExcelHelper<Product> excelHelper = ExcelHelper.create(Product.class);

    @GetMapping
    public List<Product> excelToProducts(@RequestBody MultipartFile file){
        return excelHelper.toStream(file.getInputStream()).toList();
    }

       @GetMapping("/download")
    public ResponseEntity<InputStreamResource>
    downloadExcelFromProducts() {
        String filename = "products-" + LocalDate.now() + ".xlsx";
        InputStreamResource file = new InputStreamResource(excelHelper.toExcel(getProducts()));
        return ResponseEntity.ok()
                .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=" + filename)
                .contentType(MediaType.parseMediaType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"))
                .body(file);
    }
}

這同樣適用于轉(zhuǎn)換 CSV 文件，只是我們需要定義將使用的分隔符

    private final CsvHelper<ProductV2> csvHelper = CsvHelper.create(ProductV2.class,";");

ReflectionUtil：動態(tài)檢驗類

ReflectionUtil 類是該 Java 庫的支柱，通過 Java 反射的強大功能促進動態(tài)類檢查和操作。ReflectionUtil 類的一個顯著特點是為提高性能而進行的優(yōu)化。在初始化過程中，所有的get、set和字段都會被快速加載并封裝在 SheetField 中。這種有意識的操作最大限度地減少了后續(xù)操作中的反射查找需求，提高了整體效率。