全部产品
弹性计算 会员服务 网络 安全 移动云 数加·大数据分析及展现 数加·大数据应用 管理与监控 云通信 阿里云办公 培训与认证 智能硬件
存储与CDN 数据库 域名与网站(万网) 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 更多
对象存储 OSS

初始化

更新时间:2018-05-23 23:45:42

OSSClient是OSS的Java客户端,用于管理、操作Bucket和Object等OSS资源,它为调用者提供一系列与OSS进行交互的接口。使用Java SDK发起OSS请求,您需要初始化一个OSSClient实例,并根据需要修改ClientConfiguration的默认配置项。

新建OSSClient

要接入OSS,您需要有阿里云账号(注册阿里云账号)、有效的AccessKey (包括AccessKeyId和AccessKeySecret,申请AccessKey)和Endpoint。其中Endpoint可以有以下几种形式:

示例 说明
http://oss-cn-hangzhou.aliyuncs.com 用于公网访问杭州区域的Bucket。支持HTTP协议。
https://oss-cn-beijing.aliyuncs.com 用于公网访问北京区域的Bucket。支持HTTPS协议。
http://my-domain.com 用于用户自定义域名(CNAME)访问特定的Bucket。支持HTTP协议。

有关Endpoint的更多信息,请参见访问域名和数据中心自定义访问域名

获取AccessKeyId和AccessKeySecret之后,您便可以按照以下说明进行初始化。

使用OSS域名新建OSSClient

以下代码用于使用OSS域名新建OSSClient:

  1. // endpoint以杭州为例,其它region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. // 创建OSSClient实例。
  7. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret);
  8. // 关闭client。
  9. ossClient.shutdown();

说明:您的工程中可以有一个或多个OSSClient。OSSClient可以并发使用。

使用自定义域名(CNAME)新建OSSClient

以下代码用于使用自定义域名新建OSSClient:

  1. String endpoint = "<yourEndpoint>";
  2. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  3. String accessKeyId = "<yourAccessKeyId>";
  4. String accessKeySecret = "<yourAccessKeySecret>";
  5. // 创建ClientConfiguration实例,按照您的需要修改默认参数。
  6. ClientConfiguration conf = new ClientConfiguration();
  7. // 开启支持CNAME选项。
  8. conf.setSupportCname(true);
  9. // 创建OSSClient实例。
  10. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret, conf);
  11. // 关闭client。
  12. ossClient.shutdown();

说明:使用自定义域名时无法使用ossClient.listBuckets方法。

有关自定义域名的更多信息,请参见OSS自定义域名

专有云/专有域环境新建OSSClient

以下代码用于使用专有云或专有域环境新建OSSClient:

  1. // endpoint以杭州为例,其它region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. // 创建ClientConfiguration实例,按照您的需要修改默认参数。
  7. ClientConfiguration conf = new ClientConfiguration();
  8. // 关闭CNAME选项。
  9. conf.setSupportCname(false);
  10. // 创建OSSClient实例。
  11. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret, conf);
  12. // 关闭client。
  13. ossClient.shutdown();

使用IP新建OSSClient

以下代码用于使用IP新建OSSClient:

  1. // 某些特殊情况(比如专有域)下,您需要IP地址做作为endpoint,请按照实际IP填写。
  2. String endpoint = "http://10.10.10.10";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. // 创建ClientConfiguration实例,按照您的需要修改默认参数。
  7. ClientConfiguration conf = new ClientConfiguration();
  8. // 开启二级域名访问OSS,默认不开启,(OSS Java SDK 2.1.2以前的版本需要设置此值,OSS Java SDK 2.1.2以后的版本会自动检测到IP地址,不需要再调用setSLDEnabled设置)。
  9. conf.setSLDEnabled(true);
  10. // 创建OSSClient实例。
  11. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret, conf);
  12. // 关闭client。
  13. ossClient.shutdown();

使用STS新建OSSClient

以下代码用于使用STS新建一个OSSClient:

  1. // endpoint以杭州为例,其它region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. String securityToken = "<yourSecurityToken>";
  7. // 创建OSSClient实例。
  8. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret, securityToken);
  9. // 关闭client。
  10. ossClient.shutdown();

关于STS的介绍,请参见RAM和STS介绍。关于Java SDK的STS过期自动处理功能,请参见授权访问

配置OSSClient

以下代码用于使用ClientConfiguration设置OSSClient参数:

  1. // endpoint以杭州为例,其它region请按实际情况填写。
  2. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // 阿里云主账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM账号进行API访问或日常运维,请登录 https://ram.console.aliyun.com 创建RAM账号。
  4. String accessKeyId = "<yourAccessKeyId>";
  5. String accessKeySecret = "<yourAccessKeySecret>";
  6. // 创建ClientConfiguration实例(ClientConfiguration是OSSClient的配置类,可配置代理、连接超时、最大连接数等参数)。
  7. ClientConfiguration conf = new ClientConfiguration();
  8. // 设置OSSClient允许打开的最大HTTP连接数,默认1024。
  9. conf.setMaxConnections(200);
  10. // 设置Socket层传输数据的超时时间(单位:毫秒),默认为50000毫秒。
  11. conf.setSocketTimeout(10000);
  12. //设置建立连接的超时时间(单位:毫秒),默认为50000毫秒。
  13. conf.setConnectionTimeout(10000);
  14. //设置从连接池中获取连接的超时时间(单位:毫秒),默认不超时。
  15. conf.setConnectionRequestTimeout(1000);
  16. //如果空闲时间超过此参数的设定值,则关闭连接(单位:毫秒),默认为60000毫秒 。
  17. conf.setIdleConnectionTime(10000);
  18. // 设置失败请求重试次数,默认3次。
  19. conf.setMaxErrorRetry(5);
  20. //设置是否支持CNAME作为Endpoint,默认支持。
  21. conf.setSupportCname(true);
  22. //设置是否开启二级域名(Second Level Domain)的访问方式,默认不开启。
  23. conf.setSLDEnabled(true);
  24. //设置连接OSS所采用的协议(HTTP/HTTPS),默认为HTTP。
  25. conf.setProtocol(Protocol.HTTP);
  26. //设置用户代理,指HTTP的User-Agent头,默认为“aliyun-sdk-java”。
  27. conf.setUserAgent("aliyun-sdk-java");
  28. //设置代理服务器端口,默认值无。
  29. conf.setProxyHost("<yourProxyHost>");
  30. //设置代理服务器验证的用户名,默认值无。
  31. conf.setProxyUsername("<yourProxyUserName>");
  32. //设置代理服务器验证的密码,默认值无。
  33. conf.setProxyPassword("<yourProxyPassword>");
  34. // 创建OSSClient实例。
  35. OSSClient ossClient = new OSSClient(endpoint, accessKeyId, accessKeySecret, conf);
  36. // 关闭OSSClient。
  37. ossClient.shutdown();

关于Java SDK超时设置,请参见 阿里云OSS Java SDK超时时间设置

本文导读目录