投稿
  1. 极客之音首页
  2. 其他分类

OSS概念了解+Springboot+OSS整合配置元数据+代理+自定义域名+重试策略

小半 • • 其他分类 • 阅读 136

导读：本篇文章讲解 OSS概念了解+Springboot+OSS整合配置元数据+代理+自定义域名+重试策略，希望对大家有帮助，欢迎收藏，转发！站点地址：www.bmabk.com

Springboot+OSS整合

概念了解

阿里云对象存储OSS（Object Storage Service）是一款海量、安全、低成本、高可靠的云存储服务，可提供99.9999999999%（12个9）的数据持久性，99.995%的数据可用性。多种存储类型供选择，全面优化存储成本。

可以使用阿里云提供的API、SDK接口或者OSS迁移工具轻松地将海量数据移入或移出阿里云OSS。

上面都是一些基本概述，简单来讲，就是可以将大量的文件给上传到阿里云OSS文件系统，并且可控这些文件的读写权限等。

先来了解下oss中的一些基本概念：

  • Bucket:存储空间，所有上传的对象必须放置到存储空间中。存储空间有各种的配置属性地域、访问权限、存储类型等，在OSS中可以通过设置bucket的读写权限，也可以给文件对象单独设置读写权限(一种是全局的，一种是局部的)
  • Object:对象，OSS存储数据的基本单元，就是要上传的文件对象。对象由元信息(Object Meta)，用户数据(Data)和文件名(key)组成，key是唯一标识，文件key重复时将会覆盖文件。
  • ObjectKey:ObjectKey和key以及ObjectName都是说的一个概念，都是文件的名称(标识)。注意：在OSS的bucket中，不存在目录这一说法，我们上传文件时可以用’/’自己区分目录，如: abc/def/111.jpg，这个就是一个ObjectKey
  • Region:地域，表示OSS服务器所在的物理位置。
  • Endpoint:访问域名，表示OSS对外的访问域名(分为内网和外网)，一般可能外网用的多一点。
  • AccessKey:访问秘钥，指的是访问身份验证中用到的AccessKey ID和AccessKey Secret，这两个东西要保密。

OSS基本概念详情，请参见此网址

AccessKey和OSS访问域名问题

AccessKey

这里着重说一下这两个概念，其中AccessKey就是上面说的身份验证时的AccessKey ID和AccessKey Secret，而AccessKey ID和AccessKey Secret又分为好几种：

  • 一种是当前主账号下创建的AccessKey，如图：

在这里插入图片描述

以主账号下的AccessKey访问OSS时，权限是最高的。

  • 还有通过创建子账号(RAM用户)的方式来进行访问OSS，主账号可以设置子账号对相应的bucket的权限策略，具体如图
    在这里插入图片描述

具体如何创建和分配以及RAM用户实现文件上传，详情看官方文档

  • 还有一种方式，是通过临时凭证的方式去上传文件；RAM用户可以使用阿里云SDK请求STS临时访问凭证，然后使用STS临时访问凭证访问OSS资源。STS临时访问凭证将在设置的有效时间到期后失效。这种方式其实是创建了一个角色，可以理解是临时角色，然后给这个角色分配好权限，完事后，RAM用户去’扮演’这个角色获取一个临时凭证，然后其他无权限人员可以拿着这些凭证，临时访问OSS资源

    比较常见的一个场景就是：后端使用RAM用户扮演临时角色获取临时凭证，然后返回给前端，前端再去直接调用OSS上传文件的接口(拿着临时凭证)

具体如何创建临时角色和分配权限，以及RAM获取临时凭证，详情看官方文档

OSS域名访问问题

首先了解一下OSS的域名构成，OSS会为每个Bucket分配默认的访问域名，bucket的域名构成为BucketName.Endpoint，来个图了解下：

在这里插入图片描述

这里还有个问题：目前通过当前Bucket域名访问你上传过的文件时，只能下载文件附件，不能预览，而只有给bucket设置自定义域名时，才能通过自定义域名去直接访问OSS文件资源。

开始整合OSS

那么废话说完了，开始整合吧。

先去找下OSS的SDK依赖，注意这里是java8及一下的依赖，如果是java9及以上，那么还需要额外添加别的依赖，详情看官方文档。

<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-sdk-oss</artifactId>
    <version>3.15.0</version>
</dependency>

上传文件时，会使用一个OSS的对象，我们需要实例化出一个OSS的对象，没有太多需求的情况下，可以在一个程序中使用一个OSS对象即可(可理解为spring的单例模式)。代码贴上来

