Spring Boot:上传文件

一.使用 Spring Boot 上传文件

1.pom 包配置

我们使用 Spring Boot 版本 2.1.0、jdk 1.8、tomcat 8.0。

	<parent>
	    <groupId>org.springframework.boot</groupId>
	    <artifactId>spring-boot-starter-parent</artifactId>
	    <version>2.1.0.RELEASE</version>
	</parent>
	
	<properties>
	    <java.version>1.8</java.version>
	</properties>
	
	<dependencies>
	    <dependency>
	        <groupId>org.springframework.boot</groupId>
	        <artifactId>spring-boot-starter-web</artifactId>
	    </dependency>
	    <dependency>
	        <groupId>org.springframework.boot</groupId>
	        <artifactId>spring-boot-starter-thymeleaf</artifactId>
	    </dependency>
	    <dependency>
	        <groupId>org.springframework.boot</groupId>
	        <artifactId>spring-boot-devtools</artifactId>
	        <optional>true</optional>
	    </dependency>
	</dependencies>

引入了 spring-boot-starter-thymeleaf 做页面模板引擎,写一些简单的上传示例。

2.启动类设置
	@SpringBootApplication
	public class FileUploadWebApplication {
	
	    public static void main(String[] args) throws Exception {
	        SpringApplication.run(FileUploadWebApplication.class, args);
	    }
	
	    @Bean
	    public TomcatServletWebServerFactory tomcatEmbedded() {
	        TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory();
	        tomcat.addConnectorCustomizers((TomcatConnectorCustomizer) connector -> {
	            if ((connector.getProtocolHandler() instanceof AbstractHttp11Protocol<?>)) {
	                //-1 means unlimited
	                ((AbstractHttp11Protocol<?>) connector.getProtocolHandler()).setMaxSwallowSize(-1);
	            }
	        });
	        return tomcat;
	    }
	}

tomcatEmbedded 这段代码是为了解决,上传文件大于10M出现连接重置的问题。此异常内容 GlobalException 也捕获不到。
在这里插入图片描述
详细内容参考:Tomcat large file upload connection reset

3.编写前端页面

上传页面:

	<!DOCTYPE html>
	<html xmlns:th="http://www.thymeleaf.org">
	<body>
	<h1>Spring Boot file upload example</h1>
	<form method="POST" action="/upload" enctype="multipart/form-data">
	    <input type="file" name="file" /><br/><br/>
	    <input type="submit" value="Submit" />
	</form>
	</body>
	</html>

非常简单的一个 Post 请求,一个选择框选择文件,一个提交按钮,效果如下:
在这里插入图片描述
上传结果展示页面:

	<!DOCTYPE html>
	<html lang="en" xmlns:th="http://www.thymeleaf.org">
	<body>
	<h1>Spring Boot - Upload Status</h1>
	<div th:if="${message}">
	    <h2 th:text="${message}"/>
	</div>
	</body>
	</html>

效果图如下:
在这里插入图片描述

4.编写上传控制类

访问 localhost 自动跳转到上传页面:

	@GetMapping("/")
	public String index() {
	    return "upload";
	}

上传业务处理:

	@PostMapping("/upload") 
	public String singleFileUpload(@RequestParam("file") MultipartFile file, RedirectAttributes redirectAttributes) {
	    if (file.isEmpty()) {
	        redirectAttributes.addFlashAttribute("message", "Please select a file to upload");
	        return "redirect:uploadStatus";
	    }
	
	    try {
	        // Get the file and save it somewhere
	        byte[] bytes = file.getBytes();
	        Path path = Paths.get(UPLOADED_FOLDER + file.getOriginalFilename());
	        Files.write(path, bytes);
	
	        redirectAttributes.addFlashAttribute("message", "You successfully uploaded '" + file.getOriginalFilename() + "'");
	    } catch (IOException e) {
	        e.printStackTrace();
	    }
	    return "redirect:/uploadStatus";
	}

