阿里云OSS——对象存储服务（工具）

阿里云SDK（Java）文档

一、依赖

<!--阿里云文件管理服务-->
<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-sdk-oss</artifactId>
    <version>3.10.2</version>
</dependency>

二、yaml配置

#阿里云OOS服务全局配置
aliyun:
  oss:
  	#yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
    end-point: your endpoint #也可以填写自己的域名（详情查看官网文档）
    #阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维，请登录RAM控制台创建RAM用户。
    accessKey-id: your accessKeyId
    secret: your secret
    #存储空间是您用于存储对象（Object）的容器，所有的对象都必须隶属于某个存储空间。
    bucket-name: your bucketName

三、OSS工具类

注：目前只完成了单个文件上传、批量文件删除，其余功能待完善…

/**
 * @Description
 * @Author cb
 * @Date 2022-01-06 11:25
 **/
@Setter
@Getter
@Component
@ConfigurationProperties(prefix = "aliyun.oss")
public class OSSUtils {

    private String endPoint;
    private String accessKeyId;
    private String secret;
    private String bucketName;

    /**
     * 将本地文件上传到目标存储空间的目录中
     * @param file 要上传的文件
     * @return 返回文件的网络路径
     */
    public String uploadFileStream(MultipartFile file) {
        //System.out.println(endPoint+"."+accessKeyId+"."+secret+"."+bucketName);
        InputStream inputStream = null;
        // 创建OSSClient实例。
        OSS ossClient = new OSSClientBuilder().build(endPoint, accessKeyId, secret);
        // 从上传的文件中得到流
        try {
            inputStream = file.getInputStream();
            String oldName = file.getOriginalFilename();
            int lastIndexOf = oldName.lastIndexOf(".");//后缀名前面的 . 的索引
            //获取新的文件名（原文件名+UUID+后缀名）
            String fileName= oldName.substring(0,lastIndexOf)+"-"+UUID.randomUUID().toString().replaceAll("-","")+oldName.substring(lastIndexOf);
            //要保存文件的目录结构，就是类似于20220102的三级目录
            String dir = LocalDate.now().format(DateTimeFormatter.ofPattern("yyyyMMdd"));
            fileName=dir+"/"+fileName;

            // 创建PutObjectRequest对象。
            // 依次填写Bucket名称（例如examplebucket）、Object完整路径（例如exampledir/exampleobject.txt）和本地文件的完整路径。Object完整路径中不能包含Bucket名称。
            // 如果未指定本地路径，则默认从示例程序所属项目对应本地路径中上传文件。
            PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, fileName, inputStream);

            // 如果需要上传时设置存储类型和访问权限，请参考以下示例代码。
            // ObjectMetadata metadata = new ObjectMetadata();
            // metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard.toString());
            // metadata.setObjectAcl(CannedAccessControlList.Private);
            // putObjectRequest.setMetadata(metadata);

            // 上传文件。
            ossClient.putObject(putObjectRequest);

            //  https://bucketName.endPoint/文件的路径(目录+文件名),%s是字符串的占位符
            String url=String.format("https://%s.%s/%s",bucketName,endPoint,fileName);
            System.out.println("上传的文件路径："+url);
            return url;
        } catch (IOException e) {
            throw new RuntimeException("上传文件失败");
        }finally {
            if (null != ossClient){
                // 关闭OSSClient。
                ossClient.shutdown();
            }else if (null != inputStream){
                try {
                    inputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    /**
     * 批量删除文件
     *  1.填写需要删除的多个文件完整路径。
     *  2.文件完整路径不能包含Bucket名称。格式：xxxDir/test.png 或 test.png
     *
     * @param fileWithPathList
     * @return 删除的文件个数
     */
    public Long deleteBatchObj(List<String> fileWithPathList){
        Long count = 0L;
        OSS ossClient = new OSSClientBuilder().build(endPoint,accessKeyId,secret);
        DeleteObjectsResult deleteObjectsResult = ossClient.deleteObjects(new DeleteObjectsRequest(bucketName).withKeys(fileWithPathList).withEncodingType("url"));
        List<String> deletedObjects = deleteObjectsResult.getDeletedObjects();
        for (String obj : deletedObjects) {
            try {
                String delObjStr = URLDecoder.decode(obj,"UTF-8");
                System.out.println(delObjStr);//输出删除的文件名
                count++;
            } catch (UnsupportedEncodingException e) {
                e.printStackTrace();
            }
        }
        if (null != ossClient){
            ossClient.shutdown();
        }
        return count;
    }

}

四、demo演示

4.1 SpringBoot启动类

@SpringBootApplication
@ComponentScan(basePackages = {"com.ccbx.ymjr.base", "com.ccbx.ymjr.oss"})
public class OssServiceAp {
    public static void main(String[] args) {
        SpringApplication.run(OssServiceAp.class,args);
    }
}

4.2 Controller接口

/**
 * @Description
 * @Author cb
 * @Date 2022-01-06 11:59
 **/
@RestController
@RequestMapping("/api/oos")
@Api(tags = "操作阿里云OOS服务器的接口")
public class OSSController {

    @Autowired
    private OSSUtils ossUtils;

    @PostMapping("/upload")
    @ApiOperation("上传文件到OSS服务器")
    public Result  upload(MultipartFile file){
        String url = ossUtils.uploadFileStream(file);
        return Result.ok().data("url",url);
    }

    @PostMapping("/deleteBatchFile")
    @ApiOperation("批量删除OSS服务器上的文件")
    public Result deleteBatchFileFromOSS(@RequestBody List<String> filePathList){
        try {
            Long deleteCount = ossUtils.deleteBatchObj(filePathList);
            return Result.ok().data("deleteCount",deleteCount);
        } catch (Exception e) {
            e.printStackTrace();
            return Result.error().message("批量删除文件时出错");
        }
    }

}

4.3 swagger测试

4.3.1 上传测试

4.3.2 批量删除测试

此时在查看Bucket中的文件已经就被删除了。