遊量android SDK接入指南
注: 此SDK文檔對應的版本是1.0.0,本文檔只針對於Android Studio開發環境提供接入文檔
1. 申請你的clientid
請到 開發者應用登記頁面 進行登記,登記並選擇移動應用進行設置後,將該應用提交審覈,由遊量平臺生成並且提供clientid, 只有審覈通過的應用才能進行開發。
2. 下載SDK和對應demo
3. 搭建開發環境
1. 在android studio中建立你的工程
下載完SDK後解壓,把下載的SDK開發工具包下面的libs中的JinTuSDK_xxx.aar (xxx是對應的SDK版本號)文件複製到工程下面的libs目錄:
2. 添加依賴
在對應的app module的build.gradle中加入以下依賴:
dependencies {
// 這邊加入 '*.aar'資源
implementation fileTree(include: ['*.jar', '*.aar'], dir: 'libs')
implementation 'com.android.support:appcompat-v7:28.0.0'
implementation 'com.android.support.constraint:constraint-layout:1.1.3'
implementation 'com.android.support:design:28.0.0'
}
3.設置SDK最小版本
defaultConfig {
...
minSdkVersion 15
...
}
注:若沒有設置上面的最小版本爲15,會出現構建錯誤:
Manifest merger failed with multiple errors, see logs
4.設置編譯SDK版本
android {
...
compileSdkVersion 28
...
}
注: 若沒有設置編譯SDK版本爲 28, 會出現構建錯誤:
error: resource android:attr/dialogCornerRadius not found. Message{kind=ERROR, text=error: resource android:attr/dialogCornerRadius not found., sources=[C:\Users\B150M-Am.2\.gradle\caches\transforms-1\files-1.1\appcompat-v7-28.0.0.aar\3226f64da50349bb62338cc62a0d162d\res\values-v28\values-v28.xml:9:5-12:13], original message=, tool name=Optional.of(AAPT)}
…
5.添加databinding支持
android {
...
// 遊量SDK接入,導入aar包需要配置flatDir
repositories {
flatDir {
dirs 'libs'
}
}
// 遊量SDK接入,開放databinding
dataBinding {
enabled true
}
...
}
4. 在代碼中使用開發工具包
1. 新建自己的Application類:
在工程項目下新建自己的MyApplication繼承Application:
2. 註冊遊量SDK:
在MyApplication中的onCreate回調方法中對遊量的SDK進行註冊:
2. 在AndroidManifest.mxl文件中設置application的name屬性爲自己創建的Application類:
3. 在主活動中註冊 遊量API:
- 在工程主Activity中的 onCreate回調方法中加入JinTuApi.onCreate(this);
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// 初始化遊量api
JinTuApi.onCreate(this);
}
- 在工程主Activity的onDestroy回調方法中加入 JinTuApi.onDestroy();
@Override
protected void onDestroy() {
JinTuApi.onDestroy();
super.onDestroy();
}
4. 遊量平臺登錄API
public void jintuLogin(View view) {
//調用遊量登錄,參數0是登錄方式,現在遊量只有唯一登錄方式:手機登錄-0;
JinTuApi.login(0);
}
5. 設置遊量平臺登錄回調
// 務必設置這個監聽,在調用遊量登錄的時候會把返回消息傳遞到 onLoginNotify
// 方法中,其中主要是accessToken,應用方在登錄應用服務器的時候,攜帶此accessToken
// 給服務端進行驗證登錄(服務端需要通過accessToken驗證用戶的合法性)。
JinTuApi.setUserListener(new JinTuUserListener() {
@Override
public void onLoginNotify(UserLoginRet userLoginRet) {
//回調方法中執行應用方應用端登錄或其他邏輯
tv.setText("登錄成功: " + userLoginRet);
}
});
6. 代碼混淆
如果項目工程有開啓代碼混淆的話,在混淆文件中添加如下代碼:
-keep class com.jintu.bz.account.*{*;}
-keep class com.jintu.bz.account.api.** {*;}
-keep class com.jintu.bz.account.model.** {*;}
-keep class com.jintu.bz.account.databinding.** {*;}
-dontwarn okio.**
-dontwarn retrofit2.**
-dontwarn android.databinding.**
至此,你已經能使用遊量Android 開發工具包的 API 內容了。如果想更詳細瞭解每個 API 函數的用法,請查閱 Android 平臺參考手冊 或自行下載閱讀錦途 SDK Sample Demo 源碼, 源碼包含在SDK包中。