七牛云模块化文档

前言

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

介绍

七牛云是国内领先的企业级公有云服务商,致力于打造以数据为核心的场景化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,甚至是思维。闲着没事做,封些模块化使用,可以一点点抽离项目服务,其实挺类似 服务提供者 暴露服务的。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,445评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,596评论 18 139
  • 文/静言锋语 图/来自网络 得即高歌失即休,多愁多恨亦悠悠。人生一世不容易,生命里最渴望的,往往事与愿违,感情里最...
    静言锋语阅读 219评论 0 1
  • 大家都热衷于发现外星人,找到外星人,期待他们带来高科技,拯救地球糟糕的环境,可怕的瘟疫,无休止的战争!真的是这样的...
    袋鼠的尾巴阅读 363评论 0 1
  • 一开始的我其实很厌倦 明明不喜欢却还要去选择 可是时间久了 原来发现自己已经爱上了这个东西 分享几个自己的作品 大...
    肆与十四阅读 279评论 7 8