Android SMSSDK非Gradle集成教程

1、說明

（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咱們開始集成；

2、獲取SDK

請至Mob官網下載最新SDK，解壓後會看到如下目錄結構：

SMSSDK下存放的是短信SDK的所有內容。

3、導入SDK

1.Eclipse

 

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

SMSSDK：短信SDK核心庫（必須）

ShortMessageSDKGUI：咱們提供的開源GUI庫（非必須）

若是你不想定製本身的UI，能夠直接使用咱們提供的ShortMessageSDKGUI，不然，不須要導入ShortMessageSDKGUI。接下來，咱們以使用ShortMessageSDKGUI爲例說明。

1.1、首先將上述兩個工程導入Eclipse：

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

右鍵你的工程 → Properties → Android

同時將SMSSDK掛接到ShortMessageSDKGUI上：

注意：若是你不須要使用ShortMessageSDKGUI，請直接將SMSSDK掛接到你的項目上。

2.Android Studio

從3.1.0版本開始，再也不提供獨立的Android Studio版本下載，推薦AS版開發者按照最新的maven集成方式進行在線下載安裝。

AS版本的SMSSDK目錄下包含如下內容：

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裏面：

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看起來應該像這樣：

4、添加代碼

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看起來應該像這樣：

 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");

5、代碼混淆

若是你開啓了proguard混淆，須要在proguard的rules裏面添加如下規則：

# SMSSDK
-dontwarn com.mob.**
-keep class com.mob.**{*;}
 
-dontwarn cn.smssdk.**
-keep class cn.smssdk.**{*;}