平安云 - 云以致用智造未来

Android SDK

1. 简介 <ul> <li>本文档主要介绍 OBS Android SDK 的接口使用及注意事项；</li> <li>并且假设您已经开通了 OBS 服务，并已是平安公有云用户；</li> <li>如果您还没有开通或者还不了解平安云 OBS 服务，请登录 <a href="/ssr/products/OBS" target="_blank">OBS产品主页</a>进行了解；</li> <li>OBS-Android-SDK 是由平安云团队开发的工具包。便于开发者在 Android 上方便使用平安云当中的 OBS 服务；</li> <li>文档主要罗列了 OBS-Android-SDK 中，上传以及下载的一些基本方法，并对方法参数进行简要解释，且对响应方法有一个详细的说明。</li> </ul> 2. SDK下载 Android SDK 开发包最新版本 <a href="https://pcp-portal-sca.obs-cn-shenzhen.pinganyun.com/sdk%2Fobs-android-sdk-1.2.0.jar?response-content-disposition=attachment%3Bfilename%3Dobs-android-sdk-1.2.0.jar" target="_blank">v1.2.0</a> 3. API概览 <table> <caption> </caption> <thead> <tr> <th> API </th> <th> 描述 </th> </tr> </thead> <tbody> <tr> <td> init </td> <td> 初始化服务 </td> </tr> <tr> <td> uploadFile </td> <td> 上传文件 OBS SDK提供了丰富的文件上传接口，可以通过以下方式上传文件： <ul> <li>文件上传</li> <li>分片上传</li> </ul> </td> </tr> <tr> <td> sliceUploadFile </td> <td> 分片上传文件 </td> </tr> <tr> <td> uploadImageScale </td> <td> 压缩上传图片 </td> </tr> <tr> <td> downloadFile </td> <td> 下载文件 </td> </tr> </tbody> </table> 4. API描述 （1） init 接口描述 初始化服务，在 Application 中初始化： <pre> <code>RequestManager.getInstance().init(this); </code></pre> （2） uploadFile 接口描述 根据文件路径上传 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucket </td> <td> String </td> <td> true </td> <td> 所要上传到指定bucket的名称 </td> <td> - </td> </tr> <tr> <td> fileKey </td> <td> String </td> <td> true </td> <td> 对应bucket里文件的key </td> <td> - </td> </tr> <tr> <td> filePath </td> <td> String </td> <td> true </td> <td> 上传文件路径 </td> <td> - </td> </tr> <tr> <td> config </td> <td> Configuration </td> <td> true </td> <td> 配置上传下载服务器地址 </td> <td> - </td> </tr> <tr> <td> requestListener </td> <td> RequestListener </td> <td> true </td> <td> 请求的回调 </td> <td> - </td> </tr> </tbody> </table> 响应参数 无 （3） uploadFile 接口描述 根据文件上传 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucket </td> <td> String </td> <td> true </td> <td> 所要上传到指定bucket的名称 </td> <td> - </td> </tr> <tr> <td> fileKey </td> <td> String </td> <td> true </td> <td> 对应bucket里文件的key </td> <td> - </td> </tr> <tr> <td> file </td> <td> File </td> <td> true </td> <td> 上传文件对象 </td> <td> - </td> </tr> <tr> <td> config </td> <td> Configuration </td> <td> true </td> <td> 配置上传下载服务器地址 </td> <td> - </td> </tr> <tr> <td> requestListener </td> <td> RequestListener </td> <td> true </td> <td> 请求的回调 </td> <td> - </td> </tr> </tbody> </table> 响应参数 无 （4） sliceUploadFile 接口描述 分片上传文件 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucket </td> <td> String </td> <td> true </td> <td> 所要上传到指定bucket的名称 </td> <td> - </td> </tr> <tr> <td> fileKey </td> <td> String </td> <td> true </td> <td> 对应bucket里文件的key </td> <td> - </td> </tr> <tr> <td> filePath </td> <td> String </td> <td> true </td> <td> 上传文件路径 </td> <td> - </td> </tr> <tr> <td> config </td> <td> Configuration </td> <td> true </td> <td> 配置上传下载服务器地址 </td> <td> 必须设置recorder参数 </td> </tr> <tr> <td> requestListener </td> <td> RequestListener </td> <td> true </td> <td> 请求的回调 </td> <td> - </td> </tr> </tbody> </table> 响应参数 无 （5） uploadImageScale 接口描述 压缩上传图片 请求参数 <table> <caption> </caption> <thead> <tr> <th> 参数名称 </th> <th> 参数类型 </th> <th> 是否必须 </th> <th> 参数描述 </th> <th> 备注 </th> </tr> </thead> <tbody> <tr> <td> bucket </td> <td> String </td> <td> true </td> <td> 所要上传到指定bucket的名称 </td> <td> - </td> </tr> <tr> <td> fileKey </td> <td> String </td> <td> true </td> <td> 对应bucket里文件的key </td> <td> - </td> </tr> <tr> <td> file </td> <td> File </td> <td> true </td> <td> 上传文件路径 </td> <td> - </td> </tr> <tr> <td> config </td> <td> Configuration </td> <td> true </td> <td> 配置上传下载服务器地址 </td> <td> 必须设置recorder参数 </td> </tr> <tr> <td> compress </td> <td> float </td> <td> true </td> <td> 缩小的比例0-1 </td> <td> - </td> </tr> <tr> <td> requestListener </td> <td> RequestListener </td> <td> true </td> <td> 请求的回调 </td> <td> - </td> </tr> </tbody> </table> 响应参数 无 （6）downloadFile 接口描述 下载文件 请求参数 <table> <caption> </caption> <thead> <tr> <th>参数名称</th> <th>参数类型</th> <th>是否必须</th> <th>参数描述</th> <th>备注</th> </tr> </thead> <tbody> <tr> <td> bucket </td> <td> String </td> <td> true </td> <td> 所要上传到指定bucket的名称 </td> <td> - </td> </tr> <tr> <td> fileKey </td> <td> String </td> <td> true </td> <td> 对应bucket里文件的key </td> <td> - </td> </tr> <tr> <td> downloadLocaPath </td> <td> String </td> <td> true </td> <td> 下载到本地的文件夹路径 </td> <td> 以/结尾 </td> </tr> <tr> <td> config </td> <td> Configuration </td> <td> true </td> <td> 配置上传下载服务器地址 </td> <td> - </td> </tr> <tr> <td> fileName </td> <td> String </td> <td> true </td> <td> 下载后展示的文件名 </td> <td> - </td> </tr> <tr> <td> requestListener </td> <td> RequestListener </td> <td> true </td> <td> 请求的回调 </td> <td> - </td> </tr> </tbody> </table> 响应参数 <table> <caption> </caption> <thead> <tr> <th>参数名称</th> <th>参数类型</th> <th>参数描述</th> <th>备注</th> </tr> </thead> <tbody> <tr> <td> / </td> <td> String </td> <td> sdk请求Id </td> <td> 可作为取消cancel下载的入参 </td> </tr> </tbody> </table> 5.其他说明 （1）设置https <pre> Configuration config = new Configuration.Builder().***.useHttps(true).***.build();</pre> （2）取消请求 <pre> RequestManager.getInstance().cancel(NET_TAG);</pre> 说明：每一个请求会返回一个唯一的tag。 （3）签名回调 <pre> config.setSignerCredentialProvider(new SignerCredentialProvider() { @Override public String signContent(String content) { //signContent中的content的数据是由“\n”分割的参数： String[] params = content.split(“\n”); //访问后端签名服务(建议采用POST提交，所有参数都放在Body，避免对部分参数进行url编码)，返回完整的authorization（AWS AK:token），如：AWS NEM3NEE************jA2NTE3M0I0RjY:Zy3ewmKyDQyQoQLc+ssoxoPKqaE= return authorization; } </pre> 入参content各元素含义： <ul> <li>params[0]; POST/GET……，Http method</li> <li>params[1]; Bucket，桶名称</li> <li>params[2]; key，文件在OBS唯一标识</li> <li>params[3]; content-type，文件类型</li> <li>params[4]; date，请求产生时间(GMT格式，如：Fri, 15 May 2020 06:20:34 GMT)</li> <li>params[5]; uri，一般为/{bucket}/{key}(普通上传、下载等接口uri)或者/mkblk/{bucket}/{key:.*}/{blockIndex}(分片上传接口，分片上传另外还有bput、mkfile等接口)</li> </ul> 后端签名服务实现 （1） JAVA SDK方式 请参见<a href="/ssr/help/storage/obs/OBS_SDK_.creatsign" target="_blank">生成签名</a>。 （2）自行实现签名算法 请参见<a href="/ssr/help/storage/obs/api.Introduction" target="_blank">签名生成规则</a>。

以上内容是否解决了您的问题？是否