本文针对于qiniu的javaSDK使用教程进行编写并测试,仅测试部分功能。
1,因为最近要用到cdn,正好之前注册过七牛,所以研究了一下。
2,使用前提:七牛账户。
3,七牛的开发者中心提供了非常详细的api文档,具体请参考Java SDK使用指南
4,下载相关包qiniu-java-sdk-7、Google Gson 、okhttp (JDK1.7 及以上) 、okio (JDK1.7 及以上)、okhttp-jdk1.6 、okio-jdk1.6(我直接从官网拷过来的链接)
正式开始
一,上传
上传主要分为两步:
- 业务服务器颁发 uptoken(上传授权凭证)给客户端(终端用户)
- 客户端凭借 uptoken 上传文件到七牛
先介绍获取token下面的代码是获取token的一个方法,通过传入相关参数即可获取token。官网上还提供了几种简单的方法,根据需要进行选择,这里我用的是参数最全的一个。
1 /** 2 * 生成上传token 3 * 4 * @param bucket 5 * 空间名 6 * @param key 7 * key,可为 null 8 * @param expires 9 * 有效时长,单位秒。默认3600s 10 * @param policy 11 * 上传策略的其它参数,如 new StringMap().put("endUser", 12 * "uid").putNotEmpty("returnBody", "")。 scope通过 13 * bucket、key间接设置,deadline 通过 expires 间接设置 (此处的设置会影响下面的文件上传时返回的参数) 14 * @param strict 15 * 是否去除非限定的策略字段,默认true 16 * @return 生成的上传token 17 */ 18 public String uploadToken(String bucket, String key, long expires, StringMap policy, boolean strict) { 19 20 return auth.uploadToken(bucket, key, expires, policy, strict); 21 22 }
下面是上传文件
这个是原方法
/** * 上传数据 * * @param data 上传的数据 byte[]、File、filePath * @param key 上传数据保存的文件名 * @param token 上传凭证 * @param params 自定义参数,如 params.put("x:foo", "foo") * @param mime 指定文件mimetype * @param checkCrc 是否验证crc32 * @return 返回参数JSON类型 * @throws QiniuException */ public Response put(XXXX data, String key, String token, StringMap params, String mime, boolean checkCrc) throws QiniuException
使用的话先实例化UploadManager
UploadManager uploadManager = new UploadManager();
然后调用即可,下面是我封装的一个简单的方法
/** * 上传图片 * @param file * @param fileName */ private void upload(File file,String fileName) { try { Response res = uploadManager.put(file, fileName, token); // Map m2 = res.jsonToObject(Map.class); // Map<String, Object> m3 = res.jsonToObject(Map.class); Map<String, Object> m4 = res.jsonToObject(HashMap.class); // StringMap m1 = res.jsonToMap(); System.out.println(m4.get("key")); System.out.println(m4.get("hash")); System.out.println(m4.get("width")); System.out.println(m4.get("height")); System.out.println(res); System.out.println(res.bodyString()); } catch (QiniuException e) { Response r = e.response; // 请求失败时简单状态信息 System.out.println(r.toString()); try { // 响应的文本信息 System.out.println(r.bodyString()); } catch (QiniuException e1) { // ignore } } }
运行后返回的参数为
1448699528661.png //key FtAbKp8pY3gIoEIdsgrMdmiVTuUi //hash 500.0 //width 531.0 //height {ResponseInfo:com.qiniu.http.Response@d86cae,status:200, reqId:giUAAOpSzwWM0BoU, xlog:s.ph;s.put.tw;s.put.tr:1;s.put.tw;s.put.tr:2;s.ph;s.put.tw;s.put.tr:2;s.ph;PFDS:2;PFDS:3;PFDS:4;rs16_8.sel/not found;rs15_8.sel/not found;rdb.g/no such key;DBD/404;v4.get/Document not found;rs16_8.ins;qtbl.ins:2;mc.s;RS:2;rs.put:3;rs-upload.putFile:9;FOPAGENT;IMAGE:2;FOPAGENT:3;FOPAGENT;IMAGE:2;FOPAGENT:3;FOPG:4;FOPAGENT;UP:21, xvia:, adress:up.qiniu.com/101.71.89.200:80, duration:0.000000 s, error:null} //res {"key": "1448699528661.png", "hash": "FtAbKp8pY3gIoEIdsgrMdmiVTuUi", "width": 500, "height": 531} //res.bodyString()
这里的返回参数全是由最前面的putPolicy定义的,我是这样子定义的
private final static StringMap policy = new StringMap().putNotEmpty("returnBody", "{"key": $(key), "hash": $(etag), "width": $(imageInfo.width), "height": $(imageInfo.height)}"); //我是仅用于上传图片才这样定义的
这里有个putPolicy详细介绍
二,文件操作
根据前缀获取空间文件列表,文件名设置为空的话是全部获取
/** * 根据前缀获取文件列表的迭代器 * * @param bucket 空间名 * @param prefix 文件名前缀 * @param limit 每次迭代的长度限制,最大1000,推荐值 100 * @param delimiter 指定目录分隔符,列出所有公共前缀(模拟列出目录效果)。缺省值为空字符串 * @return FileInfo迭代器 */ // BucketManager.FileListIterator it = bucketManager.createFileListIterator(bucket, prefix) public void fileList(String prefix) { BucketManager.FileListIterator it = bm.createFileListIterator(bucket, prefix, 100, null); System.out.println(it.toString()); while (it.hasNext()) { FileInfo[] items = it.next(); System.out.println(items.length); for (int i = 0; i < items.length; i++) { System.out.println(items[i].key+"---"+items[i].hash); } } }
抓取资源
这个功能非常好,而且方法很简单。
//要求url可公网正常访问,不指定 key 时以文件的 hash 值为 key bucketManager.fetch(url, bucket); //要求url可公网正常访问 bucketManager.fetch(url, bucket, key);
三,生成私有空间的文件外链
私有空间才需要这一步
找到链接
我们需要先上找到这个链接,或者去也能找到,但是比较麻烦,不过第二种可以进行校验一会我们生成的url是否正确。
开始构造链接。
//java默认的getTime()是获取的毫秒数,我们需要将其转换成功秒,然后保存时间为5min String time = ""+(new Date().getTime()/1000+5*60); //e指的是过期时间。Unix时间戳 String url = "http://xx.xx.xx.x.clouddn.com/"+fileName+"?e="+time;
对上一步得到的url进行HMAC-SHA1签名,并对结果做URL安全的Base64编码:
进行签名我是参考Java加密技术,进行加密
class HMACSHA1 { private static final String MAC_NAME = "HmacSHA1"; private static final String ENCODING = "UTF-8"; /** * 使用 HMAC-SHA1 签名方法对对encryptText进行签名 * @param encryptText 被签名的字符串 * @param encryptKey 密钥 * @return * @throws Exception */ public String HmacSHA1Encrypt(String encryptText, String encryptKey) throws Exception { byte[] data=encryptKey.getBytes(ENCODING); //根据给定的字节数组构造一个密钥,第二参数指定一个密钥算法的名称 SecretKey secretKey = new SecretKeySpec(data, MAC_NAME); //生成一个指定 Mac 算法 的 Mac 对象 Mac mac = Mac.getInstance(MAC_NAME); //用给定密钥初始化 Mac 对象 mac.init(secretKey); byte[] text = encryptText.getBytes(ENCODING); //完成 Mac 操作 byte[] ft = mac.doFinal(text); //这里的Base64.Default换成Url_safe return Base64.encodeToString(ft, Base64.URL_SAFE); } }
使用
HMACSHA1 h = new HMACSHA1(); String rk = null; try { //这里的sk为七牛给你的secretKey rk = h.HmacSHA1Encrypt(url, SK); } catch (Exception e) { // TODO Auto-generated catch block e.printStackTrace(); }
将AccessKey
与上一步计算得到的结果以“:”连接起来:
//这里的ak为accessKey url = url+"&token="+AK+":"+rk;
这样就生成了生命周期为5分钟的链接。
三,结束
折腾了几个小时测试了部分方法,其实官网给的方法已经非常全面的,我也没有测试全面,只是简单的几个例程。