【Spring-boot-route(三)实现多文件上传+(四)全局异常处理】

时间:2023-02-09 16:12:33

Spring Boot默认上传的单个文件大小​​1MB​​​,一次上传的总文件大小为​​10MB​​。

单个文件上传使用MultipartFile参数来接收文件,多文件使用MultipartFile[]数组来接收,然后遍历它,当成单文件来处理。

问题一:如何配置上传文件大小限制?

@Configuration
public class FileConfig implements WebMvcConfigurer {
@Bean
public MultipartConfigElement multipartConfigElement(){
MultipartConfigFactory factory = new MultipartConfigFactory();
// 单个文件大小
factory.setMaxFileSize(DataSize.parse("10240MB"));
// 上传的总文件大小
factory.setMaxRequestSize(DataSize.parse("20480MB"));
return factory.createMultipartConfig();
}
}

思考:SpringBoot项目推荐使用jar包的方式来运行项目,而实际应用中我们也发现jar包运行项目更加方便。但是当打完jar包后,这个jar的大小就固定好了,上传的文件肯定传不到jar包里面了。SpringBoot提供了一种方式,将文件上传到服务器物理路径下,然后做个映射关系,让图片可以正常被访问,具体操作如下:


@Configuration
public class FileConfig implements WebMvcConfigurer {

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/static/**").addResourceLocations("file:"+"D://uploadfile/");
}
}

addResourceHandler("/static/**")表示访问路径为/static/文件名,addResourceLocations("file:"+"D://uploadfile/")表示文件存储的物理路径,"file:"为固定写法。

文件上传后台实现


@RestController
@Slf4j
public class FileUpload {

@PostMapping("uploadFile")
public List uploadFile(@RequestParam("files") MultipartFile[] files) {

// 存储上传成功的文件名,响应给客户端
List<String> list = new ArrayList<>();
// 判断文件数组长度
if(files.length <= 0){
list.add("请选择文件");
return list;
}
for(MultipartFile file : files){
// 源文件名
String originalFilename = file.getOriginalFilename();
// 文件格式
String suffix = originalFilename.substring(originalFilename.lastIndexOf("."));
// 新文件名,避免文件名重复,造成文件替换问题
String fileName = UUID.randomUUID()+"."+suffix;
// 文件存储路径
String filePath = "D:/uploadFile/";
// 文件全路径
File targetFile = new File(filePath+fileName);

// 判断文件存储目录是否存在,不存在则新建目录
if(!targetFile.getParentFile().exists()){
targetFile.getParentFile().mkdir();
}
try {
// 将图片保存
file.transferTo(targetFile);
list.add(originalFilename);
} catch (IOException e) {
log.info("文件上传异常={}",e);
}
}
return list;
}
}

静态资源问题

SpringBoot静态资源默认路径为:​​classpath:/META-INF/resources/​​ ,​​classpath:/resources/​​,​​classpath:/static/​​,​​classpath:/public/​​。也就是说如果想访问静态资源,则需要将静态资源 文件放在这四个路径下面。

注:classpath 指的是 SpringBoot项目resources

如果想自定义静态资源路径有两种方式,

application.yml中指定


spring:
resources:
static-locations: classpath:/templates/

代码实现WebMvcConfigurer


@Configuration
public class FileConfig implements WebMvcConfigurer {

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**").addResourceLocations("classpath:/templates/");
}

注:当配置了自定义静态资源路径后,其默认配置将失效

文件上传前端实现

在静态资源路径下,新建file.html文件,浏览器访问ip:port/file.html,进入file页面


<form enctype="multipart/form-data" method="post" action="/uploadFile">
文件:<input type="file" name="files"/>
<input type="submit" value="上传"/>
</form>

这里需要注意的是文件上传表单的enctype为multipart/form-data

此是spring-boot-route系列的第三篇文章,这个系列的文章都比较简单,主要目的就是为了帮助初次接触Spring Boot 的同学有一个系统的认识。


》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》》

下面来讲解:

【spring-boot-route(四)全局异常处理】

在开发中,我们经常会使用​​try/catch块​​​来捕获异常进行处理,如果有些代码中忘记捕获异常或者不可见的一些异常出现,就会响应给前端一些不友好的提示,这时候我们可以使用全局异常处理。这样就不用在代码中写那些烦人的​​try/catch块了​​,代码的可读性也会提高。

SpringBoot提供的的注解​​@ControllerAdvice​​表示开启全局异常捕获,在自定义的异常方法上使用​​ExceptionHandler​​来进行统一处理。

下面一起看看如何优雅的处理全局异常!

一 定义响应状态码及信息的枚举类


@Getter
public enum CodeEnum {

SUCCESS(0,"请求成功"),
ERROR(500,"未知异常"),
ERROR_EMPTY_RESULT(1001,"查询结果为空"),
ERROR_INCOMPLETE_RESULT(1002,"请求参数不全");

private int code;
private String message;
CodeEnum(int code,String message){
this.code = code;
this.message = message;
}
}

二 定义响应数据的实体类


@Slf4j
@Data
public class R<T> implements Serializable {

private static final long serialVersionUID = 572235155491705152L;
/**
* 响应的状态码
*/
private int code;
/***
* 响应的信息
*/
private String message;
/**
* 响应数据
*/
private T data;

/**
* 放入响应码并返回
* @param code
* @param msg
* @return
*/
public R fillCode(int code,String msg){
this.code = code;
this.message = msg;
return this;
}

/**
* 放入响应码并返回
* @param codeEnum
* @return
*/
public R fillCode(CodeEnum codeEnum){
this.code = codeEnum.getCode();
this.message = codeEnum.getMessage();
return this;
}

/**
* 放入数据并响应成功状态
* @param data
* @return
*/
public R fillData(T data){
this.code = CodeEnum.SUCCESS.getCode();
this.message = CodeEnum.SUCCESS.getMessage();
this.data = data;
return this;
}
}

