亚洲乱码中文字幕综合,中国熟女仑乱hd,亚洲精品乱拍国产一区二区三区,一本大道卡一卡二卡三乱码全集资源,又粗又黄又硬又爽的免费视频

Spring?Boot項目如何優(yōu)雅實現(xiàn)Excel導入與導出功能

 更新時間:2022年06月10日 16:47:40   作者:大鵬cool  
在我們平時工作中經(jīng)常會遇到要操作Excel的功能,比如導出個用戶信息或者訂單信息的Excel報表,下面這篇文章主要給大家介紹了關于Spring?Boot項目中如何優(yōu)雅實現(xiàn)Excel導入與導出功能的相關資料,需要的朋友可以參考下

背景

Excel 導入與導出是項目中經(jīng)常用到的功能,在 Java 中常用 poi 實現(xiàn) Excel 的導入與導出。由于 poi 占用內(nèi)存較大,在高并發(fā)下很容易發(fā)生 OOM 或者頻繁 fullgc,阿里基于 poi 開源了 EasyExcel 項目。

除了節(jié)約內(nèi)存,EasyExcel 還簡化了 API,通過注解映射 Excel 單元格與對象字段之間的關系,簡單的幾行代碼就能搞定復雜的導入導出功能了。

EasyExcel 問題

看似一切美好,不過經(jīng)常做 Excel 導入與導出就會發(fā)現(xiàn),EasyExcel 還是沒那么完美的。

首先,導入與導出 Excel 本質(zhì)是上將 Excel 文件內(nèi)容與 Java 對象之間做一個映射,EasyExcel 做的只是在這兩者之間轉(zhuǎn)換。如果項目中的 Excel 導入與導出功能比較多,會產(chǎn)生大量的樣板式代碼,使用體驗類似于 JDBC。

另外,導入往往還伴隨著校驗,這是 EasyExcel 沒有支持的功能。如果需要校驗,要么寫代碼手動判斷,要么調(diào)用 Java Validation 規(guī)范 定義的 API 判斷,這又會產(chǎn)生大量樣板式代碼。

而且,當前 spring boot 已經(jīng)成了必備的 Java 開發(fā)框架,easyexcel 也沒有進行整合。

分析與解決

導入與導出通常發(fā)生在 Web 環(huán)境,對于 Spring MVC 來說,可以將請求信息轉(zhuǎn)換為任意類型的 contoller 方法參數(shù),將 controller 方法返回值轉(zhuǎn)換為客戶端支持的內(nèi)容。

如果能夠使用自定義的 controller 方法參數(shù)接收 Excel 文件內(nèi)容,將 controller 方法返回值轉(zhuǎn)換為 Excel 文件響應,可以直接消除 Excel 導入與導出時的樣板式代碼。

另外在將請求內(nèi)容轉(zhuǎn)換為 controller 方法參數(shù)時還可以加入自定義的校驗邏輯。

由于 Excel 導入與導出樣板式代碼、校驗問題與具體的業(yè)務邏輯無關,可以單獨抽象出來,我這里在 EasyExcel 的基礎上封裝了一個 easyexcel-spring-boot-starter 的項目,大大降低了 EasyExcel 上手的門檻,對用戶來說只需要使用 EasyExcel 定義的注解提供映射關系就可以了,適用于簡單場景的導入導出。

項目代碼已上傳 github easyexcel-spring-boot-starter 倉庫,點擊鏈接即可查閱。下面就來看看怎樣使用吧。

Spring Boot Excel 導入與導出

依賴引入

首先需要引入依賴,坐標如下。

<dependency>
    <groupId>com.zzuhkp</groupId>
    <artifactId>easyexcel-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

不過很不幸的是目前還沒傳至中央倉庫,需要的小伙伴可自行上傳到私有倉庫或直接把代碼嵌入自己的項目。

Excel 導入

首先看下要導入的 Excel 內(nèi)容吧。

為了接收 Excel 文件內(nèi)容,我們需要定義一個對應的 Model 類。

