使用Java實(shí)現(xiàn)Excel導(dǎo)入并進(jìn)行數(shù)據(jù)校驗(yàn)

更新時(shí)間：2025年03月04日 09:59:14 作者：Javaの甘乃迪

這篇文章主要為大家詳細(xì)介紹了Java如何根據(jù)下載的指定數(shù)據(jù)模板寫入數(shù)據(jù)和導(dǎo)入并進(jìn)行數(shù)據(jù)校驗(yàn),文中的示例代碼講解詳細(xì),需要的可以了解下

一、產(chǎn)品需求

1.下載指定的excel數(shù)據(jù)模板

2.excel模板寫入數(shù)據(jù)并導(dǎo)入

3.導(dǎo)入的時(shí)候根據(jù)校驗(yàn)規(guī)則進(jìn)行篩選，導(dǎo)入成功的返回成功列表，數(shù)據(jù)存在問題的返回失敗列表，失敗列表支持?jǐn)?shù)據(jù)編輯修正

看到需求的第一眼，可能就覺得第三點(diǎn)有點(diǎn)難度，我們知道，傳統(tǒng)的數(shù)據(jù)校驗(yàn)可以通過在傳輸對象dto上面加注解實(shí)現(xiàn)。

//第一種
public Result test1(@RequestBody @Validated TestDTO dto) {...}
 