上面代码的意思就是,通过 MultipartFile 读取文件信息,如果文件为空跳转到结果页并给出提示;如果不为空读取文件流并写入到指定目录,最后将结果展示到页面。
MultipartFile 是 Spring 上传文件的封装类,包含了文件的二进制流和文件属性等信息,在配置文件中也可对相关属性进行配置,基本的配置信息如下:

  • spring.http.multipart.enabled=true #默认支持文件上传。
  • spring.http.multipart.file-size-threshold=0 #支持文件写入磁盘。
  • spring.http.multipart.location= # 上传文件的临时目录。
  • spring.http.multipart.max-file-size=1Mb # 最大支持文件大小。
  • spring.http.multipart.max-request-size=10Mb # 最大支持请求大小。

最常用的是最后两个配置内容,限制文件上传大小,上传时超过大小会抛出异常:
在这里插入图片描述
更多配置信息参考这里:Common application properties

5.异常处理
	@ControllerAdvice
	public class GlobalExceptionHandler {
	
	    @ExceptionHandler(MultipartException.class)
	    public String handleError1(MultipartException e, RedirectAttributes redirectAttributes) {
	        redirectAttributes.addFlashAttribute("message", e.getCause().getMessage());
	        return "redirect:/uploadStatus";
	    }
	}

设置一个 @ControllerAdvice 用来监控 Multipart 上传的文件大小是否受限,当出现此异常时在前端页面给出提示。利用 @ControllerAdvice可以做很多东西,比如全局的统一异常处理等,感兴趣的同学可以下来了解。

二.使用 Spring Boot 集成 FastDFS

1.pom 包配置
	<dependency>
	    <groupId>org.csource</groupId>
	    <artifactId>fastdfs-client-java</artifactId>
	    <version>1.27-SNAPSHOT</version>
	</dependency>

加入了 fastdfs-client-java 包,用来调用 FastDFS 相关的 API。

2.配置文件

resources 目录下添加 fdfs_client.conf 文件:

	connect_timeout = 60
	network_timeout = 60
	charset = UTF-8
	http.tracker_http_port = 8080
	http.anti_steal_token = no
	http.secret_key = 123456
	
	tracker_server = 192.168.53.85:22122
	tracker_server = 192.168.53.86:22122

配置文件设置了连接的超时时间,编码格式以及 tracker_server 地址等信息。
详细内容参考:fastdfs-client-java

3.封装 FastDFS 上传工具类

封装 FastDFSFile,文件基础信息包括文件名、内容、文件类型、作者等。

	public class FastDFSFile {
	    private String name;
	    private byte[] content;
	    private String ext;
	    private String md5;
	    private String author;
	    //省略getter、setter
	}

封装 FastDFSClient 类,包含常用的上传、下载、删除等方法。
首先在类加载的时候读取相应的配置信息,并进行初始化。

	static {
	    try {
	        String filePath = new ClassPathResource("fdfs_client.conf").getFile().getAbsolutePath();;
	        ClientGlobal.init(filePath);
	        trackerClient = new TrackerClient();
	        trackerServer = trackerClient.getConnection();
	        storageServer = trackerClient.getStoreStorage(trackerServer);
	    } catch (Exception e) {
	        logger.error("FastDFS Client Init Fail!",e);
	    }
	}

文件上传

	public static String[] upload(FastDFSFile file) {
	    logger.info("File Name: " + file.getName() + "File Length:" + file.getContent().length);
	
	    NameValuePair[] meta_list = new NameValuePair[1];
	    meta_list[0] = new NameValuePair("author", file.getAuthor());
	
	    long startTime = System.currentTimeMillis();
	    String[] uploadResults = null;
	    try {
	        storageClient = new StorageClient(trackerServer, storageServer);
	        uploadResults = storageClient.upload_file(file.getContent(), file.getExt(), meta_list);
	    } catch (IOException e) {
	        logger.error("IO Exception when uploadind the file:" + file.getName(), e);
	    } catch (Exception e) {
	        logger.error("Non IO Exception when uploadind the file:" + file.getName(), e);
	    }
	    logger.info("upload_file time used:" + (System.currentTimeMillis() - startTime) + " ms");
	
	    if (uploadResults == null) {
	        logger.error("upload file fail, error code:" + storageClient.getErrorCode());
	    }
	    String groupName = uploadResults[0];
	    String remoteFileName = uploadResults[1];
	
	    logger.info("upload file successfully!!!" + "group_name:" + groupName + ", remoteFileName:" + " " + remoteFileName);
	    return uploadResults;
	}

