Android(安卓)Oss上传文件简单使用
16lz
2021-01-25
一、oos简介
阿里云对象存储服务（Object Storage Service，简称 OSS），是阿里云提供的海量、安全、低成本、高可靠的云存储服务。
官网文档地址 ：https://help.aliyun.com/document_detail/31883.html?spm=a2c4g.11186623.6.560.71c865d307nMqB
Android的SDK使用的github地址：https://github.com/aliyun/aliyun-oss-android-sdk
二 、使用
1 依赖
在AS中build中添加依赖，代码如下：
compile 'com.aliyun.dpa:oss-android-sdk:+'compile 'com.squareup.okhttp3:okhttp:3.4.1'compile 'com.squareup.okio:okio:1.9.0'引入okhttp 以及okio，是因为，利用oss上传文件利用的okttp，所以必须依赖 ，只有build一下，尝试是否可以导入关于oss的API
本人在使用时无build之后无法导入oss的API，之后就直接导入了他的jar包，关于jar的编译在github上有说明，或者直接去找下载也可，然后导入到lib之后依赖即可。
2 AndroidManifest权限配置
3 混淆设置
-keep class com.alibaba.sdk.android.oss.** { *; }-dontwarn okio.**-dontwarn org.apache.commons.codec.binary.**
4 原理介绍
上面的图直接用的官网的介绍图，如果是首次一定得看清楚上面的图，从移动端开始，角色分析如下：
- 1 移动端向应服务器请求STS凭证（为了安全）
- 2 服务器向oss端请求所需的凭证
- 3 oss将STS凭证返回应用服务器
- 4 应用服务器将STS返回给移动端
- 5 移动端使用STS进行文件上传
- 6 OSS将上传结果返回给移动端
注意 ： 过程5移动端上传的时候可以设置给应用服务器的回调地址和自定义参数，这样移动端上传到oss之后，会上传结果发到到应用服务器，服务器同时可以设置移动应用所需要的数据，在oss上传成功的回调中传给移动应用
具体代码如下，在代码中看具体逻辑：
/** * 步骤1 首先创建对象 * 2 调用initOss 初始化oss 相关 * 3 上传文件 * 视频上传到Oss的流程 本地请求服务器获取accessKeyId，accessKeySecret，securityToken --->上传文件到OSS服务器的同时 * 并设置本司服务器的回调地址 * ---> 上传成功后oss会根据之前设置的回调通知本司服务器 本地也会收到关于oss的上传回调 * * STS 鉴权服务器地址，使用前请参照文档 https://help.aliyun.com/document_detail/31920.html */public class AliYunOssUploadOrDownFileConfig { private static final String TAG = AliYunOssUploadOrDownFileConfig.class.getSimpleName(); private static AliYunOssUploadOrDownFileConfig aliyunOssUploadFileUtil; /** * 服务器的地址 */ private static final String ENDPOINT = "http://oss-cn-beijing.aliyuncs.com"; private ClientConfiguration conf = null; private OSS oss = null; private PutObjectRequest put = null; private OSSAsyncTask task = null; private OnUploadFile onUploadFile; public static final String CALLBACK_URL = "callbackUrl"; public static final String CALLBACK_BODY = "callbackBody"; /** * callback 的回调地址 eg : "http://oss-demo.aliyuncs.com:23450"; * 通过这个地址oss可以将所需要的数据传到应用服务器，服务器就可以根据上传的参数为所欲为了 */ private String mCallbackAddress = "http://oss-demo.aliyuncs.com:23450"; private Context mContext; private AliYunOssUploadOrDownFileConfig(Context context){ this.mContext = context; } public static AliYunOssUploadOrDownFileConfig getInstance(Context context) { if(aliyunOssUploadFileUtil == null) { synchronized (AliYunOssUploadOrDownFileConfig.class) { if(aliyunOssUploadFileUtil == null) { aliyunOssUploadFileUtil = new AliYunOssUploadOrDownFileConfig(context); } } } return aliyunOssUploadFileUtil; } /** * 调用这个方法之前必须先设置accessKeyId，accessKeySecret，securityToken; */ public void initOss( String accessKeyId, String accessKeySecret, String securityToken){ conf = new ClientConfiguration(); conf.setConnectionTimeout(5*60*1000); conf.setSocketTimeout(5*60*1000); conf.setMaxConcurrentRequest(5); conf.setMaxErrorRetry(2); OSSLog.enableLog(); //请求后台服务器返回 // "StatusCode":200, // "AccessKeyId":"STS.3p***dgagdasdg", // "AccessKeySecret":"rpnwO9***tGdrddgsR2YrTtI", // "SecurityToken":"CAES+wMIARKAAZhjH0EUOIhJMQBMjRywXq7MQ/cjLYg80Aho1ek0Jm63XMhr9Oc5s˙∂˙∂3qaPer8p1YaX1NTDiCFZWFkvlHf1pQhuxfKBc+mRR9KAbHUefqH+rdjZqjTF7p2m1wJXP8S6k+G2MpHrUe6TYBkJ43GhhTVFMuM3BZajY3VjZWOXBIODRIR1FKZjIiEjMzMzE0MjY0NzM5MTE4NjkxMSoLY2xpZGSSDgSDGAGESGTETqOio6c2RrLWRlbW8vKgoUYWNzOm9zczoqOio6c2RrLWRlbW9KEDExNDg5MzAxMDcyNDY4MThSBTI2ODQyWg9Bc3N1bWVkUm9sZVVzZXJgAGoSMzMzMTQyNjQ3MzkxMTg2OTExcglzZGstZGVtbzI=", // "Expiration":"2017-12-12T07:49:09Z", OSSCredentialProvider credentialProvider = new OSSStsTokenCredentialProvider( accessKeyId, accessKeySecret, securityToken ); oss = new OSSClient(mContext,ENDPOINT,credentialProvider,conf); } /** * 上传文件 * @param bucketName oss上所建的仓库名称 eg : smartDev 如果设置的合理，将会报错，oss会提示说设置的bucketName不可用 * @param objectKey oss上所存储文件的名称 eg: vic/test/xxx.mp4 * @param uploadFilePath 本地存储文件的路径 */ public void uploadFile(String bucketName, String objectKey, String uploadFilePath, final String filename, final int reminderId){ put = new PutObjectRequest( bucketName, objectKey, uploadFilePath); ObjectMetadata metadata = new ObjectMetadata(); metadata.setContentType("application/octet-stream"); put.setMetadata(metadata); put.setCRC64(OSSRequest.CRC64Config.YES); if(!TextUtils.isEmpty(mCallbackAddress)) { put.setCallbackParam(new HashMap() { { //这里 filename 中的object 不用替换，如果到oss了，object 将自动在服务器自动被上传文件名替换 并且是全路径名称 put(CALLBACK_URL,mCallbackAddress);put(CALLBACK_BODY,"filename=${object}"+ "&reminder_id=${x:" + reminderId + "}");// put(CALLBACK_BODY,"filename=${object}"); } }); } put.setProgressCallback(new OSSProgressCallback() { @Override public void onProgress(PutObjectRequest request, long currentSize, long totalSize) { Log.d(TAG, "currentSize: " + currentSize + " totalSize: " + totalSize); } }); task = oss.asyncPutObject(put, new OSSCompletedCallback() { @Override public void onSuccess(PutObjectRequest request, PutObjectResult result) { Log.d(TAG,"uploadSuccess"); if(onUploadFile != null) { onUploadFile.onUploadFileSuccess("上传成功"); } } @Override public void onFailure(PutObjectRequest request, ClientException clientException, ServiceException serviceException) { if(onUploadFile != null) { try{ if(serviceException != null) { onUploadFile.onUploadFileFailed(serviceException.toString()); } else { onUploadFile.onUploadFileFailed("上传失败"); } }catch (Exception e) { onUploadFile.onUploadFileFailed("上传失败"); } } // Request exception if (clientException != null) { // Local exception, such as a network exception clientException.printStackTrace(); } if (serviceException != null) { // Service exception Log.d(TAG,"ErrorCode="+ serviceException.getErrorCode()); Log.d(TAG,"RequestId=" + serviceException.getRequestId()); Log.d(TAG,"HostId=" + serviceException.getHostId()); Log.d(TAG,"RawMessage=" + serviceException.getRawMessage()); } } // task.cancel(); // Cancel the task // task.waitUntilFinished(); // Wait till the task is finished }); } public void setOnUploadFile(OnUploadFile onUploadFile) { this.onUploadFile = onUploadFile; } public interface OnUploadFile { void onUploadFileSuccess(String info); void onUploadFileFailed(String errCode); }} 以上就是移动应用上传文件的一些大概逻辑了，注意：
移动端所需服务端提的参数 STS凭证的三个参数 accessKeyId，accessKeySecret，securityToken
所用的oss服务器的地址endPoint，bucketName oss上的名称，objectKey oss上所存储文件的名称 eg: vic/test/xxx.mp4 前半段由服务器提供，最好在请求STS的时候返回给移动端（这样后期服务器迁移也不会出现问题，），后一部分xxx 文件名自行解决，但是要保证文件名称唯一，查找使用， uploadFilePath 本地存储文件的路径
总结
使用oss传输文件，效率高，成本低，使用和其他的三方SDK一样，必须仔细阅读文档，然后阅读官方提供的sample，基本能保证顺利完成
更多相关文章
- 万字长文带你了解最常用的开源 Squid 代理服务器
- Nginx系列教程（一）| 手把手教你在Linux环境下搭建Nginx服务
- Nginx系列教程（三）| 一文带你读懂Nginx的负载均衡
- GitHub优秀的Android(安卓)开源项目（一)
- 简单的 Android(安卓)拍照并显示以及获取路径后上传
- android实现选择图片并压缩上传的功能
- Android(安卓)Studio中设置ButterKnife、android butterknife ze
- S5PV210 Android(安卓)DM9000驱动
- Android(安卓)Crash 报告反馈