人证核身服务 IVS-Java SDK:开始使用SDK

时间:2024-11-04 16:58:02

开始使用SDK

  1. 导入依赖模块
    import com.huaweicloud.sdk.core.auth.ICredential;
    // 对用户身份进行认证
    import com.huaweicloud.sdk.core.auth.BasicCredentials;
    // 请求异常类
    import com.huaweicloud.sdk.core.exception.ConnectionException;
    import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
    import com.huaweicloud.sdk.core.exception.ServiceResponseException;
    
    // 导入ivs sdk
    import com.huaweicloud.sdk.ivs.v2.region.IvsRegion;
    import com.huaweicloud.sdk.ivs.v2.*;
    import com.huaweicloud.sdk.ivs.v2.model.*;
  2. 配置认证信息
    配置AK、SK信息。华为云通过AK识别用户的身份,通过SK对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。AK、SK获取方法请参见准备工作
    // 创建AK、SK认证凭据
    public static ICredential getCredential(String ak, String sk) {
        return new BasicCredentials()
                .withAk(ak)
                .withSk(sk);
    }

    初始化认证信息:

    String ak = System.getenv("HUAWEICLOUD_SDK_AK");
    String sk = System.getenv("HUAWEICLOUD_SDK_SK");
    ICredential credential = getCredential(ak, sk);
    • 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
    • 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
    图3 Windows环境新建环境变量
  3. 初始化客户端

    指定region方式

    public static IvsClient getClient(Region region, ICredential auth) {
        // 初始化客户端
        return IvsClient.newBuilder()
                .withCredential(auth)
                .withRegion(region)
                .build();
    }

    华北-北京四region获取:IvsRegion.CN_NORTH_4

    华北-北京一region获取:IvsRegion.CN_NORTH_1

  4. 发送请求并查看响应
    // 以调用标准版(三要素)DetectStandardByIdCardImage 接口为例
    DetectStandardByIdCardImageRequest request = new DetectStandardByIdCardImageRequest();
    DetectStandardByIdCardImageResponse response = client.detectStandardByIdCardImage(request);
    System.out.println(response.toString());
  5. 异常处理
    表1 异常处理

    一级分类

    一级分类说明

    二级分类

    二级分类说明

    ConnectionException

    连接类异常

    HostUnreachableException

    网络不可达、被拒绝。

    SslHandShakeException

    SSL认证异常。

    RequestTimeoutException

    响应超时异常

    CallTimeoutException

    单次请求,服务器处理超时未返回。

    RetryOutageException

    在重试策略消耗完成后,仍无有效的响应。

    ServiceResponseException

    服务器响应异常

    ServerResponseException

    服务端内部错误,Http响应码:[500,]。

    ClientRequestException

    请求参数不合法,Http响应码:[400, 500)

    // 捕获和处理不同类型的异常
    DetectStandardByIdCardImageRequest request = new DetectStandardByIdCardImageRequest();
    try {
        DetectStandardByIdCardImageResponse response = client.detectStandardByIdCardImage(request);
        System.out.println(response.toString());
    } catch (ConnectionException e) {
        e.printStackTrace();
    } catch (RequestTimeoutException e) {
        e.printStackTrace();
    } catch (ServiceResponseException e) {
        e.printStackTrace();
        System.out.println(e.getHttpStatusCode());
        System.out.println(e.getErrorCode());
        System.out.println(e.getErrorMsg());
    }
support.huaweicloud.com/sdkreference-ivs/ivs_07_0002.html