SDK接入方法

2023.01.12 10:52:14

    1. 准备工作

    1.1 环境要求

    • Java: 1.8+

      说明 您可以执行命令java -version 查看Java版本。

    1.2 接入准备

    • 从 易盾控制台 开通账号,套餐以及相应产品和业务。
    • 根据服务类型从 易盾控制台 获取 SecretID、SecretKey、BusinessId 以及 RegionCode(默认中国杭州,其他区域支持请参考)

      例如:易盾控制台 -> 内容安全 -> 服务管理 -> 查看产品秘钥

    1.3 安装SDK

    • 开发环境安装并配置好maven管理工具

    • 在您的项目中添加maven依赖,只需在 pom.xml 中找到 <dependencies> 标签,在里面添加以下依赖项即可。

      <dependency>
          <groupId>com.netease.yidun</groupId>
          <artifactId>yidun-java-sdk</artifactId>
          <version>1.1.4</version>
      </dependency>
      

      注意: 这里的版本号只是举例,您可以在 Maven 仓库 上找到最新的版本。

    2.配置支持

    • http请求各项参数配置

    常用的http请求的各项配置,包括接口超时参数,http连接池连接数、空闲时间等核心参数。

     ClientProfile clientProfile = AntispamRequester.createDefaultProfile("SecretId", "SecretKey");
     // 按照需求设置http请求的多个参数配置
     HttpClientConfig httpClientConfig = clientProfile.getHttpClientConfig();
     httpClientConfig.setSocketTimeoutMillis(60000);
    
    • 请求协议

    切换请求协议,通过在请求对象中设置protocol字段,切换HTTP/HTTPS协议,默认HTTPS

    ImageV5SyncCheckRequest checkRequest = new ImageV5SyncCheckRequest();
    checkRequest.setProtocol(ProtocolEnum.HTTPS);
    
    • 重试配置

    设置请求失败的重试次数

    ClientProfile clientProfile = AntispamRequester.createDefaultProfile("SecretId", "SecretKey");
    // 最大10次
    clientProfile.setMaxRetryCount(2);
    
    • 熔断配置

    熔断窗口的各项配置,包括窗口大小、熔断时间、错误率阈值、熔断生效的请求数阈值

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

    3.SDK更新动态

    sdk更新动态详情请参见发布日志

    Online Chat Tel:95163223