使用限制

Android SDK使用限制如下：

• 不支持模擬器模式調試。

• 僅支持Android 4.4及以上系統版本的移動智能設備（手機或Pad）接入。

接入步驟

一、前期準備

接入前需要進行權限配置和SDK依賴配置，您可以參考下面的步驟操作。

// 阿里云實人認證服務SDK AAR，fileTree 方式依賴指定目錄
implementation(fileTree(dir: "libs", includes: ["*.aar"]))

// 阿里云實人認證服務三方依賴庫，不能省略
implementation 'com.squareup.okhttp3:okhttp:3.11.0'
implementation 'com.squareup.okio:okio:1.14.0'
implementation 'com.alibaba:fastjson:1.2.83_noneautotype'

二、調用SDK

前期準備完成后，需要按下面三個動作完成SDK的調用。

1. 初始化（install）

2. 獲取MetaInfos（getMetaInfos）

3. 調用認證方法（verify）

初始化（install）

調用該函數完成SDK內部初始化。請務必做延遲初始化配置，確保在用戶同意《隱私權政策》后，在人臉識別業務場景中初始化SDK。

• 初始化：

  ZIMFacade.install(context);

• 如需使用IPv6網絡初始化，參考如下代碼：

  ZIMFacade.installIPv6(context);

• context參數為當前Application的context。

獲取MetaInfos（getMetaInfos）

移動端環境信息發送至業務服務器端，業務服務器端將這些信息作為參數之一（MetaInfos）調用服務端初始化認證接口（InitFaceVerify），從而獲取CertifyId，用于后續認證環節。

• 調用代碼：

  // context參數為當前Application的context。
  ZIMFacade.getMetaInfos(context);

• 返回值：String類型，以JSON格式返回當前移動設備端的環境信息。（點擊查看）

  注意：此JSON僅作為結構示范，由于不通設備產生的數據不一樣，調試時請使用真實數據，否則可能無法認證。

  {
      "apdidToken": "xxxx",
      "appName": "com.aliyun.facedemo",
      "appVersion": "1.2.8",
      "bioMetaInfo": "6.7.0:21478612992,0",
      "deviceModel": "Mi 10",
      "deviceType": "android",
      "osVersion": "12",
      "sdkVersion": "2.1.0",
      "securityVersion": "2",
      "voiceSdkVersion": "1.0.0",
      "zimVer": "1.0.0"
  }

調用認證方法（verify）

調用示例如下：

ZIMFacade zimFacade = ZIMFacadeBuilder.create(MainActivity.this);
zimFacade.verify(certifyId,useMsgBox,extParams,callback);

public interface ZIMCallback {
    boolean response(ZIMResponse response);
}

完整代碼示例

完整代碼示例如下所示。您也可以下載Android Demo代碼包在本地搭建工程體驗。

public class MainActivity extends Activity {

    private String certifyId = "<從服務端InitFaceVerify接口獲取>";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 初始化（install）
        ZIMFacade.install(this);

        // 獲取MetaInfos
        String metaInfos = ZIMFacade.getMetaInfos(this);

        // 將MetaInfos發送到App服務器端，調用云端InitFaceVerify接口獲取CertifyId。
        // certifyId = getCertifyIdFromServer(metaInfo); // 需客戶自己實現

        HashMap<String, String> extParams = new HashMap<>();
        // extParams取值示例
        extParams.put("ext_params_key_use_video", "false");

        // 調用認證方法（verify）
        ZIMFacade zimFacade = ZIMFacadeBuilder.create(MainActivity.this);
        zimFacade.verify(certifyId, true, extParams,new ZIMCallback() {
            @Override
            public boolean response(ZIMResponse response) {
                if (null != response && 1000 == response.code) {
                    // 認證成功
                    Toast.makeText(getApplicationContext(),
                            "認證成功\n" +
                                    "code: " + response.code + "\n" +
                                    "reason: " + response.reason,
                            Toast.LENGTH_LONG).show();
                } else {
                    // 認證失敗
                    Toast.makeText(getApplicationContext(),
                            "認證失敗\n" +
                                    "code: " + response.code + "\n" +
                                    "reason: " + response.reason,
                            Toast.LENGTH_LONG).show();
                }
                return true;
            }
        });
    }
}

