本文介绍如何在Flutter应用开发中集成使用HTTPDNS。
Flutter是Google开源的应用开发框架,仅通过一套代码库,就能构建精美的、原生平台编译的多平台应用。
我们提供Flutter框架下的HTTPDNS插件,并展示如何在Flutter常用的网络框架中集成使用HTTPDNS。本插件已在GitHub和pub.dev发布。
以下是插件的使用说明和最佳实践:
一、快速入门
1.1 开通服务
请参考快速入门开通HTTPDNS。
1.2 获取配置
请参考开发配置在EMAS控制台开发配置中获取AccountId/SecretKey/AESSecretKey等信息,用于初始化SDK。
二、安装配置
2.1 添加Flutter依赖
在您的Flutter项目的pubspec.yaml中加入dependencies:
dependencies:
flutter:
sdk: flutter
aliyun_httpdns: ^1.0.0 # 从pub.dev获取最新版本号
dio: ^5.9.0 # Dio网络库
http: ^1.2.0 # http包
http2: ^2.3.1 # 可选,支持HTTP/2添加依赖之后需要执行一次 flutter pub get。
2.2 原生SDK版本说明
2.2.1 验证原生SDK版本
插件已集成了对应平台的HTTPDNS原生SDK,当前版本:
Android:
com.aliyun.ams:alicloud-android-httpdns:2.6.5iOS:
AlicloudHTTPDNS:3.2.1
如需更新SDK版本,请参考下面的版本更新指导。
如果要更新原生SDK版本,请使用GitHub fork或本地源码方式引入插件,以便修改插件内部的build.gradle/podspec文件。
2.2.2 更新Android SDK版本
编辑 packages/aliyun_httpdns/android/build.gradle 文件,修改依赖版本:
dependencies {
implementation 'androidx.annotation:annotation:1.8.0'
// 更新为您需要的版本
implementation 'com.aliyun.ams:alicloud-android-httpdns:2.6.5'
}可用版本请参考:Android SDK发布说明
2.2.3 更新iOS SDK版本
编辑 packages/aliyun_httpdns/ios/aliyun_httpdns.podspec 文件,修改依赖版本:
Pod::Spec.new do |s|
# ... 其他配置 ...
s.dependency 'Flutter'
# 更新为您需要的版本
s.dependency 'AlicloudHTTPDNS', '3.2.1'
# ... 其他配置 ...
end可用版本请参考:iOS SDK发布说明
2.2.4 重新构建项目
更新版本后,需要重新构建项目:
Android:
flutter clean
flutter pub get
flutter build apk # 或其他构建命令iOS:
flutter clean
flutter pub get
cd ios
pod install
cd ..
flutter build ios三、配置和使用
3.1 初始化配置
应用启动后,需要先初始化插件,才能调用HTTPDNS能力。 初始化主要是配置AccountId/SecretKey等信息及功能开关。 示例代码如下:
// 初始化 HTTPDNS
await AliyunHttpdns.init(
accountId: '您的AccountId',
secretKey: '您的SecretKey',
);
// 设置功能选项
await AliyunHttpdns.setHttpsRequestEnabled(true);
await AliyunHttpdns.setLogEnabled(true);
await AliyunHttpdns.setPersistentCacheIPEnabled(true);
await AliyunHttpdns.setReuseExpiredIPEnabled(true);
await AliyunHttpdns.setPreResolveAfterNetworkChanged(true);
await AliyunHttpdns.setIPRankingList({
'www.aliyun.com': 443,
});
// 构建服务
await AliyunHttpdns.build();
// 设置预解析域名
await AliyunHttpdns.setPreResolveHosts(['www.aliyun.com'], ipType: 'both');
print("init success");3.1.1 日志配置
应用开发过程中,如果要输出HTTPDNS的日志,可以调用日志输出控制方法,开启日志,示例代码如下:
await AliyunHttpdns.setLogEnabled(true);
print("enableLog success");3.1.2 sessionId记录
应用在运行过程中,可以调用获取SessionId方法获取sessionId,记录到应用的数据采集系统中。 sessionId用于表示标识一次应用运行,线上排查时,可以用于查询应用一次运行过程中的解析日志,示例代码如下:
final sessionId = await AliyunHttpdns.getSessionId();
print("SessionId = $sessionId");3.2 域名解析
3.2.1 预解析
当需要提前解析域名时,可以调用预解析域名方法,示例代码如下:
await AliyunHttpdns.setPreResolveHosts(["www.aliyun.com", "www.example.com"], ipType: 'both');
print("preResolveHosts success");调用之后,插件会发起域名解析,并把结果缓存到内存,用于后续请求时直接使用。
3.2.2 域名解析
当需要解析域名时,可以通过调用域名解析方法解析域名获取IP,示例代码如下:
Future<void> _resolve() async {
final res = await AliyunHttpdns.resolveHostSyncNonBlocking('www.aliyun.com', ipType: 'both');
final ipv4List = res['ipv4'] ?? [];
final ipv6List = res['ipv6'] ?? [];
print('IPv4: $ipv4List');
print('IPv6: $ipv6List');
}四、Flutter最佳实践
4.1 原理说明
本示例展示了一种更直接的集成方式,通过自定义HTTP客户端适配器来实现HTTPDNS集成:
创建自定义的HTTP客户端适配器,拦截网络请求
在适配器中调用HTTPDNS插件解析域名为IP地址
使用解析得到的IP地址创建直接的Socket连接
对于HTTPS连接,确保正确设置SNI(Server Name Indication)为原始域名
这种方式避免了创建本地代理服务的复杂性,直接在HTTP客户端层面集成HTTPDNS功能。
4.2 示例说明
本示例提供了一个完整的Flutter应用,展示如何集成HTTPDNS功能。
4.2.1 自定义HTTP客户端适配器实现
自定义适配器的实现请参考 lib/net/httpdns_http_client_adapter.dart 文件。本方案由EMAS团队设计实现,参考请注明出处。 适配器内部会拦截HTTP请求,调用HTTPDNS进行域名解析,并使用解析后的IP创建socket连接。
本示例支持三种网络库:Dio、HttpClient、http包。代码如下:
import 'dart:io';
import 'package:dio/io.dart';
import 'package:http/http.dart' as http;
import 'package:http/io_client.dart';
import 'package:flutter/foundation.dart';
import 'package:aliyun_httpdns/aliyun_httpdns.dart';
// Dio 适配器
IOHttpClientAdapter buildHttpdnsHttpClientAdapter() {
final HttpClient client = HttpClient();
_configureHttpClient(client);
_configureConnectionFactory(client);
final IOHttpClientAdapter adapter = IOHttpClientAdapter(createHttpClient: () => client)
..validateCertificate = (cert, host, port) => true;
return adapter;
}
// 原生 HttpClient
HttpClient buildHttpdnsNativeHttpClient() {
final HttpClient client = HttpClient();
_configureHttpClient(client);
_configureConnectionFactory(client);
return client;
}
// http 包适配器
http.Client buildHttpdnsHttpPackageClient() {
final HttpClient httpClient = buildHttpdnsNativeHttpClient();
return IOClient(httpClient);
}
// HttpClient 基础配置
void _configureHttpClient(HttpClient client) {
client.findProxy = (Uri _) => 'DIRECT';
client.idleTimeout = const Duration(seconds: 90);
client.maxConnectionsPerHost = 8;
}
// 配置基于 HTTPDNS 的连接工厂
// 本方案由EMAS团队设计实现,参考请注明出处。
void _configureConnectionFactory(HttpClient client) {
client.connectionFactory = (Uri uri, String? proxyHost, int? proxyPort) async {
final String domain = uri.host;
final bool https = uri.scheme.toLowerCase() == 'https';
final int port = uri.port == 0 ? (https ? 443 : 80) : uri.port;
final List<InternetAddress> targets = await _resolveTargets(domain);
final Object target = targets.isNotEmpty ? targets.first : domain;
if (!https) {
return Socket.startConnect(target, port);
}
// HTTPS:先 TCP,再 TLS(SNI=域名),并保持可取消
bool cancelled = false;
final Future<ConnectionTask<Socket>> rawStart = Socket.startConnect(target, port);
final Future<Socket> upgraded = rawStart.then((task) async {
final Socket raw = await task.socket;
if (cancelled) {
raw.destroy();
throw const SocketException('Connection cancelled');
}
final SecureSocket secure = await SecureSocket.secure(
raw,
host: domain, // 重要:使用原始域名作为SNI
);
if (cancelled) {
secure.destroy();
throw const SocketException('Connection cancelled');
}
return secure;
});
return ConnectionTask.fromSocket(
upgraded,
() {
cancelled = true;
try {
rawStart.then((t) => t.cancel());
} catch (_) {}
},
);
};
}
// 通过 HTTPDNS 解析目标 IP 列表
Future<List<InternetAddress>> _resolveTargets(String domain) async {
try {
final res = await AliyunHttpdns.resolveHostSyncNonBlocking(domain, ipType: 'both');
final List<String> ipv4 = res['ipv4'] ?? [];
final List<String> ipv6 = res['ipv6'] ?? [];
final List<InternetAddress> targets = [
...ipv4.map(InternetAddress.tryParse).whereType<InternetAddress>(),
...ipv6.map(InternetAddress.tryParse).whereType<InternetAddress>(),
];
if (targets.isEmpty) {
debugPrint('[dio] HTTPDNS no result for $domain, fallback to system DNS');
} else {
debugPrint('[dio] HTTPDNS resolved $domain -> ${targets.first.address}');
}
return targets;
} catch (e) {
debugPrint('[dio] HTTPDNS resolve failed: $e, fallback to system DNS');
return const <InternetAddress>[];
}
}4.2.2 适配器集成和使用
适配器的集成请参考 lib/main.dart 文件。 首先需要初始化HTTPDNS,然后配置网络库使用自定义适配器,示例代码如下:
class _MyHomePageState extends State<MyHomePage> {
late final Dio _dio;
late final HttpClient _httpClient;
late final http.Client _httpPackageClient;
@override
void initState() {
super.initState();
// 初始化 HTTPDNS
_initHttpDnsOnce();
// 配置网络库使用 HTTPDNS 适配器
_dio = Dio();
_dio.httpClientAdapter = buildHttpdnsHttpClientAdapter();
_dio.options.headers['Connection'] = 'keep-alive';
_httpClient = buildHttpdnsNativeHttpClient();
_httpPackageClient = buildHttpdnsHttpPackageClient();
}
Future<void> _initHttpDnsOnce() async {
try {
await AliyunHttpdns.init(
accountId: 139450,
secretKey: '您的SecretKey',
);
await AliyunHttpdns.setHttpsRequestEnabled(true);
await AliyunHttpdns.setLogEnabled(true);
await AliyunHttpdns.setPersistentCacheIPEnabled(true);
await AliyunHttpdns.setReuseExpiredIPEnabled(true);
await AliyunHttpdns.build();
// 设置预解析域名
await AliyunHttpdns.setPreResolveHosts(['www.aliyun.com'], ipType: 'both');
} catch (e) {
debugPrint('[httpdns] init failed: $e');
}
}
}使用配置好的网络库发起请求时,会自动使用HTTPDNS进行域名解析:
// 使用 Dio
final response = await _dio.get('https://www.aliyun.com');
// 使用 HttpClient
final request = await _httpClient.getUrl(Uri.parse('https://www.aliyun.com'));
final response = await request.close();
// 使用 http 包
final response = await _httpPackageClient.get(Uri.parse('https://www.aliyun.com'));4.2.3 资源清理
在组件销毁时,记得清理相关资源:
@override
void dispose() {
_urlController.dispose();
_httpClient.close();
_httpPackageClient.close();
super.dispose();
}五、API
5.1 日志输出控制
控制是否打印Log。
await AliyunHttpdns.setLogEnabled(true);
print("enableLog success");5.2 初始化
初始化配置, 在应用启动时调用。
// 基础初始化
await AliyunHttpdns.init(
accountId: 139450,
secretKey: 'your_secret_key',
aesSecretKey: 'your_aes_secret_key', // 可选
);
// 配置功能选项
await AliyunHttpdns.setHttpsRequestEnabled(true);
await AliyunHttpdns.setLogEnabled(true);
await AliyunHttpdns.setPersistentCacheIPEnabled(true);
await AliyunHttpdns.setReuseExpiredIPEnabled(true);
await AliyunHttpdns.setPreResolveAfterNetworkChanged(true);
await AliyunHttpdns.setIPRankingList({
'www.aliyun.com': 443,
});
// 构建服务实例
await AliyunHttpdns.build();
print("init success");初始化参数:
参数名 | 类型 | 是否必须 | 功能 | 支持平台 |
accountId | int | 必选参数 | Account ID | Android/iOS |
secretKey | String | 可选参数 | 加签密钥 | Android/iOS |
aesSecretKey | String | 可选参数 | 加密密钥 | Android/iOS |
功能配置方法:
setHttpsRequestEnabled(bool)- 设置是否使用HTTPS解析链路setLogEnabled(bool)- 设置是否开启日志setPersistentCacheIPEnabled(bool)- 设置是否开启持久化缓存setReuseExpiredIPEnabled(bool)- 设置是否允许复用过期IPsetPreResolveAfterNetworkChanged(bool)- 设置网络切换时是否自动刷新解析setIPRankingList(hostPortMap)- 设置IP优选域名列表
5.3 域名解析
解析指定域名。
Future<void> _resolve() async {
final res = await AliyunHttpdns.resolveHostSyncNonBlocking(
'www.aliyun.com',
ipType: 'both', // 'auto', 'ipv4', 'ipv6', 'both'
);
final ipv4List = res['ipv4'] ?? [];
final ipv6List = res['ipv6'] ?? [];
print('IPv4: $ipv4List');
print('IPv6: $ipv6List');
}参数:
参数名 | 类型 | 是否必须 | 功能 |
hostname | String | 必选参数 | 要解析的域名 |
ipType | String | 可选参数 | 请求IP类型: 'auto', 'ipv4', 'ipv6', 'both' |
返回数据结构:
字段名 | 类型 | 功能 |
ipv4 | List | IPv4地址列表,如: ["1.1.1.1", "2.2.2.2"] |
ipv6 | List | IPv6地址列表,如: ["::1", "::2"] |
5.4 预解析域名
预解析域名, 解析后缓存在SDK中,下次解析时直接从缓存中获取,提高解析速度。
await AliyunHttpdns.setPreResolveHosts(
["www.aliyun.com"],
ipType: 'both'
);
print("preResolveHosts success");参数:
参数名 | 类型 | 是否必须 | 功能 |
hosts | List | 必选参数 | 预解析域名列表 |
ipType | String | 可选参数 | 请求IP类型: 'auto', 'ipv4', 'ipv6', 'both' |
5.5 获取SessionId
获取SessionId, 用于排查追踪问题。
final sessionId = await AliyunHttpdns.getSessionId();
print("SessionId = $sessionId");无需参数,直接返回当前会话ID。
5.6 清除缓存
清除所有DNS解析缓存。
await AliyunHttpdns.cleanAllHostCache();
print("缓存清除成功");5.7 网络变化时自动刷新预解析
设置在网络环境变化时是否自动刷新预解析域名的缓存。
await AliyunHttpdns.setPreResolveAfterNetworkChanged(true);
print("网络变化自动刷新已启用");5.8 持久化缓存配置
设置是否开启持久化缓存功能。开启后,SDK 会将解析结果保存到本地,App 重启后可以从本地加载缓存。
await AliyunHttpdns.setPersistentCacheIPEnabled(true);
await AliyunHttpdns.setPersistentCacheIPEnabled(
true,
discardExpiredAfterSeconds: 86400 // 可选参数
);
print("持久化缓存已开启");参数:
参数名 | 类型 | 是否必须 | 功能 |
enabled | bool | 必选参数 | 是否开启持久化缓存 |
discardExpiredAfterSeconds | int | 可选参数 | 过期时间阈值(秒),App 启动时会丢弃过期超过此时长的缓存记录 |
5.9 IP 优选
设置需要进行 IP 优选的域名列表。开启后,SDK 会对解析返回的 IP 列表进行 TCP 测速并排序,以保证第一个 IP 是可用性最好的 IP。
await AliyunHttpdns.setIPRankingList({
'www.aliyun.com': 443,
});
print("IP 优选配置成功");参数:
参数名 | 类型 | 是否必须 | 功能 |
hostPortMap | Map<String, int> | 必选参数 | 域名和端口的映射,如:{'www.aliyun.com': 443} |
六、旧版SDK升级到1.0.0以上指南
1.0.0 版本进行了全面的架构重构和接口优化。这次升级旨在:
统一配置模式:从分散的运行时配置改为两阶段初始化模式(init + build),解决配置时序问题,提升 SDK 稳定性
标准化解析接口:重新设计解析接口架构,提供统一的
resolveHostSyncNonBlocking方法,返回结构化数据而非 JSON 字符串静态方法设计:从单例模式改为静态方法调用,简化使用方式,无需创建实例
性能优化:通过接口优化和内部实现改进,提升解析性能和资源利用效率
这是一次不兼容的重大变更,虽然变更较大,但您只需要修改应用中实际使用的接口。通过下面的升级步骤和新旧 API 映射表,您可以系统性地完成这次重要升级。
升级步骤详解
1. 更新依赖版本
pubspec.yaml
dependencies:aliyun_httpdns: ^1.0.0执行更新:
flutter pub upgrade aliyun_httpdns2. 重构初始化代码
升级前
// 旧版本:单例模式 + 一步初始化
final _aliyunHttpDns = AliyunHttpDns();
await _aliyunHttpDns.init(
"YOUR_ACCOUNT_ID", // String 类型
secretKey: "your_secret_key",
aesSecretKey: "your_aes_key",
region: "",
timeout: 2000,
enableHttps: true,
enableExpireIp: true,
enableCacheIp: true,
enableDegradationLocalDns: true,
preResolveAfterNetworkChanged: true,
ipRankingMap: {"www.aliyun.com": 80},
sdnsGlobalParam: {"aa": "bb"},
bizTags: ["tag1", "tag2"]
);升级后
// 新版本:静态方法 + 两阶段初始化
// 第一阶段:初始化基本配置
await AliyunHttpdns.init(
accountId: your_account_id, // int 类型,必须设置
secretKey: "your_secret_key", // 可选
aesSecretKey: "your_aes_key", // 可选
);
// 第二阶段:设置功能选项
await AliyunHttpdns.setHttpsRequestEnabled(true); // 替代 enableHttps
await AliyunHttpdns.setLogEnabled(true); // 替代 enableLog
await AliyunHttpdns.setPersistentCacheIPEnabled(true); // 替代 enableCacheIp
await AliyunHttpdns.setReuseExpiredIPEnabled(true); // 替代 enableExpireIp
await AliyunHttpdns.setPreResolveAfterNetworkChanged(true); // 替代 preResolveAfterNetworkChanged
// 第三阶段:构建服务(必须调用)
await AliyunHttpdns.build();说明:
移除了
region、timeout、enableDegradationLocalDns、ipRankingMap、sdnsGlobalParam、bizTags等参数新增
build()方法,必须在配置完成后调用所有方法改为静态方法,无需创建实例
3. 更新解析接口
升级前
// 同步非阻塞,返回 JSON 字符串
String result = await _aliyunHttpDns.resolve(
"YOUR_ACCOUNT_ID", // accountId
"www.aliyun.com", // host
kRequestIpv4AndIpv6, // requestIpType
);
// 需要手动解析 JSON
Map<String, dynamic> map = json.decode(result);
List<String> ipv4s = List<String>.from(map['ipv4'] ?? []);
List<String> ipv6s = List<String>.from(map['ipv6'] ?? []);
// 使用第一个 IP
String ip = ipv4s.isNotEmpty ? ipv4s.first : '';升级后
// 同步非阻塞,返回结构化数据
Map<String, List<String>> result = await AliyunHttpdns.resolveHostSyncNonBlocking(
'www.aliyun.com', // hostname(无需 accountId)
ipType: 'both', // 替代 kRequestIpv4AndIpv6
);
// 直接获取 IP 列表
List<String> ipv4s = result['ipv4'] ?? [];
List<String> ipv6s = result['ipv6'] ?? [];
// 使用第一个 IP
String ip = ipv4s.isNotEmpty ? ipv4s.first : '';自定义解析参数:
// 升级前
String result = await _aliyunHttpDns.resolve(
"YOUR_ACCOUNT_ID",
"www.aliyun.com",
kRequestIpv4AndIpv6,
params: {"key": "value"},
cacheKey: "custom_key"
);
// 升级后
Map<String, List<String>> result = await AliyunHttpdns.resolveHostSyncNonBlocking(
'www.aliyun.com',
ipType: 'both',
sdnsParams: {"key": "value"}, // 参数名变更
cacheKey: "custom_key"
);4. 更新预解析接口
升级前
await _aliyunHttpDns.setPreResolveHosts(
"YOUR_ACCOUNT_ID", // accountId
["www.aliyun.com"],
kRequestIpv4AndIpv6 // requestIpType
);升级后
await AliyunHttpdns.setPreResolveHosts(
["www.aliyun.com"], // 无需 accountId
ipType: 'both' // 替代 kRequestIpv4AndIpv6
);5. 更新日志配置
升级前
await _aliyunHttpDns.enableLog(true);升级后
await AliyunHttpdns.setLogEnabled(true);6. 更新 SessionId 获取
升级前
String sessionId = await _aliyunHttpDns.getSessionId("YOUR_ACCOUNT_ID");升级后
String? sessionId = await AliyunHttpdns.getSessionId();7. 新增功能使用
清除缓存
await AliyunHttpdns.cleanAllHostCache();持久化缓存配置
await AliyunHttpdns.setPersistentCacheIPEnabled(true);若您的应用未使用到不兼容的 API,可以不用处理。
API 升级映射表
接口分类 | 升级前 | 升级后 |
创建实例 |
| 无需创建,直接使用静态方法 |
初始化 |
|
|
构建服务 | 无 |
|
启用 HTTPS 请求 |
|
|
启用过期 IP |
|
|
开启本地缓存 |
|
|
网络切换预解析 |
|
|
控制日志输出 |
|
|
同步非阻塞解析 |
|
|
IPv4 解析 |
|
|
IPv6 解析 |
|
|
IPv4 和 IPv6 解析 |
|
|
自动选择 | 无 |
|
自定义解析参数 |
|
|
设置预解析域名 |
|
|
获取 SessionId |
|
|
清除缓存 | 无 |
|
校正签名时间 |
| 已移除 |