Yidun Java SDK

https://github.com/yidun/yidun-java-sdk
Admin
The Yidun Java SDK is a companion tool for Yidun APIs, supporting content and business security...
Tokens:746
Snippets:6
Trust Score:6.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Add Yidun SDK Maven Dependency

Source: https://github.com/yidun/yidun-java-sdk/blob/main/README.md

Add the Yidun Java SDK as a dependency in your project's pom.xml file to include it in your build process using Maven.

```XML
<dependency>
    <groupId>com.netease.yidun</groupId>
    <artifactId>yidun-java-sdk</artifactId>
    "version">1.4.11</version>
</dependency>
```

--------------------------------

### Configure Yidun SDK Fault Recovery

Source: https://github.com/yidun/yidun-java-sdk/blob/main/README.md

Set up the fault recovery mechanism for asynchronous retries of failed requests, including defining handlers for successful recovery and optional fallback responses.

```Java
// 创建文件恢复的执行器，这个对象全局是单例的
DefaultRequestRecover requestRecover = DefaultRequestRecover.createRecover("恢复文件所在的目录");
// 注册故障恢复的handler，用于接口请求失败，异步重试成功后的处理逻辑，每个接口对应一个，否则对应接口不开启故障恢复
// 如果多个接口都需要开启故障恢复，则需要register多个handler
requestRecover.registerRecoverHandler(new AbstractRequestRecoverHandler<ImageV5CheckResponse>() {
    @Override
    public void handle(ImageV5CheckResponse response) {
        // 请求异步恢复成功后，处理请求结果
    }
});

// 注册请求失败后的fallback，用于接口请求失败，返回默认值，选填（不指定时，默认返回code为200的fallback对象）
ImageV5CheckResponse fallbackResp = new ImageV5CheckResponse();
fallbackResp.setCode(100);
fallbackResp.setMsg("fallback response");

requestRecover.registerFallback(fallbackResp);

// 指定故障恢复的recover
clientProfile.setRequestRecover(requestRecover);
```

--------------------------------

### Configure Yidun SDK Circuit Breaker

Source: https://github.com/yidun/yidun-java-sdk/blob/main/README.md

Configure parameters for the fixed-window circuit breaker strategy, such as the statistics window duration, error rate threshold, and break duration.

```Java
ClientProfile clientProfile = AntispamRequester.createDefaultProfile("SecretId", "SecretKey");
// 按照需求设置固定窗口的多个熔断参数配置
FixedWindowBreakStrategy.Config breakerConfig = clientProfile.getBreakerConfig();
breakerConfig.statWindowMillis(300000);
```

--------------------------------

### Configure Yidun SDK HTTP Client

Source: https://github.com/yidun/yidun-java-sdk/blob/main/README.md

Customize the underlying HTTP client configuration for the Yidun SDK, such as setting socket timeouts or connection pool parameters.

```Java
// 按照需求设置http请求的多个参数配置
HttpClientConfig httpClientConfig = clientProfile.getHttpClientConfig();
httpClientConfig.setSocketTimeoutMillis(60000);
```

--------------------------------

### Set Yidun SDK Request Protocol

Source: https://github.com/yidun/yidun-java-sdk/blob/main/README.md

Specify the protocol (HTTP or HTTPS) to be used for a specific SDK request object. Defaults to HTTPS.

```Java
ImageV5SyncCheckRequest checkRequest = new ImageV5SyncCheckRequest();
checkRequest.setProtocol(ProtocolEnum.HTTPS);
```

--------------------------------

### Configure Yidun SDK Retry Count

Source: https://github.com/yidun/yidun-java-sdk/blob/main/README.md

Set the maximum number of synchronous retries the SDK will attempt for a failed request within the same region before considering it failed.

```Java
ClientProfile clientProfile = AntispamRequester.createDefaultProfile("SecretId", "SecretKey");
// 最大10次
clientProfile.setMaxRetryCount(2);
```
Tokens:
Raw