SpringBoot整合——阿里云对象存储（OSS）

妖狐艹你老母 2024-04-01 09:34 97阅读 0赞

## SpringBoot整合——阿里云对象存储 ##

### 1 OSS介绍 ###

在开发应用的过程中，我们经常会有用户需要实名认证之后才能访问的需求。

用户认证需要上传证件图片、首页轮播也需要上传图片，因此我们要做文件服务，阿里云oss是一个很好的分布式文件服务系统，所以我们只需要集成阿里云oss即可。

> OSS本质上来说就是帮助我们存储图片、文件的一个地方。

### 2 项目集成阿里OSS ###

#### 2.1 前置准备：账号服务开通 ####

①申请阿里云账号  
https://www.aliyun.com/?spm=5176.21213303.J\_3207526240.1.4eb853c9FFk35J  
②实名认证  
③开通"对象存储OSS服务"  
![在这里插入图片描述][3cbbdaaf1f144a49a62c58433482faec.png]  
https://free.aliyun.com/product/storage/freetrial

④进入管理控制台  
https://oss.console.aliyun.com/bucket  
![在这里插入图片描述][46201b0e451a41629120abe2dad1ba22.png]

> 新用户免费体验三个月OSS

#### 测试：手动上传文件 ####

1.  创建自己的bucket

> 因为这里只是为了演示，所以我好多功能没有开通，大家在使用OSS服务时候，可以根据自己业务场景需要来开通

![在这里插入图片描述][fb488f8089e843a5a74b386494c79fa1.png]

1.  开通之后，选择文件列表，测试手动上传文件  
    ![在这里插入图片描述][36ea1807c2764724a964b3a068dda83d.png]
2.  选择上传文件，然后选择扫描文件，选择好文件或图片之后，点击上传  
    ![在这里插入图片描述][2af01dbcec52444fa0e991691f53d6eb.png]
3.  上传完成之后，点击文件列表，可以看到文件已经上传成功，点击详情可以查看文件访问地址  
    ![在这里插入图片描述][ab2dd6da128a44cfbfb7ebf72eaeb6e6.png]
4.  将url复制下来，然后在新的浏览器打开，可以发现成功访问  
    ![在这里插入图片描述][4ce3e5f638aa4fe9aa2492541b061928.png]

#### 2.2 SpringBoot项目集成OSS ####

[官方文档][Link 1]

##### 2.2.1 获取到AccessKey与Secret #####

①来到自己的工作台，将鼠标停留在头像上，选择AccessKey管理  
![在这里插入图片描述][8fabb7d5b6794c45929f398da7cb301d.png]  
②查看自己的AccessKey，如果没有就创建一个  
![在这里插入图片描述][88cbee4ea5864c1fbeba3fbd4478d10f.png]  
③点击查看Secret  
![在这里插入图片描述][4f120f0a659145bc97d8dd3a25e07ee6.png]

##### 2.2.2 编写配置文件、配置类 #####

①配置文件  
application.properties:

# 阿里云oss配置
    aliyun.oss.endpoint=oss-cn-hangzhou.aliyuncs.com//填写自己的即可
    aliyun.oss.accessKeyId=LTAI5t7md8W*****//填写自己的即可
    aliyun.oss.secret=dcusDHFIXN8u*****//填写自己的即可
    aliyun.oss.bucket=***//填写自己的即可

> endpoint获取：  
> 在之前测试过的上传文件中，查看URL详情

![在这里插入图片描述][c726c4c07cea4617a9930f304ba9f6c8.png]

> 或者如果之前没有创建的话，新建一个Bucket

![在这里插入图片描述][c0fdbe5dae2745e6b8da2926c63c06b6.png]

②配置类

> 读取配置文件内容

@Component
    public class ConstantOssPropertiesUtils implements InitializingBean {
        
    
        @Value("${aliyun.oss.endpoint}")
        private String endpoint;
    
        @Value("${aliyun.oss.accessKeyId}")
        private String accessKeyId;
    
        @Value("${aliyun.oss.secret}")
        private String secret;
    
        @Value("${aliyun.oss.bucket}")
        private String bucket;
    
        public static String ENDPOINT;
        public static String ACCESS_KEY_ID;
        public static String SERECT;
        public static String BUCKET;
    
    
        @Override
        public void afterPropertiesSet() throws Exception {
        
            ENDPOINT=endpoint;
            ACCESS_KEY_ID=accessKeyId;
            SERECT=secret;
            BUCKET=bucket;
        }
    }

##### 2.2.3 创建service与serviceImpl #####

service接口：

public interface FileService {
        
    
        /**
         * 上传文件到阿里云
         * @param file
         * @return
         */
        String upload(MultipartFile file);
    }

serviceImpl：

> 注意：为了防止上传的不同文件重名，此处我采用了UUID+时间来避免此情况，大家可以根据自己的想法实现

