解决vue-office项目中后端返回Excel数据流的问题
vue-office 项目地址: https://gitcode.com/gh_mirrors/vu/vue-office
问题背景
在使用vue-office项目时,开发者遇到了后端返回Excel文件数据流的问题。具体表现为:
- 当后端直接使用
new File()
创建文件对象时,前端能够正常处理 - 但当后端通过
ResourceUtil.getStream()
从JAR包中读取Excel模板文件时,前端接收到的数据流会出现问题 - 尝试将InputStream转换为FileInputStream也未能解决问题
- 对比发现,从JAR包读取的流比直接文件读取的字节数大很多
问题分析
这个问题实际上与Java项目的打包机制有关。当使用Maven构建项目时,默认情况下会对资源文件进行过滤处理,这可能导致二进制文件(如Excel、PDF等)在打包过程中被修改,从而破坏了文件的原始结构。
解决方案
通过在Maven的pom.xml文件中配置maven-resources-plugin
插件,可以指定不需要过滤处理的文件类型:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>${maven-resources-plugin.version}</version>
<configuration>
<nonFilteredFileExtensions>
<nonFilteredFileExtension>xlsx</nonFilteredFileExtension>
<nonFilteredFileExtension>xls</nonFilteredFileExtension>
<nonFilteredFileExtension>zip</nonFilteredFileExtension>
<nonFilteredFileExtension>pdf</nonFilteredFileExtension>
</nonFilteredFileExtensions>
</configuration>
</plugin>
配置说明
- 插件作用:
maven-resources-plugin
负责处理项目资源文件的复制和过滤 - nonFilteredFileExtensions:指定不需要过滤处理的文件扩展名
- 常见二进制文件:通常需要排除过滤的文件类型包括Excel(.xlsx, .xls)、压缩文件(.zip)和PDF文档(.pdf)等
最佳实践
- 对于任何二进制文件,都应该在Maven配置中排除过滤处理
- 可以根据项目实际使用的文件类型,扩展
nonFilteredFileExtensions
列表 - 建议在开发初期就配置好这些排除项,避免后期出现难以排查的问题
总结
通过合理配置Maven资源插件,可以确保后端从JAR包中读取的Excel等二进制文件保持原始状态,从而保证vue-office项目能够正确处理这些数据流。这是Java项目中处理二进制资源文件的通用解决方案,不仅适用于Excel文件,也适用于其他类型的二进制资源。
vue-office 项目地址: https://gitcode.com/gh_mirrors/vu/vue-office
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考