AI 助理
备案控制台
官方文档
输入文档关键字查找
首页

Java SDK实例程序

更新时间：
我的收藏

JAVA示例程序

AliyunOASClient和ArchiveManager

AliyunOASClient和ArchiveManager分别是低阶接口、高级接口的入口对象，在每个功能中都会使用到它们，为避免实例程序的冗长，将AliyunOASClient和ArchiveManager的创建在这里单独介绍。

注：在本文档中出现的 aliyunOASClient 均是 AliyunOASClient 实例，archiveManager 均是 ArchiveManager实例

AliyunOASClient实例化

  1. // AccessId和AccessKey配置
  2. ServiceCredentials credentials = new ServiceCredentials(
  3.     "[yourAccessId]", "[yourAccessKey]");
  4. // 配置客户端设置
  5. ClientConfiguration clientConf = new ClientConfiguration();
  6. // 指定要连接的服务地址
  7. ServiceHost serviceHost = new ServiceHost("http://cn-hangzhou.oas.aliyuncs.com");
  9. // 用OAS工厂获得AliyunOASClient对象
  10. AliyunOASClient aliyunOASClient = OASFactory.aliyunOASClientFactory(
  11.     serviceHost, credentials, clientConf);
  1. // 或者像下面这样，通过ServiceCredentials和url直接创建AliyunOASClient对象
  2. AliyunOASClient aliyunOASClient = OASFactory.aliyunOASClientFactory(
  3.     credentials, "http://cn-hangzhou.oas.aliyuncs.com");

ArchiveManager实例化

  1. // 使用默认配置
  2. ServiceCredentials credentials = new ServiceCredentials("[yourAccessKeyID]", "[yourAccessKeySecret]");
  4. ArchiveManager manager = OASFactory.archiveManagerFactory(
  5.     credentials, "http://cn-hangzhou.oas.aliyuncs.com");
  1. // 自定义配置ClientConfiguration
  2. ServiceCredentials credentials = new ServiceCredentials("[yourAccessKeyID]", "[yourAccessKeySecret]");
  3. // 指定要连接的服务地址
  4. ServiceHost serviceHost = new ServiceHost("http://cn-hangzhou.oas.aliyuncs.com");
  5. // 配置客户端设置
  6. ClientConfiguration clientConf = new ClientConfiguration();
  8. ArchiveManager archiveManager = new ArchiveManager(serviceHost, credentials, clientConf);
  1. // 使用AliyunOASClient初始化
  2. AliyunOASClient aliyunOASClient = OASFactory.aliyunOASClientFactory(
  3.     credentials, clientConf).withLogger();
  4. ArchiveManager archiveManager = OASFactory.archiveManagerFactory(aliyunOASClient);

Vault操作

创建Vault

  • 如果指定名称的Vault不存在，则创建Vault；
  • 如果指定名称的Vault已存在，不执行创建动作，返回Vault的信息。
  1. // vaultName必须满足已下2个条件：
  2. // 1. 总长度在3~63之间（包括3和63）；
  3. // 2. 只允许包含以下字符：
  4. //    0-9(数字),
  5. //    a-z(小写英文字母),
  6. //    -(短横线),
  7. //    _(下划线)
  8. // 其中 短横线 和 下划线 不能作为vaultName的开头和结尾；
  9. String vaultName = "oas_demo";
  11. // 发送创建vault请求
  12. // 创建Vault的名称，用CreateVaultRequest来指定
  13. CreateVaultRequest createRequest = new CreateVaultRequest().
  14.     withVaultName(vaultName);
  16. // 发起创建Vault的请求
  17. // 如果有同名的vault存在，OAS会返回已有的vault的vaultId，而不会执行创建动作
  18. try {
  19.     CreateVaultResult result = aliyunOASClient.createVault(createRequest);
  20.     logger.info("Vault created vaultId={}", result.getVaultId());
  21.     logger.info("Vault created vaultLocation={}", result.getLocation());
  22. } catch (OASClientException e) {
  23.     logger.error("OASClientException Occured:", e);
  24. } catch (OASServerException e) {
  25.     logger.error("OASServerException Occured:", e);
  26. }

删除Vault

  1. // 删除vault是高危动作，因此只能通过vaultId来删除
  2. DeleteVaultRequest deleteVaultRequest = new DeleteVaultRequest().withVaultId(yourVaultId);
  4. try {
  5.     OASResult result = aliyunOASClient.deleteVault(deleteVaultRequest);
  6.     logger.info("Delete Success! {} {}", result.getRequestId(), result.getDate());
  7. } catch (OASClientException e) {
  8.     logger.error("OASClientException Occured:", e);
  9. } catch (OASServerException e) {
  10.     logger.error("OASServerException Occured:", e);
  11. }

上传Archive

快速上传

  • ArchiveManager的upload接口会根据文件大小判断是直接上传还是用Multipart上传，无须用户选择

