SpringBoot實現(xiàn)文件上傳接口

更新時間：2019年11月30日 08:36:22 作者：lan_xuewei

這篇文章主要為大家詳細介紹了SpringBoot實現(xiàn)文件上傳接口，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下

摘要

公司都是采用SpringBoot作為項目框架，其實SpringBoot和SSM框架很接近，基本上只是將SSM的一些配置項修改為自動配置或者簡單的注解配置就可以了，建議不了解的SpringBoot的朋友們可以了解一下，上手很快，其實文件上傳框架根本沒有多大關(guān)系。我只是順便幫SpringBoot打個廣告罷了。

正題

需求：需要實現(xiàn)一個文件上傳的web接口。

1、先實現(xiàn)一個Controller接口，如下：

package com.lanxuewei.utils.aspect;

import com.lanxuewei.utils.interceptor.annotation.AppIdAuthorization;
import com.lanxuewei.utils.model.ReturnCodeAndMsgEnum;
import com.lanxuewei.utils.model.ReturnValue;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

/**
 * @author lanxuewei Create in 2018/7/3 20:01
 * Description: aop 測試控制器
 */
@RestController
@RequestMapping(value = "/aop")
public class TestController {

 private static final Logger logger = LoggerFactory.getLogger(TestController.class);

 @Autowired
 private TestService testService;

 /**
 * 文件上傳測試接口
 * @return
 */
 @AppIdAuthorization
 @RequestMapping("/upload")
 public ReturnValue uploadFileTest(@RequestParam("uploadFile") MultipartFile zipFile) {
 return testService.uploadFileTest(zipFile);
 }
}

2、Service接口如下：

package com.lanxuewei.utils.aspect;

import org.springframework.web.multipart.MultipartFile;

import com.lanxuewei.utils.model.ReturnValue;

public interface TestService {

 public ReturnValue uploadFileTest(MultipartFile zipFile);
}

3、Service實現(xiàn)如下：

package com.lanxuewei.utils.aspect;

import com.lanxuewei.utils.model.ReturnCodeAndMsgEnum;
import com.lanxuewei.utils.model.ReturnValue;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.UUID;

/**
 * @author lanxuewei Create in 2018/8/14 10:01
 * Description: 
 */
@Service
public class TestServiceImp implements TestService {

 private static final Logger logger = LoggerFactory.getLogger(TestServiceImp.class);

 @Override
 public ReturnValue uploadFileTest(MultipartFile zipFile) {
 String targetFilePath = "D:\\test\\uploadTest";
 String fileName = UUID.randomUUID().toString().replace("-", "");
 File targetFile = new File(targetFilePath + File.separator + fileName);

 FileOutputStream fileOutputStream = null;
 try {
  fileOutputStream = new FileOutputStream(targetFile);
  IOUtils.copy(zipFile.getInputStream(), fileOutputStream);
  logger.info("------>>>>>>uploaded a file successfully!<<<<<<------");
 } catch (IOException e) {
  return new ReturnValue<>(-1, null);
 } finally {
  try {
  fileOutputStream.close();
  } catch (IOException e) {
  logger.error("", e);
  }
 }
 return new ReturnValue<>(ReturnCodeAndMsgEnum.Success, null);
 }
}

說明：

1、targetFilePath為文件保存路徑，本人用于測試所以指定路徑，可根據(jù)實際情況進行修改。
2、fileName采用UUID生成，保證文件名唯一不重復，但是沒有保留原文件后綴，可通過獲取原文件文件名后，調(diào)用lastIndexOf(“.”)獲取文件原后綴加上。
3、IOUtils為org.apache.commons.io.IOUtils，注意別導入錯誤。
4、本文中采用logback日志系統(tǒng)，可根據(jù)實際情況修改或刪除。

附上ReturnValue以及ReturnCodeAndMsgEnum類，用于Controller層統(tǒng)一返回前端的model，如下：

package com.lanxuewei.utils.model;

import java.io.Serializable;

/**
 * @author lanxuewei Create in 2018/7/3 20:05
 * Description: 統(tǒng)一web返回結(jié)果
 */
