[[394532]]

最近太忙了，剛剛到家趕緊抽空趕一篇，不知道能不能幫到你。

最近在做Excel導入功能，產品要求對導入數據先進行校驗然后再入庫。于是簡單封裝了一個工具，結果兄弟們用了都說好，今天就把思路分享出來。

easyexcel 庫

我們都知道POI是Java操作Excel的基礎庫。為了通用性并沒有做定制，而且還有一些局限性。經過一番調研決定采用二次封裝庫easyexcel來進行業(yè)務開發(fā)。

<dependency> 
    <groupId>com.alibaba</groupId> 
    <artifactId>easyexcel</artifactId> 
    <version>${easyexcel.version}</version> 
</dependency> 

easyexcel將讀取Excel的生命周期抽象為了幾個階段，方便我們在各個階段注入你想要實現的邏輯。這幾個階段包含在ReadListener接口中

public interface ReadListener<T> extends Listener { 
    /** 
     * 當任何一個偵聽器執(zhí)行錯誤報告時，所有偵聽器都將接收此方法。 如果在此處引發(fā)異常，則整個讀取將終止。 
     * 這里是處理讀取excel異常的 
     * 
     * @param exception 
     * @param context 
     * @throws Exception 
     */ 
    void onException(Exception exception, AnalysisContext context) throws Exception; 
 
    /** 
     * 讀取每行excel表頭時會執(zhí)行此方法 
     * 
     * @param headMap 
     * @param context 
     */ 
    void invokeHead(Map<Integer, CellData> headMap, AnalysisContext context); 
 
    /** 
     * 讀取每行數據的時候回執(zhí)行此方法  
     * 
     * @param data 
     *            one row value. Is is same as {@link AnalysisContext#readRowHolder()} 
     * @param context 
     *            analysis context 
     */ 
    void invoke(T data, AnalysisContext context); 
 
    /** 
     * 如果有額外的單元格信息返回就用此方法處理 
     * 
     * @param extra 
     *            extra information 
     * @param context 
     *            analysis context 
     */ 
    void extra(CellExtra extra, AnalysisContext context); 
 
    /** 
     * 在整個excel sheet解析完畢后執(zhí)行的邏輯。 
     * 
     * @param context 
     */ 
    void doAfterAllAnalysed(AnalysisContext context); 
 
    /** 
     * 用來控制是否讀取下一行的策略 
     * 
     * @param context 
     * @return 
     */ 
    boolean hasNext(AnalysisContext context); 
} 

其抽象實現AnalysisEventListener提供更加符合需要的抽象，我會進一步實現這個抽象來實現Excel的導入和校驗。

在你了解一個框架的抽象接口后，盡量要去看一下它有沒有能滿足你需要的實現。

另外這里要多說一點，接口中的AnalysisContext包含了很多有用的上下文元信息，比如 當前行、當前的配置策略、excel整體結構等信息，你可以在需要的時候調用這些信息。

JSR303校驗

最開始自己寫了一個抽象的校驗工具，最后發(fā)現每一個字段都要編寫其具體的校驗邏輯，如果一個Excel的字段量爆炸，這對開發(fā)來說就可能是噩夢。這使我想到了業(yè)界已經有的規(guī)范-JSR303校驗規(guī)范，它將數據模型(Model)和校驗(Validation)各自抽象，非常靈活，而且工作量明顯降低。我們只需要找到和esayexcel生命周期結合的地方就行了。我們只需要引入以下依賴就能在Spring Boot項目中集成JSR303校驗：

<dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-starter-validation</artifactId> 
</dependency> 

關于JSR303相關的教程可以查看我這一篇文章。

實現過程

我們可以在解析每個字段的時候校驗，這對應ReadListener的invoke(T data, AnalysisContext context)方法，這種方式可以實現當字段校驗觸發(fā)約束時就停止excel解析的策略;另一種可以在Excel解析完畢后執(zhí)行校驗，對應doAfterAllAnalysed(AnalysisContext context)。這里以第二種為例我們來實現一下。

我們在編寫代碼時，盡量職責單一，一個類或者一個方法盡量只干一個事，這樣讓自己的代碼足夠清晰。

編寫校驗處理類

這里我把解析和校驗分開實現，先編寫JSR303校驗工具。這里假設已經有了校驗器javax.validation.Validator的實現，稍后我會講這個實現從哪里注入。