//第二種
public Result test2(@RequestBody @Valid TestDTO dto{...}
//第三種
public Result test3(@RequestBody @Validated(value = {SaveGroup.class}) TestDTO dto) {...}

TestDTO里面會(huì)有一些類似 @NotNull、@NotBlank、@Size等校驗(yàn)注解，這里就不列了。

然后在全局異常攔截那里進(jìn)行統(tǒng)一封裝，使其返回的數(shù)據(jù)結(jié)構(gòu)盡量保持統(tǒng)一，所以一般還得有一個(gè)RestExceptionHandler類。

@ControllerAdvice
public class RestExceptionHandler {
 
    /**
     * 處理參數(shù)驗(yàn)證失敗異常
     * @param e
     * @return
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.OK)
    private Response<?> methodArgumentNotValidException(MethodArgumentNotValidException e) {
        log.warn("MethodArgumentNotValidException", e);
        FieldError fieldError = e.getBindingResult().getFieldError();
        return ResponseUtils.create(CommonCodeEnum.VALIDATE_ERROR.getCode(), CommonCodeEnum.VALIDATE_ERROR.getMessage(), fieldError.getDefaultMessage());
    }
}

講到常見的數(shù)據(jù)校驗(yàn)，那么我們畫風(fēng)一轉(zhuǎn)，再回來看需求，可見以上是不滿足需求的，首先，我們的入?yún)⑹且粋€(gè)文件流（指定的Excel模板文件），我們得先解析文件再進(jìn)行數(shù)據(jù)校驗(yàn)，合法的放一個(gè)集合，不合法的放另一個(gè)集合；再者，即使入?yún)⑹且粋€(gè)數(shù)組，這種校驗(yàn)一旦不滿足立馬進(jìn)異常處理了，無法返回給前端正確的數(shù)據(jù)結(jié)構(gòu)，所以今天就分享解決這類需求的解決方案。

二、解決方法

基礎(chǔ)數(shù)據(jù)

UserExcelVO

import lombok.Data;
 
import java.util.List;
 
/**
 *
 */
@Data
public class UserExcelVO {
 
    /**
     * 成功列表
     */
    private List<UserExcel> success;
 
    /**
     * 失敗列表
     */
    private List<UserExcel> fail;
}

UserExcel

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
 
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import java.io.Serializable;
 
/**
 *
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserExcel implements Serializable {
 
    @NotBlank(message = "手機(jī)號(hào)不能為空")
    @Size(max = 4)
    @ExcelProperty(value = "用戶名", index = 0)
    private String name;
 
    @ExcelProperty(value = "年齡", index = 1)
    private Integer age;
 
    @Pattern(regexp = "^[1][3,4,5,7,8][0-9]{9}$$", message = "手機(jī)號(hào)不合法")
    @NotBlank(message = "手機(jī)號(hào)不能為空")
    @ExcelProperty(value = "手機(jī)號(hào)", index = 2)
    private String mobile;
 
    @ExcelProperty(value = "性別", index = 3)
    private String sex;
 
}

excel模板數(shù)據(jù)：

方案一：大量if-else判斷校驗(yàn)

import com.alibaba.excel.EasyExcel;
import org.apache.commons.lang3.StringUtils;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
 
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
 
/**
 *
 */
@RestController
@RequestMapping("/excel")
public class ExcelController {
 
    @PostMapping("/importExcel1")
    public UserExcelVO importExcel(@RequestParam("file") MultipartFile file) {
        List<UserExcel> list;
        List<UserExcel> fail = new ArrayList<>();
        UserExcelVO userExcelVO = new UserExcelVO();
        String mobileReg = "^[1][3,4,5,7,8][0-9]{9}$";
        try {
            list = EasyExcel.read(file.getInputStream(), UserExcel.class, new ModelExcelListener()).sheet().doReadSync();
 
            list.forEach(data -> {
                // 處理姓名的校驗(yàn)
                if (StringUtils.isEmpty(data.getName()) || data.getName().length() > 4) {
                    fail.add(data);
                    return;
                }
                // 處理手機(jī)號(hào)的校驗(yàn)
                if (StringUtils.isEmpty(data.getMobile()) || !data.getMobile().matches(mobileReg)) {
                    fail.add(data);
                    return;
                }
                // 以下根據(jù)字段多少可能有n個(gè)if...
 
            });
            userExcelVO.setFail(fail);
            list.removeAll(fail);
            userExcelVO.setSuccess(list);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return userExcelVO;
    }
 
}

方案二：請求體加入注解進(jìn)行校驗(yàn)

實(shí)際的業(yè)務(wù)場景，一個(gè)excel里面假如是訂單數(shù)據(jù)，最少是幾十個(gè)字段起步的，難道要寫幾十個(gè)if else嗎？方案一明顯是不合理的，因此使用注解的方式幫我們解決。

ValidationUtils

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
 
/**
 *
 */
public class ValidationUtils {
 
    public static Validator getValidator() {
        return validator;
    }
 
    static Validator validator;
 
    static {
        ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
        validator = validatorFactory.getValidator();
    }
 
}

ModelExcelListener

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import lombok.extern.slf4j.Slf4j;
 
import java.util.ArrayList;
import java.util.List;
 
/**
 *
 */
@Slf4j
public class ModelExcelListener extends AnalysisEventListener<UserExcel> {
 
    private List<UserExcel> datas = new ArrayList<>();
 
    /**
     * 通過 AnalysisContext 對象還可以獲取當(dāng)前 sheet，當(dāng)前行等數(shù)據(jù)
     */
    @Override
    public void invoke(UserExcel data, AnalysisContext context) {
        //數(shù)據(jù)存儲(chǔ)到list，供批量處理，或后續(xù)自己業(yè)務(wù)邏輯處理。
        log.info("讀取到數(shù)據(jù){}",data);
        datas.add(data);
        //根據(jù)業(yè)務(wù)自行處理，可以寫入數(shù)據(jù)庫等等
 
    }
 
    //所有的數(shù)據(jù)解析完了調(diào)用
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        log.info("所有數(shù)據(jù)解析完成");
    }
 
}

請求：

import com.alibaba.excel.EasyExcel;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
 
import javax.validation.ConstraintViolation;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
 
/**
 *
 */
@RestController
@RequestMapping("/excel")
public class ExcelController {
 
    @PostMapping("/importExcel2")
    public UserExcelVO importExcelV2(@RequestParam("file") MultipartFile file) {
        List<UserExcel> list;
        List<UserExcel> fail = new ArrayList<>();
        UserExcelVO userExcelVO = new UserExcelVO();
        try {
            list = EasyExcel.read(file.getInputStream(), UserExcel.class, new ModelExcelListener()).sheet().doReadSync();
            list.forEach(data -> {
                Set<ConstraintViolation<UserExcel>> violations = ValidationUtils.getValidator().validate(data);
                if (violations.size() > 0) {
                    fail.add(data);
                }
            });
            userExcelVO.setFail(fail);
            list.removeAll(fail);
            userExcelVO.setSuccess(list);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return userExcelVO;
    }
 
}

三、測試結(jié)果

方案一的結(jié)果：

{
    "success": [
        {
            "name": "張2",
            "age": 19,
            "mobile": "13056781235",
            "sex": "女"
        },
        {
            "name": "張3",
            "age": 20,
            "mobile": "13056781236",
            "sex": "男"
        },
        {
            "name": "張4",
            "age": 21,
            "mobile": "13056781237",
            "sex": "女"
        },
        {
            "name": "張5",
            "age": 22,
            "mobile": "13056781238",
            "sex": "男"
        },
        {
            "name": "張6",
            "age": 23,
            "mobile": "13056781239",
            "sex": "男"
        },
        {
            "name": "張7",
            "age": 24,
            "mobile": "13056781240",
            "sex": "男"
        },
        {
            "name": "張8",
            "age": 25,
            "mobile": "13056781241",
            "sex": "男"
        },
        {
            "name": "張9",
            "age": 26,
            "mobile": "13056781242",
            "sex": "男"
        }
    ],
    "fail": [
        {
            "name": "張1",
            "age": 18,
            "mobile": "3056781234",
            "sex": "男"
        },
        {
            "name": "張10",
            "age": 27,
            "mobile": "130567812436",
            "sex": "男"
        }
    ]
}

方案二的結(jié)果：

{
    "success": [
        {
            "name": "張2",
            "age": 19,
            "mobile": "13056781235",
            "sex": "女"
        },
        {
            "name": "張3",
            "age": 20,
            "mobile": "13056781236",
            "sex": "男"
        },
        {
            "name": "張4",
            "age": 21,
            "mobile": "13056781237",
            "sex": "女"
        },
        {
            "name": "張5",
            "age": 22,
            "mobile": "13056781238",
            "sex": "男"
        },
        {
            "name": "張6",
            "age": 23,
            "mobile": "13056781239",
            "sex": "男"
        },
        {
            "name": "張7",
            "age": 24,
            "mobile": "13056781240",
            "sex": "男"
        },
        {
            "name": "張8",
            "age": 25,
            "mobile": "13056781241",
            "sex": "男"
        },
        {
            "name": "張9",
            "age": 26,
            "mobile": "13056781242",
            "sex": "男"
        }
    ],
    "fail": [
        {
            "name": "張1",
            "age": 18,
            "mobile": "3056781234",
            "sex": "男"
        },
        {
            "name": "張10",
            "age": 27,
            "mobile": "130567812436",
            "sex": "男"
        }
    ]
}

發(fā)現(xiàn)兩種方案的測試結(jié)果雖然是一樣的，但是很明顯，方案二更優(yōu)秀。我們后續(xù)寫代碼的時(shí)候，除了做功能，也要考慮代碼的擴(kuò)展性，不然產(chǎn)品說加個(gè)功能，我們又得吭哧吭哧寫代碼了。

以上就是使用Java實(shí)現(xiàn)Excel導(dǎo)入并進(jìn)行數(shù)據(jù)校驗(yàn)的詳細(xì)內(nèi)容，更多關(guān)于Java Excel導(dǎo)入與數(shù)據(jù)校驗(yàn)的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: