更新时间:2023-12-25 gmt 08:00

java sdk-凯发k8国际娱乐官网入口

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

准备工作

  • 注册华为帐号并开通华为云,并完成实名认证,帐号不能处于欠费或冻结状态。
  • 已具备开发环境,支持java jdk 1.8 及其以上版本。
  • 登录“ > 访问秘钥”页面,依据界面操作指引获取access key(ak)和secret access key(sk)。下载的访问秘钥为credentials.csv文件,包含ak/sk信息。

  • 登录“”页面,获取“iam用户名”“帐号名”以及待使用区域的“项目id”。调用服务时会用到这些信息,请提前保存。

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

    图1 我的凭证

安装sdk

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

使用sdk前,需要安装“huaweicloud-sdk-core”和“huaweicloud-sdk-ocr”。请在获取最新的sdk包版本,替换代码中版本。


    com.huaweicloud.sdk
    huaweicloud-sdk-core
    3.1.5


    com.huaweicloud.sdk
    huaweicloud-sdk-ocr
    3.1.5

当出现第三方库冲突的时,如jackson,okhttp3版本冲突等。可以引入如下bundle包(3.0.40-rc版本后),该包包含所有支持的服务和重定向了sdk依赖的第三方软件,避免和业务自身依赖的库产生冲突:


    com.huaweicloud.sdk
    huaweicloud-sdk-bundle
    [3.0.40-rc, 3.1.0)

jackson版本要求请见。sdk常见报错请参考代码运行报错json解析报错

开始使用

  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证书验证
      // 执行sdk时出现javax.net.ssl.sslhandshakeexception: received fatal alert: handshake_failure报错,可添加此代码,跳过ssl证书验证
      config.withignoresslverification(true);
  3. 配置认证信息

    配置ak、sk、project_id信息。华为云通过ak识别用户的身份,通过sk对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。有两种认证方式,分别如下。

    • 初始化认证信息:
      string ak = system.getenv("huaweicloud_sdk_ak");
      string sk = system.getenv("huaweicloud_sdk_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)
    • 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
    • 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量huaweicloud_sdk_ak和huaweicloud_sdk_sk。

    认证参数说明:

    • ak、sk:访问秘钥信息,获取方法请参见准备工作
    • projectid:华为云项目id,获取方法请参见准备工作
    • securitytoken:临时认证场景下的安全票据,可以或者。
  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.with;
    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());
    }

使用异步客户端,配置日志等操作,请参见、,sdk使用方法可参考。

代码示例自动生成

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

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

图2 api explorer

代码运行报错

  • java.lang.noclassdeffounderror: could not initialize class com.huaweicloud.sdk.core.http.httpconfig at com.huaweicloud.sdk.core.clientbuilder.build(clientbuilder.java:98)

    httpconfig 这个类在sdk-core 包里面找不到,造成原因为用户使用的sdk版本太老导致,建议使用的华为云java sdk,运行代码再具体定位。

  • java.lang.nosuchfielderror: allow_leading_decimal_point_for_numbers

    这个字段是 jackson-core 里面用来标识解析json格式数据是否支持前导小数点的字段,这个报错的意思是找不到这个字段,很可能是因为用户使用的jackson 版本太老导致。

    建议客户本地将jackson 版本升级到和华为云 java sdk一致,jackson版本要求请见。

    引用华为云java sdk的来解决 jackson 版本冲突的问题。

    
        com.huaweicloud.sdk
        huaweicloud-sdk-bundle
        [3.0.40-rc, 3.1.0)
    
  • java.lang.classnotfoundexception: com.fasterxml.jackson.datatype.jsr310.javatimemodule

    用户本地工程引入了jackson 框架,和 华为云sdk引入的jackson 框架冲突了,导致会报找不到某个类,建议 客户在本地引入报来避免出现依赖冲突。

    
        com.huaweicloud.sdk
        huaweicloud-sdk-bundle
        [3.0.40-rc, 3.1.0)
    
  • java.lang.classnotfoundexception: okhttp3/interceptor

    用户本地引入的okhttp3 版本和 华为云冲突,okhttp版本要求请见。

  • info com.huaweicloud.sdk.core.hcclient - project id of region 'cn-north-4' not found in basiccredentials, trying to obtain project id from iam service: https://iam.myhuaweicloud.com

    调用服务对应终端节点下的项目id没有生成。

    在“”页面中查看对应终端节点的项目id,确认系统中没有生成。在将终端节点切换至调用服务所在的终端节点,之后前往“我的凭证”页面,即可查看到已生成对应的项目id。

json解析报错

图3 json parse error
  • 服务端返回的数据格式不符合json格式,导致sdk侧解析json数据报错。
  • 服务端返回的json 数据 不符合json反序列化的规则,和sdk定义的数据结构不一致,导致反序列化失败。
  • sdk json 数据解析问题。

建议排查服务端返回的数据是否和服务sdk设计的结构、字段一致。

分享:
网站地图