Appearance

大纲

初始化 ​

确认Endpoint ​

在确认您使用SDK时配置的Endpoint时，可先阅读开发人员指南中关于 FOS访问域名 的部分，理解Endpoint相关的概念。目前暂时支持一个Endpoint，对应信息为：

区域访问Endpoint支持协议
中国-华南fos.flymeyun.comHTTPS

获取密钥 ​

要使用Flyme云FOS，您需要拥有一个有效的AK（Access Key ID）和SK（Secret Access Key）用来进行签名认证。AK/SK是由系统分配给用户的，均为字符串，用于标识用户，为访问FOS做签名验证。 目前情况下，请通过控制台 Bucket详情 获取。

新建FOSClient ​

FosClient是FOS服务的客户端，为开发者与FOS服务进行交互提供了一系列的方法。

使用AK/SK新建FosClient ​

通过AK/SK方式访FOS，用户可以参考如下代码新建一个FosClient：

java
public class Sample {
    public static void main(String[] args) {
        String ACCESS_KEY_ID = <your-access-key-id>;                   // 用户的Access Key ID
        String SECRET_ACCESS_KEY = <your-secret-access-key>;           // 用户的Secret Access Key
        String ENDPOINT = <domain-name>;                               // 指定域名

        // 初始化一个FosClient
        FosClientConfiguration config = new FosClientConfiguration();
        config.setCredentials(new DefaultFosCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
        config.setEndpoint(ENDPOINT);
        FosClient client = new FosClient(config);
    }
}

在上面代码中，ACCESS_KEY_ID对应控制台中的“Access Key ID”，SECRET_ACCESS_KEY对应控制台中的“Access Key Secret”，获取方式请参考控制台 Bucket详情 获取

配置HTTPS协议访问FOS ​

FOS支持HTTPS传输协议，您可以通过如下两种方式在FOS Java SDK中使用HTTPS访问FOS服务：

  • 在endpoint中指明https:

    java
    String endpoint = "https://fos.flymeyun.com";
String ak = "ak";
String sk = "sk";
FosClientConfiguration config = new FosClientConfiguration();
config.setCredentials(new DefaultFosCredentials(ak, sk));
FosClient client = new FosClient(config);

  • 通过调用setProtocol方法设置https协议:

    java
    String endpoint = "fos.flymeyun.com"; // endpoint中不包含protocol
String ak = "ak";
String sk = "sk";
FosClientConfiguration config = new FosClientConfiguration();
config.setCredentials(new DefaultFosCredentials(ak, sk));
config.setEndpoint(ENDPOINT);
config.setProtocol(Protocol.HTTPS); // 如果不指明, 则使用http
FosClient client = new FosClient(config);

    注意：如果在endpoint中指明了protocol, 则endpoint中的生效, 另外单独再调用setProtocol()不起作用。

配置FosClient ​

如果用户需要配置FosClient的一些细节的参数，可以在构造FosClient的时候传入FosClientConfiguration对象。 FosClientConfiguration是FOS服务的配置类，可以为客户端配置代理，最大连接数等参数。

使用代理 ​

下面一段代码可以让客户端使用代理访问FOS服务：

java
String ACCESS_KEY_ID = <your-access-key-id>;                   // 用户的Access Key ID
String SECRET_ACCESS_KEY = <your-secret-access-key>;           // 用户的Secret Access Key
String ENDPOINT = <domain-name>;                               // 指定域名
// 初始化一个FosClient
FosClientConfiguration config = new FosClientConfiguration();

// 配置代理为本地8080端口
config.setProxyHost("127.0.0.1");
config.setProxyPort(8080);

// 创建FOS客户端
config.setCredentials(new DefaultFosCredentials(ACCESS_KEY_ID, SECRET_ACCESS_KEY));
config.setEndpoint(ENDPOINT);
config.setPathStyleAccessEnable(true);
FosClient client = new FosClient(config);

使用上面的代码段，客户端的所有操作都会通过127.0.0.1地址的8080端口做代理执行。 对于有用户验证的代理，可以通过下面的代码段配置用户名和密码：

java
// 创建FosClientConfiguration实例
FosClientConfiguration config = new FosClientConfiguration();

// 配置代理为本地8080端口
config.setProxyHost("127.0.0.1");
config.setProxyPort(8080);//设置用户名和密码

config.setProxyUsername(<username>);                             //用户名
config.setProxyPassword(<password>);                             //密码

设置网络参数 ​

用户可以用FosClientConfiguration对基本网络参数进行设置：

java
FosClientConfiguration config = new FosClientConfiguration();

// 设置HTTP最大连接数为10
config.setMaxConnections(10);

// 设置TCP连接超时为5000毫秒
config.setConnectionTimeoutInMillis(5000);

// 设置Socket传输数据超时的时间为2000毫秒
config.setSocketTimeoutInMillis(2000);

设置访问域名风格 ​

SDK会默认自动开启bucket virtual hosting，可以通过以下配置开启使用PathStyle风格的endpoint：

java
FosClientConfiguration config = new FosClientConfiguration();

// 开启使用PathStyle
config.setPathStyleAccessEnable(true);

注意：部分非FOS常规域名下，默认bucket virtual hosting风格的可能会有不兼容场景，表现为dns解析失败等，可以开启PathStyle解决。 其他场景建议使用默认风格。

设置同步PUT ​

对PUT操作，默认使用CloseableHttpAsyncClient，可能会出现用户进程执行完未退出的现象。用户可以通过FosClientConfiguration设置所有FOS请求都通过FosClient同步的方式：

java
FosClientConfiguration config = new FosClientConfiguration();

// 设置PUT操作为同步方式，默认异步
config.setEnableHttpAsyncPut(false);

参数说明 ​

通过FosClientConfiguration能指定的所有参数如下表所示：

参数说明
CnameEnabled使用cname访问FOS资源
ConnectionTimeoutInMillis建立连接的超时时间（单位：毫秒）
Credentials客户端用于签署HTTP请求的Fos凭据
EnableHttpAsyncPut异步put
Endpoint访问域名
LocalAddress本地地址
MaxConnections允许打开的最大HTTP连接数
Protocol连接协议类型
ProxyDomain访问NTLM验证的代理服务器的Windows域名
ProxyHost代理服务器主机地址
ProxyPassword代理服务器验证的密码
ProxyPort代理服务器端口
ProxyPreemptiveAuthenticationEnabled是否设置用户代理认证
ProxyUsername代理服务器验证的用户名
ProxyWorkstationNTLM代理服务器的Windows工作站名称
RetryPolicy连接重试策略
SocketBufferSizeInBytesSocket缓冲区大小
SocketTimeoutInMillis通过打开的连接传输数据的超时时间（单位：毫秒）
StreamBufferSize流文件缓冲区大小
UserAgent用户代理，指HTTP的User-Agent头
RedirectsEnabled是否开启HTTP重定向。默认开启
PathStyleAccessEnable是否使用PathStyle风格的endpoint，默认关闭，即使用bucket virtual hosting

©2025 珠海星纪魅族信息技术有限公司