常见问题

更新时间:

本文档旨在帮助开发者快速接入和使用JAVA SDK,重点解答使用过程中遇到的常见问题,确保开发者能够准确且高效地进行相关操作。

环境检查

  • 确保Java语言环境已经正确安装,Java版本 >= 1.8。

  • 确保您的网络能够访问阿里云的API。

问题列表

问题1:运行时,提示“java.lang.NullPointerException: Cannot invoke "java.util.Map.get(Object)" because the return value of "com.aliyun.tea.TeaException.getData()" is null at ...”。

可能是因为您没有正确地设置阿里云的访问密钥(AccessKey)。

错误示例:

 Config config = new Config()
         // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
         .setAccessKeyId(System.getenv("LTAI5tA******"))
         // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
         .setAccessKeySecret(System.getenv("0wpTxkN******"));

正确示例:

Config config = new Config()
        // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
        .setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
        // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
        .setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));

建议做法:

重要

切勿直接在代码中明文写入 AccessKey 的值。该写法存在安全隐患。

说明

System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")和System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),表示是从环境变量中获取ALIBABA_CLOUD_ACCESS_KEY_ID及ALIBABA_CLOUD_ACCESS_KEY_SECRET的值。

  • 检查您的环境变量中是否配置有ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。

  • 在终端(Linux/macOS)或单击开始(或快捷键:Win+R)>运行(输入 cmd)>确定(或按 Enter 键),打开命令提示符(Windows),执行以下命令。若返回正确的AccessKey,则说明配置成功。如果返回为空或错误,请尝试重新设置,具体操作请参见设置访问凭据

Windows

echo %ALIBABA_CLOUD_ACCESS_KEY_ID%
echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%

Linux/macOS

echo $ALIBABA_CLOUD_ACCESS_KEY_ID
echo $ALIBABA_CLOUD_ACCESS_KEY_SECRET

问题2:运行时,提示“java: 错误:不支持发行版本 X”。

同时按下Ctrl+Alt+Shift+S,进入Project Structure窗口。选择Modules,在右侧Language Level中选择跟您所使用JDK版本一致的版本,例如您所使用的JDK 8,Language Level选择“8 - Lambdas, type annotations etc. ”。单击Apply,单击OK。

image

问题3:运行时,提示“java: Compilation failed: internal java compiler error”。

在IntelliJ IDEA菜单栏,单击File->Settings->Build, Execution, Deployment->Compiler->Java Compiler,Project bytecode version和Target bytecode version选择跟您所使用JDK版本一致的版本,例如您所使用的JDK 8,这两项选择 8 即可。单击Apply,单击OK。

image

问题4:运行时,提示“code: 400, <CERTAIN_FIELD > is mandatory for this action... ...”

此问题的直接原因在于在调用API时未填写必填参数。解决方案:

这里以调用短信服务的SendSms接口为例:

  • 进入OpenAPI门户的API调试页面,选择云产品和接口。

  • 仔细对比构造的请求对象(如 SendSmsRequest)是否填充了所有必需字段,例如手机号、签名等。

  • 参考API文档确认必填项。确保必填参数值正确。

  • 确保填写的必填参数值正确无误,例如手机号格式是否符合要求。

  • 在调用 API 前,SDK 会对参数进行自动校验。如果缺少必要参数,您将收到类似 MissingRequiredParameter 的错误提示。例如,如果手机号参数缺失,会报错 “MissingPhoneNumbers: code: 400”。

image

SendSmsRequest sendSmsRequest = new SendSmsRequest()
        //需要替换成为您接收短信的手机号码
        .setPhoneNumbers("<YOUR_VALUE>")
        //需要替换成为您的短信签名
        .setSignName("<YOUR_VALUE>")
        //需要替换成为您的短信模板code
        .setTemplateCode("<YOUR_VALUE>");

问题5:运行时,提示“java.lang.NoSuchMethodError”。

NoSuchMethodError异常多由依赖包版本冲突造成,主要因为在编译与运行时使用了不同版本的依赖包,类加载器在编译时检索到未定义方法/字段/类。解决方案:

  • 若是直接使用jar的用户,可能是某些子级jar未依赖。根据堆栈排查缺失的jar包即可。

  • 若是使用maven/gradle等包管理器用户,可能是子级依赖冲突导致项目编译时使用的是低版本的包导致。可根据堆栈排查冲突的依赖并指定高版本即可。

