Android SMSSDK非Gradle整合教程

皮皮醬發表於2019-01-08

一、說明

(1)3.x與之前的舊版本互不相容,請嚴格按照本文件進行3.x的首次整合或老版本的升級操作。

(2)3.x之前版本的整合,請參考:http://wiki.mob.com/android-%e7%9f%ad%e4%bf%a1sdk%e9%9b%86%e6%88%90%e6%96%87%e6%a1%a3/

–>整合之前先要申請Mob的appkey與appsecret;申請完新增簡訊SDK的產品;得到key我們開始整合;

二、獲取SDK

請至Mob官網下載最新SDK,解壓後會看到以下目錄結構:

Android SMSSDK非Gradle整合教程

SMSSDK下存放的是簡訊SDK的全部內容。

三、匯入SDK

1.Eclipse

Eclipse版本的SMSSDK目錄下包含兩個工程:

Android SMSSDK非Gradle整合教程

SMSSDK:簡訊SDK核心庫(必須)

ShortMessageSDKGUI:我們提供的開源GUI庫(非必須)

如果你不想定製自己的UI,可以直接使用我們提供的ShortMessageSDKGUI,否則,不需要匯入ShortMessageSDKGUI。接下來,我們以使用ShortMessageSDKGUI為例說明。

1.1、首先將上述兩個工程匯入Eclipse:

Android SMSSDK非Gradle整合教程

1.2、將上述兩個工程掛接到你的工程上:

右鍵你的工程 → Properties → Android

Android SMSSDK非Gradle整合教程

同時將SMSSDK掛接到ShortMessageSDKGUI上:

Android SMSSDK非Gradle整合教程

注意:如果你不需要使用ShortMessageSDKGUI,請直接將SMSSDK掛接到你的專案上。

2.Android Studio

從3.1.0版本開始,不再提供獨立的Android Studio版本下載,推薦AS版開發者按照最新的maven整合方式進行線上下載安裝。

AS版本的SMSSDK目錄下包含以下內容:

Android SMSSDK非Gradle整合教程

MobCommons.jar:Mob 通用公共庫(必須)

MobTools.jar:Mob 工具公共庫(必須)

SMSSDK-<version>.aar:SMSSDK 核心(必須)

SMSSDKGUI-<version>.aar:SMSSDK GUI 開源庫(非必須)

HowToUse.txt:使用說明

注意:如果你同時使用ShareSDK,保留一份公共庫就行(公共庫版本一致或相容)。

2.1、將以上檔案按需放入Android Studio專案所要使用SMSSDK的Module所在的Libs裡面:

Android SMSSDK非Gradle整合教程

2.2、在Module的build.gradle裡面將libs加入倉庫(repositories):

repositories{
    flatDir{
        dirs 'libs' //就是你放aar的目錄地址
    }
}
複製程式碼

2.3、在Module的build.gradle裡面新增依賴(dependencies )注意:SMSSDK-<verison>,是隨著版本變化的;eg:3.0.0的版本則需要改成:compile name:’SMSSDK-3.0.0′,ext:’aar’

dependencies {
    ....//你的其他依賴
    compile name:'SMSSDK-<version>',ext:'aar'
    compile name:'SMSSDKGUI-<version>',ext:'aar'
}
複製程式碼

最終,你的build.gradle看起來應該像這樣:

Android SMSSDK非Gradle整合教程

四、新增程式碼

1.配置AndroidManifest.xml

1.1、新增以下許可權:

<uses-permission android:name="android.permission.READ_CONTACTS" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.RECEIVE_SMS" />
<uses-permission android:name="android.permission.GET_TASKS" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
複製程式碼

1.2、新增以下Activity:

<activity
   android:name="com.mob.tools.MobUIShell"
   android:theme="@android:style/Theme.Translucent.NoTitleBar"
   android:configChanges="keyboardHidden|orientation|screenSize"
   android:windowSoftInputMode="stateHidden|adjustResize"/>
複製程式碼

1.3、在Application節點下新增以下屬性:

android:name="com.mob.MobApplication"
複製程式碼

1.4、在Application節點下新增以下meta-data:

<!-- 通過AndroidManifest配置AppKey和AppSecret,如果你選擇通過程式碼配置,則不需要配置以下meta-data -->
<meta-data android:name="Mob-AppKey" android:value="你的AppKey"/>
<meta-data android:name="Mob-AppSecret" android:value="你的AppSecret"/>
複製程式碼

最終,你的AndroidManifest.xml看起來應該像這樣:

Android SMSSDK非Gradle整合教程

 2.使用SDK功能

有兩種方法完成驗證碼簡訊的傳送和驗證:呼叫視覺化介面和使用無介面介面

2-1、以視覺化介面完成操作

