Pgyer document center

Android SDK 集成指南

1

获取 App key

2

添加 Framework

3

在 Application 中集成

4

添加权限

5

上报异常和检查更新

集成蒲公英 Android SDK 有两种方式:

方式一:

  1. 下载蒲公英 Android SDK 并将 jar 包复制到工程的 libs 目录下面

点击这里下载 Android SDK

Android SDK

  1. 在项目 app/build.gradle 中添加以下代码
repositories {
    flatDir {
        dirs 'libs'   // jar目录
    }
}
...  

dependencies {
     ...
    implementation files('libs/pgy_analytics_sdk.jar')
}                        

方式二:

  1. 在项目下 build.gradle 中添加
allprojects {
        repositories {
            ...
            maven { url "https://raw.githubusercontent.com/Pgyer/analytics/master" }
        }
    } 
  1. 然后在 app/build.gradle 中添加
dependencies {
                    ...
            implementation 'com.pgyer:analytics:4.1.6'
    }                   

下一步:添加 Framework

获取 FrontJS Token 和 Api key :

  1. 找到蒲公英上需要集成 Android SDK 的应用「 应用监控 」,然后点击“立即创建”

通过 Cocoapods 添加 Framework:

上传到蒲公英上的每一个 App 都拥有唯一的 App Key,以此来标识唯一应用,可以在应用管理 — 应用概述中查看。

pod 'Pgyer'
pod 'PgyUpdate'

通手工添加 Framewrok:

  1. 下载蒲公英iOS SDK

  2. 添加 PgySDK.framework,PgyUpdate.framework.

    将 PgySDK.framework 和 PgyUpdate.framework 拖动到你的 Xcode 工程里,并勾选“Copy items if needed”。

PgySDK

  1. 配置依赖项(提示:如果仅使用检查更新功能,则无需添加依赖项)

导入 SDK 后,切换到 Build Phases 选项卡中,在 Link Binary With Libraries 中添加如下六个系统 Framework:

CoreTelephony.framework
OpenGLES.framework
CoreMotion.framework
AudioToolbox.framework
AvFoundation.framework
SystemConfiguration.framework                          

PgySDK 下一步:初始化并调用 SDK

在 Application 中集成 :

import android.app.Application;
import com.pgyer.pgysdk.PgyerSDKManager;
public class {当前应用的application} extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        init(this);
    }
    //初始化
    private static void init( {当前应用的application} application){
         new PgyerSDKManager.InitSdk()
                .setContext(application) //设置上下问对象
                .enable(FeatureEnum.CHECK_UPDATE)  //添加检查新版本
                .build();
    }
}

下一步:添加权限

添加权限 :

在 AndroidManifest.xml 修改 android:name=“{当前应用的application}”(此处的名字对应继承上面 Application 的类名),并添加权限

<!-- 必选-->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <!-- 获取网络状态 -->
<uses-permission
        android:name="android.permission.READ_PRIVILEGED_PHONE_STATE"
        tools:ignore="ProtectedPermissions" />
<uses-permission android:name="android.permission.INTERNET" /> <!-- 网络通信-->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />  <!-- 获取设备信息 -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> <!-- 获取网络信息权限-->

<!-- 用户手机设置中允许未知来源安装包安装状态为关;-->
<!-- Android8.0 以后,如果要安装 apk 需要额外添加权限:-->
<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />

<application
    android:name=""{当前应用的application}"
    android:icon="@drawable/ic_launcher"
    android:label="@string/app_name"
    android:theme="@style/AppTheme" >

    <meta-data
            android:name="PGYER_API_KEY"
            android:value="蒲公英后台申请的apikey"></meta-data>
        <meta-data
            android:name="PGYER_FRONTJS_KEY"
            android:value="蒲公英后台申请的frontJSToken"></meta-data>

        <!--添加新版本检测-->
        <meta-data
            android:name="PGYER_FEATURE_CHECK_UNPDATE"
            android:value="true"></meta-data>

</application>

下一步:主动上报异常

手动上报异常:

PgySDK

import com.pgyer.pgyersdk.PgyerSDKManager;
...
PgyerSDKManager.reportException(Exception e);                         

手动调用检查更新:

import com.pgyer.pgyersdk.PgyerSDKManager;
...
PgyerSDKManager.checkSoftwareUpdate(Exception e);