cn.herodotus.oss.rest.specification.controller.OssObjectStreamController Maven / Gradle / Ivy
/*
* Copyright (c) 2020-2030 码匠君
*
* Dante Cloud licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Dante OSS 采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
*
* 1.请不要删除和修改根目录下的LICENSE文件。
* 2.请不要删除和修改 Dante Cloud 源码头部的版权声明。
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
* 4.分发源码时候，请注明软件出处
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处
* 6.若您的项目无法满足以上几点，可申请商业授权
*/
package cn.herodotus.oss.rest.specification.controller;
import cn.herodotus.engine.rest.core.annotation.Idempotent;
import cn.herodotus.engine.rest.core.controller.Controller;
import cn.herodotus.oss.rest.specification.arguments.ObjectStreamDownloadArguments;
import cn.herodotus.oss.solution.service.OssObjectStreamService;
import cn.herodotus.oss.specification.domain.object.PutObjectDomain;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Parameters;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.tags.Tags;
import jakarta.servlet.http.HttpServletResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
/**
* Description: TODO
*
* @author : gengwei.zheng
* @date : 2023/8/17 17:16
*/
@RestController
@RequestMapping("/oss/object/stream")
@Tags({
@Tag(name = "对象存储管理接口"),
@Tag(name = "OSS统一管理接口"),
@Tag(name = "OSS统一流式上传下载接口")
})
public class OssObjectStreamController implements Controller {
private static final Logger log = LoggerFactory.getLogger(OssObjectStreamController.class);
private final OssObjectStreamService ossObjectStreamService;
public OssObjectStreamController(OssObjectStreamService ossObjectStreamService) {
this.ossObjectStreamService = ossObjectStreamService;
}
@Idempotent
@Operation(summary = "流式下载", description = "后台返回响应流，下载对应的对象",
requestBody = @io.swagger.v3.oas.annotations.parameters.RequestBody(content = @Content(mediaType = "application/json")),
responses = {
@ApiResponse(description = "所有对象", content = @Content(mediaType = "application/json")),
@ApiResponse(responseCode = "200", description = "操作成功"),
@ApiResponse(responseCode = "500", description = "操作失败"),
@ApiResponse(responseCode = "503", description = "Server无法访问或未启动")
})
@Parameters({
@Parameter(name = "arguments", required = true, description = "ObjectStreamDownloadArguments参数实体", schema = @Schema(implementation = ObjectStreamDownloadArguments.class))
})
@PostMapping("/download")
public void download(@Validated @RequestBody ObjectStreamDownloadArguments arguments, HttpServletResponse response) {
try {
ossObjectStreamService.download(arguments.getBucketName(), arguments.getObjectName(), response);
} catch (IOException e) {
log.error("[Herodotus] |- Download file from minio catch error", e);
}
}
@Idempotent
@Operation(summary = "流式打开", description = "后台返回响应流，直接打开对应的对象",
requestBody = @io.swagger.v3.oas.annotations.parameters.RequestBody(content = @Content(mediaType = "application/json")),
responses = {
@ApiResponse(description = "所有对象", content = @Content(mediaType = "application/json")),
@ApiResponse(responseCode = "200", description = "操作成功"),
@ApiResponse(responseCode = "500", description = "操作失败"),
@ApiResponse(responseCode = "503", description = "Server无法访问或未启动")
})
@Parameters({
@Parameter(name = "arguments", required = true, description = "ObjectStreamDownloadArguments参数实体", schema = @Schema(implementation = ObjectStreamDownloadArguments.class))
})
@PostMapping("/display")
public void display(@Validated @RequestBody ObjectStreamDownloadArguments arguments, HttpServletResponse response) {
try {
ossObjectStreamService.display(arguments.getBucketName(), arguments.getObjectName(), response);
} catch (IOException e) {
log.error("[Herodotus] |- Download file from minio catch error", e);
}
}
@Idempotent
@Operation(summary = "流式文件上传", description = "以文件流的方式上传文件",
requestBody = @io.swagger.v3.oas.annotations.parameters.RequestBody(content = @Content(mediaType = "application/json")),
responses = {
@ApiResponse(description = "所有对象", content = @Content(mediaType = "application/json", schema = @Schema(implementation = PutObjectDomain.class))),
@ApiResponse(responseCode = "200", description = "操作成功"),
@ApiResponse(responseCode = "500", description = "操作失败"),
@ApiResponse(responseCode = "503", description = "Minio Server无法访问或未启动")
})
@Parameters({
@Parameter(name = "bucketName", required = true, description = "存储桶名称"),
@Parameter(name = "file", required = true, description = "文件", schema = @Schema(implementation = MultipartFile.class))
})
@PostMapping("/upload")
public PutObjectDomain upload(@RequestParam(value = "bucketName") String bucketName, @RequestPart(value = "file") MultipartFile file) {
return ossObjectStreamService.upload(bucketName, file);
}
}