Spring--boot自动配置原理案例--阿里云--starter

news2024/9/28 23:25:53

Spring–boot自动配置原理案例–阿里云–starter

定义这个starter的作用是它可以将阿里云的工具类自动放入IOC容器中，供人使用。
我们看一看构建starter的过程，其实就是在atuoconfigure模块中加入工具类，然后写一个配置类在其中将工具类放入IOC容器，之后在starter中引入atuoconfigure模块
在这里插入图片描述
我们在配置类中的代码，作用是将AliOSSUtils类放入IOC容器，使用时可以自动注入。

package com.aliyun.oss;

import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
//说明配置类
@Configuration
//直接将配置类AliOSSProperties注入IOC容器
@EnableConfigurationProperties(AliOSSProperties.class)

public class AliOSSAutoConfiguration {
 //将第三方类注入
    @Bean
    //把配置类当成参数注入
    public AliOSSUtils aliOSSUtils(AliOSSProperties aliOSSProperties){
        AliOSSUtils aliOSSUtils = new AliOSSUtils();
        //用set函数放好阿里云的配置参数类
        aliOSSUtils.setAliOSSProperties(aliOSSProperties);
        return aliOSSUtils;
    }

}

starter模块引入atuoconfigure模块，在pom文件中加入依赖

<dependency>
            <groupId>com.aliyun.oss</groupId>
            <artifactId>aliyun-oss-spring-boot-autoconfigure</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

下面的代码是我们的oss工具类：

package com.aliyun.oss;

import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;
import java.io.InputStream;
import java.util.UUID;

/**
 * 阿里云 OSS 工具类
 */
public class AliOSSUtils {
    private AliOSSProperties aliOSSProperties;
//获得配置类
    public AliOSSProperties getAliOSSProperties() {
        return aliOSSProperties;
    }

    public void setAliOSSProperties(AliOSSProperties aliOSSProperties) {
        this.aliOSSProperties = aliOSSProperties;
    }

    /**
     * 实现上传图片到OSS
     * 我们的文件用的是MultipartFile类来传输文件
     */
    public String upload(MultipartFile file) throws IOException {
        //获取阿里云OSS参数

        String endpoint = aliOSSProperties.getEndpoint();
        String accessKeyId = aliOSSProperties.getAccessKeyId();
        String accessKeySecret = aliOSSProperties.getAccessKeySecret();
        String bucketName = aliOSSProperties.getBucketName();

        // 获取上传的文件的输入流
        InputStream inputStream = file.getInputStream();

        // 避免文件覆盖
        String originalFilename = file.getOriginalFilename();
        //使用UUID类生成随机的名字同时加上文件后缀名
        String fileName = UUID.randomUUID().toString() + originalFilename.substring(originalFilename.lastIndexOf("."));

        //上传文件到 OSS
        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
        ossClient.putObject(bucketName, fileName, inputStream);

        //文件访问路径
        //先从  endpoint中分割出协议部分（如 "https:"），并取第一部分（即协议部分）
        //添加bucket名称
        //再取 endpoint的第二部分
        String url = endpoint.split("//")[0] + "//" + bucketName + "." + endpoint.split("//")[1] + "/" + fileName;
        // 关闭ossClient
        ossClient.shutdown();
        return url;// 把上传到oss的路径返回
    }
}

我们建立一个测试类，在其中调用OSS的工具类

package com.huihui.controller;

import com.aliyun.oss.AliOSSUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;

@RestController
public class ossController {
    @Autowired
    private AliOSSUtils ossUtils;
    @PostMapping("/uploadImage")
    public String uploadOss(MultipartFile image) throws IOException {
        //上传文件到阿里云 OSS

        String url=ossUtils.upload(image);
        return url;
    }
}