easyExcel 使用自定义注解
package com.ane56.contract.Entity; import com.alibaba.excel.annotation.ExcelProperty; import com.ane56.contract.annotation.IdcardValidate; import lombok.Data; import javax.validation.constraints.NotBlank; /** * 基础数据类 * **/ @Data public class IndexOrNameData { /** * 强制读取第三个 这里不建议 index 和 name 同时用，要么一个对象只用index，要么一个对象只用name去匹配 */ @ExcelProperty(index = 2) private Double doubleData; /** * 用名字去匹配，这里需要注意，如果名字重复，会导致只有一个字段读取到数据 */ @ExcelProperty("字符串标题") private String string; @NotBlank(message = "日期标题不能为空") @ExcelProperty("日期标题") private String date; @IdcardValidate @ExcelProperty("身份证号") private String idcard; }
package com.ane56.contract.listener; import com.alibaba.excel.context.AnalysisContext; import com.alibaba.excel.event.AnalysisEventListener; import com.alibaba.excel.metadata.property.ExcelContentProperty; import com.alibaba.excel.read.metadata.holder.ReadHolder; import com.alibaba.excel.read.metadata.holder.ReadRowHolder; import com.alibaba.excel.read.metadata.property.ExcelReadHeadProperty; import com.alibaba.fastjson.JSON; import com.ane56.contract.Entity.ExcelCellBo; import com.ane56.contract.Entity.ExcelErrorDTO; import com.ane56.contract.Entity.IndexOrNameData; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import javax.validation.ConstraintViolation; import javax.validation.Path; import javax.validation.Validation; import javax.validation.groups.Default; import java.util.*; /** * 模板的读取类 * * @author Jiaju Zhuang */ public class IndexOrNameDataListener extends AnalysisEventListener<IndexOrNameData> { private static final Logger LOGGER = LoggerFactory.getLogger(IndexOrNameDataListener.class); /** * 每隔5条存储数据库，实际使用中可以3000条，然后清理list ，方便内存回收 */ private static final int BATCH_COUNT = 5; List<IndexOrNameData> dataList = new ArrayList<IndexOrNameData>(); List<ExcelErrorDTO> errorList = new ArrayList<ExcelErrorDTO>(); boolean validateResult = true; public boolean getValidateResult(){ return validateResult; } public List<ExcelErrorDTO> getErrorList(){ return errorList; } @Override public void invoke(IndexOrNameData data, AnalysisContext context) { LOGGER.info("解析到一条数据:{}", JSON.toJSONString(data)); Map<String, ExcelCellBo> propertyNameMap = getPropertyNameMap(true,context); if (validate(data,propertyNameMap)) { dataList.add(data); } if (dataList.size() >= BATCH_COUNT) { saveData(); dataList.clear(); } } @Override public void doAfterAllAnalysed(AnalysisContext context) { saveData(); LOGGER.info("所有数据解析完成！"); } /** * 加上存储数据库 */ private void saveData() { LOGGER.info("{}条数据，开始存储数据库！", dataList.size()); LOGGER.info("存储数据库成功！"); } boolean validate(IndexOrNameData e, Map<String, ExcelCellBo> propertyNameMap) { Set<ConstraintViolation<IndexOrNameData>> validateSet = Validation.buildDefaultValidatorFactory().getValidator().validate(e, Default.class); if (validateSet != null && !validateSet.isEmpty()) { validateResult = false; ExcelErrorDTO errorDTO; for (ConstraintViolation<IndexOrNameData> constraint : validateSet) { Path propertyPath = constraint.getPropertyPath(); String propertyName = propertyPath.toString(); ExcelCellBo bo = propertyNameMap.get(propertyName); errorDTO = new ExcelErrorDTO(); errorDTO.setHeadName(bo.getHeadName()); Object invalidValue = constraint.getInvalidValue(); if (invalidValue != null) { errorDTO.setValue(invalidValue.toString()); }else { errorDTO.setValue(null); } errorDTO.setColumnIndex(bo.getColumnIndex()+1); errorDTO.setRowIndex(bo.getRowIndex()+1); errorDTO.setErrMsg("第"+errorDTO.getRowIndex()+"行,第"+errorDTO.getColumnIndex()+"列,"+constraint.getMessage()); errorList.add(errorDTO); } } return validateResult; } Map<String, ExcelCellBo> getPropertyNameMap(boolean isSingleHeader, AnalysisContext analysisContext) { Map<String, ExcelCellBo> propertyNameMap = new HashMap<>(16); ReadRowHolder readRowHolder = analysisContext.readRowHolder(); Integer rowIndex = readRowHolder.getRowIndex(); ReadHolder readHolder = analysisContext.currentReadHolder(); ExcelReadHeadProperty excelReadHeadProperty = readHolder.excelReadHeadProperty(); Collection<ExcelContentProperty> values; if (isSingleHeader) { Map<Integer, ExcelContentProperty> contentPropertyMap = excelReadHeadProperty.getContentPropertyMap(); values = contentPropertyMap.values(); } else { //也适用于单行表头 Map<String, ExcelContentProperty> fieldNameContentPropertyMap = excelReadHeadProperty.getFieldNameContentPropertyMap(); values = fieldNameContentPropertyMap.values(); } ExcelCellBo bo; for (ExcelContentProperty contentProperty : values) { bo = new ExcelCellBo(); bo.setRowIndex(rowIndex); bo.setColumnIndex(contentProperty.getHead().getColumnIndex()); bo.setFieldName(contentProperty.getHead().getFieldName()); //多行表头 bo.setHeadName(String.join(",", contentProperty.getHead().getHeadNameList())); bo.setField(contentProperty.getField()); propertyNameMap.put(contentProperty.getHead().getFieldName(), bo); } return propertyNameMap; } }
package com.ane56.contract.Entity; import lombok.Data; import java.lang.reflect.Field; @Data public class ExcelCellBo { private Field field; private String fieldName; private String headName; private Integer columnIndex; private Integer rowIndex; }
package com.ane56.contract.Entity; import lombok.Data; @Data public class ExcelErrorDTO { String headName; String value; Integer columnIndex; Integer rowIndex; String errMsg; }
package com.ane56.contract.annotation; import javax.validation.Constraint; import javax.validation.Payload; import java.lang.annotation.Retention; import java.lang.annotation.Target; import static java.lang.annotation.ElementType.FIELD; import static java.lang.annotation.RetentionPolicy.RUNTIME; @Target(FIELD) @Retention(RUNTIME) @Constraint(validatedBy = IdcardValidator.class) public @interface IdcardValidate { String message() default "身份证号不正确"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }
package com.ane56.contract.annotation; import com.ane56.contract.utils.IdCardVerification; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; import java.text.ParseException; public class IdcardValidator implements ConstraintValidator<IdcardValidate, String> { private static final Logger logger = LoggerFactory.getLogger(IdcardValidator.class); @Override public void initialize(IdcardValidate idcardValidate) { } @Override public boolean isValid(String idcard, ConstraintValidatorContext context) { String info = ""; try { info = IdCardVerification.IDCardValidate(idcard); } catch (ParseException e) { logger.error("身份证号校验异常"); } if(!"0".equals(info)){ context.disableDefaultConstraintViolation(); context.buildConstraintViolationWithTemplate(info).addConstraintViolation(); return false; } return true; } }
package com.ane56.contract.utils; import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.Calendar; import java.util.GregorianCalendar; import java.util.Hashtable; import java.util.regex.Matcher; import java.util.regex.Pattern; /** * 身份证号码的格式：610821-20061222-612-X 由18位数字组成：前6位为地址码，第7至14位为出生日期码，第15至17位为顺序码， * 第18位为校验码。检验码分别是0-10共11个数字，当检验码为“10”时，为了保证公民身份证号码18位，所以用“X”表示。虽然校验码为“X”不能更换，但若需全用数字表示，只需将18位公民身份号码转换成15位居民身份证号码，去掉第7至8位和最后1位3个数码。 * 当今的身份证号码有15位和18位之分。1985年我国实行居民身份证制度，当时签发的身份证号码是15位的，1999年签发的身份证由于年份的扩展（由两位变为四位）和末尾加了效验码，就成了18位。 * （1）前1、2位数字表示：所在省份的代码； * （2）第3、4位数字表示：所在城市的代码； * （3）第5、6位数字表示：所在区县的代码； * （4）第7~14位数字表示：出生年、月、日； * （5）第15、16位数字表示：所在地的派出所的代码； * （6）第17位数字表示性别：奇数表示男性，偶数表示女性 * （7）第18位数字是校检码：根据一定算法生成 */ public class IdCardVerification { /**身份证有效*/ public static final String VALIDITY = "0"; /**位数不足*/ public static final String LACKDIGITS = "身份证号码长度应该为15位或18位。"; /**最后一位应为数字*/ public static final String LASTOFNUMBER = "身份证15位号码都应为数字 ; 18位号码除最后一位外，都应为数字。"; /**出生日期无效*/ public static final String INVALIDBIRTH = "身份证出生日期无效。"; /**生日不在有效范围*/ public static final String INVALIDSCOPE = "身份证生日不在有效范围。"; /**月份无效*/ public static final String INVALIDMONTH = "身份证月份无效"; /**日期无效*/ public static final String INVALIDDAY = "身份证日期无效"; /**身份证地区编码错误*/ public static final String CODINGERROR = "身份证地区编码错误。"; /**身份证校验码无效*/ public static final String INVALIDCALIBRATION = "身份证校验码无效，不是合法的身份证号码"; /** * 检验身份证号码是否符合规范 * @param IDStr 身份证号码 * @return 错误信息或成功信息 */ public static String IDCardValidate(String IDStr) throws ParseException { String tipInfo = VALIDITY;// 记录错误信息 String Ai = ""; // 判断号码的长度 15位或18位 if (IDStr.length() != 15 && IDStr.length() != 18) { tipInfo = LACKDIGITS; return tipInfo; } // 18位身份证前17位位数字，如果是15位的身份证则所有号码都为数字 if (IDStr.length() == 18) { Ai = IDStr.substring(0, 17); } else if (IDStr.length() == 15) { Ai = IDStr.substring(0, 6) + "19" + IDStr.substring(6, 15); } if (isNumeric(Ai) == false) { tipInfo = LASTOFNUMBER; return tipInfo; } // 判断出生年月是否有效 String strYear = Ai.substring(6, 10);// 年份 String strMonth = Ai.substring(10, 12);// 月份 String strDay = Ai.substring(12, 14);// 日期 if (isDate(strYear + "-" + strMonth + "-" + strDay) == false) { tipInfo = INVALIDBIRTH; return tipInfo; } GregorianCalendar gc = new GregorianCalendar(); SimpleDateFormat s = new SimpleDateFormat("yyyy-MM-dd"); try { if ((gc.get(Calendar.YEAR) - Integer.parseInt(strYear)) > 150 || (gc.getTime().getTime() - s.parse(strYear + "-" + strMonth + "-" + strDay).getTime()) < 0) { tipInfo = INVALIDSCOPE; return tipInfo; } } catch (NumberFormatException e) { e.printStackTrace(); } catch (java.text.ParseException e) { e.printStackTrace(); } if (Integer.parseInt(strMonth) > 12 || Integer.parseInt(strMonth) == 0) { tipInfo = INVALIDMONTH; return tipInfo; } if (Integer.parseInt(strDay) > 31 || Integer.parseInt(strDay) == 0) { tipInfo = INVALIDDAY; return tipInfo; } // 判断地区码是否有效 Hashtable<String, String> areacode = GetAreaCode(); // 如果身份证前两位的地区码不在Hashtable，则地区码有误 if (areacode.get(Ai.substring(0, 2)) == null) { tipInfo = CODINGERROR; return tipInfo; } if (isVarifyCode(Ai, IDStr) == false) { tipInfo = INVALIDCALIBRATION; return tipInfo; } return tipInfo; } /* * 判断第18位校验码是否正确 第18位校验码的计算方式： * 1. 对前17位数字本体码加权求和 公式为：S = Sum(Ai * Wi), i = * 0, ... , 16 其中Ai表示第i个位置上的身份证号码数字值，Wi表示第i位置上的加权因子，其各位对应的值依次为： 7 9 10 5 8 4 * 2 1 6 3 7 9 10 5 8 4 2 * 2. 用11对计算结果取模 Y = mod(S, 11) * 3. 根据模的值得到对应的校验码 * 对应关系为： Y值： 0 1 2 3 4 5 6 7 8 9 10 校验码： 1 0 X 9 8 7 6 5 4 3 2 */ private static boolean isVarifyCode(String Ai, String IDStr) { String[] VarifyCode = { "1", "0", "X", "9", "8", "7", "6", "5", "4", "3", "2" }; String[] Wi = { "7", "9", "10", "5", "8", "4", "2", "1", "6", "3", "7", "9", "10", "5", "8", "4", "2" }; int sum = 0; for (int i = 0; i < 17; i++) { sum = sum + Integer.parseInt(String.valueOf(Ai.charAt(i))) * Integer.parseInt(Wi[i]); } int modValue = sum % 11; String strVerifyCode = VarifyCode[modValue]; Ai = Ai + strVerifyCode; if (IDStr.length() == 18) { if (Ai.equals(IDStr) == false) { return false; } } return true; } /** * 将所有地址编码保存在一个Hashtable中 * @return Hashtable 对象 */ private static Hashtable<String, String> GetAreaCode() { Hashtable<String, String> hashtable = new Hashtable<String, String>(); hashtable.put("11", "北京"); hashtable.put("12", "天津"); hashtable.put("13", "河北"); hashtable.put("14", "山西"); hashtable.put("15", "内蒙古"); hashtable.put("21", "辽宁"); hashtable.put("22", "吉林"); hashtable.put("23", "黑龙江"); hashtable.put("31", "上海"); hashtable.put("32", "江苏"); hashtable.put("33", "浙江"); hashtable.put("34", "安徽"); hashtable.put("35", "福建"); hashtable.put("36", "江西"); hashtable.put("37", "山东"); hashtable.put("41", "河南"); hashtable.put("42", "湖北"); hashtable.put("43", "湖南"); hashtable.put("44", "广东"); hashtable.put("45", "广西"); hashtable.put("46", "海南"); hashtable.put("50", "重庆"); hashtable.put("51", "四川"); hashtable.put("52", "贵州"); hashtable.put("53", "云南"); hashtable.put("54", "西藏"); hashtable.put("61", "陕西"); hashtable.put("62", "甘肃"); hashtable.put("63", "青海"); hashtable.put("64", "宁夏"); hashtable.put("65", "新疆"); hashtable.put("71", "台湾"); hashtable.put("81", "香港"); hashtable.put("82", "澳门"); hashtable.put("91", "国外"); return hashtable; } /** * 判断字符串是否为数字,0-9重复0次或者多次 * @param strnum * @return true, 符合; false, 不符合。 */ private static boolean isNumeric(String strnum) { Pattern pattern = Pattern.compile("[0-9]*"); Matcher isNum = pattern.matcher(strnum); if (isNum.matches()) { return true; } else { return false; } } /** * 功能：判断字符串出生日期是否符合正则表达式：包括年月日，闰年、平年和每月31天、30天和闰月的28天或者29天 * @return true, 符合; false, 不符合。 */ public static boolean isDate(String strDate) { Pattern pattern = Pattern.compile( "^((\\d{2}(([02468][048])|([13579][26]))[\\-\\/\\s]?((((0?[13578])|(1[02]))[\\-\\/\\s]?((0?[1-9])|([1-2][0-9])|(3[01])))|(((0?[469])|(11))[\\-\\/\\s]?((0?[1-9])|([1-2][0-9])|(30)))|(0?2[\\-\\/\\s]?((0?[1-9])|([1-2][0-9])))))|(\\d{2}(([02468][1235679])|([13579][01345789]))[\\-\\/\\s]?((((0?[13578])|(1[02]))[\\-\\/\\s]?((0?[1-9])|([1-2][0-9])|(3[01])))|(((0?[469])|(11))[\\-\\/\\s]?((0?[1-9])|([1-2][0-9])|(30)))|(0?2[\\-\\/\\s]?((0?[1-9])|(1[0-9])|(2[0-8]))))))?$"); Matcher m = pattern.matcher(strDate); if (m.matches()) { return true; } else { return false; } } }
IndexOrNameDataListener indexOrNameDataListener = new IndexOrNameDataListener(); EasyExcel.read(new FileInputStream("D:\\test\\hg2.xls"), IndexOrNameData.class, indexOrNameDataListener).sheet().doRead(); if(!indexOrNameDataListener.getValidateResult()){ for (ExcelErrorDTO excelErrorDTO : indexOrNameDataListener.getErrorList()){ System.out.println(excelErrorDTO.getErrMsg()); } }
