文档服务DOC

    安装DOC-Java-SDK

    安装SDK包

    开始前请确保下述前提条件已准备就绪:

    • 下载最新的BCE Java SDK
    • 准备 Java 运行环境:jdk1.7及更高版本。
    • 申请账号并开通权限: 您需要登录百度智能云,在安全认证页面获取 Access Key (AK)。SDK 认证时必须传入 AK 参数。
    1. 解压安装包并浏览SDK目录后,将其复制到工程文件夹中。

      com.baidubce

         ├── auth                                        //BCE签名相关类
         ├── http                                        //BCE的Http通信相关类
         ├── internal                                    //SDK内部类
         ├── model                                       //BCE公用model类
         ├── services
         │       └── doc                                 //Document服务相关类
         │           ├── model                           //Document内部model,如Request或Response
         │           └── DocClient.class                 //Document客户端入口类
         ├── util                                        //BCE公用工具类
         ├── BceClientConfiguration.class                //对BCE的HttpClient的配置
         ├── BceClientException.class                    //BCE客户端的异常类
         ├── BceServiceException.class                   //与BCE服务端交互后的异常类
         ├── ErrorCode.class                             //BCE通用的错误码
         └── Region.class                                //BCE提供服务的区域
    2. 在Eclipse右键“工程 -> Properties -> Java Build Path -> Add JARs”。
    3. 添加SDK工具包lib/bce-java-sdk-version.jar和第三方依赖工具包third-party/*.jar。其中,version为版本号,添加完成后,即可在工程中使用Java SDK。

    安装DocClient

    新建DocClient

    DocClient是Document Service的Java客户端,为使用Document Service的开发者提供了一系列的交互方法。

    下面的示例代码用于新建一个DocClient:

    public class Sample {
    public static void main(String[] args) {
        String ACCESS_KEY_ID = "<AK>";
        String SECRET_ACCESS_KEY = "<SK>";
    
        // 初始化一个DocClient
        BceClientConfiguration config = new BceClientConfiguration();
        config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
        DocClient client = new DocClient(config);
    
        }
    }

    其中获取AK/SK为访问DOC做签名验证。

    上面的方式使用默认域名作为文档服务的服务地址,如果您需要自己制定域名,可以通过传入ENDPOINT参数来指定。

    String ACCESS_KEY_ID = "<AK>";
    String SECRET_ACCESS_KEY = "<SK>";
    String ENDPOINT = "http://doc.bj.baidubce.com";
    
    BceClientConfiguration config = new BceClientConfiguration();
    config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
    config.setEndpoint(ENDPOINT);
    DocClient client = new DocClient(config);

    注意: ENDPOINT参数只能用指定的包含Region的域名来进行定义,目前文档服务只提供北京一个Region,因此ENDPOINT支持域名http://doc.bj.baidubce.com,随着Region的增加将会开放其他可以支持的域名。

    配置DocClient

    BceClientConfiguration是文档服务的配置类,可为客户端配置代理、最大连接数等参数。通过在构造DocClient的时候传入BceClientConfiguration对象,您可以配置DocClient的一些细节参数。

    使用代理

    下面一段代码可以让客户端使用代理访问文档服务:

    String ACCESS_KEY_ID = "your-access-key-id";
    String SECRET_ACCESS_KEY = "your-secret-access-key";
    String ENDPOINT = "http://doc.bj.baidubce.com";
    
    // 创建BceClientConfiguration实例
    BceClientConfiguration config = new BceClientConfiguration();
    
    // 配置代理为本地8080端口
    config.setProxyHost("127.0.0.1");
    config.setProxyPort(8080);
    
    // 配置认证秘钥和服务器信息
    config.setCredentials(new DefaultBceCredentials(ACCESS_KEY_ID,SECRET_ACCESS_KEY));
    config.setEndpoint(ENDPOINT);
    
    // 创建DOC客户端
    DocClient client = new DocClient(config);

    使用上面的代码段,客户端的所有操作都会通过127.0.0.1地址的8080端口做代理执行。

    对于有用户验证的代理,可以通过下面的代码段配置用户名和密码:

    // 创建BceClientConfiguration实例
    BceClientConfiguration config = new BceClientConfiguration();
    
    // 配置代理为本地8080端口
    config.setProxyHost("127.0.0.1");
    config.setProxyPort(8080);
    
    //设置用户名和密码
    config.setProxyUsername("username");
    config.setProxyPassword("password");

    设置网络参数

    您可以用BceClientConfiguration对基本网络参数进行设置:

    BceClientConfiguration config = new BceClientConfiguration();
    
    // 设置HTTP最大连接数为10
    config.setMaxConnections(10);
    
    // 设置TCP连接超时为5000毫秒
    config.setConnectionTimeout(5000);
    
    // 设置Socket传输数据超时的时间为2000毫秒
    config.setSocketTimeout(2000);

    BceClientConfiguration参数说明

    通过BceClientConfiguration指定的所有参数如下表所示:

    参数 说明
    UserAgent 用户代理,指HTTP的User-Agent头
    Protocol 连接协议类型
    ProxyDomain 访问NTLM验证的代理服务器的Windows域名
    ProxyHost 代理服务器主机地址
    ProxyPort 代理服务器端口
    ProxyUsername 代理服务器验证的用户名
    ProxyPassword 代理服务器验证的密码
    ProxyPreemptiveAuthenticationEnabled 是否设置用户代理认证
    ProxyWorkstation NTLM代理服务器的Windows工作站名称
    LocalAddress 本地地址
    ConnectionTimeoutInMillis 建立连接的超时时间(单位:毫秒)
    SocketTimeoutInMillis 通过打开的连接传输数据的超时时间(单位:毫秒)
    MaxConnections 允许打开的最大HTTP连接数
    RetryPolicy 连接重试策略
    SocketBufferSizeInBytes Socket缓冲区大小
    上一篇
    DOC-Java-SDK-简介
    下一篇
    开发者指南