使用 FastDFS 提供的客户端 storageClient 来进行文件上传,最后将上传结果返回。
根据 groupName 和文件名获取文件信息。

	public static FileInfo getFile(String groupName, String remoteFileName) {
	    try {
	        storageClient = new StorageClient(trackerServer, storageServer);
	        return storageClient.get_file_info(groupName, remoteFileName);
	    } catch (IOException e) {
	        logger.error("IO Exception: Get File from Fast DFS failed", e);
	    } catch (Exception e) {
	        logger.error("Non IO Exception: Get File from Fast DFS failed", e);
	    }
	    return null;
	}

下载文件

	public static InputStream downFile(String groupName, String remoteFileName) {
	    try {
	        storageClient = new StorageClient(trackerServer, storageServer);
	        byte[] fileByte = storageClient.download_file(groupName, remoteFileName);
	        InputStream ins = new ByteArrayInputStream(fileByte);
	        return ins;
	    } catch (IOException e) {
	        logger.error("IO Exception: Get File from Fast DFS failed", e);
	    } catch (Exception e) {
	        logger.error("Non IO Exception: Get File from Fast DFS failed", e);
	    }
	    return null;
	}

删除文件

	public static void deleteFile(String groupName, String remoteFileName)
	        throws Exception {
	    storageClient = new StorageClient(trackerServer, storageServer);
	    int i = storageClient.delete_file(groupName, remoteFileName);
	    logger.info("delete file successfully!!!" + i);
	}

使用 FastDFS 时,直接调用 FastDFSClient 对应的方法即可。

4.编写上传控制类

从 MultipartFile 中读取文件信息,然后使用 FastDFSClient 将文件上传到 FastDFS 集群中。

	public String saveFile(MultipartFile multipartFile) throws IOException {
	    String[] fileAbsolutePath={};
	    String fileName=multipartFile.getOriginalFilename();
	    String ext = fileName.substring(fileName.lastIndexOf(".") + 1);
	    byte[] file_buff = null;
	    InputStream inputStream=multipartFile.getInputStream();
	    if(inputStream!=null){
	        int len1 = inputStream.available();
	        file_buff = new byte[len1];
	        inputStream.read(file_buff);
	    }
	    inputStream.close();
	    FastDFSFile file = new FastDFSFile(fileName, file_buff, ext);
	    try {
	        fileAbsolutePath = FastDFSClient.upload(file);  //upload to fastdfs
	    } catch (Exception e) {
	        logger.error("upload file Exception!",e);
	    }
	    if (fileAbsolutePath==null) {
	        logger.error("upload file failed,please upload again!");
	    }
	    String path=FastDFSClient.getTrackerUrl()+fileAbsolutePath[0]+ "/"+fileAbsolutePath[1];
	    return path;
	}

请求控制,调用上面方法 saveFile()。

	@PostMapping("/upload") //new annotation since 4.3
	public String singleFileUpload(@RequestParam("file") MultipartFile file,
	                               RedirectAttributes redirectAttributes) {
	    if (file.isEmpty()) {
	        redirectAttributes.addFlashAttribute("message", "Please select a file to upload");
	        return "redirect:uploadStatus";
	    }
	    try {
	        // Get the file and save it somewhere
	        String path=saveFile(file);
	        redirectAttributes.addFlashAttribute("message",
	                "You successfully uploaded '" + file.getOriginalFilename() + "'");
	        redirectAttributes.addFlashAttribute("path",
	                "file path url '" + path + "'");
	    } catch (Exception e) {
	        logger.error("upload file failed",e);
	    }
	    return "redirect:/uploadStatus";
	}

上传成功之后,将文件的路径展示到页面,效果图如下:
在这里插入图片描述
在浏览器中访问此 Url,可以看到成功通过 FastDFS 展示。

参考文章:http://www.ityouknow.com/springboot/2018/01/12/spring-boot-upload-file.html
http://www.ityouknow.com/springboot/2018/01/16/spring-boot-fastdfs.html

  • 0
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值