为Android应用集成SDK

Android SDK文件

联系阿里云技术支持人员获取对应的SDK包后，将其解压至本地。下表描述了解压获得的sdk-Android文件夹中包含的文件。

配置Android工程

1. 在Android Studio中导入解压SDK获得的.aar文件。将sdk-Android文件夹中所有.aar文件复制到Android应用工程的libs目录中。

   说明

   如果当前工程中不存在libs目录，请在指定路径下手动创建libs文件夹。

2. 编辑配置信息。打开该Module的build.gradle文件，完成以下配置修改。

   • 将libs目录添加为查找依赖的源。

     repositories{
        flatDir {
          dirs 'libs'
        }
     }

   • 添加编译依赖。

     说明

     .aar文件的版本号可能有所不同，以您下载解压得到的文件名为准。

     dependencies {
       compile fileTree(include: ['*.jar'], dir: 'libs')
       compile ('com.android.support:appcompat-v7:23.0.0')
       compile (name:'AVMPSDK-external-release-xxx', ext:'aar')
       compile (name:'SecurityBodySDK-external-release-xxx', ext:'aar')
       compile (name:'SecurityGuardSDK-external-release-xxx', ext:'aar')
     }

3. 将解压SDK获得的.jpg配置文件导入drawable目录。将sdk-Android文件夹中的yw_1222_0335_mwua.jpg配置文件复制到Android应用工程的drawable目录中。

   说明

   如果当前工程中不存在drawable目录，请在指定路径下手动创建drawable文件夹。

4. 过滤ABI（删除多余架构SO）。爬虫防护SDK目前仅支持armeabi、armeabi-v7a、arm64-v8a架构的SO。

   警告

   您必须对最终导出的ABI进行过滤，否则可能导致应用崩溃。

   1. 在Android应用工程的lib目录中，删除armeabi、armeabi-v7a、arm64-v8a文件夹以外所有其他CPU架构的文件夹，包括x86、x86_64、mips、mips64等，只保留armeabi、armeabi-v7a、arm64-v8a文件夹。

   2. 参考以下代码示例，在应用工程的build.gradle配置文件中增加过滤规则，被abiFilters指定的架构将会被包含在APK文件中。

      说明

      本代码示例中仅指定了armeabi架构，您可以根据实际情况指定或兼容armeabi-v7a、arm64-v8a架构。

      defaultConfig{
        applicationId "com.xx.yy"
        minSdkVersion xx
        targetSdkVersion xx
        versionCode xx
        versionName "x.x.x"
        ndk {
          abiFilters "armeabi"
          // abiFilters "armeabi-v7a"
          // abiFilters "arm64-v8a"
        }
      }

      说明

      只保留armeabi架构的SO，不会影响应用的兼容性，还能大幅减小应用的体积。

5. 添加应用权限。

   • 如果是Android Studio项目，并且使用了aar方式进行集成，由于在.aar文件中已经声明了相关权限，因此不需要在项目中额外配置权限。

   • 如果是Eclipse项目，您需要在AndroidManifest.xml文件中添加以下权限配置：

     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
     <uses-permission android:name="android.permission.READ_PHONE_STATE" />
     <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
     <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
     <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
     <uses-permission android:name="android.permission.WRITE_SETTINGS" />

6. 添加ProGuard配置。

   说明

   如果您使用了Proguard进行混淆，则需要添加ProGuard配置。ProGuard的配置根据集成方式的不同，分为Eclipse和Android Studio两种情况。

   • Android Studio

     如果在build.gradle中配置了proguardFiles，并且开启了minifyEnabled，则表明使用了proguard-rules.pro配置文件进行混淆。

   • Eclipse

     如果在project.properties中指定了proguard配置，例如在project.properties中存在proguard.config=proguard.cfg语句，则表明使用了proguard进行混淆。

     说明

     混淆配置在proguard.cfg文件中。

   添加keep规则

   为了保证一些需要的类不被混淆，需要在proguard的配置文件中添加以下规则：

   -keep class com.taobao.securityjni.**{*;}
   -keep class com.taobao.wireless.security.**{*;}
   -keep class com.ut.secbody.**{*;}
   -keep class com.taobao.dp.**{*;}
   -keep class com.alibaba.wireless.security.**{*;}

