初始化
更新时间:2020-08-26
确认Endpoint
在确认您使用SDK时配置的Endpoint时,可先阅读API参考中关于服务域名的部分,理解Endpoint相关的概念。BVW的Endpoint目前仅支持“华北-北京”区域。服务域名的对应信息为:
访问区域 | 对应Endpoint |
---|---|
BJ | bvw.bj.baidubce.com |
新建BvwClient
使用AK/SK新建BvwClient
通过AK/SK方式访问BVW,用户可以参考如下代码新建一个BvwClient:
public class Sample {
public static void main(String[] args) {
String ak = "<your-access-key-id>"; // 用户的Access Key ID
String sk = "<your-secret-access-key>"; // 用户的Secret Access Key
String endpoint = "http://bvw.bj.baidubce.com";
// 初始化一个BosClient
BvwClientConfiguration config = new BvwClientConfiguration()
.withCredentials(new DefaultBceCredentials(ak, sk))
.withEndpoint(endpoint);
BvwClient client = new BvwClient(config);
}
}
在上面代码中,ACCESS_KEY_ID
对应控制台中的“Access Key ID”,SECRET_ACCESS_KEY
对应控制台中的“Access Key Secret”,获取方式请参考《操作指南 管理ACCESSKEY》。
配置HTTPS协议访问BVW
BVW支持HTTPS传输协议,您可以通过如下两种方式在BVW Java SDK中使用HTTPS访问BVW服务:
- 在endpoint中指明https:
String ak = "<your-access-key-id>";
String sk = "<your-secret-access-key>";
String endpoint = "https://bvw.bj.baidubce.com";
BvwClientConfiguration config = new BvwClientConfiguration()
.withCredentials(new DefaultBceCredentials(ak, sk))
.withEndpoint(endpoint);
BvwClient client = new BvwClient(config);
- 通过调用setProtocol方法设置https协议:
String ak = "<your-access-key-id>";
String sk = "<your-secret-access-key>";
String endpoint = "bvw.bj.baidubce.com"; // endpoint中不包含protocol
BvwClientConfiguration config = new BvwClientConfiguration()
.withCredentials(new DefaultBceCredentials(ak, sk))
.withEndpoint(endpoint);
config.setProtocol(Protocol.HTTPS); // 如果不指明, 则使用http
BvwClient client = new BvwClient(config);
注意:如果在endpoint中指明了protocol, 则endpoint中的生效, 另外单独再调用setProtocol()不起作用。
String ak = "<your-access-key-id>";
String sk = "<your-secret-access-key>";
String endpoint = "http://bvw.bj.baidubce.com";
BvwClientConfiguration config = new BvwClientConfiguration()
.withCredentials(new DefaultBceCredentials(ak, sk))
.withEndpoint(endpoint);
config.setProtocol(Protocol.HTTPS); // endpoint中已经指明, 此为无效操作, 对http也是如此
BvwClient client = new BvwClient(config);
配置BvwClient
如果用户需要配置BvwClient的一些细节的参数,可以在构造BvwClient的时候传入BvwClientConfiguration对象。 BvwClientConfiguration是BVW服务的配置类,可以为客户端配置代理,最大连接数等参数。
使用代理
下面一段代码可以让客户端使用代理访问BVW服务:
String ak = "<your-access-key-id>";
String sk = "<your-secret-access-key>";
String endpoint = "http://bvw.bj.baidubce.com";
BvwClientConfiguration config = new BvwClientConfiguration()
.withCredentials(new DefaultBceCredentials(ak, sk))
.withEndpoint(endpoint);
// 配置代理为本地8080端口
config.setProxyHost("127.0.0.1");
config.setProxyPort(8080);
BvwClient client = new BvwClient(config);
使用上面的代码段,客户端的所有操作都会通过127.0.0.1地址的8080端口做代理执行。 对于有用户验证的代理,可以通过下面的代码段配置用户名和密码:
// 创建BvwClientConfiguration实例
BvwClientConfiguration config = new BvwClientConfiguration();
// 配置代理为本地8080端口
config.setProxyHost("127.0.0.1");
config.setProxyPort(8080);
// 设置用户名和密码
config.setProxyUsername("<username>");
config.setProxyPassword("<password>");
设置网络参数
用户可以用BvwClientConfiguration对基本网络参数进行设置:
BvwClientConfiguration config = new BvwClientConfiguration();
// 设置HTTP最大连接数为10
config.setMaxConnections(10);
// 设置TCP连接超时为5000毫秒
config.setConnectionTimeout(5000);
// 设置Socket传输数据超时的时间为2000毫秒
config.setSocketTimeout(2000);
参数说明
通过BvwClientConfiguration能指定的所有参数如下表所示:
参数 | 说明 |
---|---|
UserAgent | 用户代理,指HTTP的User-Agent头 |
Protocol | 连接协议类型 |
ProxyDomain | 访问NTLM验证的代理服务器的Windows域名 |
ProxyHost | 代理服务器主机地址 |
ProxyPort | 代理服务器端口 |
ProxyUsername | 代理服务器验证的用户名 |
ProxyPassword | 代理服务器验证的密码 |
ProxyPreemptiveAuthenticationEnabled | 是否设置用户代理认证 |
ProxyWorkstation | NTLM代理服务器的Windows工作站名称 |
LocalAddress | 本地地址 |
ConnectionTimeoutInMillis | 建立连接的超时时间(单位:毫秒) |
SocketTimeoutInMillis | 通过打开的连接传输数据的超时时间(单位:毫秒) |
MaxConnections | 允许打开的最大HTTP连接数 |
RetryPolicy | 连接重试策略 |
SocketBufferSizeInBytes | Socket缓冲区大小 |
StreamBufferSize | 流文件缓冲区大小 |