SpringBoot实战之文件上传微软云（Azure Storage）

╰+攻爆jí腚メ 2023-08-17 15:22 145阅读 0赞

#### 前言 ####

> 上传文件到Azure Storage 的案例比较少，只能到官网去研究，并且也不一定拿来就可以使用。

#### Blob 存储简介 ####

为任何种类的非结构化数据使用可进行大规模缩放的对象存储

![13.pic.jpg][]

#### 第一步：配置pom.xml ####

<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("图片格式不正确");
                            }

#### 扩展 ####

![14.pic.jpg][]

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):

[13.pic.jpg]: /images/20230810/47ed940dd89b47d79fcdbc10ebe8d3e5.png
[14.pic.jpg]: /images/20230810/dc6fe5834e6b496aa48b19d12a0f571a.png