关于高级接口ArchiveManager的详细文档，参考 OAS Java SDK高级接口文档 。

  1. // java sdk 会帮助用户完成 vaultName 到 vaultId 的转换
  2. // 由此避免了用户对一长串vaultId的记忆负担
  3. String yourVaultName = "oas_demo";
  4. File file = new File("oas_demo_data/random10M.bin");
  5. try {
  6.     UploadResult uploadResult = archiveManager.upload(yourVaultName, file);
  7.     logger.info("File {} uploaded complete. ArchiveId={},md5={},treeEtag={}",
  8.         file.getAbsolutePath(), uploadResult.getArchiveId(),
  9.         uploadResult.getHashValue(),
  10.         uploadResult.getHashTreeValue());
  11. } catch (OASClientException e) {
  12.     logger.error("OASClientException Occured:", e);
  13. } catch (OASServerException e) {
  14.     logger.error("OASServerException Occured:", e);
  15. }

根据UploadId上传

  1. File file = new File("oas_demo_data/random120M-2.bin");
  2. //获得uploadId
  3. //文件大小必须大于100MB，否则会抛异常提示用普通上传接口进行上传
  4. String uploadId = archiveManager.initiateMultipartUpload(vaultName, file, "Hello OAS!");
  5. //如果是已有的uploadId，直接使用之前获取过的uploadId
  6. //String uploadId = "[yourUploadId]";
  7. System.out.println("Get uploadId=" + uploadId);
  8. UploadResult uploadResult = archiveManager.uploadWithUploadId(vaultName, file, uploadId);
  9. System.out.println("Archive ID=" + uploadResult.getArchiveId());

任务执行

下载任务是通过提交任务、下载任务输出的异步过程执行的，任务的详细介绍，参考 OAS Java SDK高级接口文档。

提交提档任务

  1. String yourVaultName = "oas_demo";
  2. String yourArchiveId = "6086C62DBFFD4A68BAEE9D1B680EC77C8FE6AE617FF47BCD3DB3CB71AFAE29B33431AED14D06D9C4AD251F17C173F3CD";
  3. JobMonitor jobMonitor = archiveManager.downloadAsync(yourVaultName, yourArchiveId);

执行Inventory

  1. JobMonitor jobMonitor = archiveManager.downloadInventoryAsync("oas_demo");

下载Job输出

  1. archiveManager.downloadJobOutput(yourVaultName, jobId,
  2.     new File("oas_demo_data/mySaveFile.bin"));

配置ProcessListener

以上传Archive为例：

  1. ServiceCredentials credentials = new ServiceCredentials(
  2.     DemoConstants.ACCESS_ID,
  3.     DemoConstants.ACCESS_KEY);
  5. // 通过工厂类获得archiveManager接口
  6. ArchiveManager archiveManager = OASFactory.archiveManagerFactory(credentials);
  7. File file = new File("[pathToYourFile]");
  9. final BaseTransfer<UploadResult> bt = archiveManager.uploadAsync(
  10.     "[yourVaultName]", file);
  12. //设置最大并发数，默认为3，最大为10
  13. bt.setNumConcurrence(5);
  15. bt.addProgressListener(new ProgressListener() {
  17.     @Override
  18.     public void onStart(String id) {
  19.         // 任务开始时调用，其中id为Multipart Upload任务ID，对于一般上传任务id为空
  20.         System.out.println("Start! Upload ID: " + id);
  21.     }
  23.     @Override
  24.     public boolean onError(Range range, Throwable t) {
  25.         // 出错时调用，range是出错的字节范围，t是相应的错误
  26.         // 当返回true时，BaseTransfer会进行重试，false则放弃
  27.         System.out.println("ERROR!!!");
  28.         return false;
  29.     }
  31.     @Override
  32.     public void onCompleted() {
  33.         // 任务完成时调用
  34.         System.out.println("Upload complete");
  35.     }
  37.     @Override
  38.     public void onProgressed(long current, long total) {
  39.         // 上传进度，total为文件字节大小，current为当前已上传字节数
  40.         System.out.println("Progress: " + current + " / " + total);
  41.     }
  42. });
  44. bt.start();
  46. final Timer timer = new Timer();
  47. timer.scheduleAtFixedRate(new TimerTask() {
  49.     @Override
  50.     public void run() {
  51.         System.out.println("Running time: " + bt.getRunningTime() + " seconds");
  52.         System.out.println("Completed size: " + bt.getSizeCompleted() + " bytes");
  53.         System.out.println("Total size: " + bt.getSizeTotal() + " bytes");
  54.         System.out.println("Average speed: " + bt.getAverageSpeedInBytesPerSecond()
  55.                            + " B/s");
  56.         if (bt.isComplete()) {
  57.             timer.cancel();
  58.             synchronized (bt) {
  59.                 bt.notify();
  60.             }
  61.         }
  62.     }
  64. }, 0, 1000);
  66. synchronized (bt) {
  67.     try {
  68.         bt.wait();
  69.     } catch (InterruptedException e) {
  70.         logger.error("", e);
  71.     }
  72. }
  74. // 任务结束
  75. System.out.println("=============================");
  76. System.out.println("Running time: " + bt.getRunningTime() + " seconds");
  77. System.out.println("Completed size: " + bt.getSizeCompleted() + " bytes");
  78. System.out.println("Total size: " + bt.getSizeTotal() + " bytes");
  79. System.out.println("Average speed: " + bt.getAverageSpeedInBytesPerSecond() + " B/s");
  80. UploadResult uploadResult = bt.getResult();
  81. System.out.println("Archive ID: " + uploadResult.getArchiveId());
  82. System.out.println("Hash Value: " + uploadResult.getHashValue());