问题6:调用API时可能出现超时情况,提示信息包括:“java.net.SocketTimeoutException:connect timed out”、 “java.net.SocketTimeoutException:Read timed out”、 “SDK.ServerUnreachable”、 “Connection aborted”或“RemoteDisconnected”。

超时问题可能由多种因素引起,以下是一些常见的原因及相应的解决步骤:

网络连接问题

情况描述:客户端与服务器之间的网络不通或网络不稳定导致请求无法到达目标服务器。

解决方案:

  • 使用命令ping [www.example.com/192.168.x.x]curl -Is https://xxx.xxx.xx检查网络连通性。当遇到网络不通时,应在防火墙或路由器中检查是否有阻断策略;对于网络不稳定的情况,建议更换网络环境。

  • 通过配置延长超时时间, 具体操作请参见超时机制。例如通过配置连接超时参数来延长连接超时时间,示例代码如下:

// 运行时参数超时设置,仅对使用了该运行时参数实例的请求有效
RuntimeOptions runtimeOptions = new RuntimeOptions();
runtimeOptions.connectTimeout = 5000;

API处理时间过长

情况描述:目标API处理请求的时间超过了设置的读超时时间。

解决方案:通过配置读超时时间来适应较长的API响应时间, 具体操作请参见超时机制。例如通过配置读超时时间参数来延长当前请求的读超时时间,示例代码如下:

// 运行时参数超时设置,仅对使用了该运行时参数实例的请求有效
RuntimeOptions runtimeOptions = new RuntimeOptions();
runtimeOptions.readTimeout = 10000;

问题7:运行时,提示“Your request is denied as lack of ssl protect.RequestId ...”。

此问题是由于接口要求使用HTTPS协议进行调用,而您可能使用了原版JavaSDK,采用了HTTP协议进行调用。解决方案:

  • V1.0 SDK 可以通过对 Request 对象设置请求通过 HTTPS 协议发送:

    request.setSysProtocol(com.aliyuncs.http.ProtocolType.HTTPS);
  • 使用V2.0SDK,V2.0SDK默认使用HTTPS协议。

问题8:运行时,提示“code: 404, Specified api is not found, please check your url and method.”。

此类错误的直接原因可能是您在调用某产品API时,填写了错误的Endpoint或RegionId。解决方法如下:

确保您所选区域支持您正在调用的服务。产品的Endpoint可以通过OpenAPI 开发者门户的产品主页中进行查找,这里以短信服务为例。image

问题9:运行时,提示“Unexpected response code for CONNECT: 400”。

此问题直接原因为请求未发送到阿里云网关,被中间节点截断。解决方案:

  • 可能是代理配置错误,例如您配置的是setHttpProxy,V2.0 SDK默认发送HTTPS请求,即代理不生效会引发此报错。可通过配置协议类型为HTTP尝试解决,config.protocol = "HTTP"。

  • 可能代理服务配置错误,即代理服务无法正确转发请求到阿里云网关,可通过curl检查代理配置是否正确。curl https://<阿里云服务域名>/ -v -x <代理IP/代理域名>:<代理端口>,例如curl https://ecs-cn-hangzhou.aliyuncs.com/ -v -x 127.0.0.1:3128。

  • 可能被内网防火墙拦截,本地环境可尝试切换网络环境测试,例如连接移动网络热点。

问题10:运行时,提示“Specified signature does not match our calculation. server StringToSign is ...”。

此问题直接原因为客户端签名参数和服务端计算得到签名参数不匹配导致报错。解决方案:

在绝大多数场景中,用户SK填写信息存在错误,因此应首先重新生成一版新的AK,然后再进行后续的排查。

  • 升级SDK子级依赖openapiutil到最新版本。

  • 通过抓取请求包,检查网络层面是否遭遇字段拦截。

  • 代码调试,检查客户端是否存在特殊字符导致的转码异常。

  • 检查以下依赖包版本是否过低。

     <dependency>
       <groupId>commons-codec</groupId>
       <artifactId>commons-codec</artifactId>
       <version>1.15</version>
     </dependency>
  • 检查是否在并发场景重新new request,request并不线程安全。

问题11:运行时,提示“Can not set java.lang.String field com.aliyun.imm20200930.models.GenerateWebofficeTokenShrinkRequest.userShrink to java.util ...”。

此问题直接原因为低版本Tea包无法将复杂结构转化为String结构导致报错。解决方案:

