阿里云OSS工具类

【前言】

       我们上家公司的存储系统用的是FastDFS（智能一代云平台（二十八）:对前后端分离和FastDFS的使用的再理解）；现在在职的公司用的是阿里云的OSS（OSS的官方文档），在工作的时候整理一个上传OSS文件的工具类，现在与大家分享一下。

【工具类】

       1、工具类的代码：

  1. package zhanghan.oss.utils;
  2.  
  3. import com.aliyun.oss.ClientException;
  4. import com.aliyun.oss.OSSClient;
  5. import com.aliyun.oss.OSSException;
  6. import com.aliyun.oss.model.ObjectMetadata;
  7. import com.aliyun.oss.model.PutObjectResult;
  8. import com.fasterxml.jackson.annotation.JsonValue;
  9. import org.apache.commons.io.FilenameUtils;
  10. import org.apache.commons.lang3.time.DateUtils;
  11. import org.springframework.util.StringUtils;
  12. import org.springframework.web.multipart.MultipartFile;
  13. import zhanghan.oss.exception.OSSCreateBucketRuntimeException;
  14. import zhanghan.oss.exception.OSSGeneratePresignedUrlRuntimeException;
  15. import zhanghan.oss.exception.OssPutObjectRuntimeException;
  16. import java.io.InputStream;
  17. import java.net.URL;
  18. import java.util.Date;
  19. import java.util.UUID;
  20.  
  21. /**
  22.  * OSS上传工具类-张晗-2017/10/10
  23.  */
  24. public class OSSUtil {
  25.     private volatile static OSSClient instance;
  26.  
  27.     private OSSUtil() {
  28.     }
  29.  
  30.     /**
  31.      * 单例
  32.      * @return  OSS工具类实例
  33.      */
  34.     private static OSSClient getOSSClient() {
  35.         if (instance == null) {
  36.             synchronized (OSSUtil.class) {
  37.                 if (instance == null) {
  38.                     instance = new OSSClient(OSS_END_POINT, OSS_ACCESS_KEY_ID, OSS_ACCESS_KEY_SECRET);
  39.                 }
  40.             }
  41.         }
  42.         return instance;
  43.     }
  44.  
  45.     //定义日志
  46.     private final static LogUtils logger = LogUtils.getLogger(OSSUtil.class);
  47.     //OSS 的地址
  48.     private final static String OSS_END_POINT = "http://oss-cn-qingdao.aliyuncs.com";
  49.     //OSS 的key值
  50.     private final static String OSS_ACCESS_KEY_ID = "OSSKEY";
  51.     //OSS 的secret值
  52.     private final static String OSS_ACCESS_KEY_SECRET = "OSSSECRET";
  53.     //OSS 的bucket名字
  54.     private final static String OSS_BUCKET_NAME = "zhanghan-test";
  55.     //设置URL过期时间为10年
  56.     private final static Date OSS_URL_EXPIRATION = DateUtils.addDays(new Date(), 365 * 10);
  57.  
  58.     //文件路径的枚举
  59.     public enum FileDirType {
  60.         ZHANGHAN_TEST("test");
  61.         private String dir;
  62.  
  63.         FileDirType(String dir) {
  64.             this.dir = dir;
  65.         }
  66.  
  67.         @JsonValue
  68.         public String getDir() {
  69.             return dir;
  70.         }
  71.     }
  72.  
  73.     /**
  74.      * 上传文件---去除URL中的？后的时间戳
  75.      * @param file 文件
  76.      * @param fileDir 上传到OSS上文件的路径
  77.      * @return 文件的访问地址
  78.      */
  79.     public static String upload(MultipartFile file, FileDirType fileDir) {
  80.         OSSUtil.createBucket();
  81.         String fileName = OSSUtil.uploadFile(file, fileDir);
  82.         String fileOssURL = OSSUtil.getImgUrl(fileName, fileDir);
  83.         int firstChar = fileOssURL.indexOf("?");
  84.         if (firstChar > 0) {
  85.             fileOssURL = fileOssURL.substring(0, firstChar);
  86.         }
  87.         return fileOssURL;
  88.     }
  89.  
  90.  
  91.     /**
  92.      * 当Bucket不存在时创建Bucket
  93.      *
  94.      * @throws OSSException 异常
  95.      * @throws ClientException Bucket命名规则：
  96.      *                         1.只能包含小写字母、数字和短横线，
  97.      *                         2.必须以小写字母和数字开头和结尾
  98.      *                         3.长度在3-63之间
  99.      */
  100.     private static void createBucket() {
  101.         try {
  102.             if (!OSSUtil.getOSSClient().doesBucketExist(OSS_BUCKET_NAME)) {//判断是否存在该Bucket，不存在时再重新创建
  103.                 OSSUtil.getOSSClient().createBucket(OSS_BUCKET_NAME);
  104.             }
  105.         } catch (Exception e) {
  106.             logger.error("{}", "创建Bucket失败,请核对Bucket名称(规则：只能包含小写字母、数字和短横线，必须以小写字母和数字开头和结尾，长度在3-63之间)");
  107.             throw new OSSCreateBucketRuntimeException("创建Bucket失败,请核对Bucket名称(规则：只能包含小写字母、数字和短横线，必须以小写字母和数字开头和结尾，长度在3-63之间)");
  108.         }
  109.     }
  110.  
  111.  
  112.     /**
  113.      * 上传到OSS服务器  如果同名文件会覆盖服务器上的
  114.      * @param file 文件
  115.      * @param fileDir  上传到OSS上文件的路径
  116.      * @return 文件的访问地址
  117.      */
  118.     private static String uploadFile(MultipartFile file, FileDirType fileDir) {
  119.         String fileName = String.format(
  120.                 "%s.%s",
  121.                 UUID.randomUUID().toString(),
  122.                 FilenameUtils.getExtension(file.getOriginalFilename()));
  123.         try (InputStream inputStream = file.getInputStream()) {
  124.             //创建上传Object的Metadata
  125.             ObjectMetadata objectMetadata = new ObjectMetadata();
  126.             objectMetadata.setContentLength(inputStream.available());
  127.             objectMetadata.setCacheControl("no-cache");
  128.             objectMetadata.setHeader("Pragma", "no-cache");
  129.             objectMetadata.setContentType(getContentType(FilenameUtils.getExtension("." + file.getOriginalFilename())));
  130.             objectMetadata.setContentDisposition("inline;filename=" + fileName);
  131.             //上传文件
  132.             PutObjectResult putResult = OSSUtil.getOSSClient().putObject(OSS_BUCKET_NAME, fileDir.getDir() + fileName, inputStream, objectMetadata);
  133.             return fileName;
  134.         } catch (Exception e) {
  135.             logger.error("{}", "上传文件失败");
  136.             throw new OssPutObjectRuntimeException("上传文件失败");
  137.         }
  138.     }
  139.  
  140.  
  141.     /**
  142.      * 获得文件路径
  143.      * @param fileUrl  文件的URL
  144.      * @param fileDir  文件在OSS上的路径
  145.      * @return 文件的路径
  146.      */
  147.     private static String getImgUrl(String fileUrl, FileDirType fileDir) {
  148.         if (StringUtils.isEmpty(fileUrl)) {
  149.             logger.error("{}", "文件地址为空");
  150.             throw new RuntimeException("文件地址为空");
  151.         }
  152.         String[] split = fileUrl.split("/");
  153.  
  154.         //获取oss图片URL失败
  155.         URL url = OSSUtil.getOSSClient().generatePresignedUrl(OSS_BUCKET_NAME, fileDir.getDir() + split[split.length - 1], OSS_URL_EXPIRATION);
  156.         if (url == null) {
  157.             logger.error("{}", "获取oss文件URL失败");
  158.             throw new OSSGeneratePresignedUrlRuntimeException("获取oss文件URL失败");
  159.         }
  160.         return url.toString();
  161.     }
  162.  
  163.     /**
  164.      * 判断OSS服务文件上传时文件的contentType
  165.      *
  166.      * @param FilenameExtension 文件后缀
  167.      * @return 后缀
  168.      */
  169.     private static String getContentType(String FilenameExtension) {
  170.         if (FilenameExtension.equalsIgnoreCase("bmp")) {
  171.             return "image/bmp";
  172.         }
  173.         if (FilenameExtension.equalsIgnoreCase("gif")) {
  174.             return "image/gif";
  175.         }
  176.         if (FilenameExtension.equalsIgnoreCase("jpeg") ||
  177.                 FilenameExtension.equalsIgnoreCase("jpg") ||
  178.                 FilenameExtension.equalsIgnoreCase("png")) {
  179.             return "image/jpeg";
  180.         }
  181.         if (FilenameExtension.equalsIgnoreCase("html")) {
  182.             return "text/html";
  183.         }
  184.         if (FilenameExtension.equalsIgnoreCase("txt")) {
  185.             return "text/plain";
  186.         }
  187.         if (FilenameExtension.equalsIgnoreCase("vsd")) {
  188.             return "application/vnd.visio";
  189.         }
  190.         if (FilenameExtension.equalsIgnoreCase("pptx") ||
  191.                 FilenameExtension.equalsIgnoreCase("ppt")) {
  192.             return "application/vnd.ms-powerpoint";
  193.         }
  194.         if (FilenameExtension.equalsIgnoreCase("docx") ||
  195.                 FilenameExtension.equalsIgnoreCase("doc")) {
  196.             return "application/msword";
  197.         }
  198.         if (FilenameExtension.equalsIgnoreCase("xml")) {
  199.             return "text/xml";
  200.         }
  201.         return "image/jpeg";
  202.     }
  203. }

       2、调用工具类的代码：

  1.    /**
  2.      * 上传文件测试
  3.      * @param multipartFile 待上传的文件
  4.      * @return  上传在OSS文件的访问路径
  5.      * @throws BusinessException  上传异常
  6.      */
  7.     public String uploadTest(MultipartFile multipartFile) throws BusinessException{
  8.         try {
  9.             uploadResult = OSSUtil.upload(multipartFile, OSSUtil.FileDirType.ZHANGHAN_TEST);
  10.         } catch (Exception e) {
  11.             LoggerUtil.logService(LoggerUtil.spManualLoan, "SPManualLoanServiceImpl-submitLoan", "call OSSUtil.upload; Exception:" + e.getMessage());
  12.             throw new BusinessException(WrongMessageEnum.EXCEPTION_STORE);
  13.         }
  14.         return uploadResult;
  15.     }

       3、问题&解决：

          （1） 问题：通过URL在浏览器中访问时报如下错：

  

          （2）解决方案：在阿里云的控制台上，进入OSS的设置界面，将Bucket的访问权限由 私有 设置为 公共读


【总结】

       阿里云现在很多公司都在用，阿里云稳定，安全，相对来说成本更低；给自己更多思考的是如何让项目减少成本，以及阿里云等带来的商业模式。

【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/jpfss/p/10146505.html