Skip to content

Commit 0ec4072

Browse files
summerboy2134liucheng.yao
andauthored
更新版本号 (#29)
Co-authored-by: liucheng.yao <[email protected]>
1 parent fd80a21 commit 0ec4072

File tree

8 files changed

+81
-66
lines changed

8 files changed

+81
-66
lines changed

collections/_java-sdk/快速使用.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
title: '快速使用'
33
sidebar:
44
nav: java-sdk
@@ -22,17 +22,18 @@ sidebar:
2222

2323
- **[ufile-client-java ](https://github.com/ucloud/ufile-sdk-java/tree/master/ufile/ufile-client-java/apidocs.zip)**
2424
- **[ufile-core ](https://github.com/ucloud/ufile-sdk-java/tree/master/ufile/ufile-core/apidocs.zip)**
25-
25+
2626
## 安装
2727
- Maven
2828

29-
您可以通过在pom.xml中添加以下依赖项,来配置您的Maven项目
29+
您可以通过在pom.xml中添加以下依赖项,来配置您的Maven项目。添加依赖后,请执行项目刷新(如 IDEA 中点击 Reload Project)以使依赖生效。
3030

3131
``` xml
3232
<dependency>
3333
<groupId>cn.ucloud.ufile</groupId>
3434
<artifactId>ufile-client-java</artifactId>
35-
<version>latest-release-version</version>
35+
<!-- 当前推荐版本 -->
36+
<version>2.7.4</version>
3637
</dependency>
3738
```
3839

@@ -51,11 +52,11 @@ sidebar:
5152

5253
- 基本说明:
5354
- 所有API均包含同步执行(execute)和异步执行(executeAsync)两种执行方式。
54-
55+
5556
- 同步执行会返回指定的业务结果类,若执行出错则会抛出UfileException为父类的异常;
56-
57+
5758
- 异步执行需要传入UfileCallback<T>的回调接口,执行成功时会回调onResponse,泛型<T>为回调结果(即:同步执行的返回类型),**值得注意的是,若Ufile Server业务错误,也会回调onResponse,请注意结果类中的信息**,若出现异常,则回调onError。
58-
59+
5960
- 如果是上传下载等耗时API,建议使用异步执行(executeAsync),并可以重写UfileCallback中的onProgress回调来进行进度监听
6061

6162
## 配置UfileClient
@@ -76,7 +77,7 @@ sidebar:
7677
// Bucket相关API的授权器
7778
BucketAuthorization BUCKET_AUTHORIZER = new UfileBucketLocalAuthorization(
7879
"Your PublicKey", "Your PrivateKey");
79-
80+
8081
UfileClient.bucket(BUCKET_AUTHORIZER)
8182
.APIs // Bucket相关操作API
8283
.execute() or executeAsync(UfileCallback<T>)
@@ -96,7 +97,7 @@ UfileClient.bucket(BUCKET_AUTHORIZER)
9697
e.printStackTrace();
9798
}
9899
```
99-
100+
100101
- 异步
101102

102103
``` java
@@ -105,12 +106,12 @@ UfileClient.bucket(BUCKET_AUTHORIZER)
105106
.executeAsync(new UfileCallback<BucketResponse>() {
106107
@Override
107108
public void onResponse(BucketResponse response) {
108-
109+
109110
}
110-
111+
111112
@Override
112113
public void onError(Request request, ApiError error, UfileErrorBean response) {
113-
114+
114115
}
115116
});
116117
```
@@ -123,7 +124,7 @@ UfileClient.bucket(BUCKET_AUTHORIZER)
123124
// 对象相关API的授权器
124125
ObjectAuthorization OBJECT_AUTHORIZER = new UfileObjectLocalAuthorization(
125126
"Your PublicKey", "Your PrivateKey");
126-
127+
127128
/**
128129
* 您也可以创建远程对象相关API的授权器,远程授权器将签名私钥放于签名服务器上,更为安全
129130
* 远程签名服务端示例代码在 (https://github.com/ucloud/ufile-sdk-auth-server)
@@ -138,7 +139,7 @@ ObjectAuthorization OBJECT_AUTHORIZER = new UfileObjectRemoteAuthorization(
138139
// 对象操作需要ObjectConfig来配置您的地区和域名后缀
139140
ObjectConfig config = new ObjectConfig("your bucket region", "ufileos.com");
140141

141-
/**
142+
/**
142143
* 您也可以使用已登记的自定义域名
143144
* 注意'http://www.your_domain.com'指向的是某个特定的bucket+region+域名后缀,
144145
* eg:http://www.your_domain.com -> www.your_bucket.bucket_region.ufileos.com
@@ -148,7 +149,7 @@ ObjectConfig config = new ObjectConfig("http://www.your_domain.com");
148149
/**
149150
* ObjectConfig同时支持从本地文件来导入
150151
* 配置文件内容必须是含有以下参数的json字符串:
151-
* {"Region":"","ProxySuffix":""}
152+
* {"Region":"","ProxySuffix":""}
152153
* 或
153154
* {"CustomDomain":""}
154155
*/
@@ -169,7 +170,7 @@ UfileClient.object(OBJECT_AUTHORIZER, config)
169170

170171
``` java
171172
File file = new File("your file path");
172-
173+
173174
try {
174175
PutObjectResultBean response = UfileClient.object(Constants.OBJECT_AUTHORIZER, config)
175176
.putObject(file, "mimeType")
@@ -189,7 +190,7 @@ UfileClient.object(OBJECT_AUTHORIZER, config)
189190
.setOnProgressListener(new OnProgressListener() {
190191
@Override
191192
public void onProgress(long bytesWritten, long contentLength) {
192-
193+
193194
}
194195
})
195196
.execute();
@@ -204,7 +205,7 @@ UfileClient.object(OBJECT_AUTHORIZER, config)
204205

205206
``` java
206207
File file = new File("your file path");
207-
208+
208209
UfileClient.object(OBJECT_AUTHORIZER, config)
209210
.putObject(file, "mimeType")
210211
.nameAs("save as keyName")
@@ -220,17 +221,17 @@ UfileClient.object(OBJECT_AUTHORIZER, config)
220221
.executeAsync(new UfileCallback<PutObjectResultBean>() {
221222
@Override
222223
public void onProgress(long bytesWritten, long contentLength) {
223-
224+
224225
}
225-
226+
226227
@Override
227228
public void onResponse(PutObjectResultBean response) {
228-
229+
229230
}
230-
231+
231232
@Override
232233
public void onError(Request request, ApiError error, UfileErrorBean response) {
233-
234+
234235
}
235236
});
236237
```

collections/_java-sdk/获取文件基本信息.md

Lines changed: 24 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
---
1+
---
22
title: '获取文件基本信息'
33
sidebar:
44
nav: java-sdk
55
---
6-
SDK 提供`HeadFile`方法获取文件基本信息。
6+
SDK 提供`ObjectProfile`方法获取文件基本信息。
77

8-
`HeadFile`方法请求的 US3 API 为 HEADFile,具体详见[HEADFileAPI文档](https://docs.ucloud.cn/api/ufile-api/head_file)
8+
`ObjectProfile`方法请求的 US3 API 为 HEADFile,具体详见[HEADFileAPI文档](https://docs.ucloud.cn/api/ufile-api/head_file)
99

1010
### 文件基本信息说明
1111

@@ -26,40 +26,30 @@ SDK 提供`HeadFile`方法获取文件基本信息。
2626
<div class="copyable" markdown="1">
2727

2828
{% highlight go linenos %}
29-
package main
30-
31-
import (
32-
ufsdk "github.com/ufilesdk-dev/ufile-gosdk"
33-
"log"
34-
)
29+
public static void main(String[] args) {
30+
// 配置参数
31+
String keyName = "your-file-name.txt";
32+
String bucketName = "your-bucket-name";
33+
ObjectConfig config = new ObjectConfig("cn-sh2", "ufileos.com");
3534

36-
const (
37-
ConfigFile = "config.json"
38-
KeyName = "FakeBigFile.txt"
39-
)
35+
try {
36+
// 获取文件头信息
37+
ObjectProfile profile = UfileClient.object(Constants.OBJECT_AUTHORIZER, config)
38+
.objectProfile(keyName, bucketName)
39+
.execute();
4040

41-
func main() {
41+
System.out.println("Content-Type: " + profile.getContentType());
42+
System.out.println("Content-Length: " + profile.getContentLength());
43+
System.out.println("X-Ufile-Create-Time: " + profile.getCreateTime());
44+
System.out.println("X-Ufile-Storage-Class: " + profile.getStorageType());
45+
System.out.println("ETag: " + profile.geteTag());
46+
System.out.println("Last-Modified: " + profile.getLastModified());
4247

43-
// 加载配置,创建请求
44-
config, err := ufsdk.LoadConfig(ConfigFile)
45-
if err != nil {
46-
panic(err.Error())
47-
}
48-
req, err := ufsdk.NewFileRequest(config, nil)
49-
if err != nil {
50-
panic(err.Error())
51-
}
52-
// 获取文件基本信息,获取成功
53-
err = req.HeadFile(KeyName)
54-
if err != nil {
55-
log.Fatalf("查询文件信息失败,具体错误详情:%s", err.Error())
56-
}
57-
// 若获取成功,返回的文件基本信息保存在req.LastResponseHeader中
58-
log.Println("查询文件信息成功,返回信息为:")
59-
for key, val := range req.LastResponseHeader {
60-
log.Println(key, ":", val)
61-
}
62-
}
48+
} catch (Exception e) {
49+
System.err.println("获取文件信息失败: " + e.getMessage());
50+
e.printStackTrace();
51+
}
52+
}
6353

6454
{% endhighlight %}
6555
</div>

collections/_js-sdk/分片上传.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,14 @@ sidebar:
2222
- `Body`: 要上传的文件分片的内容
2323
- `ContentMD5`: 指定分片数据的 MD5 校验值
2424

25+
### 注意
26+
在通过AWS SDK使用US3的分片上传服务时,一定要指定分片大小为8MB
27+
const partSize = 8 * 1024 * 1024; // 固定8MB
28+
2529
### 示例
2630
> 执行该示例前请确保配置文件的正确性<br>以下代码段需要在上下文中运行
2731
28-
<div class="copyable" markdown="1">
32+
<div class="copyable" markdown="1">
2933
{% highlight javascript linenos %}
3034
function MultipartUpload() {
3135
const [bucketName, setBucketName] = useState("");
@@ -49,8 +53,8 @@ function MultipartUpload() {
4953
const partSize = 8 * 1024 * 1024; // 8MB
5054
const numParts = Math.ceil(selectedFile.size / partSize);
5155
let uploadId;
52-
try {
53-
56+
try {
57+
5458
// 创建分片上传任务
5559
const createMultipartUploadResponse = await s3.send(
5660
new CreateMultipartUploadCommand({
@@ -89,8 +93,8 @@ function MultipartUpload() {
8993
if (!part.ETag) {
9094
throw new Error(`Part ${part.PartNumber} 上传失败`);
9195
}
92-
});
93-
96+
});
97+
9498
// 完成分片上传
9599
await s3.send(
96100
new CompleteMultipartUploadCommand({
@@ -107,8 +111,8 @@ function MultipartUpload() {
107111
} catch (error) {
108112
console.error("上传文件失败:", error);
109113
setUploadStatus("上传文件失败");
110-
if (uploadId) {
111-
114+
if (uploadId) {
115+
112116
// 如果上传失败,中止上传
113117
await s3.send(
114118
new AbortMultipartUploadCommand({
@@ -121,5 +125,5 @@ function MultipartUpload() {
121125
}
122126
};
123127

124-
{% endhighlight %}
125-
</div>
128+
{% endhighlight %}
129+
</div>

collections/_js-sdk/安装.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ sidebar:
55
---
66

77
## 环境准备
8+
对象存储提供了 AWS S3 兼容的 API,因此只需要进行简单的配置修改,即可使用 S3 SDK 的接口来访问对象存储系统中的文件。
9+
810
AWS SDK for JavaScript v3,推荐使用 ES6+ 版本的 JavaScript。在 Node.js 环境中,版本为 16.x 或更高。浏览器需支持基本的 HTML5 特性(支持 IE10 以上浏览器)
911

12+
AWS SDK版本是 3.627.0
1013
## 下载SDK源码
1114

1215
* [通过Github下载](https://github.com/aws/aws-sdk-js-v3)

collections/_node.js-sdk/分片上传.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ sidebar:
2222
- `Body`: 要上传的文件分片的内容
2323
- `ContentMD5`: 指定分片数据的 MD5 校验值
2424

25+
### 注意
26+
在通过AWS SDK使用US3的分片上传服务时,一定要指定分片大小为8MB
27+
const partSize = 8 * 1024 * 1024; // 固定8MB
28+
2529
### 示例
2630
> 执行该示例前请确保配置文件的正确性<br>以下代码段需要在上下文中运行
2731

collections/_node.js-sdk/安装.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,12 @@ sidebar:
44
nav: node.js-sdk
55
---
66
## 环境准备
7+
对象存储提供了 AWS S3 兼容的 API,因此只需要进行简单的配置修改,即可使用 S3 SDK 的接口来访问对象存储系统中的文件。
8+
79
AWS SDK for JavaScript v3,推荐使用 ES6+ 版本的 JavaScript。在 Node.js 环境中,版本为 16.x 或更高。浏览器需支持基本的 HTML5 特性(支持 IE10 以上浏览器)
810

11+
推荐AWS SDK版本是3.621.0
12+
913
## 下载SDK源码
1014

1115
* [通过Github下载](https://github.com/aws/aws-sdk-js-v3)

collections/_php-sdk/分片上传.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ sidebar:
1919
- `Body`: 要上传的文件分片的内容
2020
- `ContentMD5`: 指定分片数据的 MD5 校验值
2121

22+
### 注意
23+
在通过AWS SDK使用US3的分片上传服务时,一定要指定分片大小为8MB
24+
$partSize = 8 * 1024 * 1024; // 固定8MB
25+
26+
2227
### 示例
2328
> 执行该示例前请确保配置文件的正确性<br>以下代码段需要在上下文中运行
2429

collections/_php-sdk/安装.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,12 @@ sidebar:
55
---
66

77
## 环境准备
8+
对象存储提供了 AWS S3 兼容的 API,因此只需要进行简单的配置修改,即可使用 S3 SDK 的接口来访问对象存储系统中的文件。
9+
810
PHP SDK适用于PHP 5.3以上版本。本文以PHP 5.6.22为例。
911

12+
AWS SDK版本号: 3.320.4
13+
1014
### 安装环境
1115

1216
您需要安装PHP和cURL扩展:

0 commit comments

Comments
 (0)