升级Tea包到1.2.7及以上。

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>tea</artifactId>
  <version>1.2.7</version>
</dependency>

问题12:IDEA中使用Maven自动下载依赖失败。

  • 更新Maven仓库

    打开”File“菜单,选择”Settings“(或”Preferences“)。左侧导航栏中,展开“Build, Execution, Deployment”,然后选择“Build Tools” > “Maven”。找到“Repositories”选项卡,选择本地仓库,点击“Update”按钮,等待更新完成。tempsnip

  • 检查IDEA缓存

    打开“File”菜单,选择“Invalidate Caches…”,在弹出的对话框中,选择“Invalidate and Restart”,等待IDEA清理缓存并重新启动。

    image

  • 检查网络链接

    如果Maven无法连接到中央仓库或其他远程仓库,它可能会无法下载依赖项。确保您的网络连接正常,并且没有任何防火墙或代理服务器阻止Maven的访问。

  • 检查Maven配置

    检查Maven配置文件(通常是settings.xml)是否正确配置。确保”localRepository“指向正确的本地仓库路径,”mirrors”、”proxies“、”profiles“正确配置。

问题13:NoPermission : You are not authorized to do this operation. Action: xxxx。

image

此问题的直接原因在于未为调用所属账号授予所需API的权限。解决方案:

  1. 权限诊断:使用诊断平台进行权限检查。请登录OpenAPI自助诊断进行排查。

  2. 权限授予:检查调用所属账号是否具有所调用API的权限,如果没有权限则需要为其授予相应的API权限。具体操作,请参见为RAM用户授权

  3. 权限验证:授权完成后,请重新尝试执行原操作,确认权限已正确授予所属账号。

问题14:使用反射导致的警告(WARNING)信息如何避免。

image.png

在阿里云 SDK 的使用中,当使用较高版本的JDK进行开发时,可能会遇到与反射相关的警告信息,这些警告信息可能影响程序的输出,尤其是当您希望在生产环境中避免不必要的日志信息时。

解决方案:

您可以通过设置环境变量 ALIBABA_CLOUD_SDK_LOG_LEVEL 将日志级别调整为 ERROR,以抑制警告信息的显示。操作步骤:

  1. 设置环境变量:

    Windows

    set ALIBABA_CLOUD_SDK_LOG_LEVEL=ERROR

    Linux/macOS

    export ALIBABA_CLOUD_SDK_LOG_LEVEL=ERROR
  2. 确认环境变量设置:

    Windows

    echo %ALIBABA_CLOUD_SDK_LOG_LEVEL%

    Linux/macOS

    echo $ALIBABA_CLOUD_SDK_LOG_LEVEL
  3. 启动您的应用程序:在您配置好环境变量后,启动您的 Java 应用程序。此时,阿里云 SDK 产生的警告信息将不会被显示,您只会看到ERROR级别或更高的日志信息。

说明
  • 如果您需要更改日志级别以调试或开发,可以将环境变量的值更改为DEBUGINFO

问题15:报错“Specified signature does not match our calculation”。

image.png

此问题直接原因通常是由于请求的签名与服务器计算的签名不匹配引起的。可能的原因包括:

  • Access Key (AK) 复制错误

  • 签名算法不正确

  • 检查请求参数及其顺序是否符合API要求。

确保在代码中设置的Access Key和Secret Key与您在控制台上获取的完全一致。检查是否有多余的空格或者特殊字符。解决方案:

升级commons-codec版本,以避免潜在的签名计算错误:image.png

更新依赖:

Maven

修改pom.xml文件

   <dependency>
       <groupId>commons-codec</groupId>
       <artifactId>commons-codec</artifactId>
       <version>1.15</version> <!-- 更新后的版本 -->
   </dependency>

进行版本号更新后,执行以下命令:

mvn clean install

Gradle

build.gradle文件中添加或更新依赖:

dependencies {
     implementation 'commons-codec:commons-codec:1.15' // 更新后的版本
}

执行以下命令以构建项目:

gradle build

问题16:使用RAM用户请求STS临时签名时,提示:SDK.EndpointResolvingError :” No such region 'cn-XX'. Please check your region ID“。

此问题直接原因是由于SDK版本过低导致无法支持新区域或接口的调用,解决方案:

升级SDK依赖版本:

Maven

如果您使用 Maven 进行项目管理,请在 pom.xml 文件中更新依赖版本:

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-core</artifactId>
  <version>4.7.2</version>
</dependency>

<dependency>
  <groupId>com.aliyun</groupId>
  <artifactId>aliyun-java-sdk-sts</artifactId>
  <version>3.1.2</version>
</dependency>

Gradle

如果您使用 Gradle 进行项目管理,请在 build.gradle 文件中更新依赖版本:

dependencies {
    implementation 'com.aliyun:aliyun-java-sdk-core:4.7.2'
    implementation 'com.aliyun:aliyun-java-sdk-sts:3.1.2'
}

Java语言基础异常自查表

报错信息

错误原因

解决方案

NullPointerException

尝试在一个空对象上调用方法或访问属性。

在使用对象之前,先进行空对象判断(null check)以避免空指针异常。可以使用条件语句或断言来进行判断。

ArrayIndexOutOfBoundsException

尝试访问数组中不存在的索引。

确保数组索引在有效范围内,即大于等于0且小于数组长度。可以使用循环结构或条件语句来避免数组越界异常。

IllegalArgumentException

方法接收到一个不合法的参数。

检查传递给方法的参数,确保其满足方法的要求。可以使用条件语句或断言进行参数合法性检查。

ArithmeticException

在算术运算中发生了异常,例如除以0。

在进行算术运算之前,先进行必要的判断和处理,确保不会出现异常情况。可以使用条件语句或异常处理机制来处理算术异常。

ClassCastException

尝试将一个对象转换为不兼容的类型。

在进行类型转换之前,先使用 instanceof 运算符进行类型检查,确保对象的类型是兼容的。如果类型不兼容,可以考虑使用合适的类型转换或者重新设计对象的继承关系。

FileNotFoundException

尝试打开一个不存在的文件。

确保文件路径和文件名正确,并且文件存在于指定的位置。可以使用条件语句或异常处理机制来处理文件未找到异常。

IOException

在进行输入输出操作时发生了异常,如读写文件、网络通信等。

检查输入输出操作的正确性,确保文件或资源可用,并处理可能的异常情况。可以使用异常处理机制来处理输入输出异常。

InterruptedException

在进行多线程操作时,线程被意外中断。

在处理多线程操作时,对线程中断进行适当的处理。可以使用异常处理机制或条件判断来处理线程中断异常。

NoSuchMethodException

尝试调用一个不存在的方法。

检查方法名和参数是否正确,并确保调用的方法存在。可以使用条件语句或异常处理机制来处理方法不存在异常。

NumberFormatException

将一个无法转换为数字的字符串转换为数字。

在进行字符串转换为数字的操作时,先进行合理的校验,确保字符串能够正确转换为数字。可以使用条件语句或异常处理机制来处理数字格式异常。

IndexOutOfBoundsException

尝试访问列表或字符串中不存在的索引。

确保索引在有效范围内,即大于等于0且小于列表或字符串的长度。可以使用条件语句或异常处理机制来处理索引越界异常。

UnsupportedOperationException

尝试调用一个不支持的方法或操作。

查阅文档或API文档,了解支持的方法和操作。确保方法或操作在当前环境下是可行的。

IllegalMonitorStateException

在不合适的时候调用 wait()、notify() 或 notifyAll() 方法。

确保在同步代码块中正确使用 wait()、notify() 或 notifyAll() 方法。可以使用条件语句或异常处理机制来处理非法的监视器状态异常。

SecurityException

尝试执行违反安全规则的操作,如未授权的访问、文件权限等。

检查代码中的安全规则,确保不违反安全规则。可以根据安全规则进行相应的调整和修改。

ClassNotFoundException

尝试加载一个不存在的类。

在SDK中一般是依赖冲突,即低版本依赖抢占了索引,导致V2.0 SDK的类不存在。检查类名和类路径是否正确,并确保所需的类存在。可以使用条件语句或异常处理机制来处理类未找到异常。

NoSuchFieldException

尝试访问一个不存在的字段。

在SDK中一般是依赖冲突,即低版本依赖抢占了索引,导致V2.0 SDK的方法不存在。确保字段名正确,并确保访问的字段存在。可以使用条件语句或异常处理机制来处理字段不存在异常。

技术支持

以上问题的解决方案旨在帮助您更友好地使用阿里云SDK。如果您在使用过程中遇到其他问题,请通过以下方式与我们联系:

  • 提交工单:阿里云提交工单页面

  • 如果您有相关需求或反馈,可以添加钉钉群联系阿里云技术支持人员,群号为60965016010。