OSS服务架构 oss模块

经过一番纠结，最后决定，项目所有的文件资源还是单独放阿里云的oss上比较好，以下是这个文件系统的微服务模块搭建过程。

---

0x01.OSS概述

• 全称阿里云对象存储OSS
• 阿里云oss其实就是阿里云提供的类型云盘的服务，收费也还算合理，一般小项目使用简直香的不行啊，哈哈哈~
• 由于是阿里的产品，不管是技术上，还是服务上，体验都非常良好。
• 具体前往：https://www.aliyun.com/product/oss

0x02.OSS的基础使用

• 首先你需要在上面那个链接里开通阿里云oss，开通不收费，你具体创建了Bucket并使用了才会收费。

• 在控制台中创建一个Bucket，你可以把它理解为一个oss的实例。

• 存储类型来说，一般项目中的文件资源可能都需要使用标准类型，意思就是经常读取的，收费略高一点。
• 读写权限，看文件的敏感程度，一般的头像啥的，就使用公共读就可以了。
• Bucket创建好后，就可以看到你的文件管理页面了。

• 在这里面如果你的文件处于公共读状态，那么你就可以根据提供的url来直接下载你的文件了。
• 可视化操作还是很友好的，不过我们肯定不是使用可视化来进行相关操作的。

0x03.后台使用OSS的四个重要参数

如果想在项目中使用OSS，需要提供要访问的Bucket的四个参数，分别是：

• endpoint：终端地址 在Bucket实例的概览里面可以看到。
• bucketname：Bucket名称 你的Bucket的全称。
• keyid，keysecret：身份验证的密钥 在控制台的主页可以看到入口，

0x04.OSS微服务模块的搭建

1.环境搭建

• 该模块是我项目中service模块里面的子模块。父模块中已确保SpringBoot的所有环境。

2.依赖导入

• 需要导入OSS的依赖，由于父工程已做了依赖版本控制，所以这里没有写上具体的版本。
• 由于实际中对文件的分类需要使用到一个日期的工具依赖，所以一并导入。

<dependencies>
        <!-- 阿里云oss依赖 -->
        <dependency>
            <groupId>com.aliyun.oss</groupId>
            <artifactId>aliyun-sdk-oss</artifactId>
        </dependency>

        <!-- 日期工具栏依赖 -->
        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
        </dependency>
    </dependencies>

3.配置文件编写

• 编写application.properties配置文件，将关键参数填上.

#服务端口
server.port=8002
#服务名
spring.application.name=service-oss

#环境设置：dev、test、prod
spring.profiles.active=dev

#阿里云 OSS
#不同的服务器，地址不同
aliyun.oss.file.endpoint=
aliyun.oss.file.keyid=
aliyun.oss.file.keysecret=
#bucket可以在控制台创建，也可以使用java代码创建
aliyun.oss.file.bucketname=

4.创建一个工具类从配置文件读取常量参数

• ConstantPropertiesUtils 工具类。
• 注意包不要导错。

import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;


//当项目已启动，spring接口，spring加载之后，执行接口一个方法
@Component
public class ConstantPropertiesUtils implements InitializingBean {

    //读取配置文件内容
    @Value("${aliyun.oss.file.endpoint}")
    private String endpoint;

    @Value("${aliyun.oss.file.keyid}")
    private String keyId;

    @Value("${aliyun.oss.file.keysecret}")
    private String keySecret;

    @Value("${aliyun.oss.file.bucketname}")
    private String bucketName;

    //定义公开静态常量
    public static String END_POIND;
    public static String ACCESS_KEY_ID;
    public static String ACCESS_KEY_SECRET;
    public static String BUCKET_NAME;

    public ConstantPropertiesUtils() {
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        END_POIND = endpoint;
        ACCESS_KEY_ID = keyId;
        ACCESS_KEY_SECRET = keySecret;
        BUCKET_NAME = bucketName;
    }
}

5.创建启动类

• 先把启动类OssApplication创建好。
• 细节：手动避免springboot对数据源的自动配置，不然启动会报错。

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
@ComponentScan(basePackages = {"com.gfbbs"})
public class OssApplication {