@Data
public class DemoData {
    @ExcelProperty(index = 0)
    private Integer integer;

    @ExcelProperty(index = 1)
    private String string;

    @ExcelProperty(index = 2)
    private Date date;
}

基本導入功能

然后使用 List<T> 參數(shù)接收即可。

@PostMapping("/list/obj")
public List<DemoData> listObj(@ExcelParam List<DemoData> list) {
    return list;
}

注意參數(shù)前添加了 @ExcelParam 注解,用來標識 Excel 文件參數(shù)。這樣,一個導入功能實現(xiàn)了,是不是很簡單呢?

默認情況下接收名稱為 file 的表單字段作為 Excel 文件,如果不滿足還可以修改。

@ExcelParam(value = "file", required = true)

進階導入功能

有時候,我們可能比較關心對象對應 Excel 的元數(shù)據(jù),例如這個對象是第幾行記錄產(chǎn)生的,這個對象的字段對應 Excel 第幾列,這個時候我們可以使用 ReadRows<T> 參數(shù)接收 Excel。

@PostMapping("/list/rows")
public ReadRows<DemoData> readRows(@ExcelParam ReadRows<DemoData> readRows) {
    return readRows;
}

ReadRows 使用兩個字段記錄行映射關系與列映射關系。

public class ReadRows<T> {

    private ExcelReadHeadProperty excelReadHeadProperty;

    private List<ReadRow<T>> rows;
}

ExcelReadHeadProperty 是 EasyExcel 自帶的類,表示列映射關系的元數(shù)據(jù)。ReadRow 是框架自定義的類,表示行映射關系的元數(shù)據(jù)。

看下 ReadRow 定義吧。

public class ReadRow<T> {

    // 行索引,從 0 開始
    private final Integer rowIndex;

    // 行記錄對應對象
    private final T data;
}

使用 ExcelReadHeadProperty 獲取字段對應列索引的示例代碼如下。

// 對象字段名稱 -> 從 0 開始的列索引
Map<String, Integer> fieldColumnIndexMap = readRows.getExcelReadHeadProperty().getHeadMap().values()
        .stream().collect(Collectors.toMap(Head::getFieldName, Head::getColumnIndex));

Excel 導出

這里對 Excel 的導出進行了簡單的支持。將 List<T> 定義為 controller 方法返回值即可。

@ExcelResponse
@GetMapping("/list/download")
public List<DemoData> downloadList() {
    return Arrays.asList(new DemoData(1, "hello", new Date()), new DemoData(2, "excel", new Date()));
}

需要注意的是使用 @ExcelResponse 注解表示響應內(nèi)容為 Excel 文件。默認情況,下載的文件名稱為 default.xlxs,寫入到名稱為 Sheet1 的工作表中。如果不滿足需求可以修改。

@ExcelResponse(fileName = "測試文件", sheetName = "工作表1")

Excel 導入?yún)?shù)校驗

參數(shù)校驗是 Excel 導入常用的功能,這里進行了強有力的支持,使用體驗如原生 spring boot 校驗般順滑。

開啟校驗

與 spring boot 原生使用方式一樣,將 @Validated@Valid 注解添加到 @ExcelParam 參數(shù)上即可。

@PostMapping("/list/obj")
public List<DemoData> listObj(@ExcelParam @Validated List<DemoData> list) {
    return list;
}

校驗規(guī)則定義

Bean Validation 定義校驗規(guī)則

默認情況下框架使用 JSR-303 Bean Validation 規(guī)范定義的校驗注解校驗,需要手動引入 spring-boot-starter-validation,可通過設置環(huán)境變量 easyexcel.validator.default.enable=false 關閉。

@Data
public class DemoData {
    @NotNull(message = "參數(shù)不能為空")
    private Integer integer;

    private String string;

    private Date date;
}

另外還可以自定義注解對對象校驗。

... 省略其他元注解
@Constraint(validatedBy = {DemoDataValid.DemoDataValidator.class})
public @interface DemoDataValid {
		... 省略注解屬性
		
