ps: 代码已提交到gitee: https://gitee.com/Lazy_001/file-demo
文件上传下载导入导出
一、首先完成准备工作
1. 创建一个Springboot项目
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.5.4</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.file.demo</groupId> <artifactId>file</artifactId> <version>0.0.1-SNAPSHOT</version> <name>file</name> <description>文件上传下载导入导出</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <!-- web --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- SpringBoot集成thymeleaf模板 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <!--easypoi--> <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-base</artifactId> <version>3.0.3</version> </dependency> <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-web</artifactId> <version>3.0.3</version> </dependency> <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-annotation</artifactId> <version>3.0.3</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <configuration> <excludes> <exclude> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </exclude> </excludes> </configuration> </plugin> </plugins> </build> </project>
2. 编写配置文件
server:
port: 9000
spring:
servlet:
multipart:
enabled: true
# 最大支持文件大小
max-file-size: 100MB
# 最大支持请求大小
max-request-size: 100MB
#文件存储路径
filepath: E:/file/
二、上传下载功能样例
// 读取yml中的文件存储路径 下面java代码用的都是这个filepath
@Value("${filepath}")
private String filepath;
1. 文件上传
/**
* 表单提交
* 处理文件上传
*/
@PostMapping(value = "/upload")
public String uploading(@RequestParam("file") MultipartFile file) {
File targetFile = new File(filepath);
if (!targetFile.exists()) {
targetFile.mkdirs();
}
try (FileOutputStream out = new FileOutputStream(filepath + file.getOriginalFilename());){
out.write(file.getBytes());
} catch (Exception e) {
e.printStackTrace();
log.error("文件上传失败!");
return "uploading failure";
}
log.info("文件上传成功!");
return "uploading success";
}
SimpleDateFormat sdf=new SimpleDateFormat("/yyyy-MM-dd/");
/**
*ajax提交
*/
@PostMapping("/ajaxUpload")
public String file(MultipartFile file, HttpServletRequest request){
String format = sdf.format(new Date());
String realPath =filepath + format;
//创建文件夹路径
File folder = new File(realPath);
//如果文件夹已经不存在那么我们就创建一下
if(!folder.exists()){
folder.mkdirs();
}
String originalFilename = file.getOriginalFilename();
String newName = UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf("."));
try {
file.transferTo(new File(folder,newName));
String url=format+newName;
//文件名
return url;
} catch (IOException e) {
e.printStackTrace();
}
return "error";
}
文件上传的前端代码
<!DOCTYPE html>
<html lang="zh" xmlns:th="http://www.thymeleaf.org" >
<head>
<meta charset="UTF-8">
<title>文件上传</title>
</head>
<body>
表单上传
<form enctype="multipart/form-data" method="post" action="file/upload">
<input type="file" name="file" />
<input type="submit" value="上传"/>
</form>
</br>
ajax上传
<input type="file" id="file2">
<input type="button" value="ajax上传" onclick="uploadFile()"/>
</body>
</html>
<script th:src="@{/js/jquery.min.js}"></script>
<script>
var filename = "";
function uploadFile() {
var file=$("#file2")[0].files[0];
var formData = new FormData();
formData.append("file",file);
$.ajax({
type:"post",
url:"file/ajaxUpload",
processData: false,
contentType:false,
data:formData,
success:function (filepath) {
filename = filepath;
console.log(filepath);
}
})
}
}
</script>
2. 文件下载
@RequestMapping("/download")
public void downLoad(HttpServletResponse response,@RequestParam("filename") String filename) throws UnsupportedEncodingException {
File file = new File(filepath + "/" + filename);
if(file.exists()){
response.setContentType("application/octet-stream");
response.setHeader("content-type", "application/octet-stream");
response.setHeader("Content-Disposition", "attachment;fileName=" + URLEncoder.encode(filename,"utf8"));
byte[] buffer = new byte[1024];
//输出流
OutputStream os = null;
try(FileInputStream fis= new FileInputStream(file);
BufferedInputStream bis = new BufferedInputStream(fis);) {
os = response.getOutputStream();
int i = bis.read(buffer);
while(i != -1){
os.write(buffer);
i = bis.read(buffer);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
文件下载前端代码
<a href="/file/download?fileName=文件名">文件下载</a>
或者
<a href="#" onclick="demodownload()">方法的形式下载</a>
function demodownload(){
// 可以在这里做一个是否确认下载的提示语句。
const link = document.createElement('a');
link.href = "file/download?filename="+filename;
link.click()
}
3. 文件删除
/**
* 删除文件
* @param filename 文件路径
* @return 是否成功
*/
@RequestMapping("/deleteFile")
public boolean deleteFile(@RequestParam String filename) {
boolean flag = false;
File file = new File(filepath+filename);
if (file.isFile() && file.exists()) {
file.delete();
flag = true;
}
return flag;
}
删除文件前端代码
<a href="#" onclick="deleteFile()">删除文件</a>
function deleteFile(){
$.ajax({
type:"get",
url:"file/deleteFile?filename="+filename,
dataType : "json",
success:function (result) {
alert(result)
}
})
}
三、导入导出Execl
1. 导入依赖
<!--easypoi-->
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-base</artifactId>
<version>3.0.3</version>
</dependency>
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-web</artifactId>
<version>3.0.3</version>
</dependency>
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-annotation</artifactId>
<version>3.0.3</version>
</dependency>
2. 编写实体类
- 处注意必须要有空构造函数,否则会报错“对象创建错误”
- 关于注解@Excel,其他还有@ExcelCollection,@ExcelEntity ,@ExcelIgnore,@ExcelTarget等,此处我们用不到,可以去官方查看更多
属性 | 类型 | 类型 | 说明 |
---|---|---|---|
name | String | null | 列名 |
needMerge | boolean | fasle | 纵向合并单元格 |
orderNum | String | “0” | 列的排序,支持name_id |
replace | String[] | {} | 值得替换 导出是{a_id,b_id} 导入反过来 |
savePath | String | “upload” | 导入文件保存路径 |
type | int | 1 | 导出类型 1 是文本 2 是图片,3 是函数,10 是数字 默认是文本 |
width | double | 10 | 列宽 |
height | double | 10 | 列高,后期打算统一使用@ExcelTarget的height,这个会被废弃,注意 |
isStatistics | boolean | fasle | 自动统计数据,在追加一行统计,把所有数据都和输出这个处理会吞没异常,请注意这一点 |
isHyperlink | boolean | false | 超链接,如果是需要实现接口返回对象 |
isImportField | boolean | true | 校验字段,看看这个字段是不是导入的Excel中有,如果没有说明是错误的Excel,读取失败,支持name_id |
exportFormat | String | “” | 导出的时间格式,以这个是否为空来判断是否需要格式化日期 |
importFormat | String | “” | 导入的时间格式,以这个是否为空来判断是否需要格式化日期 |
format | String | “” | 时间格式,相当于同时设置了exportFormat 和 importFormat |
databaseFormat | String | “yyyyMMddHHmmss” | 导出时间设置,如果字段是Date类型则不需要设置 数据库如果是string 类型,这个需要设置这个数据库格式,用以转换时间格式输出 |
numFormat | String | “” | 数字格式化,参数是Pattern,使用的对象是DecimalFormat |
imageType | int | 1 | 导出类型 1 从file读取 2 是从数据库中读取 默认是文件 同样导入也是一样的 |
suffix | String | “” | 文字后缀,如% 90 变成90% |
isWrap | boolean | true | 是否换行 即支持\n |
mergeRely | int[] | {} | 合并单元格依赖关系,比如第二列合并是基于第一列 则{1}就可以了 |
mergeVertical | boolean | fasle | 纵向合并内容相同的单元格 |
import cn.afterturn.easypoi.excel.annotation.Excel;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.io.Serializable;
import java.util.Date;
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class UserEntity implements Serializable {
private static final long serialVersionUID = 1L;
@Excel(name = "ID", orderNum = "0")
private Long id;
@Excel(name = "姓名", orderNum = "1")
private String userName;
@Excel(name = "年龄", orderNum = "2")
private Integer age;
@Excel(name = "邮箱", orderNum = "3")
private String email;
@Excel(name = "出生日期",width = 60,exportFormat = "yyyy-MM-dd",importFormat="yyyy-MM-dd",orderNum = "4")
private Date birth;
}
3. ExcelUtil工具类
import cn.afterturn.easypoi.excel.ExcelExportUtil;
import cn.afterturn.easypoi.excel.ExcelImportUtil;
import cn.afterturn.easypoi.excel.entity.ExportParams;
import cn.afterturn.easypoi.excel.entity.ImportParams;
import cn.afterturn.easypoi.excel.entity.enmus.ExcelType;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.ss.usermodel.Workbook;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
public class ExcelUtil {
public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,String fileName,boolean isCreateHeader, HttpServletResponse response){
ExportParams exportParams = new ExportParams(title, sheetName);
exportParams.setCreateHeadRows(isCreateHeader);
defaultExport(list, pojoClass, fileName, response, exportParams);
}
public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,String fileName, HttpServletResponse response){
defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName));
}
public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response){
defaultExport(list, fileName, response);
}
private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) {
Workbook workbook = ExcelExportUtil.exportExcel(exportParams,pojoClass,list);
if (workbook != null);
downLoadExcel(fileName, response, workbook);
}
private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) {
try {
response.setCharacterEncoding("UTF-8");
response.setHeader("content-Type", "application/vnd.ms-excel");
response.setHeader("Content-Disposition",
"attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));
workbook.write(response.getOutputStream());
} catch (IOException e) {
//throw new NormalException(e.getMessage());
e.printStackTrace();
}
}
private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
if (workbook != null);
downLoadExcel(fileName, response, workbook);
}
public static <T> List<T> importExcel(String filePath,Integer titleRows,Integer headerRows, Class<T> pojoClass){
if (StringUtils.isBlank(filePath)){
return null;
}
ImportParams params = new ImportParams();
params.setTitleRows(titleRows);
params.setHeadRows(headerRows);
List<T> list = null;
try {
list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
}catch (NoSuchElementException e){
//throw new NormalException("模板不能为空");
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
//throw new NormalException(e.getMessage());
}
return list;
}
public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass){
if (file == null){
return null;
}
ImportParams params = new ImportParams();
params.setTitleRows(titleRows);
params.setHeadRows(headerRows);
List<T> list = null;
try {
list = ExcelImportUtil.importExcel(file.getInputStream(), pojoClass, params);
}catch (NoSuchElementException e){
// throw new NormalException("excel文件不能为空");
e.printStackTrace();
} catch (Exception e) {
//throw new NormalException(e.getMessage());
e.printStackTrace();
}
return list;
}
}
4. 导出Execl
/**
* Excel导出
*/
@RequestMapping("exportExcel")
public void exportExcel(HttpServletResponse response) throws IOException {
// 这里只做示例 正常应该去数据库中查询
UserEntity user1 = UserEntity.builder().id(1L).userName("张三").age(10).birth(new Date()).build();
UserEntity user2 = UserEntity.builder().id(2L).userName("小李").age(16).birth(new Date()).build();
UserEntity user3 = UserEntity.builder().id(3L).userName("小王").age(14).birth(new Date()).build();
List<UserEntity> userList = Stream.of(user1, user2, user3).collect(Collectors.toList());
//导出操作
ExcelUtil.exportExcel(userList, null, "用户", UserEntity.class, "测试用户导出.xlsx", response);
}
导出前端代码
<a href="#" οnclick="exportExcel()">导出execl</a>
或者
<a href="file/exportExcel">导出execl</a>
<script>
function exportExcel(){
//这里可以获取页面上的查询条件并传入后台中 不可能都是导出全部数据吧 所以用这种方法的方式(而不是直接用a标签的方式)导出 还是更好一些
const link = document.createElement('a');
link.href = "file/exportExcel";
link.click()
}
</script>
5. 导入Execl
/**
* Excel导入
*/
@PostMapping("importExcel")
public String importExcel(HttpServletResponse response, @RequestParam("file") MultipartFile file) {
//解析excel
List<UserEntity> userList = ExcelUtil.importExcel(file, 0, 1, UserEntity.class);
//也可以使用String filePath = "xxx.xls";importExcel(String filePath,Integer titleRows,Integer headerRows, Class<T> pojoClass)导入
System.out.println("导入数据一共【" + userList.size() + "】行");
System.out.println("导入的数据:" + userList);
//TODO 保存数据库
return "Success";
}
导入前端代码
<input type="file" id="file3" value="ajax">
<input type="button" value="导入execl" onclick="importExcel()"/>
<script>
function importExcel() {
var file=$("#file3")[0].files[0];
var formData = new FormData();
formData.append("file",file);
$.ajax({
type:"post",
url:"file/importExcel",
processData: false,
contentType:false,
data:formData,
success:function (result) {
alert(result)
}
})
}
</script>