Android Oss 上傳圖片的使用
code小生,一個 Android 領域技術分享平臺
作者:喵主子的陽光
連結:https://www.jianshu.com/p/e6da7c5841cf
宣告:本文是 喵主子的陽光 原創,轉發等請聯絡原作者授權。
前言
前一陣專案中的上傳圖片改為上傳到阿里上,記錄一下實現的過程,方便以後檢視。
參考資料:官方文件
https://link.jianshu.com/?t=https%3A%2F%2Fhelp.aliyun.com%2Fdocument_detail%2F32047.html%3Fspm%3D5176.doc32047.6.699.0vOwsi
配置
Android studio新增依賴
dependencies {
compile 'com.aliyun.dpa:oss-android-sdk:2.4.5'
compile 'com.squareup.okhttp3:okhttp:3.4.1'
compile 'com.squareup.okio:okio:1.9.0'
}
直接引入jar包(對Android studio 或者 Eclipse 都適用)
1.在官網下載 sdk 包
2.解壓後得到 jar 包,目前包括 aliyun-oss-sdk-android-x.x.x.jar、okhttp-3.x.x.jar 和 okio-1.x.x.jar
3.將以上 3 個 jar 包匯入 libs 目錄
許可權設定
確保 AndroidManifest.xml 檔案中已經配置了這些許可權,否則,SDK 將無法正常工作。
<uses-permission android:name="android.permission.INTERNET"></uses-permission>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"></uses-permission>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"></uses-permission>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"></uses-permission>
混淆設定
-keep class com.alibaba.sdk.android.oss.** { *; }
-dontwarn okio.**
-dontwarn org.apache.commons.codec.binary.**
實現過程
首先為了安全起見,採用的是STS鑑權模式,則要用到的資料都是從後臺獲得然後應用到前臺的。
1.建立OSSClient (自己在這裡命名為OssService)
OSSClient為OSS 服務的 Android 客戶端,它為呼叫者提供了一系列的方法,可以用來操作,管理儲存空間(bucket)和檔案(object)等。
public class OssService {
private OSS oss;
private String bucket;
private picResultCallback callback;//回撥介面
private String path=地址(後臺告訴);
public OssService(OSS oss, String bucket,picResultCallback callback) {
this.oss = oss;
this.bucket = bucket;
this.callback=callback;
}
/**object欄位為圖片的上傳地址(具體地址的字首後端給,這個是拼起
*來的一個路徑)
*localFile圖片的本地地址
*mProgress 進度條
*img 顯示圖片的控制元件
*type 型別
*/
public void asyncPutImage(String object, final String localFile, final ProgressBar mProgress, final ImageView img,String type) {
if (object.equals("")) {
Log.w("AsyncPutImage", "ObjectNull");
return;
}
File file = new File(localFile);
if (!file.exists()) {
Log.w("AsyncPutImage", "FileNotExist");
Log.w("LocalFile", localFile);
return;
}
// 構造上傳請求
PutObjectRequest put = new PutObjectRequest(bucket, object, localFile);
put.setCallbackParam(new HashMap<String, String>() {
{
put("callbackUrl", path);
put("callbackBody", "filename=${object}&size=${size}&id=${x:id}&action=${x:action}");
//https://help.aliyun.com/document_detail/31989.html?spm=5176.doc31984.6.883.brskVg
}
});
HashMap<String, String> hashMap=new HashMap<>();
hashMap.put("x:id",id);
hashMap.put("x:action",type);
put.setCallbackVars(hashMap);
// 非同步上傳時可以設定進度回撥
put.setProgressCallback(new OSSProgressCallback<PutObjectRequest>() {
@Override
public void onProgress(PutObjectRequest request, long currentSize, long totalSize) {
int progress = (int) (100 * currentSize / totalSize);
mProgress.setProgress(progress);
}
});
OSSAsyncTask task = oss.asyncPutObject(put, new OSSCompletedCallback<PutObjectRequest, PutObjectResult>() {
@Override
public void onSuccess(PutObjectRequest request, final PutObjectResult result) {
Observable.just(result).observeOn(AndroidSchedulers.mainThread()).subscribe(new Action1<PutObjectResult>() {
@Override
public void call(PutObjectResult putObjectResult) {
mProgress.setVisibility(View.GONE);
img.setColorFilter(null);
callback.getPicData(result,localFile);
}
});
}
@Override
public void onFailure(PutObjectRequest request, ClientException clientExcepion, ServiceException serviceException) {
String info = "";
// 請求異常
if (clientExcepion != null) {
// 本地異常如網路異常等
clientExcepion.printStackTrace();
info = clientExcepion.toString();
}
if (serviceException != null) {
// 服務異常
Log.e("ErrorCode", serviceException.getErrorCode());
Log.e("RequestId", serviceException.getRequestId());
Log.e("HostId", serviceException.getHostId());
Log.e("RawMessage", serviceException.getRawMessage());
info = serviceException.toString();
}
}
});
}
//成功的回撥介面
public interface picResultCallback {
void getPicData(PutObjectResult data,String oldPath);
}
}
2.實現OssService的方法(在activity中)
public OssService initOSS(String endpoint, String bucket) {
OSSCredentialProvider credentialProvider;
credentialProvider = new STSGetter(tokenBean);
//設定網路引數
ClientConfiguration conf = new ClientConfiguration();
conf.setConnectionTimeout(15 * 1000); // 連線超時,預設15秒
conf.setSocketTimeout(15 * 1000); // socket超時,預設15秒
conf.setMaxConcurrentRequest(5); // 最大併發請求書,預設5個
conf.setMaxErrorRetry(2); // 失敗後最大重試次數,預設2次
OSS oss = new OSSClient(getApplicationContext(), endpoint, credentialProvider, conf);
return new OssService(oss, bucket, this);
}
3.過載 OSSFederationCredentialProvider 生成自己的獲取 STS 的功能(一般自動獲得 token 寫在這裡,在 getFederationToken() 方法中,告訴它你獲得token 的規則即可)
1>官方demo程式碼(自動更新token)
public class OSSAuthCredentialsProvider extends OSSFederationCredentialProvider {
private String mAuthServerUrl;
private AuthDecoder mDecoder;
public OSSAuthCredentialsProvider(String authServerUrl) {
this.mAuthServerUrl = authServerUrl;
}
/**
* set auth server url
* @param authServerUrl
*/
public void setAuthServerUrl(String authServerUrl) {
this.mAuthServerUrl = authServerUrl;
}
/**
* set response data decoder
* @param decoder
*/
public void setDecoder(AuthDecoder decoder) {
this.mDecoder = decoder;
}
@Override
public OSSFederationToken getFederationToken() throws ClientException {
OSSFederationToken authToken;
String authData;
try {
URL stsUrl = new URL(mAuthServerUrl);
HttpURLConnection conn = (HttpURLConnection) stsUrl.openConnection();
conn.setConnectTimeout(10000);
InputStream input = conn.getInputStream();
authData = IOUtils.readStreamAsString(input, OSSConstants.DEFAULT_CHARSET_NAME);
if (mDecoder != null) {
authData = mDecoder.decode(authData);
}
JSONObject jsonObj = new JSONObject(authData);
int statusCode = jsonObj.getInt("StatusCode");
if (statusCode == 200) {
String ak = jsonObj.getString("AccessKeyId");
String sk = jsonObj.getString("AccessKeySecret");
String token = jsonObj.getString("SecurityToken");
String expiration = jsonObj.getString("Expiration");
authToken = new OSSFederationToken(ak, sk, token, expiration);
} else {
String errorCode = jsonObj.getString("ErrorCode");
String errorMessage = jsonObj.getString("ErrorMessage");
throw new ClientException("ErrorCode: " + errorCode + "| ErrorMessage: " + errorMessage);
}
return authToken;
} catch (Exception e) {
throw new ClientException(e);
}
}
public interface AuthDecoder {
String decode(String data);
}
}
2>自己的程式碼(因為自己的所有資料都是從後臺獲得的,而且結合rxjava沒有想到可以返回資料的方式,所以採用手動更新token的方式)
手動更新token的具體操作:
首先token的值存在MyApp中,第一次在進入需要用到token介面時候,先獲得token的值更新MyApp中的值並記錄當下的時間,如果下次再次進入任何一個需要用到token的介面的時候,則判斷時間是否過期,過期則重新請求token更新token的值。
public class STSGetter extends OSSFederationCredentialProvider {
private OSSFederationToken ossFederationToken;
String ak;
String sk;
String token ;
String expiration ;
public STSGetter(TokenBean bean) {
this.ak = bean.getCredentials().getAccessKeyId();
this.sk = bean.getCredentials().getAccessKeySecret();
this.token = bean.getCredentials().getSecurityToken();
this.expiration = bean.getCredentials().getExpiration();
}
public OSSFederationToken getFederationToken() {
return new OSSFederationToken(ak,sk,token,expiration);
}
}
4.例項化 OSSClient,呼叫上傳圖片方法
//例項化OSSClient (自己是在onCreate()中例項化的,當然考慮到token的過期問題,也有在onResume()中再次例項化一次)
ossService = initOSS(tokenBean.getBucket().getEndPoint(), tokenBean.getBucket().getBucketName());
//上傳圖片,需要根據自己的邏輯傳引數
ossService.asyncPutImage(圖片在阿里上的儲存路徑, 本地路徑, ...);
5.回撥處理圖片邏輯
/**
* 對圖片上傳回來的資料進行處理
* @param data
*/
@Override
public void getPicData(PutObjectResult data, String oldPath) {
Gson gson = new Gson();
OssUploadImage uploadImage = gson.fromJson(data.getServerCallbackReturnBody(), OssUploadImage.class);
........邏輯自己寫吧
}
~~喵印