SpringBoot整合阿里云OSS，实现图片上传

news2024/11/17 13:41:56

在项目中，将图片等文件资源上传到阿里云的OSS，减少服务器压力。

项目中导入阿里云的SDK

<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-sdk-oss</artifactId>
    <version>3.10.2</version>
</dependency>

为自己的OSS创建访问的AccessKey，有了AccessKey程序就可以访问账户资源的API了。

这就是AccessKey

然后将AcessKey的key和secret、OSS的区域节点以及bucket名称配置到配置文件中，

alioss:
  accessKeyId: LTAI5xxxxxxxxxxxxFUDMoy
  accessKeySecret: KxxxxxxxxxxxxxxxxxI
  endpoint: oss-cn-qingdao.aliyuncs.com
  bucketName: kkbank

封装工具类，去读取配置文件中的AccessKey、endpoint、bucketName，注意配置文件中的名称要与属性名保持一致，负责无法为属性赋值。


@Data
@Slf4j
@Component
@ConfigurationProperties(prefix = "alioss") // 配置文件中，配置信息的前缀
public class AliOssUtil {

    private String endpoint;    // 区域
    private String accessKeyId; // key
    private String accessKeySecret; // secret
    private String bucketName;  // bucket名称

    /**
     * 文件上传
     * 需要获取阿里云OSS中 AccessKey和 bucket所在的区域
     * @param fileName
     * @param inputStream
     * @return
     */
    public String upload(String fileName, InputStream inputStream) {

        // 创建OSSClient实例。
        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);

        // 文件在OSS中存储的路径，此处使用日期 + 当前的毫秒数 + 文件名称 来作为文件名，防止文件重名
        String objectName = "images/" + new SimpleDateFormat("yyyy/MM/dd").format(new Date())
                + "/" + System.currentTimeMillis() +"-"+fileName;
        try {
            //解决图片预览问题（默认是下载）
            ObjectMetadata metadata = new ObjectMetadata();
            // 获取文件类型
            metadata.setContentType(getContentType(fileName.substring(fileName.lastIndexOf("."))));

            // 创建PutObject请求,开始传输文件
            ossClient.putObject(bucketName, objectName, inputStream,metadata);
        } catch (OSSException oe) {
            System.out.println("Error Message:" + oe.getErrorMessage());
        } catch (ClientException ce) {
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                // 释放连接
                ossClient.shutdown();
            }
        }
        // 此时，文件上传完成，应该立即预览
        //文件访问路径规则 https://BucketName.Endpoint/ObjectName
        StringBuilder stringBuilder = new StringBuilder("https://");
        stringBuilder
                .append(bucketName)
                .append(".")
                .append(endpoint)
                .append("/")
                .append(objectName);

        log.info("文件上传到:{}", stringBuilder.toString());
        // 返回图片的外网访问url
        return stringBuilder.toString();
    }

    /**
     * 根据文件名称后缀，设置MIME类型,此处仅设置图片类型
     * @param filenameExtension 文件名称后缀
     * @return
     */
    private String getContentType(String filenameExtension) {
        if (filenameExtension.equalsIgnoreCase(".bmp")) {
            return "image/bmp";
        }
        if (filenameExtension.equalsIgnoreCase(".gif")) {
            return "image/gif";
        }
        if (filenameExtension.equalsIgnoreCase(".jpeg") ||
                filenameExtension.equalsIgnoreCase(".jpg") ||
                filenameExtension.equalsIgnoreCase(".png")) {
            return "image/jpg";
        }
        return "image/jpg";
    }
}

在需要的地方调用即可，利用SpringMVC中的MultiPartFile来接受文件流。

@RestController
@RequestMapping("/admin/common")
@Slf4j
public class CommonController {

    @Autowired
    private AliOssUtil aliOssUtil;

    //文件上传
    @PostMapping("/upload")
    public Result upload(MultipartFile file) throws IOException {
        String path = aliOssUtil.upload(file.getOriginalFilename(), file.getInputStream());
        log.info("图片上传之后的访问路径是{}", path);
        return Result.success(path);// 返回文件在网络中的url
    }
}