public class ReturnValue<T> implements Serializable {
 private static final long serialVersionUID = -1959544190118740608L;
 private int ret;
 private String msg;
 private T data;

 public ReturnValue() {
 this.ret = 0;
 this.msg = "";
 this.data = null;
 }

 public ReturnValue(int retCode, String msg, T data) {
 this.ret = 0;
 this.msg = "";
 this.data = null;
 this.ret = retCode;
 this.data = data;
 this.msg = msg;
 }

 public ReturnValue(int retCode, String msg) {
 this.ret = 0;
 this.msg = "";
 this.data = null;
 this.ret = retCode;
 this.msg = msg;
 }

 public ReturnValue(ReturnCodeAndMsgEnum codeAndMsg) {
 this(codeAndMsg.getCode(), codeAndMsg.getMsg(), null);
 }

 public ReturnValue(ReturnCodeAndMsgEnum codeAndMsg, T data) {
 this(codeAndMsg.getCode(), codeAndMsg.getMsg(), data);
 }

 public int getRet() {
 return this.ret;
 }

 public void setRet(int ret) {
 this.ret = ret;
 }

 public String getMsg() {
 return this.msg;
 }

 public void setMsg(String msg) {
 this.msg = msg;
 }

 public T getData() {
 return this.data;
 }

 public void setData(T data) {
 this.data = data;
 }

 @Override
 public String toString() {
 return "ReturnValue{" +
  "ret=" + ret +
  ", msg='" + msg + '\'' +
  ", data=" + data +
  '}';
 }
}

package com.lanxuewei.utils.model;

/**
 * @author lanxuewei Create in 2018/7/3 20:06
 * Description: web相關(guān)接口返回狀態(tài)枚舉
 */
public enum ReturnCodeAndMsgEnum {
 Success(0, "ok"),
 No_Data(-1, "no data"),
 SYSTEM_ERROR(10004, "system error");

 private String msg;
 private int code;

 private ReturnCodeAndMsgEnum(int code, String msg) {
 this.code = code;
 this.msg = msg;
 }

 public static ReturnCodeAndMsgEnum getByCode(int code) {
 ReturnCodeAndMsgEnum[] var1 = values();
 int var2 = var1.length;

 for(int var3 = 0; var3 < var2; ++var3) {
  ReturnCodeAndMsgEnum aiTypeEnum = var1[var3];
  if (aiTypeEnum.code == code) {
  return aiTypeEnum;
  }
 }

 return Success;
 }

 public String getMsg() {
 return this.msg;
 }

 public int getCode() {
 return this.code;
 }
}

Postman發(fā)請求返回結(jié)果成功，以上代碼只需要uploadFile一個參數(shù)即可。

注意事項： application.properties配置文件中可以配置文件上傳相關(guān)屬性，配置上傳文件大小限制。
單個文件最大限制：spring.servlet.multipart.max-file-size=50Mb
單次請求最大限制：spring.servlet.multipart.max-request-size=70Mb

總結(jié)：本文功能較為簡單，所以有些過程并沒有更細致過程以及規(guī)范代碼，比如存放路徑采用項目路徑，新文件名保持和原文件后綴一致等，需要的小伙伴可以根據(jù)自己業(yè)務進行修改。

續(xù)更，總覺得代碼過于隨意了，補充文件上傳獲得文件后綴相關(guān)函數(shù)

private String getFileSuffix(MultipartFile file) {
 if (file == null) {
  return null;
 }
 String fileName = file.getOriginalFilename();
 int suffixIndex = fileName.lastIndexOf(".");
 if (suffixIndex == -1) { // 無后綴
  return null;
 } else {   // 存在后綴
  return fileName.substring(suffixIndex, fileName.length());
 }
 }

在隨機生成文件名后補充如下代碼即可，如果返回文件后綴不為空則將其加入新產(chǎn)生的文件名中即可：

String fileSuffix = getFileSuffix(zipFile);
 if (fileSuffix != null) { // 拼接后綴
  fileName += fileSuffix;
 }
 File targetFile = new File(targetFilePath + File.separator + fileName);

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: