Spring boot上传和下载文件

• 引言
  项目中使用了spring boot框架，要开发新的上传下载功能，总结一下自己的经验和工作。方便大家引用和少踩坑！（JDK采用1.8）
• 1 引入maven依赖

            <dependency>
	            <groupId>commons-io</groupId>
	            <artifactId>commons-io</artifactId>
	            <version>2.6</version>
        	</dependency>

• 2 controller层主要使用MultipartFile这个spring框架自带的文件上传工具类，前端只需要使用from表单,然后使用ajax提交即可

import com.supermap.application.common.ReturnObject;
import com.supermap.application.service.FileUploadService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.List;

/**
 * @name 文件传输 
 * @author sun'f
 * @version 1.0
 *
 */
@Controller
@RequestMapping(value = "/file/upload")
public class FileUploadController {

    @Autowired
   FileUploadService fileUploadService;
   
    /**
     * 上传文件到服务器
     * @param file 本地文件地址
     * @param serverUploadAddress 服务器上传路径
     * @return returnObject
     */
    @PostMapping("/server")
    @ResponseBody
    public ReturnObject uploadFileToServer(@RequestParam("file") MultipartFile file,
                                           String fileName,String serverUploadAddress) {
         //处理文件名称,必要时进行编码控制                                  
        String newName = fileUploadService.getWholeName(file,fileName);
        return fileUploadService.uploadFile(file,newName,serverUploadAddress);
    }

   /**
     * 遍历windows服务器上配置文件下所有上传文件信息-返回Map <文件名,文件根路径>
     * @param filePath 目标文件夹
     * @return returnObject
     */
    @GetMapping("/get/files")
    @ResponseBody
    public ReturnObject getAllFileDirectory(String filePath) {
        return fileUploadService.getAllFileDirectory(filePath);
    }


    /**
     * 下载指定模板 （主要使用上一个接口的返回文件名称，下载指定的文件，由于是get请求，所以在浏览器输入地址和参数就能测试下载）
     * @param response  	HttpServletResponse
     * @param filePath  	下载模板路径
     * @param fileName  	下载的模板文件名称(完整名称包含后缀名)
     * @return ReturnObject
     */
    @GetMapping(value = "/download")
    @ResponseBody
    public ReturnObject Download(HttpServletResponse response,String filePath,String fileName) {
        return fileUploadService.download(response,filePath,fileName);
    }

}

• Service 层

import java.io.*;
import java.net.URLEncoder;
import java.util.*;
import com.supermap.application.common.ReturnObject;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.filefilter.DirectoryFileFilter;
import org.apache.commons.io.filefilter.TrueFileFilter;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
/**
 * @author sun'f
 */
@Service
public class FileUploadService {

	//本地 windows 服务器文件存储路径，配置在application.properties文件里
    @Value("${server.upload.address}")
    private String serverUploadAddress;

  /**
     * 获取文件名的全名-处理文件名称
     * @param file      文件
     * @param fileName  文件名
     * @return string
     */
    public String getWholeName(MultipartFile file,String fileName){
        //获取文件类型
        String afterName = file.getOriginalFilename();
        String suffix = getSuffixName(afterName);
        //处理文件名称
        StringBuffer stringBuffer = new StringBuffer();
        stringBuffer.append(fileName).append(suffix);
        String newName = stringBuffer.toString();
        return newName;
    }


    //取文件后缀名
    public String getSuffixName(String afterName){
        return afterName.substring(afterName.lastIndexOf("."));
    }


  /**
     * spring boot文件上传到 windows服务器
     * @param file http文件
     * @return ReturnObject
     */
    public ReturnObject uploadFile(MultipartFile file,String fileName,String serverPath){
        // 判断是否为空文件
        if (!file.isEmpty()) {
            try {
                //文件夹校验
                File serverFileDirectory = new File(serverPath);
                if (!serverFileDirectory.exists()) {
                    serverFileDirectory.mkdir();
                }
                // 使用transferTo
                file.transferTo(new File(serverPath + fileName));
            }catch (IOException e){
                e.printStackTrace();
            }
            return new ReturnObject(true,"请求成功！","文件上传成功！");
        } else {
            return new ReturnObject("上传文件为空");
        }
    }


