SDK接入方法

2024.02.22 09:46:39

    Java SDK

    准备工作

    环境要求

    • Java: 1.8+

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

    接入准备

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

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

    安装SDK

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

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

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

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

    配置支持

    • 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);
    

    更新动态

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

    GOLANG SDK

    为了简化 GOLANG 开发者调试和接入易盾 API 的成本,这里向您介绍适用于 GOLANG 的SDK的使用流程,并提供首次使用SDK的简单示例。 让您快速了解SDK的特性和功能,并快速使用起来。

    准备工作

    环境要求

    • 建议Go: 1.2+

      说明 您可以执行命令go version 查看本地golang版本。

    • 从 易盾控制台 开通账号,套餐以及相应产品和业务。

    • 从 易盾控制台 获取 SecretID、SecretKey、BusinessId,如果有疑问请联系您的商务经理

    安装SDK

    • 开发环境使用go mod管理依赖。

    • 在您的项目中添加module依赖,只需在 go.mod 文件中添加以下依赖项即可。

        require github.com/yidun/yidun-golang-sdk v1.0.0
      

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

    使用SDK

    请参考demo模块下各接口使用方式

    功能特性

    • 完善的失败处理:

      • 接口请求提供同步重试机制,在出现调用失败时,会自动重试指定region内的下一个请求节点。

      • 接口请求支持熔断降级,在当前时间窗口内,指定region的某个节点失败请求次数到达阈值时,会触发熔断,后续请求会自动路由到region内的其他可用节点,直到超过熔断时间再对熔断节点探活。

    • 丰富的签名算法:

      • 内置多种接口签名算法支持,包括MD5、SHA1、SHA256、SM3
    • 灵活的接口配置:

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

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

      • 指定region(默认杭州),根据您服务器的所在地,选择适合的region,以达到更好的请求效果,支持的region列表请咨询您的商务经理。

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

    配置支持

    • http请求各项参数配置

       // 按照需求设置http请求的多个参数配置
       credential := auth.NewCredentials("accessKeyId", "accessKeySecret")
       clientProfile := client.NewClientProfile(credential)
       clientProfile.HttpClientConfig.ConnectionKeepAliveMillis = 10000
       crawlerSubmitClient := crawler.NewCrawlerClient(clientProfile)
      
    • 请求协议

      // 覆盖默认请求协议
      request := submit.NewCrawlerResourceV3SubmitRequest()
      request.SetProtocol(http.ProtocolEnumHTTPS)
      
    • 熔断配置

      credential := auth.NewCredentials("accessKeyId", "accessKeySecret")
      clientProfile := client.NewClientProfile(credential)
      // 按照需求设置固定窗口的多个熔断参数配置
      clientProfile.BreakerConfig.SetStatWindowMillis(10000)
      crawlerSubmitClient := crawler.NewCrawlerClient(clientProfile)
      
    • 重试配置

      credential := auth.NewCredentials("accessKeyId", "accessKeySecret")
      clientProfile := client.NewClientProfile(credential)
      // 最大10次
      clientProfile.SetMaxRetryCount(10)
      crawlerSubmitClient := crawler.NewCrawlerClient(clientProfile)
      

    更新动态

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

    Online Chat Tel:95163223 Free trial