UCloud NetAnalysis SDK for Android

关于

CN:

这个开源库允许您将UCloud全球网络分析服务集成到您的Android应用程序中，它将检测和报告应用程序终端用户和服务部署地点之间的网络可用性。

应用程序开发人员还可以使用API配置您希望在应用程序用户之间检测和分析的服务位置(IP地址)。UCloud IDC中心已经被设置为默认位置。

以下两种情况会自动触发网络检测:

• 当应用程序启动时，从终端用户发出Ping命令并跟踪服务器
• 当网络环境在WIFI和蜂窝之间发生变化时，Ping服务器

EN:

This open-source library allows you to integrate UCloud Global network analysis service into your Android app, which will detect and report the network availability between app end-user and locations where the service has been deployed.

API is available as well for app developer to configure the service location (IP Address) you would like to detect and analysis between your app users. UCloud IDC centers have been set as default locations.

The network detection is automatically triggered for following two situations:

• Ping and Tracerout the server from end-user when app initial
• Ping the server when the network environment change between WIFI and Cellular

版本

• Current Version：0.0.1

[TOC]

运行环境

Android

• Android系统版本：==2.3.3== (API 10)及以上

使用

Dependencies

NetAnalysis SDK依赖于Gson。

• 将NetAnalysisLib.jar放入项目app模块中的libs目录下，并在a™pp模块的build.gradle的dependencies中建立依赖

• 在app模块的build.gradle的dependencies中添加

  dependencies {
      // your dependence
      implementation 'com.google.code.gson:gson:2.8.5'
  }

### 项目信息配置 将你在UCloud平台注册的AppId和AppKey，配置在AndroidManifest.xml的内 ``` xml ```
### 系统权限设置 以下是NetAnalysis SDK所需要的Android权限，请确保您的AndroidManifest.xml文件中已经配置了这些权限，否则，SDK将无法正常工作。 ``` xml ```

1、在==自定义Application类==或者==主Activity类==的onCreate中构建UCNetAnalysisManager，并注册

// 使用Application Context 构建UCNetAnalysisManager实例
UCNetAnalysisManager manager = UCNetAnalysisManager.createManager(context.getApplicationContext());
// 设置SDK回调接口
manager.setSdkListener(new OnSdkListener() {
    @Override
    public void onRegister(UCSdkStatus status) {
        // SDK register完成后回调，register结果见**UCSdkStatus**说明
    }
    
    @Override
    public void onNetworkStatusChanged(UCNetworkInfo networkInfo) {
        // 网络状态改变回调，回调结果见**UCNetworkInfo**说明
    }
});
// 注册sdk模块
manager.register();

2、配置你需要分析网络质量的IP地址或者域名

List<String> ips = new ArrayList();
ips.add("127.0.0.1");
ips.add("127.0.0.2");
ips.add("www.ucloud.cn");
// 配置你想要监测的网络质量的ip/域名
manager.setCustomIps(ips);

3、开始分析你所配置的IP地址或者域名的网络质量

// 开始网络质量分析，将会分析你刚才配置的ip/域名
manager.analyse(new OnAnalyseListener() {
        @Override
        public void onAnalysed(UCAnalysisResult result) {
            // result：分析结果，详情见 UCAnalysisResult 说明
        }
    });

4、在你的应用退出时，注销并销毁UCNetAnalysisManager

@Override
protected void onDestroy(){
    // 注销UCNetAnalysisManager模块，注销后将停止一切未完成的操作
    manager.unregister();
    // 销毁UCNetAnalysisManager实例以释放内存空间
    UCNetAnalysisManager.destroy();
    super.onDestroy();
}

类

UCNetAnalysisManager

UNetAnalysisSDK的主要模块，你将多次使用UCNetAnalysisManager的单例对象进行SDK业务接口的操作

创建UCNetAnalysisManager单例对象

public static UCNetAnalysisManager createManager(Context applicationContext)

• param:
  • applicationContext: application的context
• return: UCNetAnalysisManager单例对象

获取UCNetAnalysisManager单例对象

public static UCNetAnalysisManager getManager()

• param: -
• return: UCNetAnalysisManager单例对象，若未调用createManager，则return为null

注册UCNetAnalysisManager模块

public void register()

• param: -
• return: -

设置Sdk回调接口

public void setSdkListener(OnSdkListener listener)

• param:
  • listener: OnSdkListener回调接口，详情见OnSdkListener说明
• return: -

设置自定义的IP地址或域名

public void setCustomIps(List<String> ips)

• param:
  • ips: 自定义需要网络分析的IP地址或域名列表
• return: -

获取已设置的自定义的IP地址或域名

public List<String> getCustomIps()

• param: -
• return:
  • List: 已设置的需要网络分析的IP地址或域名列表

执行网络质量诊断

public void analyse(OnAnalyseListener listener)

• param:
  • listener: 网络质量诊断结果回调接口，详情见OnAnalyseListener说明
• return: -

检查当前设备网络状态

public UCNetworkInfo checkNetworkStatus()

• param: -
• return:
  • UCNetworkInfo: 当前设备的网络状态，详情见UCNetworkInfo

注销UCNetAnalysisManager模块

public void unregister()

• param: -
• return: -

销毁UCNetAnalysisManager单例对象

public static void destroy()

• param: -
• return: -

OnSdkListener

UCNetAnalysisManager模块回调接口

public interface OnSdkListener {
    // 注册结果回调，status详情见UCSdkStatus
    void onRegister(UCSdkStatus status);
 
    // 网络情况改变回调，status详情见UCNetworkInfo
    void onNetworkStatusChanged(UCNetworkInfo status);
}

OnAnalyseListener

UCNetAnalysisManager模块，网络质量分析接口的回调

public interface OnAnalyseListener {
    // 网络质量分析结果回调，result详情见UCAnalysisResult
    void onAnalysed(UCAnalysisResult result);
}

UCAnalysisResult

网络质量分析结果

public class UCAnalysisResult {
    // 自定义IP地址或域名列表的分析结果
    private List<IpReport> ipReports;
}

IpReport

自定义IP地址或域名的分析结果

public class IpReport {
    // 目标IP
    private String ip;
 
    // 平均延时（毫秒）
    private int averageDelay;
 
    // 丢包率（0~100）
    private int packageLossRate;
 
    // 诊断该IP时的网络情况
    private UCNetStatus netStatus;
}

UCNetworkInfo

UNetAnalysisSDK状态集

public class UCNetworkInfo {
    // android系统网络信息类：android.net.NetworkInfo
    private NetworkInfo sysNetInfo;
 
    // UNetAnalysisSDK状态集,详情见UCNetStatus说明
    private UCNetStatus netStatus;
 
    // 信号强度（dbm）
    private int signalStrength;   
}

UCSdkStatus

UNetAnalysisSDK状态集

public enum UCSdkStatus {
    // 注册模块成功
    REGISTER_SUCCESS,
    // APPID或者APPKEY无效
    APPID_OR_APPKEY_ILLEGAL,
}

UCNetStatus

网络状态集

public enum UCNetStatus {
    // 无网络连接
    NET_STATUS_NOT_CONNECTED,
 
    // WIFI网络
    NET_STATUS_WIFI,
 
    // 4G网络
    NET_STATUS_4G,
 
    // 3.5G网络
    NET_STATUS_3_5G,
 
    // 3G网络
    NET_STATUS_3G,
 
    // 2.5G网络
    NET_STATUS_2_5G,
 
    // 2G网络
    NET_STATUS_2G,
 
    // 未知类型
    NET_STATUS_UNKNOW,
}