自定义springboot组件--excel导入(自定义参数解析器)

原创 已于 2022-06-22 14:47:16 修改 · 置顶 · 1.1k 阅读 · 4 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot #java #后端

于 2022-06-02 14:22:48 首次发布

一 引入

日常开发中,我们经常用到excel的导入,由于excel导入的的步骤相似度较大,本文基于自定义参数解析器实现对excel导入基本操作的抽离,在项目中快速实现excel的基本导入功能.

二 自定义参数解析器(HandlerMethodArgumentResolver )

自定义参数解析器需要实现 HandlerMethodArgumentResolver 接口，我们先来看看该接口：

public interface HandlerMethodArgumentResolver {
	boolean supportsParameter(MethodParameter parameter);
	@Nullable
	Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
			NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception;

}

这个接口中就两个方法：

  • supportsParameter：该方法表示是否启用这个参数解析器，返回 true 表示启用，返回 false 表示不启用。
  • resolveArgument：这是具体的解析过程，就是从 request 中取出参数的过程，方法的返回值就对应了接口中参数的值。既把这个最终的结果赋值给当前参数

三 自定义spingboot组件

下文中的excle导入组件基于easyexcel实现

申明一个导入注解

@Documented
@Target({ ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestExcel {
    /**
     * 前端上传文件字段名称
     * @return
     */
    String fileName() default "file";

    /**
     * 是否跳过空行
     */
    boolean ignoreEmptyRow() default false;

    /**
     * 数据读取监听器
     * @return
     */
    Class<? extends ListAnalysisEventListener<?>> readListener() default DefaultListAnalysisEventListener.class;

}

申明数据读取监听器

抽象一个list监听器,在里面定义一个获得数据和获取数据校验失败的结果集

public abstract class ListAnalysisEventListener<T> extends AnalysisEventListener<T> {
    /**
     * 获取excel解析结果的对象列表
     * @return
     */
    public abstract List<T> getList();

    /**
     * 校验错误信息
     * @return
     */
    public abstract List<ErrorMessage> getErrors();
}

@Slf4j
public class DefaultListAnalysisEventListener extends ListAnalysisEventListener<Object>{

    private final List<Object> list = new ArrayList<Object>();

    private final List<ErrorMessage> errorMessageList = new ArrayList<ErrorMessage>();

    /**
     * 行号
     */
    private Long lineNum = 1L;

    @Override
    public List<Object> getList() {
        return list;
    }

    @Override
    public List<ErrorMessage> getErrors() {
        return errorMessageList;
    }

    @Override
    public void invoke(Object data, AnalysisContext context) {
        lineNum++;
        //校验当前数据
        Set<ConstraintViolation<Object>> validates = Validators.validate(data);

        if (!validates.isEmpty()){
            Set<String> errors = validates.stream().map(ConstraintViolation::getMessage)
                    .collect(Collectors.toSet());
            errorMessageList.add(new ErrorMessage(lineNum,errors));
        }else {
            list.add(data);
        }
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        log.info("excel read analysed");
    }
}

定义校验工具及错误信息

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ErrorMessage {
    /**
     * 行号
     */
    private Long lineNum;

    private Set<String> errors = new HashSet<>();

    public ErrorMessage(Set<String> errors) {
        this.errors = errors;
    }

    public ErrorMessage(String error) {
        HashSet<String> objects = new HashSet<>();
        objects.add(error);
        this.errors = objects;
    }
}

public class Validators {
    public static final Validator validator;
    static {
        ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
        validator=validatorFactory.getValidator();
    }

    public static <T> Set<ConstraintViolation<T>> validate(T object){
        return validator.validate(object);
    }


}

定义参数转换器

public enum LocalDateStringConverter implements Converter<LocalDate> {

	/**
	 * 实例
	 */
	INSTANCE;

	@Override
	public Class supportJavaTypeKey() {
		return LocalDate.class;
	}

	@Override
	public CellDataTypeEnum supportExcelTypeKey() {
		return CellDataTypeEnum.STRING;
	}

	@Override
	public LocalDate convertToJavaData(CellData cellData, ExcelContentProperty contentProperty,
			GlobalConfiguration globalConfiguration) throws ParseException {
		if (contentProperty == null || contentProperty.getDateTimeFormatProperty() == null) {
			return LocalDate.parse(cellData.getStringValue());
		}
		else {
			DateTimeFormatter formatter = DateTimeFormatter
					.ofPattern(contentProperty.getDateTimeFormatProperty().getFormat());
			return LocalDate.parse(cellData.getStringValue(), formatter);
		}
	}

	@Override
	public CellData<String> convertToExcelData(LocalDate value, ExcelContentProperty contentProperty,
			GlobalConfiguration globalConfiguration) {
		DateTimeFormatter formatter;
		if (contentProperty == null || contentProperty.getDateTimeFormatProperty() == null) {
			formatter = DateTimeFormatter.ISO_LOCAL_DATE;
		}
		else {
			formatter = DateTimeFormatter.ofPattern(contentProperty.getDateTimeFormatProperty().getFormat());
		}
		return new CellData<>(value.format(formatter));
	}

}
public enum LocalDateTimeStringConverter implements Converter<LocalDateTime> {

	/**
	 * 实例
	 */
	INSTANCE;

	private static final String MINUS = "-";

	@Override
	public Class supportJavaTypeKey() {
		return LocalDateTime.class;
	}

	@Override
	public CellDataTypeEnum supportExcelTypeKey() {
		return CellDataTypeEnum.STRING;
	}

	@Override
	public LocalDateTime convertToJavaData(CellData cellData, ExcelContentProperty contentProperty,
			GlobalConfiguration globalConfiguration) throws ParseException {
		String stringValue = cellData.getStringValue();
		String pattern;
		if (contentProperty == null || contentProperty.getDateTimeFormatProperty() == null) {
			pattern = switchDateFormat(stringValue);
		}
		else {
			pattern = contentProperty.getDateTimeFormatProperty().getFormat();
		}
		DateTimeFormatter formatter = DateTimeFormatter.ofPattern(pattern);
		return LocalDateTime.parse(cellData.getStringValue(), formatter);
	}

	@Override
	public CellData<String> convertToExcelData(LocalDateTime value, ExcelContentProperty contentProperty,
			GlobalConfiguration globalConfiguration) {
		String pattern;
		if (contentProperty == null || contentProperty.getDateTimeFormatProperty() == null) {
			pattern = DateUtils.DATE_FORMAT_19;
		}
		else {
			pattern = contentProperty.getDateTimeFormatProperty().getFormat();
		}
		DateTimeFormatter formatter = DateTimeFormatter.ofPattern(pattern);
		return new CellData<>(value.format(formatter));
	}

	/**
	 * switch date format
	 * @param dateString dateString
	 * @return pattern
	 */
	private static String switchDateFormat(String dateString) {
		int length = dateString.length();
		switch (length) {
		case 19:
			if (dateString.contains(MINUS)) {
				return DateUtils.DATE_FORMAT_19;
			}
			else {
				return DateUtils.DATE_FORMAT_19_FORWARD_SLASH;
			}
		case 17:
			return DateUtils.DATE_FORMAT_17;
		case 14:
			return DateUtils.DATE_FORMAT_14;
		case 10:
			return DateUtils.DATE_FORMAT_10;
		default:
			throw new IllegalArgumentException("can not find date format for：" + dateString);
		}
	}

}

通过自定义参数解析器实现excel的导入

public class RequestExcelArgumentResolver implements HandlerMethodArgumentResolver {
    /**
     * 支持条件--接受参数中包含RequestExcel注解
     * @param parameter
     * @return
     */
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.hasParameterAnnotation(RequestExcel.class);
    }

    /**
     * 当前解析结果
     * @param parameter
     * @param mavContainer
     * @param webRequest
     * @param binderFactory
     * @return
     * @throws Exception
     */
    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        // 判断是否采用list接受参数
        Class<?> parameterType = parameter.getParameterType();
        if (!parameterType.isAssignableFrom(List.class)) {
            throw new IllegalArgumentException(
                    "Excel upload request resolver error, @RequestExcel parameter is not List " + parameterType);
        }
        RequestExcel requestExcel = parameter.getParameterAnnotation(RequestExcel.class);
        assert requestExcel!=null;

        //获取自定义读取处理器
        Class<? extends ListAnalysisEventListener<?>> readListenerClass = requestExcel.readListener();
        ListAnalysisEventListener<?> readListener = BeanUtils.instantiateClass(readListenerClass);

        // 获取请求文件流
        HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class);
        assert request!=null;
        InputStream inputStream;
        if (request instanceof MultipartRequest){
            MultipartRequest multipartRequest = (MultipartRequest) request;
            MultipartFile file = multipartRequest.getFile(requestExcel.fileName());
            assert file!=null;
            inputStream=file.getInputStream();
            //FileUtils.writeToFile(new File("C:\\Users\\likun\\Desktop\\新建文件夹\\lktest.xls"),inputStream);
        }else {
            inputStream=request.getInputStream();
        }
        //将数据读取到指定接受参数中
        // 获取目标类型
        Class<?> excelModelClass = ResolvableType.forMethodParameter(parameter).getGeneric(0).resolve();

        EasyExcel.read(inputStream,excelModelClass,readListener)
                .registerConverter(LocalDateStringConverter.INSTANCE)
                .registerConverter(LocalDateTimeStringConverter.INSTANCE)
                .ignoreEmptyRow(requestExcel.ignoreEmptyRow())
                .sheet().doRead();

        //将校验失败的数据绑定给BindResult
        WebDataBinder webDataBinder = binderFactory.createBinder(webRequest, readListener.getErrors(), "excel");
        ModelMap model = mavContainer.getModel();
        model.put(BindingResult.MODEL_KEY_PREFIX+"excel",webDataBinder.getBindingResult());

        return readListener.getList();
    }
}