    class DemoDataValidator implements ConstraintValidator<DemoDataValid, DemoData> {

        @Override
        public boolean isValid(DemoData value, ConstraintValidatorContext context) {
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate("測試對象校驗").addConstraintViolation();
            return false;
        }
    }
}
@DemoDataValid
public class DemoData {
    ... 省略屬性
}

ExcelValidator 接口定義校驗規(guī)則

Bean Validation 注解只能校驗單個字段或?qū)ο?,如果需要對所有的對象進行校驗,可以實現(xiàn)框架定義的 ExcelValidator 接口,然后將實現(xiàn)定義為 Spring Bean。

這個接口定義如下。

public interface ExcelValidator<T> {
    ExcelValidErrors validate(ReadRows<T> readRows);
}

ExcelValidErrors 用于接收校驗的錯誤信息,分別使用接口 ExcelValidObjectErrorExcelValidFieldError 接口定義行錯誤信息和單元格錯誤信息。

public class ExcelValidErrors {
	// 行錯誤信息或單元格錯誤信息列表
    private final List<ExcelValidObjectError> errors;
}

public interface ExcelValidObjectError {
    // 獲取行號,從 1 開始
    Integer getRow();

    // 獲取錯誤消息
    String getMessage();
}

public interface ExcelValidFieldError extends ExcelValidObjectError {
    // 獲取列,從 1 開始
    Integer getColumn();
}

例如,如果需要對所有的 DemoData 校驗 integer 字段的值不能重復,可以使用如下的代碼。

@Component
public class CustomExcelValidator implements ExcelValidator<DemoData> {
    @Override
    public ExcelValidErrors validate(ReadRows<DemoData> readRows) {
        ExcelValidErrors errors = new ExcelValidErrors();

        Map<Integer, List<ReadRow<DemoData>>> group = readRows.getRows().stream()
                .collect(Collectors.groupingBy(item -> item.getData().getInteger()));

        for (Map.Entry<Integer, List<ReadRow<DemoData>>> entry : group.entrySet()) {
            if (entry.getValue().size() > 1) {
                for (ReadRow<DemoData> readRow : entry.getValue()) {
                    errors.addError(new DefaultExcelObjectError(readRow.getRowIndex() + 1, "參數(shù)重復"));
                }
            }
        }
        return errors;
    }
}

校驗結(jié)果接收

與 Spring MVC 設計類似,這里也提供了兩種接收校驗結(jié)果的方式。

異常捕獲接收校驗結(jié)果

開啟校驗后,如果校驗結(jié)果中包含錯誤,會將錯誤信息封裝到 ExcelValidException,并拋出異常,可以通過全局異常捕獲的方式收集錯誤信息。

@RestControllerAdvice
public class GlobalExceptionControllerAdvice {
    @ExceptionHandler(ExcelValidException.class)
    public String handleException(ExcelValidException e) {
        ExcelValidErrors errors = e.getErrors();
        return JSON.toJSONString(errors);
    }
}

controller 方法參數(shù)接收校驗結(jié)果

如果不想通過異常捕獲的方式接收校驗的錯誤信息,還可以將錯誤信息添加到 @ExcelParam 參數(shù)的后面,示例代碼如下。

@PostMapping("/list/obj")
public List<DemoData> listObj(@ExcelParam @Validated List<DemoData> list, ExcelValidErrors errors) {
    if (errors.hasErrors()) {
        String messages = errors.getAllErrors().stream().map(ExcelValidObjectError::getMessage).collect(Collectors.joining(" | "));
        throw new RuntimeException("發(fā)現(xiàn)異常:" + messages);
    }
    return list;
}

總結(jié)

easyexcel-spring-boot-starter 綜合應用了前面文章介紹的各種 Spring 知識,代碼量并不大,對實現(xiàn)感興趣的小伙伴可自行查閱代碼。由于這個框架是把 Excel 中所有的行數(shù)據(jù)收集到內(nèi)存,因此只適合一些比較簡單的場景。

