Skip to content

API 参考文档

Dart SDK

DynamicDomain

Future<void> init([String? appId])

使用给定的 App ID 初始化 SDK。

  • appId: (可选) 您的应用标识 ID。请联系客服 (@zhuanmitools) 获取有效的 App ID。如果不填,将使用默认测试 ID。

Future<String> fetchRemoteConfig([String? appId])

从远程服务器获取最新的节点配置。SDK 会自动处理多级回退(DoH -> API -> GitHub)。

  • appId: (可选) 应用 ID。
  • 返回: 加密的 Xray 配置字符串。

Future<String> startTunnel(String config, {int maxRetries = 3})

启动本地代理隧道。

  • config: 由 fetchRemoteConfig 获取的配置字符串。
  • maxRetries: 启动失败时的重试次数。
  • 返回: 本地 HTTP 代理地址,格式为 IP:Port (例如 127.0.0.1:10809)。

ProxyConfig? getProxyConfig()

获取当前的结构化代理配置。在 startTunnel 成功后调用,返回一个 ProxyConfig 对象,包含以下辅助方法:

  • httpUrl: 获取 HTTP 代理字符串。
  • socksUrl: 获取 SOCKS5 代理字符串。
  • applyToEnvironment(): 一键应用代理到当前进程环境变量(异步方法),对 Go/C++ 等原生 SDK 非常有效。

int? httpPort (Getter)

获取当前 HTTP 代理端口。

int? socksPort (Getter)

获取当前 SOCKS5 代理端口。

Future<void> stopTunnel()

停止隧道并释放所有相关资源。调用此方法后,本地代理端口将关闭。

最后更新于:

基于 MIT 许可发布