华为云的obs之自定义springboot-starter

华为云的obs若是本身调用api的话，接口太多，不少不须要，依赖也不少（须要调用好几个jar包)。因而想着本身给封装下，引一个jar就能用多好啊。因而本身利用业余时间自定义了这个starer，能够快速投入开发，省时省力，但愿帮助到你们。

1、自定义的starter封装好的几个经常使用方法:

一.桶的操做

• 查询全部桶
• 桶的新增
• 桶的删除
• 设置桶内文件对象过时时间

二.对象的操做

• 1.查询某个桶的全部对象
• 2.上传某个对象（全局访问权限版2个）（经过流+经过file对象）
• 3.上传某个对象(设置对象自定义元数据版)
• 4.获取某个对象的全部信息
• 5.获取某个对象的元数据
• 6.获取某个对象的流
• 7.拷贝对象
• 8.删除单个对象
• 9.下载某个对象到本地

三.文件夹的操做

• 1.建立文件夹
• 2.判断对象是不是文件夹
• 3.列举文件夹中的全部对象
• 4.删除某个文件夹下的全部对象

2、springboot(华为云的obs)的starter核心工具类代码

/**
 * Title: ObsUtils
 * Description: obs操做工具类
 *
 * @author hfl
 * @version V1.0
 * @date 2020-05-27
 */
public class ObsService {
    private final static Logger logger = LoggerFactory.getLogger(ObsService.class);

    private ObsClient obsClient;
    private String bucketName;
    private String bucketLoc;
    private ObsConfiguration config;

    public ObsService() {
    }

    public ObsService(String bucketName, String bucketLoc, ObsConfiguration config) {
        this.bucketName = bucketName;
        this.bucketLoc = bucketLoc;
        this.config = config;
    }

    /**
     * 查询全部桶
     *
     * @return 桶的列表
     */
    @ObsClientAnnotation
    public List<ObsBucket> listBuckets() {
        ListBucketsRequest request = new ListBucketsRequest();
        request.setQueryLocation(true);
        List<ObsBucket> obsBuckets = obsClient.listBuckets(request);
        return obsBuckets;
    }

    /**
     * 桶的新增
     *
     * @param bucketName 桶的名称
     * @return 桶对象信息
     */
    @ObsClientAnnotation
    public ObsBucket createBucket(String bucketName) {
        ObsBucket obsBucket = new ObsBucket(bucketName, bucketLoc);
        obsBucket.setBucketName(bucketName);
        return obsClient.createBucket(obsBucket);
    }

    /**
     * 桶的删除
     *
     * @param bucketName 桶的名称
     * @return 响应对象
     */
    @ObsClientAnnotation
    public HeaderResponse deleteBucket(String bucketName) {
        return obsClient.deleteBucket(bucketName);
    }

    /**
     * 设置桶内指定前缀的文件对象 过时时间
     *
     * @param prefix         什么前缀的文件过时（好比/tmp）
     * @param expirationDays 几天后过时
     */
    @ObsClientAnnotation
    public HeaderResponse setLiftConfig(String prefix, Integer expirationDays) {
        LifecycleConfiguration config = new LifecycleConfiguration();
        LifecycleConfiguration.Rule rule = config.new Rule();
        rule.setEnabled(true);
        //过时规则名称
        rule.setId(String.valueOf(UUID.randomUUID()));
        rule.setPrefix(prefix);
        LifecycleConfiguration.Expiration expiration = config.new Expiration();
        // 指定知足前缀的对象建立x天后过时
        expiration.setDays(expirationDays);
        LifecycleConfiguration.NoncurrentVersionExpiration noncurrentVersionExpiration = config.new NoncurrentVersionExpiration();
        // 指定知足前缀的对象成为历史版本x天后过时
        noncurrentVersionExpiration.setDays(expirationDays);
        rule.setNoncurrentVersionExpiration(noncurrentVersionExpiration);
        config.addRule(rule);
        return obsClient.setBucketLifecycle(bucketName, config);
    }

    /**
     * 查询桶的全部对象
     *
     * @return 桶内对象集合（关键属性getObjectKey）
     */
    @ObsClientAnnotation
    public ObjectListing listObjects() {
        ObjectListing listing = obsClient.listObjects(bucketName);
        return listing;
    }

