SpringBoot實戰之文件上傳微軟雲（Azure Storage）

前言

上傳文件到Azure Storage 的案例比較少，只能到官網去研究，並且也不一定拿來就可以使用。

Blob 存儲簡介

爲任何種類的非結構化數據使用可進行大規模縮放的對象存儲

第一步：配置pom.xml

<!-- https://mvnrepository.com/artifact/com.microsoft.azure/azure-storage -->
<dependency>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure-storage</artifactId>
    <version>8.4.0</version>
</dependency>

第二步：增加azure blob配置

可以配置到項目中的*.properties和*yml 文件中

# properties 配置如下
azureblob.defaultEndpointsProtocol=https
azureblob.blobEndpoint=https://teststorage.blob.core.chinacloudapi.cn/
azureblob.queueEndpoint=https://teststorage.queue.core.chinacloudapi.cn/
azureblob.tableEndpoint=https://teststorage.table.core.chinacloudapi.cn/
azureblob.accountName=teststorage
azureblob.accountKey=accountkey

# yml 配置如下
azure blob
  defaultEndpointsProtocol: https
  blobEndpoint: https://teststorage.queue.core.chinacloudapi.cn/
  queueEndpoint: https://teststorage.queue.core.chinacloudapi.cn/
  tableEndpoint: https://teststorage.queue.core.chinacloudapi.cn/
  accountName: teststorage
  accountKey: account key

第三步：編寫配置信息類（StorageConfig）

