OSS存储工具类分享(阿里)

    最近在家办公,居然写的还没什么可写的,这是个坏习惯。多次鼓动下,公司终于换上了阿里的OSS存储。我这边也提前做好准备,尽管还不知道apiKey,apiSecret。系统也刚好还没有这样的工具类,先写着备用吧。废话不多说,直接上码。

package com.xiaotian.bus.util;

import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.model.Bucket;
import com.aliyun.oss.model.OSSObject;
import com.aliyun.oss.model.ObjectMetadata;
import com.aliyun.oss.model.PutObjectResult;
import lombok.extern.slf4j.Slf4j;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;


/**
 * 阿里云OSS存储工具类
 * @author zwsky
 */
@Component
@Slf4j
public class OSSObjectTools {

    private static String BUCKET_NAME;
    private static String END_POINT;
    private static String ACCESS_KEY_ID;
    private static String ACCESS_KEY_SECRET;

    /**
     * Endpoint以杭州为例,其它Region请按实际情况填写。
     */
    @Value("${ali.oss.endpoint}")
    private String endpoint;
    @Value("${ali.oss.accessKeyId}")
    private String accessKeyId;
    @Value("${ali.oss.accessKeySecret}")
    private String accessKeySecret;
    @Value("${ali.oss.img.pass.bucketName}")
    private String bucketName;
    private static OSS ossclient=null;

    /**
     * 常量初始化
     */
    @PostConstruct
    public void init() {
        BUCKET_NAME = bucketName;
        END_POINT = endpoint;
        ACCESS_KEY_ID = accessKeyId;
        ACCESS_KEY_SECRET = accessKeySecret;
    }




    /**
     * 获取OSS连接
     * @return
     */
    private static void getOSSClient() {
        if (ossclient == null){
            ossclient = new OSSClientBuilder().build(END_POINT, ACCESS_KEY_ID, ACCESS_KEY_SECRET);
        }
    }



    /**
     * 创建存储空间
     *
     * param ossClient OSS连接
     * param bucketName 存储空间
     * return
     */
    public static String createBucketName(String bucketName) {
        //获取OSS存储client
        getOSSClient();
        // 存储空间
        final String bucketNames = bucketName;
        if (!ossclient.doesBucketExist(bucketName)) {
            // 创建存储空间
            Bucket bucket = ossclient.createBucket(bucketName);
            log.info("创建存储空间成功");
            return bucket.getName();
        }
        return bucketNames;
    }
    /**
     * 删除存储空间buckName
     *
     * param ossClient oss对象
     * param bucketName 存储空间
     */
    public static void deleteBucket(String bucketName) {
        //获取OSS存储client
        getOSSClient();
        ossclient.deleteBucket(bucketName);
        log.info("删除" + bucketName + "Bucket成功");
    }

    /**
     * 创建模拟文件夹
     *
     * param ossClient oss连接
     * param bucketName 存储空间
     * param folder 模拟文件夹名如"qj_nanjing/"
     * return 文件夹名
     */
    public static String createFolder(String bucketName, String folder) {
        //获取OSS存储client
        getOSSClient();
        // 文件夹名
        final String keySuffixWithSlash = folder;
        // 判断文件夹是否存在,不存在则创建
        if (!ossclient.doesObjectExist(bucketName, keySuffixWithSlash)) {
            // 创建文件夹
            ossclient.putObject(bucketName, keySuffixWithSlash, new ByteArrayInputStream(new byte[0]));
            log.info("创建文件夹成功");
            // 得到文件夹名
            OSSObject object = ossclient.getObject(bucketName, keySuffixWithSlash);
            String fileDir = object.getKey();
            return fileDir;
        }
        return keySuffixWithSlash;
    }


    /**
     * 根据key删除OSS服务器上的文件
     *
     * param ossClient oss连接
     * param bucketName 存储空间
     * param folder 模拟文件夹名 如"qj_nanjing/"
     * param key Bucket下的文件的路径名+文件名 如:"upload/cake.jpg"
     */
    public static void deleteFile(String bucketName, String folder, String key) {
        //获取OSS存储client
        getOSSClient();
        ossclient.deleteObject(bucketName, folder + key);
        log.info("删除" + bucketName + "下的文件" + folder + key + "成功");
    }


