网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
文档首页/ 对象存储服务 OBS/ SDK参考/ Java/ 初始化(Java SDK)/ 创建并配置客户端(Java SDK)

创建并配置客户端(Java SDK)

更新时间:2025-01-09 GMT+08:00
分享

操作场景

本章节指导客户创建并配置客户端,该任务是使用SDK与OBS交互的必备前置任务。如果您已有客户端,请跳过该节,直接参考Java SDK接口概览(Java SDK)获取接口信息。

前提条件

初始化客户端之前,您需要先完成以下几项准备工作:

  1. 使用前须知(Java SDK):了解并选择合适的SDK版本。
  2. 使用前准备(Java SDK):完成服务环境和开发环境准备。
  3. 下载与安装SDK(Java SDK):下载SDK并完成安装。

注意事项

  • 客户端在创建时必须同步完成客户端配置,配置机会仅有一次,创建完成后,不能对客户端进行二次配置。
  • 在使用临时aksk时,aksk会有过期时间,可调用ObsClient.refresh("yourAccessKey", "yourSecretKey", "yourSecurityToken")刷新ObsClient的aksk,不必重新创建ObsClient。
  • 建议整个代码工程全局使用一个ObsClient客户端,只在程序初始化时创建一次,因为创建多个ObsClient客户端在高并发场景下会影响性能。
  • ObsClient是线程安全的,可在并发场景下使用。
  • ObsClient在调用ObsClient.close方法关闭后不能再次使用,保证全局使用一个ObsClient客户端的情况下,不建议主动关闭ObsClient客户端。

配置概览

图1 创建并配置客户端概览

所示,请根据需要选择客户端类、选择获取访问密钥的方法,以及进行其他配置:

表1 创建并配置客户端概览

选择项

可选项

说明

示例代码

客户端类

不透传密钥的客户端类

如果您只想配置一次访问凭证,不想在每一次调用OBS接口时都为客户端设置一次访问密钥,请使用普通客户端类ObsClient创建客户端。

ObsClient示例代码

透传密钥的客户端类

如果您需要在每次调用接口时,都为客户端设置一次访问凭证,OBS Java SDK提供了直接在接口方法中透传AK和SK的OBS客户端类SecretFlexibleObsClient,SecretFlexibleObsClient继承自ObsClient。

SecretFlexibleObsClient示例代码

访问凭证获取方式

从变量传入

创建OBS客户端实例,并使用变量传入方式的访问凭证。

从环境变量获取

创建OBS客户端实例,并使用EnvironmentVariableObsCredentialsProvider从环境变量获取访问凭证。

EnvironmentVariableObsCredentialsProvider示例代码

ECS场景从云服务委托获取

创建OBS客户端实例,并使用EcsObsCredentialsProvider从ECS服务器自动获取临时访问密钥,并且访问凭证会定期自动刷新。

须知:
  1. 使用EcsObsCredentialsProvider的前提,应用程序须运行在ECS服务器上,并且ECS绑定了IAM对ECS的云服务委托(该委托拥有OBS权限)。
  2. 请确保服务端和应用程序部署所在环境的UTC时间一致,否则可能会导致临时访问密钥无法及时刷新。
  3. 使用该方式创建客户端时,SDK会请求固定IP(169.254.169.254)的API获取临时AKSK,具体请参见在ECS上获取Security Key

EnvironmentVariableObsCredentialsProvider示例代码

链式获取

以链式的方式从预定义方式列表中搜索访问密钥,以第一组成功获取到的访问密钥创建OBS客户端。

当前顺序是默认先从环境变量,再从ECS服务器委托中进行搜索,暂不支持自定义获取方式和顺序。

OBSCredentialsProviderChain示例代码

其他配置

只配置终端节点(endpoint)

除了访问凭证外,只配置中终端节点(endpoint)参数。

除访问凭证外只配置endpoint示例代码

除了配置终端节点(endpoint)还有其他配置

除了配置终端节点(endpoint)还需要配置HTTP代理、Socket层传输数据超时时间等参数,您可通过ObsConfiguration配置类对ObsClient进行配置,支持的配置项参见表2

ObsConfiguration示例代码

示例代码

  • 使用不透传访问凭证的客户端类,直接配置访问凭证,除访问凭证外只配置终端节点(endpoint)的示例代码
    • 永久访问密钥(AK/SK)创建OBS客户端的代码如下:
       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      // Endpoint以北京四为例,其他地区请按实际情况填写。
      String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
      // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
      // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
      String ak = System.getenv("ACCESS_KEY_ID");
      String sk = System.getenv("SECRET_ACCESS_KEY_ID");
      // 创建ObsClient实例
      ObsClient obsClient = new ObsClient(ak, sk, endPoint);
       
      // 使用访问OBS
              
      // 关闭obsClient
      obsClient.close();
      
    • 临时访问密钥(AK/SK/SecurityToken)创建OBS客户端的代码如下:
       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      14
      // Endpoint以北京四为例,其他地区请按实际情况填写。
      String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
      // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
      // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
      String ak = System.getenv("ACCESS_KEY_ID");
      String sk = System.getenv("SECRET_ACCESS_KEY_ID");
      String securityToken = System.getenv("SECRET_TOKEN");
      // 创建ObsClient实例
      ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);
       
      // 使用访问OBS
              
      // 关闭obsClient
      obsClient.close();
      
    • BasicObsCredentialsProvider示例代码
       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      // Endpoint以北京四为例,其他地区请按实际情况填写。
      String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
      // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
      // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
      String ak = System.getenv("ACCESS_KEY_ID");
      String sk = System.getenv("SECRET_ACCESS_KEY_ID");
      // 创建ObsClient实例
      ObsClient obsClient = new ObsClient(new BasicObsCredentialsProvider(ak, sk), endPoint);
       
      // 使用访问OBS
              
      // 关闭obsClient
      obsClient.close();
      
  • 透传密钥客户端类(SecretFlexibleObsClient)示例代码
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    // Endpoint以北京四为例,其他地区请按实际情况填写。
    String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
    // 创建ObsConfiguration配置类实例
    ObsConfiguration config = new ObsConfiguration();
    config.setEndPoint(endPoint);
    
    // 创建SecretFlexibleObsClient实例
    SecretFlexibleObsClient obsClient = new SecretFlexibleObsClient(config);
    // 使用访问OBS
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
    // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
    String ak1 = System.getenv("ACCESS_KEY_ID");
    String sk1 = System.getenv("SECRET_ACCESS_KEY_ID");
    obsClient.listBuckets(ak1, sk1);
    
    String ak2 = System.getenv("ACCESS_KEY_ID");
    String sk2 = System.getenv("SECRET_ACCESS_KEY_ID");
    obsClient.listBuckets(ak2, sk2);
    
    // 关闭obsClient
    obsClient.close();
    
  • 从环境变量获取访问凭证(EnvironmentVariableObsCredentialsProvider)示例代码
    使用该方法需要在环境变量中定义OBS_ACCESS_KEY_ID和OBS_SECRET_ACCESS_KEY分别代表永久的AK和SK。
    1
    2
    3
    4
    5
    6
    7
    8
    9
    // Endpoint以北京四为例,其他地区请按实际情况填写。
    String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
    // 创建ObsClient实例
    ObsClient obsClient = new ObsClient(new EnvironmentVariableObsCredentialsProvider(), endPoint);
     
    // 使用访问OBS
            
    // 关闭obsClient
    obsClient.close();
    
  • ECS场景从云服务委托获取访问凭证(EcsObsCredentialsProvider)示例代码
    1
    2
    3
    4
    5
    6
    7
    8
    9
    // Endpoint以北京四为例,其他地区请按实际情况填写。
    String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
    // 创建ObsClient实例
    ObsClient obsClient = new ObsClient(new EcsObsCredentialsProvider(), endPoint);
     
    // 使用访问OBS
            
    // 关闭obsClient
    obsClient.close();
    
  • 链式获取访问凭证(OBSCredentialsProviderChain)示例代码
    1
    2
    3
    4
    5
    6
    7
    8
    9
    // Endpoint以北京四为例,其他地区请按实际情况填写。
    String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
    // 创建ObsClient实例
    ObsClient obsClient = new ObsClient(new OBSCredentialsProviderChain(), endPoint);
     
    // 使用访问OBS
            
    // 关闭obsClient
    obsClient.close();
    
  • 使用ObsConfiguration配置参数示例代码
    • 配置KeyManagerFactory,配置后可以在本地保存证书,并校验服务端返回证书是否正确。
       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      // Endpoint以北京四为例,其他地区请按实际情况填写。
      String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
      // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
      // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
      String ak = System.getenv("ACCESS_KEY_ID");
      String sk = System.getenv("SECRET_ACCESS_KEY_ID");
      
      String jksPassword = "you-jks-password";
      String jksPath = "/path/to/your/keystore/file";
      KeyStore ks = KeyStore.getInstance("JKS");
      char[] passArray = jksPassword.toCharArray();
      FileInputStream inputStream = new FileInputStream(jksPath);
      ks.load(inputStream, passArray);
      KeyManagerFactory kmf = KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm());
      kmf.init(ks, passArray);
      
      String trustJKSPassword = "you-trustJKS-password";
      String trustJKSPath = "/path/to/your/trustKeyStore/file";
      KeyStore trustKeyStore = KeyStore.getInstance("JKS");
      char[] trustPassArray = trustJKSPassword.toCharArray();
      FileInputStream trustInputStream = new FileInputStream(trustJKSPath);
      trustKeyStore.load(trustInputStream, trustPassArray);
      TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
      tmf.init(trustKeyStore);
      
      ObsConfiguration config = new ObsConfiguration();
      config.setEndPoint(endPoint);
      config.setKeyManagerFactory(kmf);
      config.setTrustManagerFactory(tmf);
      
      ObsClient obsClient = new ObsClient(ak, sk, config);
      
      说明:

      本地证书保存格式应为 jks 格式,可以运行以下命令调用 Java 自带的 keytool 工具将 cer 证书转换为 jks 证书。

      keytool -import -file your-cer-file.cer -keystore your-keystore-file.jks
    • 配置 HTTP 代理,配置后SDK 将会通过的代理访问服务端。
       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      14
      15
      16
      // Endpoint以北京四为例,其他地区请按实际情况填写。
      String endPoint = "https://obs.cn-north-4.myhuaweicloud.com";
      // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
      // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
      String ak = System.getenv("ACCESS_KEY_ID");
      String sk = System.getenv("SECRET_ACCESS_KEY_ID");
      
      // Url不要携带协议头"http://"和"https://"。
      String proxyUrl = "proxy.com";
      int proxyPort = 8080;
      String proxyUser = "userName";
      String proxyPassword = "password";
      ObsConfiguration config = new ObsConfiguration();
      config.setEndPoint(endPoint);
      config.setHttpProxy(proxyUrl, proxyPort, proxyUser, proxyPassword);
      ObsClient obsClient = new ObsClient(ak, sk,config);
      

配置自定义域名访问obs

使用自定义的域名,必须在工信部完成备案,具体配置步骤请参考:配置自定义域名

// 在控制台绑定成功的自定义域名。
String endPoint = "http://your-domain";
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量ACCESS_KEY_ID和SECRET_ACCESS_KEY_ID。
// 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
String ak = System.getenv("ACCESS_KEY_ID");
String sk = System.getenv("SECRET_ACCESS_KEY_ID");

// 创建ObsConfiguration配置类实例
ObsConfiguration config = new ObsConfiguration();
config.setEndPoint(endPoint);
config.setCname(true);

// 创建ObsClient实例
ObsClient obsClient = new ObsClient(ak, sk, config);

// 使用Provider创建ObsClient实例
// ObsClient obsClient = new ObsClient(new EnvironmentVariableObsCredentialsProvider(), config);
// ObsClient obsClient = new ObsClient(new EcsObsCredentialsProvider(), config);

// 使用访问OBS

// 关闭obsClient
obsClient.close();

ObsConfiguration类支持配置的参数列表

说明:
  • 如需提高文件上传下载性能,在网络带宽满足的情况下,可对socketWriteBufferSize,sockeReadBufferSize,readBufferSize,writeBufferSize四个参数进行调优。
  • 如网络状况不佳,建议增大connectionTimeout和socketTimeout的值。
表2 ObsConfiguration类支持配置的参数列表

参数

描述

方法

建议值

connectionTimeout

参数解释:

建立HTTP/HTTPS连接的超时时间。

默认取值:

60000,单位:毫秒。

ObsConfiguration.setConnectionTimeout

[10000, 60000]

socketTimeout

参数解释:

Socket层传输数据的超时时间(单位:毫秒)。

默认取值:

60000,单位:毫秒。

ObsConfiguration.setSocketTimeout

[10000, 60000]

idleConnectionTime

参数解释:

如果空闲时间超过此参数的设定值,则关闭连接。

默认取值:

30000,单位:毫秒。

ObsConfiguration.setIdleConnectionTime

根据实际情况设置

maxIdleConnections

参数解释:

连接池中最大空闲连接数。

默认取值:

1000,单位:个。

ObsConfiguration.setMaxIdleConnections

根据实际情况设置

maxConnections

参数解释:

最大允许的HTTP并发请求数。

默认取值:

1000,单位:个。

ObsConfiguration.setMaxConnections

默认

maxErrorRetry

参数解释:

请求失败(请求异常、服务端报500或503错误等)后最大的重试次数。

约束限制:

该参数对于上传对象和下载对象接口时,当上传或下载已经进入数据流处理阶段后产生异常中断,此时将不会重试。

默认取值:

3,单位:次。

ObsConfiguration.setMaxErrorRetry

[0, 5]

endPoint

参数解释:

连接OBS的服务地址。可包含协议类型、域名、端口号。示例:https://your-endpoint:443。(出于安全性考虑,建议使用https协议)

约束限制:

出于DNS解析性能和OBS服务可靠性的考虑,不允许将endPoint设置为IP,必须使用域名访问OBS服务,同时endpoint设置为IP还会导致使用path请求方式访问OBS桶,此方式已经禁止使用。(请在这个页面搜索并查看”禁止使用path请求方式访问OBS桶“相关说明)。

默认取值:

ObsConfiguration.setEndPoint

根据实际情况设置

httpProxy

参数解释:

HTTP代理配置。

默认取值:

默认为空

ObsConfiguration.setHttpProxy

根据实际情况设置

validateCertificate

参数解释:

是否验证服务端证书。

取值范围:

  • true:验证服务端证书。
  • false:不验证服务端证书。

默认取值:

false

ObsConfiguration.setValidateCertificate

根据实际情况设置

verifyResponseContentType

参数解释:

是否验证响应头信息的ContentType。

取值范围:

  • true:验证响应头信息的ContentType。
  • false:不验证响应头信息的ContentType。

默认取值:

true

ObsConfiguration.setVerifyResponseContentType

默认

readBufferSize

参数解释:

从Socket流下载对象的缓存大小,-1表示不设置缓存。

默认取值:

-1,单位:字节。

ObsConfiguration.setReadBufferSize

根据实际情况设置

writeBufferSize

参数解释:

上传对象到Socket流时的缓存大小,-1表示不设置缓存。

默认取值:

-1,单位:字节。

ObsConfiguration.setWriteBufferSize

根据实际情况设置

socketWriteBufferSize

参数解释:

Socket发送缓冲区大小,对应java.net.SocketOptions.SO_SNDBUF参数。

默认取值:

默认为-1,单位:字节,表示不设置。

ObsConfiguration.setSocketWriteBufferSize

默认

socketReadBufferSize

参数解释:

Socket接收缓冲区大小,对应java.net.SocketOptions.SO_RCVBUF参数。

默认取值:

默认为-1,单位:字节,表示不设置。

ObsConfiguration.setSocketReadBufferSize

默认

keyManagerFactory

参数解释:

用于生成javax.net.ssl.KeyManager的工厂。

默认取值:

默认为空。

ObsConfiguration.setKeyManagerFactory

根据实际情况设置

trustManagerFactory

参数解释:

用于生成javax.net.ssl.TrustManager的工厂。

默认取值:

默认为空。

ObsConfiguration.setTrustManagerFactory

根据实际情况设置

isStrictHostnameVerification

参数解释:

是否严格验证服务端主机名。设置为true后,需要通过javax.net.ssl.HttpsURLConnection.setDefaultHostnameVerifier去设置一个实现javax.net.ssl.HostnameVerifier接口的对象,用于验证主机名

取值范围:

  • true:严格验证服务端主机名。
  • false:不严格验证服务端主机名。

默认取值:

false

ObsConfiguration.setIsStrictHostnameVerification

根据实际情况设置

keepAlive

参数解释:

是否使用长连接访问OBS服务。

取值范围:

  • true:使用长连接访问OBS服务。
  • false:不使用长连接访问OBS服务。

默认取值:

true

ObsConfiguration.setKeepAlive

根据实际情况设置

cname

参数解释:

是否通过自定义域名访问OBS服务。

取值范围:

  • true:通过自定义域名访问OBS服务。
  • false:不通过自定义域名访问OBS服务。

默认取值:

false

ObsConfiguration.setCname

根据实际情况设置

sslProvider

参数解释:

SSLContext的Provider。

默认取值:

使用JDK提供的SSLContext。

ObsConfiguration.setSslProvider

根据实际情况设置

httpProtocolType

参数解释:

访问OBS服务端时使用的HTTP协议类型。

默认取值:

HTTP1.1

说明:

如果设置的endPoint不带协议类型,则默认使用HTTPS协议。

ObsConfiguration.setHttpProtocolType

根据实际情况设置

httpDispatcher

参数解释:

自定义分发器。

默认取值:

ObsConfiguration.setHttpDispatcher

根据实际情况设置

secureRandom

参数解释:

配置随机数生成器,支持设置为自定义的随机数生成器。

默认取值:

默认为 new SecureRandom()

说明:
  • 在某些平台上new SecureRandom()可能会使用不安全实现。出于安全考虑,建议通过ObsConfiguration.setSecureRandom()设置一个种子是真随机数的SecureRandom。
  • 当操作系统没有足够的熵来生成随机数时(比如系统刚启动时),那么生成真随机数的SecureRandom可能会阻塞,直到足够的熵可用为止。建议同时通过相关措施补充熵(例如linux下的haveged),改善熵源不足时生成真随机数阻塞的问题。

ObsConfiguration.setSecureRandom

根据实际情况设置

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容