refactor(swagger): 迁移Swagger注解到OpenAPI 3.0

云

2026-04-23 c247f5bf64c98595cc7e4efc9e1ae7ff1df79c11

 src/main/java/com/ruoyi/project/common/CommonController.java

@@ -1,18 +1,23 @@
package com.ruoyi.project.common;



import com.ruoyi.basic.service.StorageBlobService;

import com.ruoyi.basic.utils.FileUtil;

import com.ruoyi.framework.aspectj.lang.annotation.Anonymous;

import com.ruoyi.framework.config.ServerConfig;

import com.ruoyi.framework.web.domain.R;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiOperation;

import io.swagger.v3.oas.annotations.tags.Tag;

import io.swagger.v3.oas.annotations.Operation;

import jakarta.servlet.http.HttpServletResponse;

import lombok.AllArgsConstructor;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.core.io.FileSystemResource;

import org.springframework.http.ContentDisposition;

import org.springframework.http.MediaType;

import org.springframework.http.ResponseEntity;

import org.springframework.web.bind.annotation.*;

import org.springframework.web.multipart.MultipartFile;



import jakarta.servlet.http.HttpServletResponse;

import java.io.File;

import java.net.URLEncoder;

import java.nio.charset.StandardCharsets;

@@ -24,7 +29,7 @@
 *

 * @author ruoyi

 */

@Api(tags = "通用接口")

@Tag(name = "通用接口")

@AllArgsConstructor

@RestController

@RequestMapping("/common")

@@ -36,6 +41,7 @@
    private static final String FILE_DELIMETER = ",";



    private final StorageBlobService storageBlobService;

    private final FileUtil fileUtil;





//    /**

@@ -74,7 +80,7 @@
//     * minio通用上传请求（多个）

//     */

//    @PostMapping("/minioUploads")

//    @ApiOperation(value = "minio通用上传请求")

//    @Operation(summary = "minio通用上传请求")

//    public AjaxResult minioUploadFiles(List<MultipartFile> files, String bucketName, Long type) throws Exception

//    {

//        return AjaxResult.success();

@@ -171,9 +177,8 @@
//            log.error("下载文件失败", e);

//        }

//    }



    @PostMapping({"/upload"})

    @ApiOperation(value = "文件上传")

    @Operation(summary = "文件上传")

    public R upload(@RequestParam("files") List<MultipartFile> files) throws Exception {

        return R.ok(storageBlobService.upload(files));

    }

@@ -186,17 +191,25 @@
        String originalFileName = storageBlobService.getDownloadFileName(fileName);

        String encodedFileName = URLEncoder.encode(originalFileName, StandardCharsets.UTF_8.name()).replace("+", "%20");

        response.setHeader("Content-Disposition", "attachment;filename*=UTF-8''" + encodedFileName);

        response.setContentLengthLong(file.length());

        Files.copy(file.toPath(), response.getOutputStream());

    }



    @GetMapping("/preview/{fileName}")

    @Anonymous

    public void preview(@PathVariable String fileName, @RequestParam("token") String token, HttpServletResponse response) throws Exception {

        File file = storageBlobService.getFileByToken(fileName, token);

    public ResponseEntity<FileSystemResource> preview(@PathVariable String fileName,

                                                      @RequestParam("token") String token) throws Exception {

        File file = fileUtil.compressFile(storageBlobService.getFileByToken(fileName, token));

        String contentType = Files.probeContentType(file.toPath());

        response.setContentType(contentType == null ? "application/octet-stream" : contentType);

        String encodedFileName = URLEncoder.encode(fileName, StandardCharsets.UTF_8.name()).replace("+", "%20");

        response.setHeader("Content-Disposition", "inline;filename*=UTF-8''" + encodedFileName);

        Files.copy(file.toPath(), response.getOutputStream());



        ContentDisposition contentDisposition = ContentDisposition.inline()

                .filename(fileName, StandardCharsets.UTF_8)

                .build();



        return ResponseEntity.ok()

                .contentType(MediaType.parseMediaType(contentType != null ? contentType : "application/octet-stream"))

                .contentLength(file.length())

                .header("Content-Disposition", contentDisposition.toString())

                .body(new FileSystemResource(file));

    }

}