七牛云模块化文档

前言

闲来无事，搭建了个人私仓来放模块化项目，以便项目引入直接使用。关键是，模块化可以根据项目所需进行版本迭代，每一次的使用都是完善的根基，效果贼棒。

介绍

七牛云是国内领先的企业级公有云服务商，致力于打造以数据为核心的场景化PaaS服务。围绕富媒体场景，七牛先后推出了对象存储，融合CDN加速，数据通用处理，内容反垃圾服务，以及直播云服务等。

而此次推出的模块化，目的是为了满足项目存储图片的需求，才有了此番封模块化的构思。

话不多说...进入主题吧！

模块化说明文档

一、上传交互方式(两种)

前端上传(推荐方式)

客户端在上传资源到七牛云前，要先从业务服务器获取一个有效的上传凭证Token，即请求相应项目的七牛云接口拿到Token，
接着使用Token调用前端上传七牛云的api，上传文件至七牛云，返回数据(得到图片URl，即可传给后台存储)。

PS：如果有设置回调，则上传完成时七牛云存储会自动发起回调到指定的业务服务器。

后台上传

单图上传 & 多图上传

老规矩，后台项目会依赖七牛云模块，前端需请求相应后台接口，参数传File文件(当多图片时为数组)，后台将会直接上传文件至七牛云，并存储至数据库。

二、配置需知

一般不变配置：accessKey，secretKey
可变配置：bucket，key，expires，policy，strict

三、返回token情况分析

1.提供空间名bucket，其余默认

String getToken(String bucket)

2. 提供空间名bucket，上传指定key，其余默认

String getToken(String bucket, String key)

3. 提供空间名bucket，上传指定key，有效时长expires，上传策略policy（详见官方SDK上传策略）

String getToken(String bucket, String key, long expires, StringMap policy)

4. 提供空间名bucket，上传指定key，有效时长expires，上传策略policy，是否去除非限定的策略字段strict

String getToken(String bucket, String key, long expires, StringMap policy, boolean strict)

注：
后期将会迭代部分
七牛模块化会添加多种动态配置参数获取token，因此，暂时是默认参数获取token，不过，足够使用了。

模块化使用文档

Maven依赖七牛云

pom.xml

<dependency>
    <artifactId>qiniu</artifactId>
    <groupId>com.yuan.module</groupId>
    <version>1.0.0</version>
</dependency>

注：随着七牛模块的迭代，version会不同，但我会实时更新文档，并注上各版本的迭代内容~~~

配置文件

application.yml

覆盖accessKey，secretKey，linkAddress，bucket。

按如下配置格式配置，填充相关信息即可。

joryun:
  module:
    qiniu:
      bucket: xxx
      access-key: xxx
      secret-key: xxx
      link-address: xxx

注意

linkAddress为默认外链域名，项目需要配置，否则无法访问。(不同的bucket对应的外链也不同)
务必要覆盖如上配置，否则上传的图片资源，将会存在博主的七牛云上
坑点：bucket的创建需注意，可能会存在区域的问题，一般广东用户可选择创建“华南”地区
温馨提示：以上配置中，joryun 是博主的英文名，最好是copy到项目，免得拼错

API（接口调用）

前端上传（推荐方式）

返回Token给前端

http://server_name:port/api/module/qiniu/token

调用前端与七牛交互的API，带着Token凭证上传

后端上传（推荐方式）

单图上传

http://server_name:port/api/module/qiniu/one

Param：MultipartFile file （单个file）

多图上传

http://server_name:port/api/module/qiniu/many

Param：MultipartFile[] files （file数组）

后端文件上传，流方式

http://server_name:port/api/module/qiniu/stream

后端文件上传，字节方式

http://server_name:port/api/module/qiniu/byte

拓展小知识

说明：
项目中有引用 swagger 依赖的，在前后端分离的架构里，可能在七牛模块化的使用成本上比较高。问题在于，后台引入了模块化，但swagger文档里并无出现此接口，那就会加大时间上的沟通成本以及使用成本，实为不利。

小技巧：
博主的七牛模块化已引入了 swagger 依赖，为了减少前后端开发人员使用成本，可进行如下配置，即可在 swagger 文档看到此接口。

@Bean
    public Docket swaggerSpringMvcPlugin() {
        Parameter parameter = new ParameterBuilder()
                .name("Authorization")
                .description("token")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .defaultValue("token ")
                .build();
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .globalOperationParameters(Collections.singletonList(parameter))
                .select()
                .apis(withClassAnnotation(Api.class))
                .paths(paths())
                .build();
    }

主要是这一句配置：

.apis(withClassAnnotation(Api.class))

解析：

每个Controller都会加上如下注解，因此可由传统的包扫描更改为注解扫描，于是便出现了七牛模块化的接口文档！

@Api(tags = "xxx")

总结

个人的项目里，七牛模块化已基本足够使用了。
按上面提供的使用文档引入模块化，可以很方便地存储图片（为什么一直说存储图片呢...因为做了好多项目，大多是存储图片需要）。
好了，功能完善的项目并非一日功夫，需要时间一步步完善，但模块化绝对是很好的一个idea，甚至是思维。闲着没事做，封些模块化使用，可以一点点抽离项目服务，其实挺类似 服务提供者 暴露服务的。