首页
/ JeecgBoot项目中Excel导入校验的实现方法解析

JeecgBoot项目中Excel导入校验的实现方法解析

2025-05-02 12:56:49作者:仰钰奇

在JeecgBoot项目开发过程中,Excel数据导入是一个常见的功能需求。本文将详细介绍如何在JeecgBoot 3.7.4版本中实现Excel导入数据的校验功能,帮助开发者解决实际项目中遇到的数据验证问题。

Excel导入校验的重要性

在企业级应用开发中,Excel导入功能经常用于批量数据录入。然而,原始数据可能存在各种问题:

  • 数据格式不符合要求
  • 必填字段为空
  • 数据违反业务规则
  • 与现有数据冲突

因此,在数据真正入库前进行严格的校验至关重要,可以避免脏数据污染系统,保证数据质量。

JeecgBoot中的Excel导入校验实现

JeecgBoot基于AutoPoi库实现Excel导入功能。在3.7.4版本中,虽然AutoPoi 1.4.11缺少IExcelModel和IExcelDataModel等接口,但项目提供了替代的校验方案。

核心实现方法

项目中的SysDictController类提供了一个标准的Excel导入校验实现范例:

@PostMapping(value = "/importExcel")
public Result<?> importExcel(HttpServletRequest request, HttpServletResponse response) {
    MultipartHttpServletRequest multipartRequest = (MultipartHttpServletRequest) request;
    // 获取上传文件
    Map<String, MultipartFile> fileMap = multipartRequest.getFileMap();
    
    try {
        // 遍历处理每个上传文件
        for (Map.Entry<String, MultipartFile> entity : fileMap.entrySet()) {
            MultipartFile file = entity.getValue();
            ImportParams params = new ImportParams();
            params.setTitleRows(2);
            params.setHeadRows(1);
            params.setNeedSave(true);
            
            // 执行导入
            List<SysDict> listSysDicts = ExcelImportUtil.importExcel(
                file.getInputStream(), 
                SysDict.class, 
                params
            );
            
            // 校验数据
            for (SysDict dict : listSysDicts) {
                // 执行各种校验逻辑
                if(StringUtils.isBlank(dict.getDictName())) {
                    return Result.error("字典名称不能为空");
                }
                // 其他校验规则...
            }
            
            // 保存有效数据
            service.saveBatch(listSysDicts);
            return Result.ok("文件导入成功!数据行数:" + listSysDicts.size());
        }
    } catch (Exception e) {
        log.error(e.getMessage(), e);
        return Result.error("文件导入失败:" + e.getMessage());
    }
    return Result.error("文件导入失败!");
}

校验流程详解

  1. 文件接收:通过MultipartHttpServletRequest接收上传的Excel文件
  2. 导入参数设置:使用ImportParams配置导入参数,如标题行数、表头行数等
  3. 数据解析:通过ExcelImportUtil将Excel数据解析为Java对象列表
  4. 业务校验:遍历解析后的数据,执行各种业务规则校验
  5. 结果处理:根据校验结果返回成功或错误信息

高级校验技巧

在实际项目中,可以扩展基础校验功能:

1. 多级校验

// 第一级:基础字段校验
if(StringUtils.isBlank(dict.getDictName())) {
    return Result.error("字典名称不能为空");
}

// 第二级:业务规则校验
if(dict.getDictName().length() > 50) {
    return Result.error("字典名称长度不能超过50个字符");
}

// 第三级:数据库校验
if(service.existsDictByName(dict.getDictName())) {
    return Result.error("字典名称已存在");
}

2. 批量校验与错误收集

List<String> errorMessages = new ArrayList<>();

for(int i=0; i<listSysDicts.size(); i++) {
    SysDict dict = listSysDicts.get(i);
    int rowNum = i + 1 + params.getTitleRows() + params.getHeadRows();
    
    if(StringUtils.isBlank(dict.getDictName())) {
        errorMessages.add("第"+rowNum+"行:字典名称不能为空");
    }
    // 其他校验...
}

if(!errorMessages.isEmpty()) {
    return Result.error(String.join("<br/>", errorMessages));
}

3. 自定义校验器

可以抽象出校验逻辑,提高代码复用性:

public class DictImportValidator {
    public static List<String> validate(SysDict dict, int rowNum) {
        List<String> errors = new ArrayList<>();
        
        if(StringUtils.isBlank(dict.getDictName())) {
            errors.add("第"+rowNum+"行:字典名称不能为空");
        }
        
        // 其他校验规则...
        
        return errors;
    }
}

性能优化建议

对于大数据量导入,应考虑以下优化措施:

  1. 分批处理:将大数据集分成小批次处理,避免内存溢出
  2. 异步导入:对于耗时操作,采用异步处理方式
  3. 缓存机制:缓存频繁访问的校验数据,减少数据库查询
  4. 并行校验:对无依赖关系的校验规则使用并行流处理

总结

JeecgBoot虽然在某些版本中缺少特定的Excel校验接口,但通过合理的代码设计仍然能够实现强大的Excel导入校验功能。开发者可以根据实际业务需求,在基础校验方案上进行扩展,构建适合自己项目的校验体系。关键是要在数据入库前进行全面验证,确保系统数据的完整性和一致性。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
927
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8