三 自定义两个异常

根据业务需求自定义异常,在本文中我定义了两个异常,分别用作响应结果为空时处理和请求参数错误时处理。


@Data
public class EmptyResutlException extends RuntimeException {

private static final long serialVersionUID = -8839210969758687047L;
private int code;
private String message;

public EmptyResutlException(CodeEnum codeEnum){
this.code = codeEnum.getCode();
this.message = codeEnum.getMessage();
}
}


@Data
public class RequestParamException extends RuntimeException {

private static final long serialVersionUID = 4748844811214637041L;
private int code;
private String message;

public RequestParamException(CodeEnum codeEnum){
this.code = codeEnum.getCode();
this.message = codeEnum.getMessage();
}
}

四 定义全局异常处理类

由于这里我想要响应的结果为实体类对象,因此我直接用​​@RestControllerAdvice​​来代替了​​@ControllerAdvice​​,这两个注解的差别跟​​@Controller​​和​​@RestController​​一样,rest的响应体为json格式的数据。


@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

/**
* 查询结果为空时处理
* @param e
* @return
*/
@ExceptionHandler(EmptyResutlException.class)
public R emptyResultExceptionHandler(EmptyResutlException e){
log.error("查询结果为空:{}",e.getMessage());
R result = new R();
result.fillCode(e.getCode(),e.getMessage());
return result;
}

/**
* 请求参数错误时处理
* @param e
* @return
*/
@ExceptionHandler(RequestParamException.class)
public R requestParamExceptionHandler(RequestParamException e){
log.error("请求参数不合法:{}",e.getMessage());
R result = new R();
result.fillCode(e.getCode(),e.getMessage());
return result;
}

/**
* 处理其他异常
* @param e
* @return
*/
@ExceptionHandler(Exception.class)
public R exceptionHandler(Exception e){
log.error("未知异常:{}",e.getMessage());
R result = new R();
result.fillCode(CodeEnum.ERROR);
return result;
}
}

五 自定义接口测试异常

【Spring-boot-route(三)实现多文件上传+(四)全局异常处理】

在实际开发中可以自定义响应状态码的枚举类和自定义异常以满足需求。

此是spring-boot-route系列的第四篇文章,这个系列的文章都比较简单,主要目的就是为了帮助初次接触Spring Boot 的同学有一个系统的认识。