com.github.joekerouac.common.tools.resource.impl.OssResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-tools Show documentation
各种常用工具
The newest version!
// Generated by delombok at Fri Mar 14 11:41:38 CST 2025
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE
 * file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file
 * to You 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
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.
 */
package com.github.joekerouac.common.tools.resource.impl;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import com.aliyun.oss.OSS;
import com.aliyun.oss.model.OSSObject;
import com.github.joekerouac.common.tools.constant.ExceptionProviderConst;
import com.github.joekerouac.common.tools.constant.StringConst;
import com.github.joekerouac.common.tools.io.IOUtils;
import com.github.joekerouac.common.tools.resource.Resource;
import com.github.joekerouac.common.tools.enums.ResourceType;
import com.github.joekerouac.common.tools.string.StringUtils;
import com.github.joekerouac.common.tools.util.Assert;

/**
 * OSS类型的资源
 * 
 * @author JoeKerouac
 * @date 2022-10-14 14:37:00
 * @since 1.0.0
 */
public class OssResource implements Resource {
    private static final Class[] INIT_ARG_TYPES = new Class[] {OSS.class};
    /**
     * {@link #buckName}字段名
     */
    public static final String BUCK_NAME_FIELD_NAME = "buckName";
    /**
     * {@link #dir}字段名
     */
    public static final String DIR_FIELD_NAME = "dir";
    /**
     * {@link #fileName}字段名
     */
    public static final String FILE_NAME_FIELD_NAME = "fileName";
    private transient OSS oss;
    private final String buckName;
    private final String dir;
    private final String fileName;
    private volatile transient OSSObject ossObject;
    private volatile transient byte[] content;

    public OssResource(Map map) {
        this(map.get(BUCK_NAME_FIELD_NAME), map.get(DIR_FIELD_NAME), map.get(FILE_NAME_FIELD_NAME));
    }

    public OssResource(String buckName, String dir, String fileName) {
        Assert.notBlank(buckName, "oss buck name must not be blank", ExceptionProviderConst.IllegalArgumentExceptionProvider);
        Assert.notBlank(dir, "oss dir must not be blank", ExceptionProviderConst.IllegalArgumentExceptionProvider);
        Assert.notBlank(fileName, "oss file name must not be blank", ExceptionProviderConst.IllegalArgumentExceptionProvider);
        this.buckName = buckName;
        this.dir = StringUtils.trim(dir, Character.toString(StringConst.SLASH));
        this.fileName = StringUtils.trim(fileName, Character.toString(StringConst.SLASH));
    }

    @Override
    public Map toMap() {
        Map map = new HashMap<>();
        map.put(BUCK_NAME_FIELD_NAME, buckName);
        map.put(DIR_FIELD_NAME, dir);
        map.put(FILE_NAME_FIELD_NAME, fileName);
        return map;
    }

    @Override
    public void init(Object[] args) {
        Resource.argsCheck(args, INIT_ARG_TYPES);
        Assert.notNull(args[0], "参数不能为空", ExceptionProviderConst.IllegalArgumentExceptionProvider);
        this.oss = (OSS) args[0];
    }

    @Override
    public ResourceType type() {
        return ResourceType.OSS_RESOURCE;
    }

    @Override
    public InputStream getInputStream() throws IOException {
        Assert.notNull(oss, StringUtils.format("资源未初始化： [{}:{}:{}]", buckName, dir, fileName), ExceptionProviderConst.IllegalStateExceptionProvider);
        readFromRemote();
        return new ByteArrayInputStream(content);
    }

    @Override
    public String getName() {
        return dir + StringConst.SLASH + fileName;
    }

    @Override
    public URL getUrl() throws IOException {
        return null;
    }

    /**
     * 获取最后更新时间
     * 
     * @return 最后更新时间
     */
    public Date getLastModified() {
        readFromRemote();
        return ossObject.getObjectMetadata().getLastModified();
    }

    /**
     * 从远程读取OSS资源，注意，该读取会缓存
     */
    private void readFromRemote() {
        if (ossObject == null) {
            synchronized (this) {
                if (ossObject == null) {
                    // 注意，如果指定的key（文件）不存在，那么将直接抛出异常
                    this.ossObject = oss.getObject(buckName, dir + StringConst.SLASH + fileName);
                    this.content = IOUtils.read(ossObject.getObjectContent(), true);
                }
            }
        }
    }

    @java.lang.Override
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public boolean equals(final java.lang.Object o) {
        if (o == this) return true;
        if (!(o instanceof OssResource)) return false;
        final OssResource other = (OssResource) o;
        if (!other.canEqual((java.lang.Object) this)) return false;
        final java.lang.Object this$buckName = this.getBuckName();
        final java.lang.Object other$buckName = other.getBuckName();
        if (this$buckName == null ? other$buckName != null : !this$buckName.equals(other$buckName)) return false;
        final java.lang.Object this$dir = this.getDir();
        final java.lang.Object other$dir = other.getDir();
        if (this$dir == null ? other$dir != null : !this$dir.equals(other$dir)) return false;
        final java.lang.Object this$fileName = this.getFileName();
        final java.lang.Object other$fileName = other.getFileName();
        if (this$fileName == null ? other$fileName != null : !this$fileName.equals(other$fileName)) return false;
        return true;
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    protected boolean canEqual(final java.lang.Object other) {
        return other instanceof OssResource;
    }

    @java.lang.Override
    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public int hashCode() {
        final int PRIME = 59;
        int result = 1;
        final java.lang.Object $buckName = this.getBuckName();
        result = result * PRIME + ($buckName == null ? 43 : $buckName.hashCode());
        final java.lang.Object $dir = this.getDir();
        result = result * PRIME + ($dir == null ? 43 : $dir.hashCode());
        final java.lang.Object $fileName = this.getFileName();
        result = result * PRIME + ($fileName == null ? 43 : $fileName.hashCode());
        return result;
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getBuckName() {
        return this.buckName;
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getDir() {
        return this.dir;
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public String getFileName() {
        return this.fileName;
    }
}