配置自定义参数解析器

@RequiredArgsConstructor
public class RequestExcelConfig implements InitializingBean {
    private final RequestMappingHandlerAdapter requestMappingHandlerAdapter;

    @Override
    public void afterPropertiesSet() throws Exception {
        List<HandlerMethodArgumentResolver> argumentResolvers = requestMappingHandlerAdapter.getArgumentResolvers();
        ArrayList<HandlerMethodArgumentResolver> resloves = new ArrayList<>();
        resloves.add(new RequestExcelArgumentResolver());
        resloves.addAll(argumentResolvers);
        requestMappingHandlerAdapter.setArgumentResolvers(resloves);
    }
}

交给springboot管理

在这里插入图片描述

四 组件调用

@Data
public class PostExcelVO implements Serializable {

	private static final long serialVersionUID = 1L;

	/**
	 * 主键ID
	 */
	@ExcelProperty("岗位编号")
	private Long postId;

	/**
	 * 岗位名称
	 */
	@NotBlank(message = "岗位名称不能为空")
	@ExcelProperty("岗位名称")
	private String postName;

	/**
	 * 岗位标识
	 */
	@NotBlank(message = "岗位标识不能为空")
	@ExcelProperty("岗位标识")
	private String postCode;

	/**
	 * 岗位排序
	 */
	@NotNull(message = "岗位排序不能为空")
	@ExcelProperty("岗位排序")
	private Integer postSort;

