文档首页/ 文字识别 OCR/ SDK参考/ Java SDK

更新时间：2024-12-12 GMT+08:00

查看PDF

Java SDK

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

准备工作

注册华为账号并开通华为云，并完成实名认证，账号不能处于欠费或冻结状态。
已具备开发环境，支持Java JDK 1.8 及其以上版本。
登录“我的凭证 > 访问密钥”页面，依据界面操作指引获取Access Key（AK）和Secret Access Key（SK）。下载的访问密钥为credentials.csv文件，包含AK/SK信息。
图1 新增访问密钥
登录“我的凭证”页面，获取“IAM用户名”、“账号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息，请提前保存。
本样例以“华北-北京四”区域为例，获取对应的项目ID（project_id）。

图2 我的凭证

安装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.1.125</version>
</dependency>
<dependency>
    <groupId>com.huaweicloud.sdk</groupId>
    <artifactId>huaweicloud-sdk-ocr</artifactId>
    <version>3.1.125</version>
</dependency>

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

<dependency>
    <groupId>com.huaweicloud.sdk</groupId>
    <artifactId>huaweicloud-sdk-bundle</artifactId>
    <version>[3.0.40-rc, 3.1.0)</version>
</dependency>

jackson版本要求请见pom.xml。SDK常见报错请参考代码运行报错、json解析报错。

开始使用

在开始使用之前，请确保您安装的是最新版本的SDK。使用过时的版本可能会导致兼容性问题或无法使用最新功能。您可以通过运行以下命令来检查SDK版本，并在SDK中心获取最新的SDK包版本。

mvn dependency:tree | grep huaweicloud-sdk-core
mvn dependency:tree | grep huaweicloud-sdk-ocr

导入依赖模块

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.*;

配置客户端连接参数

默认配置

// 使用默认配置
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);

配置认证信息
 配置AK、SK、project_id信息。华为云通过AK识别用户的身份，通过SK对请求数据进行签名验证，用于确保请求的机密性、完整性和请求者身份的正确性。有两种认证方式，分别如下。
- 初始化认证信息：
```
String ak = System.getenv("HUAWEICLOUD_SDK_AK");
String sk = System.getenv("HUAWEICLOUD_SDK_SK");
```
  - 认证用的 ak 和 sk 硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。
  - 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
  - 如果没有设置环境变量，可以去掉System.getenv方法调用，直接填写对应的 ak、sk，例如：String ak = "ak"; String sk = "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：访问密钥信息，获取方法请参见准备工作。
- projectId：华为云项目ID，获取方法请参见准备工作。
- securityToken：临时认证场景下的安全票据，可以通过token获取或者通过委托授权获取。

初始化客户端（二选一）

指定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是华为云各服务应用区域和各服务的终端节点，详情请查看地区和终端节点。

发送请求并查看响应

// 以调用通用表格识别接口 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());
}

异常处理

表1 异常处理
一级分类	一级分类说明	二级分类	二级分类说明
ConnectionException	连接类异常	HostUnreachableException	网络不可达、被拒绝。
ConnectionException	连接类异常	SslHandShakeException	SSL认证异常。
RequestTimeoutException	响应超时异常	CallTimeoutException	单次请求，服务器处理超时未返回。
RequestTimeoutException	响应超时异常	RetryOutageException	在重试策略消耗完成后，仍无有效的响应。
ServiceResponseException	服务器响应异常	ServerResponseException	服务端内部错误，Http响应码：[500,]。
ServiceResponseException	服务器响应异常	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中心、Java SDK使用指导，SDK使用方法可参考Java SDK使用视频。

代码示例自动生成

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

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

图3 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版本要求请见pom.xml。

引用华为云java sdk的bundle包来解决 jackson 版本冲突的问题。
```
<dependency>
    <groupId>com.huaweicloud.sdk</groupId>
    <artifactId>huaweicloud-sdk-bundle</artifactId>
    <version>[3.0.40-rc, 3.1.0)</version>
</dependency>
```
java.lang.ClassNotFoundException: com.fasterxml.jackson.datatype.jsr310.JavaTimeModule
用户本地工程引入了jackson 框架，和华为云sdk引入的jackson 框架冲突了，导致会报找不到某个类，建议客户在本地引入bundle包报来避免出现依赖冲突。
```
<dependency>
    <groupId>com.huaweicloud.sdk</groupId>
    <artifactId>huaweicloud-sdk-bundle</artifactId>
    <version>[3.0.40-rc, 3.1.0)</version>
</dependency>
```
java.lang.ClassNotFoundException: okhttp3/Interceptor
用户本地引入的Okhttp3 版本和华为云冲突，okhttp版本要求请见pom.xml。
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，确认系统中没有生成。在OCR控制台将终端节点切换至调用服务所在的终端节点，之后前往“我的凭证”页面，即可查看到已生成对应的项目ID。
Exception in thread "main" com.huaweicloud.sdk.core.exception.SdkException: java.net.NoRouteToHostException: No route to host: connect
配置认证信息获取AK/SK时，确认本地环境中是否设置了环境变量，没有环境变量可以去掉System.getenv方法调用，直接填写对应的 ak、sk，例如：String ak = "ak"; String sk = "sk"。

json解析报错

图4 json parse error
点击放大

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

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

智能分类服务入参报错

智能分类服务extended_parameters参数不传入map数组，sdk无法解析具体参数，会出现如下报错：

图5 the input parameter is invalid
点击放大

建议使用智能分类extended_parameters参数时传入map数组：

        Map<String,Map<String,Object>> map=new HashMap<>();
        Map<String,Object> inner = new HashMap<>();
        inner.put("return_issuing_authority",true);
        map.put("driver_license",inner);

图6 succeeded
点击放大

上一篇：文字识别SDK简介

下一篇：Python SDK

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

Java SDK

准备工作

安装SDK

开始使用

代码示例自动生成

代码运行报错

json解析报错

智能分类服务入参报错

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线