    public static void main(String[] args) {
        SpringApplication.run(OssApplication.class, args);
    }
}

6.service编写（核心代码处）

• 创建接口OssService。提供一个上传普通文件的方法，参数是MultipartFile的文件流。

public interface OssService {
    //上传普通文件方法
    String uploadFileAvatar(MultipartFile file);
}

• 实现该接口：OssServiceImpl。

import org.joda.time.DateTime;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;

import java.io.InputStream;

import java.util.UUID;

@Service
public class OssServiceImpl implements OssService {

    //上传普通文件的方法
    @Override
    public String uploadFileAvatar(MultipartFile file) {
        // 工具类获取值
        String endpoint = ConstantPropertiesUtils.END_POIND;
        String accessKeyId = ConstantPropertiesUtils.ACCESS_KEY_ID;
        String accessKeySecret = ConstantPropertiesUtils.ACCESS_KEY_SECRET;
        String bucketName = ConstantPropertiesUtils.BUCKET_NAME;

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

            //获取上传文件输入流
            InputStream inputStream = file.getInputStream();
            //获取文件名称
            String fileName = file.getOriginalFilename();

            //1 在文件名称里面添加随机唯一的值
            String uuid = UUID.randomUUID().toString().replaceAll("-","");
            fileName = uuid+fileName;

            //2 把文件按照日期进行分类
            //获取当前日期
            String datePath = new DateTime().toString("yyyy/MM/dd");
            //拼接
            fileName = datePath+"/"+fileName;

            //调用oss方法实现上传
            //第一个参数  Bucket名称
            //第二个参数  上传到oss文件路径和文件名称   
            //第三个参数  上传文件输入流
            ossClient.putObject(bucketName,fileName , inputStream);

            // 关闭OSSClient。
            ossClient.shutdown();

            //把上传之后文件路径返回
            //需要把上传到阿里云oss路径手动拼接出来
            String url = "https://"+bucketName+"."+endpoint+"/"+fileName;
            return url;
        }catch(Exception e) {
            e.printStackTrace();
            return null;
        }
    }
}

• 代码整体思路：

• 1.使用写好的工具类获取配置文件中的常量。
• 2.通过这些常量创建一个OSS的实例。
• 3.获取文件输入流。
• 4.获取文件名，文件名中添加uuid值。
• 5.把文件按照日期进行分类。
• 6.调用oss方法实现上传。
• 7.关闭OSSClient。
• 8.拼接得到文件的url，并以String方式返回。

• 细节部分：

• 1.整个代码涉及了文件的读取，需要捕获异常。
• 2.如果文件名相同会被覆盖，最好的办法就是在文件名中加入唯一的uuid值。
• 3.将文件按照日期时间来进行分类是一个不错的选择。
• 4.切记要关闭OSSClient。
• 5.拼接的url中使用http或者https都可以，因为阿里云对https做了支持。

7.controller的编写

• 编写OssController。

import com.gfbbs.commonutils.R;
import com.gfbbs.oss.service.OssService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

@RestController
@RequestMapping("/eduoss/fileoss")
@CrossOrigin
public class OssController {

    @Autowired
    private OssService ossService;

    //上传头像的方法
    @PostMapping
    public R uploadOssFile(MultipartFile file) {
        //获取上传文件  MultipartFile
        //返回上传到oss的路径
        String url = ossService.uploadFileAvatar(file);
        return R.ok().data("url",url);
    }
}

• 注意：

• 1.R是我全局定义的json返回形式，直接返回其它也是可以的。
• 2.post请求，参数需要指定为MultipartFile文件流 。
• 3.对跨域做支持。

8.启动微服务，进行测试

• 启动后，打开http://localhost:8002/swagger-ui.html查看api进行测试。（已提前集成了swagger2）
• 选择测试文件上传。

• 测试成功！

9.其它处理

• 作为一个要上线的微服务模块的话，肯定还需要其它处理，比如异常，日志之类的。因为与其它模块关联较大，就没有在这给出完整代码了。比如空文件给出提示，对文件格式的限制（防止恶意文件被上传），文件大小的限制，对有异常的相关ip进行日志记录等，这些都是一个后台开发者需要具备的安全意识！

---