第2-3-4章 上傳附件的介面開發-檔案存盤服務系統-nginx/fastDFS/minio/阿里云oss/七牛云oss

• 5.3 介面開發-上傳附件
  • 5.3.1 介面檔案
  • 5.3.2 代碼實作
  • 5.3.3 介面測驗

5.3 介面開發-上傳附件

第2-1-2章 傳統方式安裝FastDFS-附FastDFS常用命令
第2-1-3章 docker-compose安裝FastDFS,實作檔案存盤服務
第2-1-5章 docker安裝MinIO實作檔案存盤服務-springboot整合minio-minio全網最全的資料

全套代碼及資料全部完整提供，點此處下載

5.3.1 介面檔案

上傳附件介面要完成的操作主要有兩個：

• 將客戶端提交的檔案上傳到指定存盤位置（具體存盤位置由組態檔配置的存盤策略確定）
• 將上傳的檔案資訊保存到資料庫的pd_attachment表中

介面檔案如下：

5.3.2 代碼實作

第一步：創建AttachmentController并提供檔案上傳方法

package com.itheima.pinda.file.controller;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.baomidou.mybatisplus.core.toolkit.support.SFunction;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.itheima.pinda.base.BaseController;
import com.itheima.pinda.base.R;
import com.itheima.pinda.file.dto.AttachmentDTO;
import com.itheima.pinda.file.dto.AttachmentRemoveDTO;
import com.itheima.pinda.file.dto.AttachmentResultDTO;
import com.itheima.pinda.file.dto.FilePageReqDTO;
import com.itheima.pinda.file.entity.Attachment;
import com.itheima.pinda.file.service.AttachmentService;
import com.itheima.pinda.utils.BizAssert;
import io.swagger.annotations.*;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.collections.MapUtils;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.List;
import java.util.Map;
import static com.itheima.pinda.exception.code.ExceptionCode.BASE_VALID_PARAM;
import static java.util.stream.Collectors.groupingBy;
/**
 * 附件處理控制器
 */
@RestController
@RequestMapping("/attachment")
@Slf4j
@Api(value = "https://www.cnblogs.com/gitBook/p/附件", tags = "附件")
public class AttachmentController extends BaseController {
    @Autowired
    private AttachmentService attachmentService;

    /**
     * 上傳附件
     */
    @ApiOperation(value = "https://www.cnblogs.com/gitBook/p/附件上傳", notes = "附件上傳")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "isSingle", value = "https://www.cnblogs.com/gitBook/p/是否單檔案", dataType = "boolean", paramType = "query"),
            @ApiImplicitParam(name = "id", value = "https://www.cnblogs.com/gitBook/p/檔案id", dataType = "long", paramType = "query"),
            @ApiImplicitParam(name = "bizId", value = "https://www.cnblogs.com/gitBook/p/業務id", dataType = "long", paramType = "query"),
            @ApiImplicitParam(name = "bizType", value = "https://www.cnblogs.com/gitBook/p/業務型別", dataType = "long", paramType = "query"),
            @ApiImplicitParam(name = "file", value = "https://www.cnblogs.com/gitBook/p/附件", dataType = "MultipartFile", allowMultiple = true, required = true),
    })
    @PostMapping(value = "https://www.cnblogs.com/upload")
    public R<AttachmentDTO> upload(
            @RequestParam(value = "https://www.cnblogs.com/gitBook/p/file") MultipartFile file,
            @RequestParam(value = "https://www.cnblogs.com/gitBook/p/isSingle", required = false, defaultValue = "https://www.cnblogs.com/gitBook/p/false") Boolean isSingle,
            @RequestParam(value = "https://www.cnblogs.com/gitBook/p/id", required = false) Long id,
            @RequestParam(value = "https://www.cnblogs.com/gitBook/p/bizId", required = false) String bizId,
            @RequestParam(value = "https://www.cnblogs.com/gitBook/p/bizType") String bizType) {
        
        // 忽略路徑欄位,只處理檔案型別
        if (file.isEmpty()) {
            return fail(BASE_VALID_PARAM.build("請求中必須至少包含一個有效檔案"));
        }
        AttachmentDTO attachment = attachmentService.upload(file, 
                                                            id, 
                                                            bizType, 
                                                            bizId, 
                                                            isSingle);

        return success(attachment);
    }
}

第二步：創建AttachmentService介面

package com.itheima.pinda.file.service;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.IService;
import com.itheima.pinda.file.dto.AttachmentDTO;
import com.itheima.pinda.file.dto.AttachmentResultDTO;
import com.itheima.pinda.file.dto.FilePageReqDTO;
import com.itheima.pinda.file.entity.Attachment;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.List;

/**
 * 附件業務介面
 */
public interface AttachmentService extends IService<Attachment> {
    /**
     * 上傳附件
     *
     * @param file 檔案
     * @param id 附件id
     * @param bizType 業務型別
     * @param bizId 業務id
     * @param isSingle 是否單個檔案
     * @return
     */
    AttachmentDTO upload(MultipartFile file, Long id, String bizType, 
                         String bizId, Boolean isSingle);

}

第三步：創建AttachmentServiceImpl實作類