// yourEndpoint填写Bucket所在地域对应的Endpoint。以华东1（杭州）为例，Endpoint填写为https://oss-cn-hangzhou.aliyuncs.com。
String endpoint = "yourEndpoint";
// 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维，请登录RAM控制台创建RAM用户。
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";

// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);

// 关闭OSSClient。
ossClient.shutdown();

那么就是实例化的时候需要一些访问的AccessKey和Endpoint信息等。这些信息属于保密级别的，轻易不要泄露出去，那么该如何去管理呢？本人说下遇到的两种情况：

  • 通常情况下是直接给放置到配置文件中，然后直接读取即可(不可手动配置)
  • 其他情况就是可能要把这些AccessKey等信息做成可配置的，在后台页面中管理员可以进行配置

两种方式其实大同小异，只是获取这些AccessKey等保密信息的途径不同罢了。我这里主要介绍下配置文件方式，可配置的方式自行扩展即可。

application.yml文件

aliyun:
  oss:
    endpoint: oss-cn-beijing.aliyuncs.com
    accessKey: xxx
    accessSecret: xxx
    bucketName: xxx
    aliyunDomain: xxx.oss-cn-beijing.aliyuncs.com

接收配置文件数据的java实体类

@Data
@ConfigurationProperties(prefix = "aliyun.oss")
@Component
public class AliyunConfigProperty {

    // 地域节点
    private String endpoint;

    // 访问Key
    private String accessKey;

    // 访问秘钥
    private String accessSecret;

    // bucket名称
    private String bucketName;

    // 阿里云OSS域名(如果是自定义的，填写自定义即可；非自定义的域名=bucketName.endpoint)
    private String aliyunDomain;

}

单例OSS注入

@Configuration
@AllArgsConstructor
public class AliyunConfiguration {

    private final AliyunConfigProperty property;

    /**
     * 通常情况下，直接构建一个OSS实例即可
     */
    @Bean
    public OSS oss() {
        return new OSSClientBuilder().build(property.getEndpoint(), property.getAccessKey(), property.getAccessSecret());
    }

}

文件上传、下载的方法实现

@Service
@AllArgsConstructor
public class FileServiceImpl implements FileService {

    private final OSS oss;
    private final AliyunConfigProperty aliyunConfig;

    /**
     * 文件上传 
     */
    @Override
    public R upload(MultipartFile file) {
        // 文件不能为空
        if (Objects.isNull(file) || file.isEmpty()) {
            return R.fail("文件不能为空");
        }
        // 后缀
        String suffix = Objects.requireNonNull(file.getOriginalFilename()).substring(file.getOriginalFilename().lastIndexOf("."));
        String path = getPath("", suffix);
        return R.success(uploadFile(path, file));
    }