import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConfigurationProperties(prefix = "azure blob"
@NoArgsConstructor
@Data
public class StorageConfig {
    @Value("${azureblob.defaultEndpointsProtocol}")
    private String defaultEndpointsProtocol;
    @Value("${azureblob.blobEndpoint}")
    private String blobEndpoint;
    @Value("${azureblob.queueEndpoint}")
    private String queueEndpoint;
    @Value("${azureblob.tableEndpoint}")
    private String tableEndpoint;
    @Value("${azureblob.accountName}")
    private String accountName;
    @Value("${azureblob.accountKey}")
    private String accountKey;
}

**備註：這裏用了lombok註解，也可以手寫get/set

第四步：編寫上傳文件類（BlobHelper）

import com.microsoft.azure.storage.CloudStorageAccount;
import com.microsoft.azure.storage.blob.BlobContainerPermissions;
import com.microsoft.azure.storage.blob.BlobContainerPublicAccessType;
import com.microsoft.azure.storage.blob.CloudBlobClient;
import com.microsoft.azure.storage.blob.CloudBlobContainer;
 
public class BlobHelper {
     
    public static CloudBlobContainer getBlobContainer(String containerName, StorageConfig storageConfig)
    {
        try
        {
            String blobStorageConnectionString = String.format("DefaultEndpointsProtocol=%s;"
                    + "BlobEndpoint=%s;"
                    + "QueueEndpoint=%s;"
                    + "TableEndpoint=%s;"
                    + "AccountName=%s;"
                    + "AccountKey=%s", 
                    storageConfig.getDefaultEndpointsProtocol(), storageConfig.getBlobEndpoint(), 
                    storageConfig.getQueueEndpoint(), storageConfig.getTableEndpoint(), 
                    storageConfig.getAccountName(), storageConfig.getAccountKey());
             
            CloudStorageAccount account = CloudStorageAccount.parse(blobStorageConnectionString);
            CloudBlobClient serviceClient = account.createCloudBlobClient();
 
            CloudBlobContainer container = serviceClient.getContainerReference(containerName);
             
            // Create a permissions object.
            BlobContainerPermissions containerPermissions = new BlobContainerPermissions();
 
            // Include public access in the permissions object.
         containerPermissions.setPublicAccess(BlobContainerPublicAccessType.CONTAINER);
            // Set the permissions on the container.
            container.uploadPermissions(containerPermissions);
            container.createIfNotExists();
            return container;
        }
        catch(Exception e)
        {
            // 加載上傳文件啓動異常
            return null;
        }
    }
}

第五步：增加工具類（MyUtil）

public class MyUtils {
    private static char hexdigits[] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e',
            'f' };

    public static String getMD5(String inStr) {
        MessageDigest md5 = null;
        try {
            md5 = MessageDigest.getInstance("MD5");
        } catch (Exception e) {

            e.printStackTrace();
            return "";
        }
        char[] charArray = inStr.toCharArray();
        byte[] byteArray = new byte[charArray.length];

        for (int i = 0; i < charArray.length; i++)
            byteArray[i] = (byte) charArray[i];

        byte[] md5Bytes = md5.digest(byteArray);

        StringBuffer hexValue = new StringBuffer();

        for (int i = 0; i < md5Bytes.length; i++) {
            int val = ((int) md5Bytes[i]) & 0xff;
            if (val < 16)
                hexValue.append("0");
            hexValue.append(Integer.toHexString(val));
        }

        return hexValue.toString();
    }

    public static String getMD5(InputStream fileStream) {

        try {
            MessageDigest md = MessageDigest.getInstance("MD5");

            byte[] buffer = new byte[2048];
            int length = -1;
            while ((length = fileStream.read(buffer)) != -1) {
                md.update(buffer, 0, length);
            }
            byte[] b = md.digest();
            return byteToHexString(b);
        } catch (Exception ex) {
            ex.printStackTrace();
            return null;
        }finally{
            try {
                fileStream.close();
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }
    }

    private static String byteToHexString(byte[] tmp) {
        String s;
        // 用字節表示就是 16 個字節
        char str[] = new char[16 * 2]; // 每個字節用 16 進製表示的話，使用兩個字符，
        // 所以表示成 16 進制需要 32 個字符
        int k = 0; // 表示轉換結果中對應的字符位置
        for (int i = 0; i < 16; i++) { // 從第一個字節開始，對 MD5 的每一個字節
            // 轉換成 16 進制字符的轉換
            byte byte0 = tmp[i]; // 取第 i 個字節
            str[k++] = hexdigits[byte0 >>> 4 & 0xf]; // 取字節中高 4 位的數字轉換,
            // >>> 爲邏輯右移，將符號位一起右移
            str[k++] = hexdigits[byte0 & 0xf]; // 取字節中低 4 位的數字轉換
        }
        s = new String(str); // 換後的結果轉換爲字符串
        return s;
    }
}

第六步：上傳文件接口（ MultipartFile）

@Api(value = "微軟雲存儲", description = "微軟雲存儲")
@RestController
@RequestMapping("azure")
@Slf4j
public class FileUploadController {
    @Autowired
    private StorageConfig storageConfig;
@ApiOperation(value = "圖片上傳Azure", notes = "圖片上傳Azure")
    @RequestMapping(value = "/uploadImg", method = RequestMethod.POST, consumes = "multipart/*", headers = "content-type=multipart/form-data")
    public Object uploadImg(@RequestBody MultipartFile file) {
try {
            if (file != null) {
                //獲取或創建container
                CloudBlobContainer blobContainer = BlobHelper.getBlobContainer(blobContainerName, storageConfig);
                if (!file.isEmpty()) {
                    try {
                      
                        //拼裝blob的名稱(前綴名稱+文件的md5值+文件擴展名稱)
                        String checkSum = MyUtils.getMD5(file.getInputStream());
                        String fileExtension = getFileExtension(file.getOriginalFilename()).toLowerCase();
                        String preName = getBlobPreName(0, false).toLowerCase();
                        String blobName = preName + checkSum + fileExtension;
                        log.info(blobName);
                        //設置文件類型，並且上傳到azure blob
                        CloudBlockBlob blob = blobContainer.getBlockBlobReference(blobName);
                        blob.getProperties().setContentType(file.getContentType());
                        blob.upload(file.getInputStream(), file.getSize());
                        //將上傳後的圖片URL返回
                        return blob.getUri().toString();
                    } catch (Exception e) {
                        log.error("upload azure oss error：{}", e);
                    }
                }
            }
//            }
        } catch (Exception e) {
            log.error("upload azure oss error：{}", e);
        }
    } 
  return null;
}

結束

好了，一個簡單的SpringBoot 上傳文件至微軟雲的小案例就完成啦，當然如果是圖片、視頻等可能還需要進行文件格式的攔截，代碼如下：

if (!(file.getContentType().toLowerCase().equals("image/jpg")
                                || file.getContentType().toLowerCase().equals("image/jpeg")
                                || file.getContentType().toLowerCase().equals("image/png"))) {
                            infoUniformResultTemplate.setCode(Code.FAIL.getCode());
                            log.info("圖片格式不正確");
                        }

擴展

Azure 信息保護客戶端支持的文件類型如下：

• Adobe 可移植文檔格式：pdf
• Microsoft Project：.mpp、.mpt
• Microsoft Publisher：.pub
• Microsoft XPS：.xps .oxps
• 圖像：.jpg、.jpe、.jpeg、.jif、.jfif、.jfi、 .png、.tif、.tiff
• Autodesk Design Review 2013：.dwfx
• Adobe Photoshop：.psd
• 數碼底片：.dng
• Microsoft Office：*
  官網地址：https://docs.microsoft.com/zh-cn/azure/information-protection/rms-client/client-admin-guide-file-types):