    /**
     * 上传对象时指定预约义访问策略为公共读(很重要)
     *
     * @param objectKey   对象的key
     * @param inputStream 要上传的文件流
     * @return 响应对象
     */
    @ObsClientAnnotation
    public PutObjectResult putObjectAndSetPreAccessStrategy(String objectKey, InputStream inputStream) {
        PutObjectRequest request = new PutObjectRequest();
        request.setBucketName(bucketName);
        //对象的key 如:  objectname1/text
        request.setObjectKey(objectKey);
        request.setInput(inputStream);
        //设置对象访问权限为公共读
        request.setAcl(AccessControlList.REST_CANNED_PUBLIC_READ);
        return obsClient.putObject(request);
    }

    /**
     * 上传对象时指定预约义访问策略为公共读(很重要)
     *
     * @param objectKey   对象的key
     * @param file 要上传的文件
     * @return 响应对象
     */
    @ObsClientAnnotation
    public PutObjectResult putObjectAndSetPreAccessStrategy(String objectKey, File file) {
        PutObjectRequest request = new PutObjectRequest();
        request.setBucketName(bucketName);
        //对象的key 如:  objectname1/text
        request.setObjectKey(objectKey);
        request.setFile(file);
        //设置对象访问权限为公共读
        request.setAcl(AccessControlList.REST_CANNED_PUBLIC_READ);
        return obsClient.putObject(request);
    }

    /**
     * 上传某个对象并设置对象自定义元数据
     *
     * @param objectKey   要上传的key
     * @param metadata    元数据对象
     * @param inputStream 要上传的文件流
     * @return 上传结果
     * //  ObjectMetadata metadata = new ObjectMetadata();
     * //  metadata.addUserMetadata("property1", "property-value1");
     * //  metadata.getMetadata().put("property2", "property-value2");
     * //  C:\\Users\\hufanglei\\Pictures\\timg.jpg"
     */
    @ObsClientAnnotation
    public PutObjectResult putObjectAndSetMeta(String objectKey, ObjectMetadata metadata, InputStream inputStream) {
        return obsClient.putObject(bucketName, objectKey, inputStream, metadata);
    }

    /**
     * 获取某个对象
     *
     * @param objectKey 对象的key
     * @return 对象的信息
     */
    @ObsClientAnnotation
    public ObsObject getObject(String objectKey) {
        return obsClient.getObject(bucketName, objectKey, null);
    }

    /**
     * 获取某个对象的流
     *
     * @param objectKey 对象的key
     * @return 对象的流
     */
    @ObsClientAnnotation
    public InputStream getObjectInpuStream(String objectKey) {
        ObsObject obsObject = obsClient.getObject(bucketName, objectKey, null);
        return obsObject.getObjectContent();
    }

    /**
     * 查询对象元数据(查询某个对象的具体信息)
     *
     * @param objectKey 要查询的key
     * @return 对象元数据
     */
    @ObsClientAnnotation
    public ObjectMetadata getObjectMetadata(String objectKey) {
        //获取对象元数据
        return obsClient.getObjectMetadata(bucketName, objectKey, null);
    }

    /**
     * 拷贝对象(也能够从一个桶拷贝到另外一个桶，这里目前桶和原始文件桶都设置成了配置文件中的桶)
     *
     * @param sourceObjectKey 原始key
     * @param destObjectKey   目标key
     * @return 响应结果
     */
    @ObsClientAnnotation
    public CopyObjectResult copyObject(String sourceObjectKey, String destObjectKey) {
        String sourceBucketName = bucketName;
        String destBucketName = bucketName;
        return obsClient.copyObject(sourceBucketName, sourceObjectKey, destBucketName, destObjectKey);
    }

    /**
     * 删除单个对象
     *
     * @param objectKey 要删除的key
     * @return 响应结果
     */
    @ObsClientAnnotation
    public DeleteObjectResult deletObj(String objectKey) {
        return obsClient.deleteObject(bucketName, objectKey);
    }
    /**
     * 下载某个对象到本地
     *
     * @param objectKey     对象的key
     * @param localFilePath 本地文件路径
     * @throws ObsException
     * @throws IOException
     */
    @ObsClientAnnotation
    public void downloadToLocalFile(String objectKey, String localFilePath) throws ObsException, IOException {
        File localFile = new File(localFilePath);
        if (!localFile.getParentFile().exists()) {
            localFile.getParentFile().mkdirs();
        }
        ObsObject obsObject = obsClient.getObject(bucketName, objectKey, null);
        ReadableByteChannel rchannel = Channels.newChannel(obsObject.getObjectContent());
        ByteBuffer buffer = ByteBuffer.allocate(4096);
        WritableByteChannel wchannel = Channels.newChannel(new FileOutputStream(new File(localFilePath)));
        while (rchannel.read(buffer) != -1) {
            buffer.flip();
            wchannel.write(buffer);
            buffer.clear();
        }
        rchannel.close();
        wchannel.close();
    }