@Service
    public class FileServiceImpl implements FileService {
        
        //上传文件到阿里云
        @Override
        public String upload(MultipartFile file) {
        
            // Endpoint以华东1（杭州）为例，其它Region请按实际情况填写。
            String endpoint = ConstantOssPropertiesUtils.ENDPOINT;
            String accessKeyId = ConstantOssPropertiesUtils.ACCESS_KEY_ID;
            String accessKeySecret = ConstantOssPropertiesUtils.SERECT;
            String bucketName = ConstantOssPropertiesUtils.BUCKET;
    
            try{
        
                //创建OSS实例
                OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
                //上传文件流
                InputStream inputStream = file.getInputStream();
                String fileName = file.getOriginalFilename();
                //为了防止不同的文件因为有相同文件名而导致前一个文件被覆盖，将uuid添加到文件名中
                String uuid = UUID.randomUUID().toString().replaceAll("-", "");
                fileName = uuid + fileName;
                //按照当前日期，创建文件夹，将文件上传到文件夹中 2022/10/22/01.jpg
                //导入joda工具类处理时间【当然也可以使用SimpleDateFormat】
                String timeUrl = new DateTime().toString("yyyy/MM/dd");
                fileName = timeUrl + "/" + fileName;
                //调用方法实现上传
                ossClient.putObject(bucketName, fileName, inputStream);
                //关闭ossClient
                ossClient.shutdown();
                //上传之后的文件路径https://yygh-zi.oss-cn-beijing.aliyuncs.com/01.jpg
                String url = "https://" + bucketName + "." + endpoint + "/" + fileName;
                //返回url
                return url;
            } catch (IOException e) {
        
                e.printStackTrace();
            }
    
            // 创建OSSClient实例。
            OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
            return null;
        }
    }

##### 2.2.4 编写controller调用 #####

@RestController
    @RequestMapping("/api/oss/file")
    public class FileApiController {
        
        @Autowired
        private FileService fileService;
        //上传文件到阿里云oss
        @PostMapping("fileUpload")
        public Result fileUpload(MultipartFile file) {
        
            //获取上传文件
            String url = fileService.upload(file);
            return Result.ok(url);
        }
    }

##### 2.2.5 测试 #####

此处因为我的项目整合了Swagger，所以我直接使用swagger来测试  
![在这里插入图片描述][39ce197d19434368826ac5a6fa7079e2.png]  
想要整合Swagger的，可以参考下面的配置类

@Configuration
    @EnableSwagger2
    public class Swagger2Config {
        
        @Bean
        public Docket webApiConfig(){
        
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("webApi")
                    .apiInfo(webApiInfo())
                    .select()
                    //只显示api路径下的页面
                    .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                    .build();
        }
    
        @Bean
        public Docket adminApiConfig(){
        
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("adminApi")
                    .apiInfo(adminApiInfo())
                    .select()
                    //只显示admin路径下的页面
                    .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                    .build();
        }
    
        private ApiInfo webApiInfo(){
        
            return new ApiInfoBuilder()
                    .title("网站-API文档")
                    .description("本文档描述了网站微服务接口定义")
                    .version("1.0")
                    .contact(new Contact("zi", "http://zi.com", "493211102@qq.com"))
                    .build();
        }
    
        private ApiInfo adminApiInfo(){
        
            return new ApiInfoBuilder()
                    .title("后台管理系统-API文档")
                    .description("本文档描述了后台管理系统微服务接口定义")
                    .version("1.0")
                    .contact(new Contact("zi", "http://zi.com", "49321112@qq.com"))
                    .build();
        }
    }

选择文件之后，点击try it out  
![在这里插入图片描述][251e434afd5641b68db1ef34da05c544.png]  
查看阿里云控制台  
![在这里插入图片描述][f47e66af56eb4705a90ba48862e66d33.png]

至此，整合OSS成功

[3cbbdaaf1f144a49a62c58433482faec.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/33e73094ea7147c2b68d568323ff2b41.png
[46201b0e451a41629120abe2dad1ba22.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/235469b7e1c74328bfbff5695334de47.png
[fb488f8089e843a5a74b386494c79fa1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/05422b69332f447b8f69ec9c27fa6eb4.png
[36ea1807c2764724a964b3a068dda83d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/fea3a1a95ef741e6a594bfaa5e9095ff.png
[2af01dbcec52444fa0e991691f53d6eb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/3992204ae6b146f6adda87d400475b27.png
[ab2dd6da128a44cfbfb7ebf72eaeb6e6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/fb9f7199445d4eebb387562fda3a5c07.png
[4ce3e5f638aa4fe9aa2492541b061928.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/a8d794339ac14740ad8f99faac626b9a.png
[Link 1]: https://help.aliyun.com/document_detail/195870.html
[8fabb7d5b6794c45929f398da7cb301d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/0878fea5962943818119dd48337be10d.png
[88cbee4ea5864c1fbeba3fbd4478d10f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/2070ab17c4824b51ba069cf937993e01.png
[4f120f0a659145bc97d8dd3a25e07ee6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/5d6da9270a0b4423adb18c7b1e9bc841.png
[c726c4c07cea4617a9930f304ba9f6c8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/75d339d37e304f3e8f14e1075dac8714.png
[c0fdbe5dae2745e6b8da2926c63c06b6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/837cd8846062497782555892c9f3a0aa.png
[39ce197d19434368826ac5a6fa7079e2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/ee3fc4049431422a8e43ac4df678bc6d.png
[251e434afd5641b68db1ef34da05c544.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/83410bbb337141089b02d69b91acda87.png
[f47e66af56eb4705a90ba48862e66d33.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/719ef9438c944faa873b86e4ddaa7493.png