    /**
     * 文件下载，以流形式 
     */
    @Override
    public void downloadOssFile(OutputStream os, String objectName) {
        BufferedInputStream in = null;
        BufferedOutputStream out = null;
        try {
            OSSObject ossObject = oss.getObject(aliyunConfig.getBucketName(), objectName);
            in = new BufferedInputStream(ossObject.getObjectContent());
            out = new BufferedOutputStream(os);
            byte[] buffer = new byte[1024];
            int length;
            while ((length = in.read(buffer)) != -1) {
                out.write(buffer, 0, length);
            }
            out.flush();
        } catch (IOException e) {
            e.printStackTrace();
            throw new BusinessException("文件下载失败");
        } finally {
            try {
                if (out != null) {
                    out.close();
                }
                if (in != null) {
                    in.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    
    private String uploadFile(String path, MultipartFile file) {
        // 直接通过bucket域名访问即可
        String ossFileUrl = "https://" + aliyunConfig.getAliyunDomain() + "/";
        try {
            // 设置oss文件元数据
            ObjectMetadata metadata = new ObjectMetadata();
            // 设置头部信息
            metadata.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard.toString());
            // 设置object文件的访问权限(公共读)
            metadata.setObjectAcl(CannedAccessControlList.PublicRead);
            oss.putObject(aliyunConfig.getBucketName(), path, file.getInputStream(), metadata);
            ossFileUrl += path;
        } catch (IOException e) {
            e.printStackTrace();
            throw new BusinessException("文件上传阿里云oss失败");
        }
        return ossFileUrl;
    }

    // 防止文件名重复，设置一个文件名称
    private String getPath(String prefix, String suffix) {
        String uuid = UUID.randomUUID().toString().replaceAll("-", "");
        String path = DateUtil.format(new Date(), "yyyyMMdd") + "/" + uuid;
        if (StringUtils.isNotBlank(prefix)) {
            path = prefix + "/" + path;
        }
        return path + suffix;
    }

}

基本上就是一个简单的文件上传和下载。上面文件上传后，如果application.yml中aliyunDomain配置的是oss的bucket域名，那么如果要访问文件/图片，只能通过下载附件的方式下载到本地查看；若aliyunDomain配置的是自定义的域名，且该域名和bucket进行了绑定，那么上传文件后，可以在线访问OSS文件/图片。

代理+自定义域名+重试策略

之前工作中又遇到这样一种情况：是公司内部的一个系统(处于局域网下)，想要访问OSS资源，那么它必须走正向代理，来访问OSS资源，这个如何设置呢？这个其实在实例化OSS的时候就可以进行配置的。

OSS实例化，详情看文档

绑定自定义域名时，即可将自动添加CNAME记录勾上即可。

在这里插入图片描述

看下官方给的代码，如果是自定义域名，设置下是否支持CNAME，设置为true即可。

// yourEndpoint填写自定义域名。
String endpoint = "yourEndpoint";
// 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维，请登录RAM控制台创建RAM用户。
String accessKeyId = "yourAccessKeyId";
String accessKeySecret = "yourAccessKeySecret";

// 创建ClientConfiguration实例，您可以根据实际情况修改默认参数。
ClientBuilderConfiguration conf = new ClientBuilderConfiguration();
// 设置是否支持CNAME。CNAME用于将自定义域名绑定到目标Bucket。
conf.setSupportCname(true);

// 创建OSSClient实例。
OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret, conf);

// 关闭OSSClient。
ossClient.shutdown();

构建OSS对象时，构函中可以传入一个ClientBuilderConfiguration的对象，作为OSS的特殊配置。

在这里插入图片描述

可以看到，可配置参数挺多的，代理的话一般就ip和端口就够用了，如果还有用户和密码，加上即可。

application.yml中

aliyun:
  oss:
    endpoint: oss-cn-beijing.aliyuncs.com
    accessKey: xxxx
    accessSecret: xxxx
    bucketName: xxxx
    aliyunDomain: xxxx.oss-cn-beijing.aliyuncs.com
    proxyHost: xxx.xxx.xxx.xxx
    proxyPort: 8080

参数接收

@Data
@ConfigurationProperties(prefix = "aliyun.oss")
@Component
public class AliyunConfigProperty {

    // 地域节点
    private String endpoint;

    // 访问Key
    private String accessKey;

    // 访问秘钥
    private String accessSecret;

    // bucket名称
    private String bucketName;

    // 阿里云OSS域名(如果是自定义的，填写自定义即可；非自定义的域名=bucketName.endpoint)
    private String aliyunDomain;
    
    // 代理主机
    private String proxyHost;
    
    // 代理端口
    private Integer port;

}

初始化OSS，给配置上代理ip和端口即可。

@Configuration
@AllArgsConstructor
public class AliyunConfiguration {

    private final AliyunConfigProperty property;

    /**
     * 通常情况下，直接构建一个OSS实例即可
     */
    @Bean
    public OSS oss() {
        ClientBuilderConfiguration config = new ClientBuilderConfiguration();
        config.setProxyHost(property.getProxyHost());
        config.setProxyPort(property.getPort());
        return new OSSClientBuilder().build(property.getEndpoint(), property.getAccessKey(), property.getAccessSecret(), config);
    }

}

重试策略，其实也同样是在配置中进行配置

@Bean
public OSS oss() {
    ClientBuilderConfiguration config = new ClientBuilderConfiguration();
    config.setProxyHost(property.getProxyHost());
    config.setProxyPort(property.getPort());
    // 设置最大失败请求次数
    config.setMaxErrorRetry(5);
    return new OSSClientBuilder().build(property.getEndpoint(), property.getAccessKey(), property.getAccessSecret(), config);
}

多余的就不讲了，篇幅也太长，详情看文档！！！一定要看文档，不要瞎捉摸。

OSS实例化，详情看文档

版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。

文章由极客之音整理，本文链接：https://www.bmabk.com/index.php/post/48374.html

赞 (0)
小半的头像小半
0 0

相关推荐

极客之音——专业性很强的中文编程技术网站，欢迎收藏到浏览器，订阅我们！