public void sendCode(Context context) {
    RegisterPage page = new RegisterPage();
    //如果使用我們的ui,沒有申請模板編號的情況下需傳null
    page.setTempCode(null);
    page.setRegisterCallback(new EventHandler() {
        public void afterEvent(int event, int result, Object data) {
            if (result == SMSSDK.RESULT_COMPLETE) {
                // 處理成功的結果
                HashMap<String,Object> phoneMap = (HashMap<String, Object>) data;
                String country = (String) phoneMap.get("country"); // 國家程式碼,如“86”
                String phone = (String) phoneMap.get("phone"); // 手機號碼,如“13800138000”
                // TODO 利用國家程式碼和手機號碼進行後續的操作
            } else{
                // TODO 處理錯誤的結果
            }
        }
    });
    page.show(context);
}
複製程式碼

2-2、以無介面介面完成操作

// 在嘗試讀取通訊錄時以彈窗提示使用者(可選功能)
SMSSDK.setAskPermisionOnReadContact(true);
 
EventHandler eventHandler = new EventHandler() {
    public void afterEvent(int event, int result, Object data) {
        // afterEvent會在子執行緒被呼叫,因此如果後續有UI相關操作,需要將資料傳送到UI執行緒
        Message msg = new Message();
        msg.arg1 = event;
        msg.arg2 = result;
        msg.obj = data;
        new Handler(Looper.getMainLooper(), new Callback() {
            @Override
            public boolean handleMessage(Message msg) {
                int event = msg.arg1;
                int result = msg.arg2;
                Object data = msg.obj;
                if (event == SMSSDK.EVENT_GET_VERIFICATION_CODE) {
                    if (result == SMSSDK.RESULT_COMPLETE) {
                        // TODO 處理成功得到驗證碼的結果
                        // 請注意,此時只是完成了傳送驗證碼的請求,驗證碼簡訊還需要幾秒鐘之後才送達
                    } else {
                        // TODO 處理錯誤的結果
                        ((Throwable) data).printStackTrace();
                    }
                } else if (event == SMSSDK.EVENT_SUBMIT_VERIFICATION_CODE) {
                    if (result == SMSSDK.RESULT_COMPLETE) {
                        // TODO 處理驗證碼驗證通過的結果
                    } else {
                        // TODO 處理錯誤的結果
                        ((Throwable) data).printStackTrace();
                    }
                }
                // TODO 其他介面的返回結果也類似,根據event判斷當前資料屬於哪個介面
                return false;
            }
        }).sendMessage(msg);
    }
};
// 註冊一個事件回撥,用於處理SMSSDK介面請求的結果
SMSSDK.registerEventHandler(eventHandler);
 
// 請求驗證碼,其中country表示國家程式碼,如“86”;phone表示手機號碼,如“13800138000”
SMSSDK.getVerificationCode(country, phone);
 
// 提交驗證碼,其中的code表示驗證碼,如“1357”
SMSSDK.submitVerificationCode(country, phone, code);
 
// 使用完EventHandler需登出,否則可能出現記憶體洩漏
protected void onDestroy() {
    super.onDestroy();
    SMSSDK.unregisterEventHandler(eventHandler);
}
複製程式碼

其中EventHandler是簡訊SDK的操作回撥,具體說明文件請參閱:簡訊SDK操作回撥章節。

3.關於配置AppKey和AppSecret的說明

配置AppKey和AppSecret有兩種方式:

(1)通過AndroidManifest配置

(2)通過程式碼配置

以上方法擇一即可,建議使用第一種方式進行配置。

3.1、通過AndroidManifest配置:

(1)在Application節點下新增以下屬性:

android:name="com.mob.MobApplication"
複製程式碼

注意:如果你有自己的Application類,那麼也可以讓你的Application類繼承MobApplication即可。

(2)在Application節點下新增以下子節點:

<!-- 通過AndroidManifest配置AppKey和AppSecret,如果你選擇通過程式碼配置,則不需要配置以下meta-data -->
<meta-data android:name="Mob-AppKey" android:value="你的AppKey"/>
<meta-data android:name="Mob-AppSecret" android:value="你的AppSecret"/>
複製程式碼

3.2、通過程式碼配置:

如果選擇通過程式碼配置,則不需要繼承MobApplication,只要在使用SMSSDK之前,呼叫以下程式碼:

// 通過程式碼註冊你的AppKey和AppSecret
MobSDK.init(context, "你的AppKey", "你的AppSecret");
複製程式碼

五、程式碼混淆

如果你開啟了proguard混淆,需要在proguard的rules裡面新增以下規則:

# SMSSDK
-dontwarn com.mob.**
-keep class com.mob.**{*;}
 
-dontwarn cn.smssdk.**
-keep class cn.smssdk.**{*;}
複製程式碼




相關文章