调用SDK接口

import com.alibaba.wireless.security.jaq.JAQException;
import com.alibaba.wireless.security.jaq.avmp.IJAQAVMPSignComponent;
import com.alibaba.wireless.security.open.SecurityGuardManager;
import com.alibaba.wireless.security.open.avmp.IAVMPGenericComponent;

步骤2：初始化

接口定义：boolean initialize();

功能：初始化SDK。

接口参数：无。

返回值：Boolean类型。初始化成功返回true，失败返回false。

IJAQAVMPSignComponent jaqVMPComp = SecurityGuardManager.getInstance(getApplicationContext()).getInterface(IJAQAVMPSignComponent.class);
boolean result = jaqVMPComp.initialize();

步骤3：签名请求数据

接口定义：byte[] avmpSign(int signType, byte[] input);

功能：使用avmp技术对input的数据进行签名处理，并且返回签名串。

返回值：byte[]类型，返回签名串。

int VMP_SIGN_WITH_GENERAL_WUA2 = 3;
String request_body = "i am the request body, encrypted or not!";
byte[] result = jaqVMPComp.avmpSign(VMP_SIGN_WITH_GENERAL_WUA2, request_body.getBytes("UTF-8"));
String wToken = new String(result, "UTF-8");
Log.d("wToken", wToken);

步骤4：将wToken放进协议头

在HttpURLConnection类的对象中添加wToken字段的内容。

String request_body = "i am the request body, encrypted or not!";
URL url = new URL("http://www.aliyundoc.com");
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("POST");
// set wToken info to header 
conn.setRequestProperty("wToken", wToken);
OutputStream os = conn.getOutputStream();
// set request body info
byte[] requestBody = request_body.getBytes("UTF-8");
os.write(requestBody);
os.flush();
os.close();

步骤5：发送数据到服务器

错误码

上述initialize和avmpSign接口的调用过程中可能出现异常。如果生成签名串异常或失败，请在Log中搜索与SecException 相关的信息。

下表描述了常见错误码及含义。

确认集成效果

您可以参考以下步骤，确认您的应用已正确集成了爬虫防护SDK。

1. 将打包生成的APK文件通过修改扩展名的方式转换成ZIP压缩文件，并将该压缩文件解压至本地。

2. 定位到工程的lib目录，确保文件夹中只存在armeabi、armeabi-v7a、arm64-v8a文件夹。

   说明

   如果存在其他架构的文件夹，请参见配置Android工程，移除其他架构的文件夹。

3. 定位到工程的res/drawable目录，确认存在yw_1222_0335_mwua.jpg文件，且文件大小不为0。

4. 通过打印日志，确保调用avmpSign接口后能生成正确的签名信息。

   说明

   如果签名信息未生成，请参见错误码信息进行排查。

常见问题

为什么指定shrinkResources后，密钥图片被错误地优化？

在Android Studio中，如果指定shrinkResources为true，在工程编译时可能对未在代码中引用的资源文件进行优化。该操作可能导致爬虫防护SDK中的.jpg文件无法正常工作。如果打包后得到APK中，yw_1222_0335.jpg配置文件的大小为0KB，则表明该图片文件已被优化。

解决方法

1. 在工程的res目录中新建raw目录，并在raw目录中创建keep.xml文件。

2. 在keep.xml文件中，添加以下内容。

   <?xml version="1.0" encoding="utf-8"?>
   <resources xmlns:tools="http://schemas.android.com/tools"
   tools:keep="@drawable/yw_1222_0335.jpg,@drawable/yw_1222_0335_mwua.jpg" />

3. 添加完成后，重新编译工程APK即可。