一、SDK兼容说明

二、集成SDK

1.导入securelink-sdk-android.aar 和 mars-xlog-1.2.6.aar

1. 把securelink-sdk-android.aar 和 mars-xlog-1.2.6.aar 复制到工程libs目录下。如果您的APP也使用了mars-xlog，这里就不需要添加，但建议使用相同的版本号，目前最新版本是1.2.6。

2. 在项目的build.gradle中添加依赖

   方式一(推荐方式)：

   dependencies {
     ...
       
     // 添加AAR包
     implementation files('libs/securelink-sdk-android.aar')
     implementation files('libs/mars-xlog-1.2.6.aar')
   }
   

   旧版本AGP的可能不支持，如果报错，请使用方式二。

   方式二：

   repositories {
       flatDir {
           dirs 'libs'
       }
   }
   
   dependencies {
     ...
       
     // 添加AAR包
     implementation(name: 'securelink-sdk-android', ext: 'aar')
     implementation(name: 'mars-xlog-1.2.6', ext: 'aar')
   }
   

2. 配置ABI

目前我们提供armeabi-v7a, arm64-v8a 两种类型的ABI，您可以根据项目中使用到的ABI进行配置：

defaultConfig {
  ...
    
	ndk{
		// 设置您需要的ABI
		abiFilters "armeabi-v7a", "arm64-v8a"
	}
}

三、调用SDK

如果应用是多进程架构，SecureLink SDK 只能在应用的主进程中调用。

1. 初始化SecureLink SDK

调用如下代码初始化SecureLink SDK。

import com.wangsu.sdwanvpn.sdk.WSVpnConfig;
import com.wangsu.sdwanvpn.sdk.WSVpnManager;

WSVpnConfig vpnConfig = new WSVPnConfig();
vpnConfig.setUserName("xxx");
vpnConfig.setPassword("xxx");
vpnConfig.setSdkToken("xxx");
WSVpnManager.getInstance().init(this.getApplicationContext(), vpnConfig);

初始化函数定义如下：

/***
 * 初始化SecureLink SDK
 * @param context ApplicationContext
 * @param config WSVpnConfig（认证配置）
 */
public void init(Context context, WSVpnConfig config);

WSVpnConfig定义如下：

public class WSVpnConfig {
	...
  
  /***
   * 设置用户名
   * @param username 用户名，设置为null会抛NullPointerException
   */
  public void setUserName(String username);
  
  /***
   * 设置密码
   * @param password 密码，设置为null会抛NullPointerException
   */  
  public void setPassword(String password);
  
  /***
   * 设置sdkToken
   * @param sdkToken sdk鉴权成功的token, 通过应用后台向网宿后台申请的sdkToken，
   *                 设置为null会抛NullPointerException
   */  
  public void setSdkToken(String sdkToken);
}

2. 启动VPN

调用如下代码启动VPN，由于启动会比较耗时，需要在子线程中执行。

import com.wangsu.sdwanvpn.sdk.WSVpnManager;

WSVpnListener vpnListener = new WSVpnListener() {
  @Override
  public void onError(int code, String msg, Bundle bundle) {
    // VPN启动失败
    Log.e(TAG, "onError: code=" + code + ", msg=" + msg);
    ...
  }
  
  @Override
  public void onConnected() {
    // VPN已连接成功，可以开始请求权限内资源
    Log.i(TAG, "onConnected");
    ...
  }
  
  @Override
  public void onDisconnected(DisconnectReason disconnectReason) {
    // VPN连接已断开，断开原因详见disconnectReason
    Log.i(TAG, "onDisconnected, reason=" + disconnectReason);
    ...
  }
}

WSVpnManager.getInstance().start(vpnListener);

启动错误码说明

断开原因

3. 关闭VPN

当您暂时不需要访问权限内资源时，可以调用如下代码关闭VPN：

WSVpnManager.getInstance().stop();

4. 退出账号登录

当用户退出登录时，请调用如下代码，退出VPN，否则无法重新登录。

WSVpnManager.getInstance().release();

5. 应用退到后台

由于VPN比较耗电，如果没有特殊需求，建议退到后台一段时间后，关闭VPN，回到前台需要访问权限内资源时，重新开启VPN。

四、用户权限说明

• 由于SecureLink SDK需要使用VPN，因此当开启VPN时，SDK会主动申请VPN使用权限，如果用户拒绝，则会启动失败。

• AndroidManifest.xml中定义的用户权限：

  <!-- 网络访问权限 -->
  <uses-permission android:name="android.permission.INTERNET" />
  <!-- VPN服务需要监听网络切换 -->
  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  <!-- VPN服务申请为前台服务，避免被系统杀死 -->
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
  

  如上权限已通过aar添加到应用，不需要您手动添加。

四、嵌入成功验证

Logcat过滤tag:SLS，出现如下日志表示嵌入成功：

I/SLS: SDK version: 1.0.0
...
I/SLS: Initialize succeed

注：如果出现错误日志，请联系网宿技术支持。