SpringCloud實現檔案上傳功能的方法詳解

2022-08-25 10:01:38

圖片上傳

剛才的新增實現中，我們並沒有上傳圖片，接下來我們一起完成圖片上傳邏輯。

檔案的上傳並不只是在品牌管理中有需求，以後的其它服務也可能需要，因此我們建立一個獨立的微服務，專門處理各種上傳。

搭建專案

建立SpringCloud專案

新增依賴

我們需要EurekaClient和web依賴：

<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>leyou</artifactId>
        <groupId>com.leyou.parent</groupId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.leyou.service</groupId>
    <artifactId>ly-upload</artifactId>
    <version>1.0.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
</project>

編寫設定

server:
  port: 8082
spring:
  application:
    name: upload-service
  servlet:
    multipart:
      max-file-size: 5MB # 限制檔案上傳的大小
# Eureka
eureka:
  client:
    service-url:
      defaultZone: http://127.0.0.1:10086/eureka
  instance:
    lease-renewal-interval-in-seconds: 5 # 每隔5秒傳送一次心跳
    lease-expiration-duration-in-seconds: 10 # 10秒不傳送就過期
    prefer-ip-address: true
    ip-address: 127.0.0.1
    instance-id: ${spring.application.name}:${server.port}

需要注意的是，我們應該新增了限制檔案大小的設定

2.1.4.啟動類

@SpringBootApplication
@EnableDiscoveryClient
public class LyUploadService {
    public static void main(String[] args) {
        SpringApplication.run(LyUploadService.class, args);
    }
}

結構：

編寫上傳功能

controller

編寫controller需要知道4個內容：

請求方式：上傳肯定是POST
請求路徑：/upload/image
請求引數：檔案，引數名是file，SpringMVC會封裝為一個介面：MultipleFile
返回結果：上傳成功後得到的檔案的url路徑

程式碼如下：

package com.leyou.upload.web;

import com.leyou.upload.service.UploadService;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
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;

@RestController
@RequestMapping("upload")
public class UploadController {
    @Autowired
    private UploadService uploadService;
    /**
     * 上傳圖片功能
     * @param file
     * @return
     */
    @PostMapping("image")
    public ResponseEntity<String> uploadImage(@RequestParam("file") MultipartFile file){
        String url = uploadService.uploadImage(file);
        if(StringUtils.isBlank(url)){
            // url為空，證明上傳失敗
            return new ResponseEntity<>(HttpStatus.BAD_REQUEST);
        }
        // 返回200，並且攜帶url路徑
        return ResponseEntity.ok(url);
    }
}

service

在上傳檔案過程中，我們需要對上傳的內容進行校驗：

校驗檔案大小
校驗檔案的媒體型別
校驗檔案的內容

檔案大小在Spring的組態檔中設定，因此已經會被校驗，我們不用管。

具體程式碼：

package com.leyou.upload.service;

import com.leyou.common.enums.ExceptionEnum;
import com.leyou.common.exception.LyException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;

@Service
@Slf4j
public class UploadService {

    private static final List<String> ALLOW_TYPES = Arrays.asList("image/png", "image/jpeg", "image/bmg");

    public String uploadImage(MultipartFile file) {
        try {
            //校驗檔案型別
            String contentType = file.getContentType();
            if(!ALLOW_TYPES.contains(contentType)){
                throw new LyException(ExceptionEnum.INVALID_FILE_TYPE);
            }
            //校驗檔案的內容
            BufferedImage image = ImageIO.read(file.getInputStream());
            if(image == null){
                throw new LyException(ExceptionEnum.INVALID_FILE_TYPE);
            }
            //準備目標路徑
            File dest = new File("E:黑馬程式設計師57期9 微服務電商【黑馬樂優商城】upload",file.getOriginalFilename());
            file.transferTo(dest);
            //返回路徑
            return "http://image.leyou.com/"+file.getOriginalFilename();
        } catch (IOException e) {
            log.error("上傳檔案失敗",e);
            throw new LyException(ExceptionEnum.UPLOAD_FILE_ERROR);
        }

    }
}

這裡有一個問題：為什麼圖片地址需要使用另外的url？

圖片不能儲存在伺服器內部，這樣會對伺服器產生額外的載入負擔

一般靜態資源都應該使用獨立域名，這樣存取靜態資源時不會攜帶一些不必要的cookie，減小請求的資料量

測試上傳

我們通過RestClient工具來測試：