import cn.felord.validate.Excel; 
import lombok.AllArgsConstructor; 
import org.springframework.util.StringUtils; 
 
import javax.validation.ConstraintViolation; 
import javax.validation.Validator; 
import java.util.*; 
import java.util.stream.Collectors; 
 
/** 
 *  excel 校驗工具 
 * 
 * @param <T> the type parameter 
 * @author felord.cn 
 * @since 2021 /4/14 14:14 
 */ 
@AllArgsConstructor 
public class ExcelValidator<T> { 
 
    private final Validator validator; 
    private final Integer beginIndex; 
 
 
    /** 
     *  集合校驗 
     * 
     * @param data 待校驗的集合 
     * @return list 
     */ 
    public List<String> validate(Collection<T> data) { 
        int index = beginIndex + 1; 
        List<String> messages = new ArrayList<>(); 
        for (T datum : data) { 
            String validated = this.doValidate(index, datum); 
            if (StringUtils.hasText(validated)) { 
                messages.add(validated); 
            } 
            index++; 
        } 
        return messages; 
    } 
     
    /** 
     * 這里是校驗的根本方法 
     * 
     * @param index 本條數據所在的行號 
     * @param data 待校驗的某條數據 
     * @return 對數據的校驗異常進行提示，如果有觸發(fā)校驗規(guī)則的會封裝提示信息。 
     */ 
    private String doValidate(int index, T data) { 
        // 這里使用了JSR303的的校驗器，同時使用了分組校驗，Excel為分組標識 
        Set<ConstraintViolation<T>> validate = validator.validate(data, Excel.class); 
        return validate.size()>0 ? "第" + index + 
                "行，觸發(fā)約束：" + validate.stream() 
                .map(ConstraintViolation::getMessage) 
                .collect(Collectors.joining(",")): ""; 
    } 
} 

上面就是整個校驗的邏輯，如果校驗通過不提示任何信息，如果校驗不通過把校驗的約束信息封裝返回。這里的Validator是從哪里來的呢?當Spring Boot集成了JSR303會有一個Validator實現被自動注入Spring IoC，我們可以利用它。

實現AnalysisEventListener

這個完全是easyexcel的功能了，我們只需要實現最開始提到的Excel抽象解析監(jiān)聽器接口AnalysisEventListener，并將解析字段加入集合，等完全解析完畢后再進行校驗。這里如果校驗不通過就會拋出攜帶校驗信息的異常，異常經過處理返回前端提示。

切記：AnalysisEventListener的實現不能注入Spring IoC。

import cn.hutool.json.JSONUtil; 
import com.alibaba.excel.context.AnalysisContext; 
import com.alibaba.excel.event.AnalysisEventListener; 
import cn.felord.exception.ServiceException; 
import org.springframework.util.CollectionUtils; 
 
import java.util.ArrayList; 
import java.util.Collection; 
import java.util.List; 
import java.util.function.Consumer; 
 
/** 
 * 該類不可被Spring托管 
 * 
 * @param <T> the type parameter 
 * @author felord.cn 
 * @since 2021 /4/14 14:19 
 */ 
public class JdbcEventListener<T> extends AnalysisEventListener<T> { 
    /** 
     * Excel總條數閾值 
     */ 
    private static final Integer MAX_SIZE = 10000; 
    /** 
     * 校驗工具 
     */ 
    private final ExcelValidator<T> excelValidator; 
    /** 
     * 如果校驗通過消費解析得到的excel數據 
     */ 
    private final Consumer<Collection<T>> batchConsumer; 
    /** 
     * 解析數據的臨時存儲容器 
     */ 
    private final List<T> list = new ArrayList<>(); 
 
    /** 
     * Instantiates a new Jdbc event listener. 
     * 
     * @param excelValidator Excel校驗工具 
     * @param batchConsumer  Excel解析結果批量消費工具，可實現為寫入數據庫等消費操作 
     */ 
    public JdbcEventListener(ExcelValidator<T> excelValidator, Consumer<Collection<T>> batchConsumer) { 
        this.excelValidator = excelValidator; 
        this.batchConsumer = batchConsumer; 
    } 
 
    @Override 
    public void onException(Exception exception, AnalysisContext context) throws Exception { 
        list.clear(); 
        throw exception; 
    } 
 
    @Override 
    public void invoke(T data, AnalysisContext context) { 
        // 如果沒有超過閾值就把解析的excel字段加入集合 
        if (list.size() >= MAX_SIZE) { 
            throw new ServiceException("單次上傳條數不得超過：" + MAX_SIZE); 
        } 
        list.add(data); 
    } 
 
    @Override 
    public void doAfterAllAnalysed(AnalysisContext context) { 
        //全部解析完畢后 對集合進行校驗并消費 
        if (!CollectionUtils.isEmpty(this.list)) { 
            List<String> validated = this.excelValidator.validate(this.list); 
            if (CollectionUtils.isEmpty(validated)) { 
                this.batchConsumer.accept(this.list); 
            } else { 
                throw new ServiceException(JSONUtil.toJsonStr(validated)); 
            } 
        } 
    } 
} 

封裝最終的工具

這里參考esayexcel的文檔封裝成一個通用的Excel讀取工具

import com.alibaba.excel.EasyExcel; 
import lombok.AllArgsConstructor; 
import lombok.Data; 
 
import javax.validation.Validator; 
import java.io.InputStream; 
import java.util.Collection; 
import java.util.function.Consumer; 
 
/** 
 * excel讀取工具 
 * 
 * @author felord.cn 
 * @since 2021 /4/14 15:10 
 */ 
@AllArgsConstructor 
public class ExcelReader { 
    private final Validator validator; 
 
    /** 
     * Read Excel. 
     * 
     * @param <T>  the type parameter 
     * @param meta the meta 
     */ 
    public <T> void read(Meta<T> meta) { 
        ExcelValidator<T> excelValidator = new ExcelValidator<>(validator, meta.headRowNumber); 
        JdbcEventListener<T> readListener = new JdbcEventListener<>(excelValidator, meta.consumer); 
        EasyExcel.read(meta.excelStream, meta.domain, readListener) 
                .headRowNumber(meta.headRowNumber) 
                .sheet() 
                .doRead(); 
    } 
 
 
    /** 
     * 解析需要的元數據 
     * 
     * @param <T> the type parameter 
     */ 
    @Data 
    public static class Meta<T> { 
        /** 
         * excel 文件流 
         */ 
        private InputStream excelStream; 
        /** 
         * excel頭的行號，參考easyexcel的api和你的實際情況 
         */ 
        private Integer headRowNumber; 
        /** 
         * 對應excel封裝的數據類，需要參考easyexcel教程 
         */ 
        private Class<T> domain; 
        /** 
         * 解析結果的消費函數 
         */ 
        private Consumer<Collection<T>> consumer; 
    } 
 
} 

我們把這個工具注入Spring IoC，方便我們使用。

/** 
 * Excel 讀取工具 
 * 
 * @param validator the validator 
 * @return the excel reader 
 */ 
@Bean 
public ExcelReader excelReader(Validator validator) { 
    return new ExcelReader(validator); 
} 

編寫接口

這里Excel的數據類ExcelData就不贅述了，過于簡單!去看esayexcel的文檔即可。編寫一個Spring MVC接口示例，沒錯就是這么簡單。

@Autowired 
private  ExcelReader excelReader; 
@Autowired 
private  DataService dataService; 
 
@PostMapping("/excel/import") 
public Rest<?> importManufacturerInfo(@RequestPart MultipartFile file) throws IOException { 
    InputStream inputStream = file.getInputStream(); 
    ExcelReader.Meta<ExcelData> excelDataMeta = new ExcelReader.Meta<>(); 
    excelDataMeta.setExcelStream(inputStream); 
    excelDataMeta.setDomain(ExcelData.class); 
    excelDataMeta.setHeadRowNumber(2); 
    // 批量寫入數據庫的邏輯 
    excelDataMeta.setConsumer(dataService::saveBatch); 
    this.excelReader.read(excelDataMeta); 
    return RestBody.ok(); 
} 

總結

今天演示了如何將easyexcel和JSR303結合起來，其實原理很簡單，你只需要找到兩個技術的結合點，并把它們組合起來即可，你學到了嗎?

本文轉載自微信公眾號「碼農小胖哥」，可以通過以下二維碼關注。轉載本文請聯(lián)系碼農小胖哥公眾號。