1. 程式人生 > >阿裏雲OSS工具類

阿裏雲OSS工具類

src lsi uuid csdn pack sso wrong ews 商業模式

【前言】

我們上家公司的存儲系統用的是FastDFS(智能一代雲平臺(二十八):對前後端分離和FastDFS的使用的再理解);現在在職的公司用的是阿裏雲的OSS(OSS的官方文檔),在工作的時候整理一個上傳OSS文件的工具類,現在與大家分享一下。

【工具類】

1、工具類的代碼:

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

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的訪問權限由 私有 設置為 公共讀

技術分享圖片

【總結】

阿裏雲現在很多公司都在用,阿裏雲穩定,安全,相對來說成本更低;給自己更多思考的是如何讓項目減少成本,以及阿裏雲等帶來的商業模式。

阿裏雲OSS工具類