更新时间:2022-05-09 GMT+08:00
分享

Java SDK

本章节介绍新版Java SDK,您可以参考本章节进行快速集成开发。

准备工作

  • 已注册华为云帐号,并完成实名认证,帐号不能处于欠费或冻结状态。
  • 已具备开发环境,支持Java JDK 1.8 及其以上版本。
  • 登录“我的凭证 > 访问秘钥”页面,获取Access Key(AK)和Secret Access Key(SK)。
  • 登录“我的凭证”页面,获取“IAM用户名”“、帐号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息,请提前保存。

    本样例以“华北-北京四”区域为例,获取对应的项目ID(project_id)。

    图1 我的凭证

安装SDK

推荐您通过Maven方式获取和安装SDK,首先需要在您的操作系统中下载安装Maven,安装完成后您只需要在Java项目的pom.xml文件中加入相应的依赖项即可。

使用SDK前,需要安装“huaweicloud-sdk-core”和“huaweicloud-sdk-ocr”。SDK的版本信息请参见SDK中心

<dependency>
    <groupId>com.huaweicloud.sdk</groupId>
    <artifactId>huaweicloud-sdk-core</artifactId>
    <version>3.0.55</version>
</dependency>
<dependency>
    <groupId>com.huaweicloud.sdk</groupId>
    <artifactId>huaweicloud-sdk-ocr</artifactId>
    <version>3.0.55</version>
</dependency>

开始使用

详细的SDK介绍,使用异步客户端,配置日志请参见SDK中心Java SDK使用指导Java SDK使用视频

  1. 导入依赖模块
    package com.huaweicloud.sdk.test;
    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;
    // 导入OCR客户端
    import com.huaweicloud.sdk.ocr.v1.region.OcrRegion;
    import com.huaweicloud.sdk.ocr.v1.*;
    import com.huaweicloud.sdk.ocr.v1.model.*;
  2. 配置客户端连接参数
    • 默认配置
      // 使用默认配置
      HttpConfig config = HttpConfig.getDefaultHttpConfig();
    • 网络代理(可选)
      // 根据需要配置网络代理,网络代理默认的协议为 `http` 协议
      config.withProxyHost("proxy.huaweicloud.com")
          .withProxyPort(8080)
          .withProxyUsername("test")
          .withProxyPassword("test");
    • 超时配置(可选)
      // 默认连接超时时间为60秒,可根据需要调整
      config.withTimeout(60);
    • SSL配置(可选)
      // 根据需要配置是否跳过SSL证书验证
      config.withIgnoreSSLVerification(true);
  3. 配置认证信息

    配置AK、SK、project_id信息。华为云通过AK识别用户的身份,通过SK对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。

    • 使用永久AK和SK
      BasicCredentials basicCredentials = new BasicCredentials()
          .withAk(ak)
          .withSk(sk)
          .withProjectId(projectId);
    • 使用临时AK和SK
      BasicCredentials basicCredentials = new BasicCredentials()
          .withAk(ak)
          .withSk(sk)
          .withSecurityToken(securityToken)
          .withProjectId(projectId)

    认证参数说明:

  4. 初始化客户端(二选一)
    • 指定region方式(推荐)
      // 增加region依赖
      import com.huaweicloud.sdk.ocr.v1.region.OcrRegion;
      
      // 初始化客户端认证信息,使用当前客户端初始化方式可不填 projectId/domainId
      ICredential auth = new BasicCredentials()
          .withAk(ak)
          .withSk(sk);
      // 初始化指定云服务的客户端 {Service}Client ,以初始化OCR服务的 OcrClient 为例
      OcrClient Client = OcrClient.newBuilder()
          .withHttpConfig(config)
          .withCredential(auth)
          .withRegion(OcrRegion.valueOf("cn-north-4"))
          .build();
    • 指定云服务endpoint方式
      // 指定终端节点,以OCR服务北京四的 endpoint 为例
      String endpoint = "https://ocr.cn-north-4.myhuaweicloud.com";
      // 初始化客户端认证信息,需要填写相应 projectId/domainId,以初始化 BasicCredentials 为例
      BasicCredentials basicCredentials = new BasicCredentials()
          .withAk(ak)
          .withSk(sk)
          .withProjectId(projectId);
      
      // 初始化指定云服务的客户端 {Service}Client ,以初始化 Region 级服务OCR的 OcrClient 为例
      OcrClient ocrClient = OcrClient.newBuilder()
          .withHttpConfig(config)
          .withCredential(basicCredentials)
          .withEndpoint(endpoint)
          .build();

      endpoint是华为云各服务应用区域和各服务的终端节点,详情请查看 地区和终端节点

  5. 发送请求并查看响应
    // 以调用通用表格识别接口 RecognizeGeneralTable 为例
    RecognizeGeneralTableRequest request = new RecognizeGeneralTableRequest();
    GeneralTableRequestBody body = new GeneralTableRequestBody();
    body.withUrl("图片的url");
    request.withBody(body);
    try {
        RecognizeGeneralTableResponse response = client.recognizeGeneralTable(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());
    }
  6. 异常处理
    表1 异常处理

    一级分类

    一级分类说明

    二级分类

    二级分类说明

    ConnectionException

    连接类异常

    HostUnreachableException

    网络不可达、被拒绝。

    SslHandShakeException

    SSL认证异常。

    RequestTimeoutException

    响应超时异常

    CallTimeoutException

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

    RetryOutageException

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

    ServiceResponseException

    服务器响应异常

    ServerResponseException

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

    ClientRequestException

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

    // 异常处理
    try {
        RecognizeGeneralTableRequest request = new RecognizeGeneralTableRequest();
    
        RecognizeGeneralTableResponse response = client.recognizeGeneralTable(request);
        System.out.println(response.toString());
    } catch(ServiceResponseException e) {
        logger.error("HttpStatusCode: " + e.getHttpStatusCode());
        logger.error("RequestId: " + e.getRequestId());
        logger.error("ErrorCode: " + e.getErrorCode());
        logger.error("ErrorMsg: " + e.getErrorMsg());
    }

代码示例自动生成

API Explorer提供API检索及平台调试,支持全量快速检索、可视化调试、帮助文档查看、在线咨询。

您只需要在API Explorer中修改接口参数,即可自动生成对应的代码示例。同时,可在集成开发环境CloudIDE中完成代码的构建、调试、运行等操作。

图2 API Explorer
分享:

    相关文档

    相关产品

close