引言

在实际开发中经常需要使用导入导出功能来加快数据的操作。在项目中可以使用注解来完成此项功能。 在需要被导入导出的实体类属性添加@Excel注解，具体见：若依官网_后台手册_导入导出

由于若依代码自动生成已经把导出功能实现好了，这里就不在赘述，下面记录一下我的Excel导入功能的实现流程。

前端部分

1、数据导入的按钮

• v-hasPermi 是权限相关的配置，记得改一下

<el-col :span="1.5">
  <el-button
    type="info"
    plain
    icon="el-icon-upload2"
    size="mini"
    @click="handleImport"
    v-hasPermi="['collegeManage:studentBase:import']"
  >导入</el-button>
</el-col>

2、数据导入的对话框

• 对话框的代码是通用的，直接粘贴即可

<!-- 用户导入对话框 -->
<el-dialog :title="upload.title" :visible.sync="upload.open" width="400px" append-to-body>
  <el-upload
    ref="upload"
    :limit="1"
    accept=".xlsx, .xls"
    :headers="upload.headers"
    :action="upload.url + '?updateSupport=' + upload.updateSupport"
    :disabled="upload.isUploading"
    :on-progress="handleFileUploadProgress"
    :on-success="handleFileSuccess"
    :auto-upload="false"
    drag
  >
    <i class="el-icon-upload"></i>
    <div class="el-upload__text">将文件拖到此处，或<em>点击上传</em></div>
    <div class="el-upload__tip text-center" slot="tip">
      <div class="el-upload__tip" slot="tip">
        <el-checkbox v-model="upload.updateSupport" /> 是否更新已经存在的用户数据
      </div>
      <span>仅允许导入xls、xlsx格式文件。</span>
      <el-link type="primary" :underline="false" style="font-size:12px;vertical-align: baseline;" @click="importTemplate">下载模板</el-link>
    </div>
  </el-upload>
  <div slot="footer" class="dialog-footer">
    <el-button type="primary" @click="submitFileForm">确 定</el-button>
    <el-button @click="upload.open = false">取 消</el-button>
  </div>
</el-dialog>

3、数据导入参数

• getToken()方法调用前，需要先 import { getToken } from “@/utils/auth”;
• url 要与后端部分对应上

import { getToken } from "@/utils/auth";
upload: {
  // 是否显示弹出层（用户导入）
  open: false,
  // 弹出层标题（用户导入）
  title: "",
  // 是否禁用上传
  isUploading: false,
  // 是否更新已经存在的用户数据
  updateSupport: 0,
  // 设置上传的请求头部
  headers: { Authorization: "Bearer " + getToken() },
  // 上传的地址
  url: process.env.VUE_APP_BASE_API + "/collegeManage/studentBase/importData" // todo
}

4、相关方法

• title 根据需要自行修改
• importTemplate()中的url要与后端对应上

/** 导入按钮操作 */
handleImport() {
  this.upload.title = "学生基本信息导入"; // todo
  this.upload.open = true;
},
/** 下载模板操作 */
importTemplate() {
  this.download('collegeManage/studentBase/importTemplate', {
  }, `stu_base_template_${new Date().getTime()}.xlsx`)  // todo
},
// 文件上传中处理
handleFileUploadProgress(event, file, fileList) {
  this.upload.isUploading = true;
},
// 文件上传成功处理
handleFileSuccess(response, file, fileList) {
  this.upload.open = false;
  this.upload.isUploading = false;
  this.$refs.upload.clearFiles();
  this.$alert("<div style='overflow: auto;overflow-x: hidden;max-height: 70vh;padding: 10px 20px 0;'>" + response.msg + "</div>", "导入结果", { dangerouslyUseHTMLString: true });
  this.getList();
},
// 提交上传文件
submitFileForm() {
  this.$refs.upload.submit();
}

后端部分

1、在实体变量上添加@Excel注解

• 有关@Excel注解各个参数的含义，详情见：若依官网_后台手册_导入导出

