README.md · 唐阔/DyJava

![输入图片说明](Logo.png)

#### 一、介绍
DyJava是一款功能强大的抖音Java开发工具包（SDK），支持抖音各个应用OpenAPI快速调用，包括但不限于移动/网站应用、抖音开放平台、抖店和抖音小程序等。DyJava致力于简化开发流程，提高开发效率，让开发者能够更专注于创新和业务逻辑的实现。

#### 二、设计使命

抖音开发，可以更简单。每一个细节，都经过精心打磨，只为了提供更好的抖音开发体验。

#### 三、Maven 引用方式

```xml
 <dependency>
     <groupId>com.dyj</groupId>
     <artifactId>（不同模块参考下文）</artifactId>
     <version>${dy-java.version}</version>
 </dependency>
```
- 移动\网站应用：`dy-java-web`   
- 小程序应用：`dy-java-applet`

#### 四、文件配置
``` yml
dyjava:
  beanId:  
  domain: https://open.douyin.com #自定义抖音域名，默认线上域名
  ttDomain: https://developer.toutiao.com #自定义头条域名，默认线上域名
  agents:  #可配置多个应用
    - tenantId: 1   #租户名称
      clientKey:  #应用Key
      clientSecret:   #应用秘钥
  #应用信息加载类，默认读取配置文件 实现IAgentConfigService接口
  agentSourceClass: com.dyj.common.service.impl.PropertiesAgentConfigServiceImpl
  #令牌信息加载类，默认读取缓存 实现IAgentTokenService接口
  tokenSourceClass: com.dyj.common.service.impl.CacheAgentTokenServiceImpl
  forest:
    backend: okhttp3             # 后端HTTP框架httpclient、okhttp3（默认为 okhttp3）
    max-connections: 1000        # 连接池最大连接数（默认为 500）
    max-route-connections: 500   # 每个路由的最大连接数（默认为 500）
    max-request-queue-size: 500  # 最大请求等待队列大小
    max-async-thread-size: 300   # 最大异步线程数
    max-async-queue-size: 16     # 最大异步线程池队列大小
    timeout: 3000                # 请求超时时间，单位为毫秒（默认为 3000）
    connect-timeout: 3000        # 连接超时时间，单位为毫秒（默认为 timeout）
    read-timeout: 3000           # 数据读取超时时间，单位为毫秒（默认为 timeout）
    max-retry-count: 3           # 请求失败后重试次数（默认为 0 次不重试）
    ssl-protocol: TLS            # 单向验证的HTTPS的默认TLS协议（默认为 TLS）
    log-enabled: true            # 打开或关闭日志（默认为 true）
    log-request: true            # 打开/关闭请求日志（默认为 true）
    log-response-status: true    # 打开/关闭响应状态日志（默认为 true）
    log-response-content: false  # 打开/关闭响应内容日志（默认为 false）
    async-mode: platform         # 异步模式（默认为 platform）
```

#### 五、使用示例

* 移动\网站应用：
```java
//单租户获取AccessToken
AccessTokenVo accessToken = DyWebClient.getInstance().accessToken(code).getData();
//多租户单应用获取AccessToken
AccessTokenVo accessToken = DyWebClient.getInstance()
        .tenantId(1)
        .accessToken(code).getData();
//多租户多应用获取AccessToken
AccessTokenVo accessToken = DyWebClient.getInstance()
        .tenantId(1)
        .clientKey("123")
        .accessToken(code).getData();
```

* 小程序应用：
```java
//单租户获取AccessToken
DyAppletClient.getInstance().accessToken(code).getData();
//多租户单应用获取AccessToken
DyAppletClient.getInstance()
        .tenantId(1)
        .accessToken(code).getData();
//多租户多应用获取AccessToken
DyAppletClient.getInstance()
        .tenantId(1)
        .clientKey("123")
        .accessToken(code).getData();
```

* IAgentConfigService 接口的作用
 ###### 用来获取agent应用信息，默认读取配置文件，从配置文件中读取agent应用信息
````java
public class PropertiesAgentConfigServiceImpl implements IAgentConfigService {
    //通过配置文件获取agent应用信息
}
````
###### 如果需要自定义获取agent应用信息，只需要实现IAgentConfigService接口即可，然后在配置文件中配置agentSourceClass即可

* IAgentTokenService 接口的作用
###### 用来获取agent应用token，默认读取本地缓存，从缓存中读取agent应用token
````java
public class CacheAgentTokenServiceImpl implements IAgentTokenService {
}
````
###### 如果需要自定义获取agent应用token，只需要实现IAgentTokenService接口即可，然后在配置文件中配置tokenSourceClass即可(推荐使用)

#### 六、开发规划
##### 接口接入计划
1. 网站应用、App(已完成，开始测试)
2. 小程序(2024-04-30前完成)
3. 直播(2024-05-15前完成)
4. 抖店(2024-05-30前完成)

##### 感谢
[forest是一个很好用的工具](https://forest.dtflyx.com/)

##### 贡献
如果您发现了任何问题或者有任何建议，欢迎提出 issue 或者提交 pull request。也可以联系下方二维码。

![输入图片说明](image2.png)
![输入图片说明](image3.jpg)

#### 七、应用案例
 完整案例登记列表，请【[访问这里](https://gitee.com/sxwdmjy/dy-java/issues/I9G8DI)】查看，欢迎登记更多的案例。

唐阔/DyJava

简介

发行版

贡献者

近期动态

唐阔/DyJava .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

唐阔/DyJava