到此這篇關于Spring Boot項目如何優(yōu)雅實現(xiàn)Excel導入與導出功能的文章就介紹到這了,更多相關SpringBoot實現(xiàn)Excel導入導出內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!

相關文章

  • SpringCloudAlibaba分布式組件詳解

    SpringCloudAlibaba分布式組件詳解

    這篇文章主要介紹了簡單了解Spring Cloud Alibaba分布式組件相關知識,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
    2021-08-08
  • Springboot使用RestTemplate調(diào)用第三方接口的操作代碼

    Springboot使用RestTemplate調(diào)用第三方接口的操作代碼

    這篇文章主要介紹了Springboot使用RestTemplate調(diào)用第三方接口,我只演示了最常使用的請求方式get、post的簡單使用方法,當然RestTemplate的功能還有很多,感興趣的朋友可以參考RestTemplate源碼
    2022-12-12
  • SpringBoot中如何啟動Tomcat流程

    SpringBoot中如何啟動Tomcat流程

    這篇文章主要介紹了SpringBoot中如何啟動Tomcat流程,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧
    2019-05-05
  • Java輕量級權(quán)限認證框架Sa-Token的使用

    Java輕量級權(quán)限認證框架Sa-Token的使用

    Sa-Token是一個輕量級Java權(quán)限認證框架,本文就詳細的來介紹一下Java輕量級權(quán)限認證框架Sa-Token的使用,主要解決:登錄認證、權(quán)限認證、Session會話、單點登錄、OAuth2.0、微服務網(wǎng)關鑒權(quán)等,感興趣的可以了解一下
    2022-03-03
  • Java+Swing實現(xiàn)醫(yī)院管理系統(tǒng)的完整代碼

    Java+Swing實現(xiàn)醫(yī)院管理系統(tǒng)的完整代碼

    這篇文章主要介紹了Java+Swing實現(xiàn)醫(yī)院管理系統(tǒng)的完整代碼,代碼簡單易懂,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下
    2021-05-05
  • 在Java中如何決定使用 HashMap 還是 TreeMap

    在Java中如何決定使用 HashMap 還是 TreeMap

    這篇文章主要介紹了在Java中如何決定使用 HashMap 還是 TreeMap,很多朋友對這樣的問題很迷茫,下面小編給大家?guī)硪黄恼聨椭蠹伊私猓枰呐笥芽梢詤⒖枷?/div> 2019-10-10
  • Java中的ReentrantLock解讀

    Java中的ReentrantLock解讀

    這篇文章主要介紹了Java中的ReentrantLock解讀,ReentantLock是java中重入鎖的實現(xiàn),一次只能有一個線程來持有鎖,包含三個內(nèi)部類,Sync、NonFairSync、FairSync,需要的朋友可以參考下
    2023-09-09
  • Java中從JSON轉(zhuǎn)Java實體的多種方法詳解

    Java中從JSON轉(zhuǎn)Java實體的多種方法詳解

    在現(xiàn)在的日常開發(fā)中不管前端還是后端,JSON 格式的數(shù)據(jù)是用得比較多的,甚至可以說無處不在,這篇文章主要給大家介紹了關于Java中從JSON轉(zhuǎn)Java實體的多種方法,需要的朋友可以參考下
    2023-12-12
  • java二維數(shù)組遍歷的2種代碼

    java二維數(shù)組遍歷的2種代碼

    這篇文章主要介紹了java二維數(shù)組遍歷的2種代碼,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
    2019-07-07
  • Java畢業(yè)設計實戰(zhàn)之養(yǎng)老院管理系統(tǒng)的實現(xiàn)

    Java畢業(yè)設計實戰(zhàn)之養(yǎng)老院管理系統(tǒng)的實現(xiàn)

    讀萬卷書不如行萬里路,只學書上的理論是遠遠不夠的,只有在實戰(zhàn)中才能獲得能力的提升,本篇文章手把手帶你用java+SSM+JSP+Easyui+maven+mysql實現(xiàn)一個養(yǎng)老院管理系統(tǒng),大家可以在過程中查缺補漏,提升水平
    2022-03-03

最新評論