package com.itheima.pinda.file.service.impl;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.itheima.pinda.base.id.IdGenerate;
import com.itheima.pinda.database.mybatis.conditions.Wraps;
import com.itheima.pinda.database.mybatis.conditions.query.LbqWrapper;
import com.itheima.pinda.dozer.DozerUtils;
import com.itheima.pinda.exception.BizException;
import com.itheima.pinda.file.dao.AttachmentMapper;
import com.itheima.pinda.file.domain.FileDO;
import com.itheima.pinda.file.domain.FileDeleteDO;
import com.itheima.pinda.file.dto.AttachmentDTO;
import com.itheima.pinda.file.dto.AttachmentResultDTO;
import com.itheima.pinda.file.dto.FilePageReqDTO;
import com.itheima.pinda.file.entity.Attachment;
import com.itheima.pinda.file.entity.File;
import com.itheima.pinda.file.enumeration.DataType;
import com.itheima.pinda.file.properties.FileServerProperties;
import com.itheima.pinda.file.service.AttachmentService;
import com.itheima.pinda.file.strategy.FileStrategy;
import com.itheima.pinda.utils.DateUtils;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.time.LocalDateTime;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

/**
 * 附件業務實作類
 */
@Slf4j
@Service
public class AttachmentServiceImpl extends ServiceImpl<AttachmentMapper, Attachment> implements AttachmentService {
    @Autowired
    private IdGenerate<Long> idGenerate;
    @Autowired
    private DozerUtils dozer;
    @Autowired
    private FileStrategy fileStrategy;
    @Autowired
    private FileServerProperties fileProperties;

    /**
     * 上傳附件
     *
     * @param multipartFile 檔案
     * @param id 附件id
     * @param bizType 業務型別
     * @param bizId 業務id
     * @param isSingle 是否單個檔案
     * @return
     */
    @Override
    public AttachmentDTO upload(MultipartFile multipartFile, Long id, String bizType, String bizId, Boolean isSingle) {
        //根據業務型別來判斷是否生成業務id
        if (StringUtils.isNotEmpty(bizType) && StringUtils.isEmpty(bizId)) {
            bizId = String.valueOf(idGenerate.generate());
        }
        File file = fileStrategy.upload(multipartFile);

        Attachment attachment = dozer.map(file, Attachment.class);

        attachment.setBizId(bizId);
        attachment.setBizType(bizType);
        setDate(attachment);

        if (isSingle) {
            super.remove(Wraps.<Attachment>lbQ().eq(Attachment::getBizId, bizId).eq(Attachment::getBizType, bizType));
        }

        if (id != null && id > 0) {
            //當前端傳遞了檔案id時，修改這條記錄
            attachment.setId(id);
            super.updateById(attachment);
        } else {
            attachment.setId(idGenerate.generate());
            super.save(attachment);
        }

        AttachmentDTO dto = dozer.map(attachment, AttachmentDTO.class);
        return dto;
    }

    private void setDate(Attachment file) {
        LocalDateTime now = LocalDateTime.now();
        file.setCreateMonth(DateUtils.formatAsYearMonthEn(now));
        file.setCreateWeek(DateUtils.formatAsYearWeekEn(now));
        file.setCreateDay(DateUtils.formatAsDateEn(now));
    }
}

5.3.3 介面測驗

第一步：啟動Nacos配置中心，pd-file-server.yml配置內容如下：

pinda:
  mysql:
    database: pd_files
  nginx:
    ip: ${spring.cloud.client.ip-address} #正式環境要將該ip設定成nginx對應的公網ip
    port: 10000  #正式環境需要將該ip設定成nginx對應的公網埠
  swagger:
    enabled: true
    docket:
      file:
        title: 檔案服務
        base-package: com.itheima.pinda.file.controller

  file:
    type: LOCAL # LOCAL ALI MINIO FAST_DFS  
    local:
      uriPrefix: http://${pinda.nginx.ip}:${pinda.nginx.port}
      bucket-name: oss-file-service
      endpoint: D:\soft\nginx-1.23.0\uploadFiles
    ali:
      # 請填寫自己的阿里云存盤配置
      bucket-name: bladex-loan
      endpoint: http://oss-cn-qingdao.aliyuncs.com
      access-key-id: LTAI4FhtimFAiz6iLGJSiJui  
      access-key-secret: SsU15qaPwpF1x5xMqwc0XzGuY92fnc

#FAST_DFS配置
fdfs:
  soTimeout: 1500
  connectTimeout: 600
  thumb-image:
    width: 150
    height: 150
  tracker-list:
    - 111.231.76.210:22122
  pool:
    #從池中借出的物件的最大數目
    max-total: 153
    max-wait-millis: 102
    jmx-name-base: 1
    jmx-name-prefix: 1


server:
  port: 8765

第二步：啟動Nginx服務

第三步：啟動檔案服務

第四步：訪問介面檔案，地址為http://localhost:8765/doc.html

可以看到上傳的檔案已經保存到了本地磁盤：

同時上傳的檔案資訊也已經保存到了pd_attachment表中：

可以通過Nginx提供的Http服務來訪問上傳的檔案：

http://192.168.137.3:10000//oss-file-service/2022/11/e76d3505-df38-4f95-a7bd-fb5de3ebe923.txt

全套代碼及資料全部完整提供，點此處下載

標籤：Java

上一篇：Java新特性（1）：Java 9和Java10

下一篇：開發者工具｜15款音視頻開發者必備實用工具，看看你用過幾個？