    /**
     * 上传图片至OSS
     *
     * param ossClient oss连接
     * param file 上传文件(文件全路径如:D:\\image\\cake.jpg)
     * param bucketName 存储空间
     * param storePath 模拟文件夹名 如"qj_nanjing/"
     * return String 返回的唯一MD5数字签名
     */
    public static String uploadObjectOSS(String storePath, File file,InputStream is) {
        //获取OSS存储client
        getOSSClient();
        String resultStr = null;
        createFolder(BUCKET_NAME, storePath);
        try {
            // 文件名
            String fileName = file.getName();
            // 文件大小
            Long fileSize = file.length();
            // 创建上传Object的Metadata
            ObjectMetadata metadata = new ObjectMetadata();
            // 上传的文件的长度
            metadata.setContentLength(is.available());
            // 指定该Object被下载时的网页的缓存行为
            metadata.setCacheControl("no-cache");
            // 指定该Object下设置Header
            metadata.setHeader("Pragma", "no-cache");
            // 指定该Object被下载时的内容编码格式
            metadata.setContentEncoding("utf-8");
            // 文件的MIME,定义文件的类型及网页编码,决定浏览器将以什么形式、什么编码读取文件。如果用户没有指定则根据Key或文件名的扩展名生成,
            // 如果没有扩展名则填默认值application/octet-stream
            metadata.setContentType(getContentType(fileName));
            // 指定该Object被下载时的名称(指示MINME用户代理如何显示附加的文件,打开或下载,及文件名称)
            metadata.setContentDisposition("filename/filesize=" + fileName + "/" + fileSize + "Byte.");
            // 上传文件 (上传文件流的形式)
            PutObjectResult putResult = ossclient.putObject(BUCKET_NAME, storePath + fileName, is, metadata);
            // 解析结果
            resultStr = storePath + fileName;
            log.info("putResult.getETag():"+putResult.getETag());
        } catch (Exception e) {
            e.printStackTrace();
            log.error("上传阿里云OSS服务器异常." + e.getMessage(), e);
        }
        return resultStr;
    }

    /**
     * 上传图片至OSS
     *
     * param ossClient oss连接
     * param file 上传文件(文件全路径如:D:\\image\\cake.jpg)
     * param bucketName 存储空间
     * param storePath 模拟文件夹名 如"qj_nanjing/"
     * return String 返回的唯一MD5数字签名
     */
    public static String uploadObjectOSS(String storePath,String fileName, File file,InputStream is) {
        //获取OSS存储client
        getOSSClient();
        String resultStr = null;
        createFolder(BUCKET_NAME, storePath);
        try {
          /*  // 文件名
            String fileName = file.getName();*/
            // 文件大小
            Long fileSize = file.length();
            // 创建上传Object的Metadata
            ObjectMetadata metadata = new ObjectMetadata();
            // 上传的文件的长度
            metadata.setContentLength(is.available());
            // 指定该Object被下载时的网页的缓存行为
            metadata.setCacheControl("no-cache");
            // 指定该Object下设置Header
            metadata.setHeader("Pragma", "no-cache");
            // 指定该Object被下载时的内容编码格式
            metadata.setContentEncoding("utf-8");
            // 文件的MIME,定义文件的类型及网页编码,决定浏览器将以什么形式、什么编码读取文件。如果用户没有指定则根据Key或文件名的扩展名生成,
            // 如果没有扩展名则填默认值application/octet-stream
            metadata.setContentType(getContentType(fileName));
            // 指定该Object被下载时的名称(指示MINME用户代理如何显示附加的文件,打开或下载,及文件名称)
            metadata.setContentDisposition("filename/filesize=" + fileName + "/" + fileSize + "Byte.");
            // 上传文件 (上传文件流的形式)
            PutObjectResult putResult = ossclient.putObject(BUCKET_NAME, storePath + fileName, is, metadata);
            // 解析结果
            resultStr = storePath + fileName;
            log.info("putResult.getETag():"+putResult.getETag());
        } catch (Exception e) {
            e.printStackTrace();
            log.error("上传阿里云OSS服务器异常." + e.getMessage(), e);
        }
        return resultStr;
    }