 /**
     * 获取文件夹下所有文件数据 （只获取文件信息，文件夹跳过，但可用递归来遍历文件夹）
     * @return ReturnObject map<文件名，根路径>
     */
    public ReturnObject getAllFileDirectory(String filePath){
        if (filePath.isEmpty()) {
        	//系统默认地址，我这里配置了一个全局配置文件变量
            filePath = serverUploadAddress;
        }
        Map<String,String> map = new HashMap<>();
        File directory = new File(filePath);
        Collection<File> files = getTemplateDirectoryFiles(directory);
        if (files.size() < 1) {
            return new ReturnObject("未上传任何文件");
        }
        files.forEach(t -> {
            if (!t.isDirectory()) {
                map.put(t.getName(),t.getAbsolutePath());
            }
        });
        return new ReturnObject(map);
    }

  /**
     * 强大如 apache
     * 获取目录所有文件列表和目录
     *
     * @param directory the directory
     * @return the file list
     */
    public Collection<File> getTemplateDirectoryFiles(File directory) {
        return FileUtils.listFilesAndDirs(directory, TrueFileFilter.INSTANCE, DirectoryFileFilter.INSTANCE);
    }




    /**
     * 下载经协服务器模板文件
     * @param res       HttpServletResponse
     * @param fileName  模板文件名
     */
    public ReturnObject download(HttpServletResponse res,String filepath,String fileName) {
        res.setHeader("content-type", "application/octet-stream");
        res.setContentType("application/octet-stream");
        byte[] buff = new byte[1024];
        BufferedInputStream bis = null;
        OutputStream os = null;
        try {
        	//有的同学这里没设置编码，下载的文件名是一条直线或者乱码
            res.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileName,"UTF-8"));
            os = res.getOutputStream();
            bis = new BufferedInputStream(new FileInputStream(new File(filepath + fileName)));
            int i = bis.read(buff);
            while (i != -1) {
                os.write(buff, 0, buff.length);
                os.flush();
                i = bis.read(buff);
            }
            os.flush();
        } catch (IOException e) {
            e.printStackTrace();
            return new ReturnObject("系统找不到指定文件！");
        } finally {
            if (bis != null) {
                try {
                    bis.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
            return new ReturnObject(true,"请求成功！","下载文件成功！");
        }
    }



}

• 最后为大家奉上我自己写的统一返回值对象类ReturnObject
  maven依赖net.json

 		<dependency>
            <groupId>net.sf.json-lib</groupId>
            <artifactId>json-lib</artifactId>
            <version>2.4</version>
            <classifier>jdk15</classifier>
        </dependency>

import net.sf.json.JSONObject;

/**
 * 新增返回对象类
 * @author sun'f
 * @param <T>
 */
public class ReturnObject<T> {

    //返回状态
    private boolean status;

    //返回提示
    private String message;

    //返回对象
    private T data;

    /**
     * 返回错误默认构造函数
     */
    public ReturnObject() {
        this.status = false;
        this.message = "请求错误！";
        this.data = null;
    }

    /**
     * 常规构造函数
     * @param status
     * @param message
     * @param data
     */
    public ReturnObject(boolean status, String message, T data) {
        this.status = status;
        this.message = message;
        this.data = data;
    }

    /**
     * post返回成功
     * 一般post请求返回值只需提供data返回数据
     * @param data
     */
    public ReturnObject(T data) {
        this.status = true;
        this.message = "请求成功！";
        this.data = data;
    }


    /**
     * post返回失败
     * 一般post请求返回值只需提供message返回数据
     * @param message
     */
    public ReturnObject(String message) {
        this.status = false;
        this.message = message;
        this.data = null;
    }

    public boolean isStatus() {
        return status;
    }

    public void setStatus(boolean status) {
        this.status = status;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public Object getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
	
	
    public JSONObject toJson(ReturnObject returnObject){
        return JSONObject.fromObject(returnObject);
    }
    
	//以下代码可扩展.考虑到线程安全使用类同StringBuffer，比如：ReturnObejct.append(true).appent("请求成功").appent(Map);
    public synchronized ReturnObject<T> append(Boolean boo){
       this.setStatus(boo);
       return this;
    }

    public synchronized ReturnObject<T> append(String str){
        this.setMessage(str);
        return this;
    }

    public synchronized ReturnObject<T> append(T t){
        this.setData(t);
        return this;
    }

}