三、結果處理：

認證結果通過verify>callback>response方法提供的ZIMResponse對象傳入，示例可參見完整代碼示例。

ZIMResponse對象包含了諸多屬性，結果處理主要關注code（結果編碼）和reason（結果原因）即可，常見的編碼和原因如下表所示。

SDK的進階使用

混淆配置（重要）

如果您的工程使用了代碼混淆，請務必在App工程的proguard-rules.pro文件中添加如下配置信息，以防止接口被混淆處理后造成功能異常。

# 必須要依賴到應用混淆中
-keepclassmembers,allowobfuscation class * {
     @com.alibaba.fastjson.annotation.JSONField <fields>;
}
-keep class net.security.device.api.** {*;}
-keep class face.security.device.api.** {*;}
-keep class com.alipay.deviceid.** { *; }
-keep class org.json.** { *;}
-keep class com.alibaba.fastjson.** {*;}

# SDK混淆配置
-keep class com.alipay.face.api.** {*;}
-keep class com.alipay.zoloz.toyger.**{*;}
-keep class com.dtf.face.api.** {*;}
-keep class com.dtf.face.ocr.verify.DTFOcrFacade { *; }
-keep class com.dtf.face.verify.** {*;}
-keep class com.dtf.face.network.model.** {*;}
-keep class com.dtf.face.network.APICallback {*;}
-keep class com.dtf.face.config.**{*;}
-keep class com.dtf.face.log.** {*;}
-keep class com.dtf.face.ui.overlay.** {*;}
-keep class com.dtf.face.ui.widget.ToygerWebView {*;}
-keep class com.dtf.face.utils.ClientConfigUtil{
   boolean needUploadPreviewTrace*();
   boolean needVideoExDegrade*();
   boolean isCfgVideoExDevice*();
}
-keep class com.dtf.toyger.base.** {*;}
-keep class com.dtf.face.network.mpass.biz.model.** { *; }
-keep class com.dtf.face.utils.LogUtils { *; }
-keep class com.dtf.wish.api.** { *; }
-keep class com.dtf.wish.ui.** { *; }
-keep class com.dtf.wish.ui.WishFragment{*;}
-keep class com.dtf.voice.api.** { *; }
-keep class xnn.* { *; }
-keep class facadeverify.** { *; }
-keep class baseverify.** { *; }
-keep class faceverify.** { *; }
-keep class ocrverify.** { *; }
-keep class wishverify.** { *; }

# R8編譯混淆配置
-keep class com.dtf.face.ui.toyger.FaceLoadingFragment{ *; }
-keep class com.dtf.face.ui.toyger.FaceShowFragment{*;}
-keep class com.dtf.face.ui.toyger.FaceShowElderlyFragment{*;}
-keepclassmembers class com.dtf.face.camera.ICameraCallback{
   void onPreviewFrame*(*);
}

# NFC編譯配置
-keep class com.dtf.face.nfc.verify.DTFNfcFacade { *; }
-keep class com.eidlink.**{*;}
-keep class net.sf.**{*;}
-keep class org.**{*;}
-keep class cn.**{*;}
-keep class com.froad.**{*;}
-keep class com.huawei.**{*;}
-keep class com.eidlink.**{*;}
-keep class org.ejbca.cvc.**{*;}
-keep class org.jmrtd.**{*;}
-keep public class com.netease.nis.sdkwrapper.Utils {public <methods>;}
-keep class net.sf.scuba.**{*;}
-keep class org.eid_bc.bouncycastle.jcajce.provider.symmetric.**{*;}

# 忽略警告
-dontwarn okio.**
-dontwarn org.apache.commons.codec.binary.**

SDK包裁剪

一些特殊的場景和需求會使用到SDK包裁剪功能，例如App打包體積要求或者三方依賴沖突等。

如果需要判斷功能是否可裁剪或者需要查找每個包負責的功能描述，請參見SDK包裁剪說明。

SDK UI自定義設置

如果對認證頁面的UI有自定義的需求，SDK提供了UI自定義配置功能，可以對認證頁面的文本、顏色和icon進行配置。

詳細操作，請參見Android SDK UI自定義配置說明。