    /**
     * 上传图片至OSS
     *
     * param ossClient oss连接
     * param file 上传文件(文件全路径如:D:\\image\\cake.jpg)
     * param bucketName 存储空间
     * param storePath 模拟文件夹名 如"qj_nanjing/"
     * return String 返回的唯一MD5数字签名
     */
    public static String uploadObjectOSS1(String storePath,String fileName,InputStream is) {
        //获取OSS存储client
        getOSSClient();
        String resultStr = null;
        createFolder(BUCKET_NAME, storePath);
        try {
          /*  // 文件名
            String fileName = file.getName();*/
            // 文件大小

            // 创建上传Object的Metadata
            ObjectMetadata metadata = new ObjectMetadata();
            // 上传的文件的长度
            metadata.setContentLength(is.available());
            // 指定该Object被下载时的网页的缓存行为
            metadata.setCacheControl("no-cache");
            // 指定该Object下设置Header
            metadata.setHeader("Pragma", "no-cache");
            // 指定该Object被下载时的内容编码格式
            metadata.setContentEncoding("utf-8");
            // 文件的MIME,定义文件的类型及网页编码,决定浏览器将以什么形式、什么编码读取文件。如果用户没有指定则根据Key或文件名的扩展名生成,
            // 如果没有扩展名则填默认值application/octet-stream
            metadata.setContentType(getContentType(fileName));
            // 指定该Object被下载时的名称(指示MINME用户代理如何显示附加的文件,打开或下载,及文件名称)
            // metadata.setContentDisposition("filename/filesize=" + fileName + "/" + fileSize + "Byte.");
            // 上传文件 (上传文件流的形式)
            PutObjectResult putResult = ossclient.putObject(BUCKET_NAME, storePath + fileName, is, metadata);
            // 解析结果
            resultStr = storePath + fileName;
            log.info("putResult.getETag():"+putResult.getETag());
        } catch (Exception e) {
            e.printStackTrace();
            log.error("上传阿里云OSS服务器异常." + e.getMessage(), e);
        }
        return resultStr;
    }


    /**
     * 通过文件名判断并获取OSS服务文件上传时文件的contentType
     *
     * param fileName 文件名
     * return 文件的contentType
     */
    public static String getContentType(String fileName) {

        // 文件的后缀名
        String fileExtension = fileName.substring(fileName.lastIndexOf("."));
        if (".bmp".equalsIgnoreCase(fileExtension)) {
            return "image/bmp";
        }
        if (".gif".equalsIgnoreCase(fileExtension)) {
            return "image/gif";
        }
        if (".jpeg".equalsIgnoreCase(fileExtension) || ".jpg".equalsIgnoreCase(fileExtension)
                || ".png".equalsIgnoreCase(fileExtension)) {
            return "image/jpeg";
        }
        if (".png".equalsIgnoreCase(fileExtension)) {
            return "image/png";
        }
        if (".html".equalsIgnoreCase(fileExtension)) {
            return "text/html";
        }
        if (".txt".equalsIgnoreCase(fileExtension)) {
            return "text/plain";
        }
        if (".vsd".equalsIgnoreCase(fileExtension)) {
            return "application/vnd.visio";
        }
        if (".ppt".equalsIgnoreCase(fileExtension) || "pptx".equalsIgnoreCase(fileExtension)) {
            return "application/vnd.ms-powerpoint";
        }
        if (".doc".equalsIgnoreCase(fileExtension) || "docx".equalsIgnoreCase(fileExtension)) {
            return "application/msword";
        }
        if (".xml".equalsIgnoreCase(fileExtension)) {
            return "text/xml";
        }
        // 默认返回类型
        return null;
    }


    @Test
    public void testAddUploadFileInfo() throws Exception{
        File file =new File("F:\\imag\\297913.jpg");
        FileInputStream fis = new FileInputStream(file);
        uploadObjectOSS("zbq/ces/", file,fis);
    }
}

实际上也没什么稀奇,之前阿里的OSS存储SDK还是2.x版本就用过了。大家可能知道的,我不喜欢用旧码的,所以顺手改成最新的,实际上我这也是参考了其他博友的代码。然后改成可以在配置文件配置相关信息的,这里穷哦觉得其实还可以将BUCKET_NAME模拟文件夹、END_POINT节点配置抽到项目的业务表配置做,如果公司多个项目都用这个,业务模块的存储要分开,那肯定这样处理更好。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章