	/**
	 * 岗位描述
	 */
	@NotBlank(message = "岗位描述不能为空")
	@ExcelProperty(value = "岗位描述")
	private String remark;


}


@PostMapping("/importExcel")
    @Inner(false)
    public R importExcel(@RequestExcel List<PostExcelVO> list, BindingResult bindingResult){
        // 获取错误信息
        List<ErrorMessage> errorMessages = (List<ErrorMessage>) bindingResult.getTarget();
        errorMessages.forEach(errorMessage -> log.info("校验错误信息:{}",errorMessage));
        log.info("读取结果:{}",list);
        return R.ok();
    }

执行结果:
在这里插入图片描述

Springboot 指定自定义模板导出Excel文件
默默不代表沉默
07-15 8528
excel指定自定义模板，导出数据
SpringBoot：自定义注解+反射实现excel导入的数据组装及字段校验
m0_71777195的博客
04-24 623
首先，我们需要添加一个自定义注解。该注解主要标记相应字段与cell的对应关系以及需要进行的处理。（PS：上面提到的特殊格式的校验，这里没有做实现，需要的增加一个字段保存正则表达式即可）//下标，与excel中列对应，从0开始//是否必填，默认是必填// 字典的Code，用于字典转换//字典的名称，用于错误提醒复制代码class：用于组装数据：我这里是将excel的内容全部读取出来保存在了Map中。：所有涉及的字段转换，调用方应将字段按照code组装成Map的形式以供使用....
springboot 实现导入excel，解析excel数据并向数据库插入insert
喵仙人
08-10 2145
导入excel文件，大致如下： controller层：此处file文件写死，自行修改 @RestController @RequestMapping("/import") public class ImportExcelController { @Autowired private ImportExcelService importExcelService; @RequestMapping(value = "/excel",method = RequestMethod.POS
SpringBoot excel解析自定义列、行数据
cb123456S的博客
11-03 780
1、excel解析任意数据 public class ParseExcelUtil { private static final Logger logger = LoggerFactory.getLogger(ParseExcelUtil.class); private static final String OFFICE_EXCEL_XLS = "xls"; private static final String OFFICE_EXCEL_XLSX = "xlsx";
SpringBoot自定义注解+反射实现 excel 导入的数据组装及字段校验
竹林幽深
01-31 120
首先，我们需要添加一个自定义注解。该注解主要标记相应字段与cell的对应关系以及需要进行的处理。（PS：上面提到的特殊格式的校验，这里没有做实现，需要的增加一个字段保存正则表达式即可）//下标，与excel中列对应，从0开始//是否必填，默认是必填// 字典的Code，用于字典转换//字典的名称，用于错误提醒class：用于组装数据：我这里是将excel的内容全部读取出来保存在了Map中。：所有涉及的字段转换，调用方应将字段按照code组装成Map的形式以供使用....
SpringBoot实现Excel导入解析（easyExcel）
MR.骑士道
07-20 3258
一、添加pom依赖 <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.2.6</version> </dependency> 二、编写UserListener package com.test.demo.listener; import com...
Springboot---整合对象储存服务MinIO
qq_55272229的博客
11-08 1284
MinIO 是在 GNU Affero 通用公共许可证 v3.0 下发布的高性能对象存储。它是与 Amazon S3 云存储服务兼容的 API。使用 MinIO 为机器学习、分析和应用程序数据工作负载构建高性能基础架构。
【项目实战SpringBoot+Vue】基于easyexcel实现Excel大数据量的导入导出（包含数据脱敏）--简单易上手
【实战】T-猿小白的博客
03-13 4445
SpringBoot2.7.9 + Vue2 + Element + easyexcel 实现大数据量的导入导出，脱敏数据展示、导出，多sheet页等复杂表单导入导出
Java实现excel大数据量导入
09-07
总结起来，Java中处理Excel大数据量导入的关键在于采用低内存消耗的策略，如SAX解析器，以及理解不同Excel版本的文件结构和限制。通过这些技术，可以高效地处理大量数据，避免对系统资源造成过大压力。
《SpringBoot》EasyExcel实现百万数据的导入导出
最新发布
mf97532的博客
05-30 1049
在日常的开发工作中，Excel 文件的读取和写入是非常常见的需求，特别是在后台管理系统中更为频繁，基于传统的方式操作excel通常比较繁琐，EasyExcel 库的出现为我们带来了更简单、更高效的解决方案。本文将介绍 EasyExcel 库的基本用法和一些常见应用场景，帮助开发者更好地利用 EasyExcel 提高工作效率。Easy Excel 官网 (alibaba.com)
springboot实现上传并解析Excel过程解析
08-25
主要介绍了springboot实现上传并解析Excel过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
springboot数据导出excel自定义封装工具
qianbanteng0945的博客
12-10 596
springboot数据导出excel自定义封装工具 实例 public class Client { private Integer id; private String bianhao; private String name; private String phone; private String remark; private Date createDateTime; publ...
SpringBoot实现Excel导入导出，好用到爆，POI可以扔掉了
m0_63827887的博客
11-03 361
在我们平时工作中经常会遇到要操作Excel的功能，比如导出个用户信息或者订单信息的Excel报表。你肯定听说过POI这个东西，可以实现。但是POI实现的API确实很麻烦，它需要写那种逐行解析的代码（类似Xml解析）。今天给大家推荐一款非常好用的Excel导入导出工具EasyPoi，希望对大家有所帮助！ EasyPoi简介 用惯了SpringBoot的朋友估计会想到，有没有什么办法可以直接定义好需要导出的数据对象，然后添加几个注解，直接自动实现Excel导入导出功能？ EasyPoi正是这么一款工具.
springboot导入Excel数据
royal1235的博客
05-08 5501
1.导入Excel一般都会给一个Excel数据模板，模板下载请看本博客另一篇模板下载文章 2.数据库数据导入效果图 3.前台简陋图 4,需要引入mybatis、mysql、poi、io等依赖 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactI...
SpringBoot实现简单的Excel导入操作
小学僧的博客
10-12 3447
本文简单的介绍SpringBoot+MongoDB下实现简单的Excel导入操作功能，关系型数据库是同样的道理，就不多做介绍了 首先定义一个注解用于实现Excel中的表头与字段名相对应 @Persistent @Inherited @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD}) public @interface ExcelName { String name() default ""; } 使用注解定义DTO @
springboot使用POI实现Excel文件写入
mishilq的博客
10-22 823
1、导入pom依赖 <!--xls(03)--> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>4.1.2</version> </dependency> &l
SpringBoot中Excel表的导入、导出功能的实现
m0_62909831的博客
01-27 2384
springboot中excel表的导入导出功能的实现
利用Spring-Boot解析Excel、用Java分析Excel、告别手动输入用程序读取Excel
XRT_knives的博客
12-03 346
利用Spring-Boot解析Excel、用Java分析Excel、告别手动输入用程序读取Excel 一、资源 java读取Excel文件 二、修改 （一）中的代码中的 import service.ApiException 可以删除，并无实际用途。
Spring Boot 导入导出Excel
qq_37663649的博客
03-05 657
原文出处：https://www.cnblogs.com/linjiqin/p/10975761.html#commentform 1、添加springBoot支持 <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>3.13</version> </dependen.
SpringBoot怎么实现excel导入信息
01-07
### Spring Boot 实现 Excel 文件数据导入 #### 添加依赖项 为了在Spring Boot项目中实现Excel文件的数据导入，首先需要引入相应的依赖库。对于本案例而言，可以选用`EasyExcel`作为操作工具之一。 ```xml <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>3.0.5</version> </dependency> ``` 上述代码展示了如何向项目的pom.xml文件添加Maven依赖以集成EasyExcel[^1]。 #### 创建实体类映射表格结构 假设有一个简单的员工信息表单，其中包含姓名(name)，年龄(age)两个字段，则对应的JavaBean如下所示： ```java public class EmployeeData { private String name; private Integer age; // getter and setter methods... } ``` 此部分定义了一个名为EmployeeData的POJO对象用于表示每条记录的内容并提供必要的访问方法。 #### 编写控制器接收上传请求 接下来，在Controller层编写接口用来接受前端传来的文件流参数，并调用服务端逻辑完成解析工作。 ```java @RestController @RequestMapping("/employee/import") public class ImportController { @Autowired private IImportService importService; /** * 处理POST方式提交过来的文件 */ @PostMapping(value = "", consumes = MediaType.MULTIPART_FORM_DATA_VALUE) public ResponseEntity<String> handleFileUpload(@RequestParam("file") MultipartFile file){ try{ List<EmployeeData> employeeList= EasyExcel.read(file.getInputStream()) .head(EmployeeData.class).sheet().doReadSync(); int resultCount = this.importService.batchInsert(employeeList); return new ResponseEntity<>("成功插入"+resultCount+"条记录", HttpStatus.OK); }catch(Exception e){ logger.error(e.getMessage(),e); throw new RuntimeException("文件读取失败"); } } } ``` 这里实现了对HTTP POST请求的支持，允许客户端发送multipart/form-data类型的payload携带待处理文档；之后借助于EasyExcel API快速获取全部行内元素形成列表传递给业务组件进一步加工保存至持久化存储介质当中去。 #### 自定义监听器优化性能表现 当面对海量级规模的数据集时，默认的一次性加载模式可能会带来内存占用过高甚至溢出的风险。为此推荐采用事件驱动型的设计思路——即每当遇到新的单元格变更通知就立即触发回调函数执行特定任务（比如批量入库），从而有效降低资源消耗水平。 ```java class CustomListener extends AnalysisEventListener<EmployeeData>{ private static final Logger LOGGER = LoggerFactory.getLogger(CustomListener.class); private transient DefaultBatchPreparedStatementSetter batchHelper; public void invoke(EmployeeData data,AnalysisContext context){ if(null !=data && !"".equals(data.getName())){ batchHelper.addBatch(new Object[]{data.getName(),data.getAge()}); if(batchHelper.hasEnough()){ executeBatchUpdate(); } } } protected void doAfterAllAnalysed(AnalysisContext context){ flushRemainingRecords(); } ... } // 修改之前的controller中的read语句为： EasyExcel.read(inputStream,new CustomListener()).sheet().doRead(); ``` 这段程序片段说明了怎样继承自内置基类创建个性化的处理器实例，以便更好地控制整个流程走向的同时也提高了系统的稳定性和响应速度。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值