    /**
     * 建立一个文件夹，必须带有/后缀
     *
     * @param keySuffixWithSlash1 文件夹名称（必须带有/后缀）
     * @return 响应对象
     */
    @ObsClientAnnotation
    public PutObjectResult createEmptyFolder(String keySuffixWithSlash1) {
        return obsClient.putObject(bucketName, keySuffixWithSlash1, new ByteArrayInputStream(new byte[0]));
    }


    /**
     * 判断对象是不是文件夹
     * @param keySuffixWithSlash1 文件夹名: 如:   "MyObjectKey1/"
     * @return 布尔值
     */
    @ObsClientAnnotation
    public boolean isEmptyFolder(String keySuffixWithSlash1)  {
        ObsObject object = obsClient.getObject(bucketName, keySuffixWithSlash1, null);
        if (object != null) {
            return object.getMetadata().getContentLength() == 0L;
        }
        return false;
    }

    /**
     * 列举某个文件夹下的全部对象
     *
     * @param folderPrefix 件夹名（必须/结尾）
     * @return 对象集合
     */
    @ObsClientAnnotation
    public ObjectListing listObjectsByFolder(String folderPrefix) {
        ListObjectsRequest request = new ListObjectsRequest(bucketName);
        // 设置文件夹对象名"dir/"为前缀
        // request.setPrefix("dir/");
        request.setPrefix(folderPrefix);
        //列举文件个数
        request.setMaxKeys(1000);
        ObjectListing result;
        do {
            result = obsClient.listObjects(request);
            for (ObsObject obsObject : result.getObjects()) {
                logger.info("\t" + obsObject.getObjectKey());
                logger.info("\t" + obsObject.getOwner());
            }
            request.setMarker(result.getNextMarker());
        } while (result.isTruncated());
        return result;
    }

    /**
     * 删除某个文件夹下的全部对象
     *
     * @param folderPrefix 文件夹名（必须/结尾）
     * @return 是否删除成功
     */
    @ObsClientAnnotation
    public boolean deleteListObjectsByFolder(String folderPrefix) {
        ListObjectsRequest request = new ListObjectsRequest(bucketName);
        // 设置文件夹对象名"/xx/xxx/"为前缀
        request.setPrefix(folderPrefix);
        //列举文件个数
        request.setMaxKeys(1000);
        ObjectListing result;
        do {
            result = obsClient.listObjects(request);
            for (ObsObject obsObject : result.getObjects()) {
                logger.info("\t" + obsObject.getObjectKey());
                logger.info("\t" + obsObject.getOwner());
                //执行删除
                obsClient.deleteObject(bucketName, obsObject.getObjectKey());
            }
            request.setMarker(result.getNextMarker());
        } while (result.isTruncated());
        return true;
    }
}

3、如何使用starter

0.前提 请注意

• obs的jar包在maven仓库的版本很老了，因此去官网下载比较新的jar包。
• 须要将esdk-obs-java-3.19.11.1.jar加载进依赖或者上传到私服，我已经上传到本身的私服了，直接引pom便可，直接使用会报错
• 若是报错，请手动添加放在/obs-upload-spring-boot-starter/doc/lib下esdk-obs-java-3.19.11.1.jar

使用步骤1.引入自定义obs的starter

<dependency>
    <groupId>com.wuzheng</groupId>
    <artifactId>obs-upload-spring-boot-starter</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

使用步骤2.配置文件设置参数

obs:
  #端点（xx和地区对应）
  endPoint: http://obs.xxx.myhuaweicloud.com
  ak: yourself ak
  sk: yourslef sk
  bucketName: yourself 桶的名字
  #地区
  bucketLoc: xxx

使用步骤3.在springboot的启动类上加上启动注解

@EnableObsAutoConfiguration

项目中调用示例

@Service
public class UserService {
    @Autowired
    private ObsService obsService;


   //以上传为例:其余方法看上面的接口列表
    public static void obsUp() {
        String objectKey = "XX";
        File file = new File("XXXX");
        obsService.putObjectAndSetPreAccessStrategy(objectKey,  file);        
    }

4、springboot(华为云的obs)starter开源项目地址

https://gitee.com/hufanglei/obs-upload-spring-boot-starter

---

我的微信公众号：
搜索： 盛开de每一天
不定时推送相关文章，期待和你们一块儿成长！！

---

完