/** 编号 */
@Excel(name = "编号", cellType = Excel.ColumnType.NUMERIC)
private Long id;
/** 学号 */
@Excel(name = "学号")
private String studentNumber;
/** 姓名 */
@Excel(name = "姓名")
private String name;
/** 班级 */
@Excel(name = "班级")
private String className;
/** 性别 */
@Excel(name = "性别", readConverterExp = "0=男,1=女,2=未知")
private Integer sex;

2、在Controller添加导入方法，

• updateSupport属性为是否存在则覆盖（可选）

@Log(title = "学生基本信息", businessType = BusinessType.IMPORT) // todo
@PreAuthorize("@ss.hasPermi('collegeManage:studentBase:import')") // todo
@PostMapping("/importData")
public AjaxResult importData(MultipartFile file, boolean updateSupport) throws Exception
{
    ExcelUtil<StudentBase> util = new ExcelUtil<>(StudentBase.class); // todo
    List<StudentBase> stuList = util.importExcel(file.getInputStream()); // todo
    String operName = getUsername();
    String message = studentBaseService.importUser(stuList, updateSupport, operName); // todo
    return AjaxResult.success(message);
}
@PostMapping("/importTemplate")
public void importTemplate(HttpServletResponse response)
{
    ExcelUtil<StudentBase> util = new ExcelUtil<>(StudentBase.class); // todo
    util.importTemplateExcel(response, "学生基本信息");
}

3、importUser

接口

 /**
  * 导入用户数据
  *
  * @param stuList 用户数据列表
  * @param isUpdateSupport 是否更新支持，如果已存在，则进行更新数据
  * @param operName 操作用户
  * @return 结果
  */
 public String importUser(List<StudentBase> stuList, Boolean isUpdateSupport, String operName);

接口实现类

private static final Logger log = LoggerFactory.getLogger(SysUserServiceImpl.class);
@Autowired
protected Validator validator;
@Override
public String importUser(List<StudentBase> stuList, Boolean isUpdateSupport, String operName) {
    if (StringUtils.isNull(stuList) || stuList.size() == 0)
    {
        throw new ServiceException("导入学生基本信息数据不能为空！");
    }
    int successNum = 0;
    int failureNum = 0;
    StringBuilder successMsg = new StringBuilder();
    StringBuilder failureMsg = new StringBuilder();
    for (StudentBase stu : stuList)
    {
        try
        {
            // 验证是否存在这个用户
            StudentBase u = studentBaseMapper.selectStudentBaseByStudentNumber(stu.getStudentNumber());
            if (StringUtils.isNull(u))
            {
                BeanValidators.validateWithException(validator, stu);
                stu.setCreateBy(operName);
                this.insertStudentBase(stu);
                successNum++;
                successMsg.append("<br/>" + successNum + "、学号 " + stu.getStudentNumber() + " 导入成功");
            }
            else if (isUpdateSupport)
            {
                BeanValidators.validateWithException(validator, stu);
                stu.setUpdateBy(operName);
                this.updateStudentBase(stu);
                successNum++;
                successMsg.append("<br/>" + successNum + "、学号 " + stu.getStudentNumber() + " 更新成功");
            }
            else
            {
                failureNum++;
                failureMsg.append("<br/>" + failureNum + "、学号 " + stu.getStudentNumber() + " 已存在");
            }
        }
        catch (Exception e)
        {
            failureNum++;
            String msg = "<br/>" + failureNum + "、学号 " + stu.getStudentNumber() + " 导入失败：";
            failureMsg.append(msg + e.getMessage());
            log.error(msg, e);
        }
    }
    if (failureNum > 0)
    {
        failureMsg.insert(0, "很抱歉，导入失败！共 " + failureNum + " 条数据格式不正确，错误如下：");
        throw new ServiceException(failureMsg.toString());
    }
    else
    {
        successMsg.insert(0, "恭喜您，数据已全部导入成功！共 " + successNum + " 条，数据如下：");
    }
    return successMsg.toString();
}