HTTPDNS:Flutter SDK の統合

3.1.1. ログ設定

アプリケーション開発中に HTTPDNS ログを出力するには、ログ出力制御メソッドを呼び出してログを有効にします。次のコードは例です。

AliyunHttpdns.setLogEnabled(true);

// カスタムログハンドラー (オプション)
AliyunHttpdns.setLogHandler((message) {
  print(message);
});

3.1.2. SessionId の記録

アプリケーションの実行中に、メソッドを呼び出して sessionId を取得し、アプリケーションのデータ収集システムに記録できます。sessionId は、単一のアプリケーション実行を識別します。オンラインでのトラブルシューティング中に、特定の実行の名前解決ログをクエリするために使用できます。次のコードは例です。

final sessionId = AliyunHttpdns.getSessionId();
print("SessionId = $sessionId");

3.2. ドメイン名の名前解決

await AliyunHttpdns.setPreResolveHosts(["www.aliyun.com", "www.example.com"], ipType: HttpdnsIpType.auto);

Future<void> _resolve() async {
  final result = await AliyunHttpdns.resolveHostSyncNonBlocking('www.aliyun.com', ipType: HttpdnsIpType.auto);
  final ipv4List = result?.ips ?? [];
  final ipv6List = result?.ipv6s ?? [];
  print('IPv4: $ipv4List');
  print('IPv6: $ipv6List');
}

4.2.1. カスタム HTTP クライアントアダプターの実装

カスタムアダプターの実装については、lib/net/httpdns_http_client_adapter.dart ファイルをご参照ください。このソリューションは EMAS チームによって設計および実装されました。このソリューションを参照する場合は、出典を明記してください。アダプターは HTTP リクエストをインターセプトし、HTTPDNS を呼び出してドメイン名を解決し、解決された IP アドレスを使用してソケット接続を作成します。

この例では、Dio、HttpClient、http パッケージの 3 つのネットワークライブラリをサポートしています。コードは次のとおりです。

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: 30);
  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 result = await AliyunHttpdns.resolveHostSyncNonBlocking(domain, ipType: HttpdnsIpType.auto);
    final List<String> ipv4 = result?.ips ?? [];
    final List<String> ipv6 = result?.ipv6s ?? [];
    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 {
      final config = AliyunHttpdnsConfig(
        accountId: ご利用のアカウント ID,
        secretKey: 'ご利用の SecretKey',
        httpsEnabled: true,
        reuseExpiredIPEnabled: true,
      );
      await AliyunHttpdns.init(config);
      AliyunHttpdns.setLogEnabled(true);
      
      // 事前解決ホストの設定
      await AliyunHttpdns.setPreResolveHosts(['www.aliyun.com'], ipType: HttpdnsIpType.auto);
    } 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();
}

5.3.1 同期非ブロッキング解決 (推奨)

キャッシュされた結果を即座に返します。キャッシュにヒットしない場合は null を返し、バックグラウンドでリクエストを開始します。

final result = await AliyunHttpdns.resolveHostSyncNonBlocking(
  'www.aliyun.com', 
  ipType: HttpdnsIpType.auto,
);

// SDNS パラメーター付き
final result2 = await AliyunHttpdns.resolveHostSyncNonBlocking(
  'www.aliyun.com',
  ipType: HttpdnsIpType.auto,
  sdnsParams: {'key': 'value'},
  cacheKey: 'custom_cache_key',
);

5.3.2 同期ブロッキング解決

結果が取得されるか、リクエストがタイムアウトするまでブロックします。

final result = await AliyunHttpdns.resolveHostSync(
  'www.aliyun.com',
  ipType: HttpdnsIpType.auto,
);

// SDNS パラメーター付き
final result2 = await AliyunHttpdns.resolveHostSync(
  'www.aliyun.com',
  ipType: HttpdnsIpType.auto,
  sdnsParams: {'key': 'value'},
  cacheKey: 'custom_cache_key',
);

5.3.3 非同期コールバック解決

コールバック関数を介して解決結果を返します。

await AliyunHttpdns.resolveHostAsync(
  'www.aliyun.com',
  ipType: HttpdnsIpType.auto,
  callback: (result) {
    print('Resolution result: $result');
  },
);

// SDNS パラメーター付き
await AliyunHttpdns.resolveHostAsync(
  'www.aliyun.com',
  ipType: HttpdnsIpType.auto,
  sdnsParams: {'key': 'value'},
  cacheKey: 'custom_cache_key',
  callback: (result) {
    print('Resolution result: $result');
  },
);

パラメーターの説明

返されるデータ構造 (ResolveResult)

詳細なアップグレード手順

dependencies:aliyun_httpdns: ^2.0.0

flutter pub upgrade aliyun_httpdns

// 1.x: 2段階の初期化
await AliyunHttpdns.init(
  accountId: ご利用のアカウント ID,
  secretKey: "your_secret_key",
  aesSecretKey: "your_aes_key",
);

await AliyunHttpdns.setHttpsRequestEnabled(true);
await AliyunHttpdns.setPersistentCacheIPEnabled(true);
await AliyunHttpdns.setReuseExpiredIPEnabled(true);
await AliyunHttpdns.setPreResolveAfterNetworkChanged(true);
await AliyunHttpdns.setIPRankingList({'www.aliyun.com': 443});

await AliyunHttpdns.build();

final config = AliyunHttpdnsConfig(
  accountId: ご利用のアカウント ID,
  secretKey: 'your_secret_key',
  aesSecretKey: 'your_aes_key',
  httpsEnabled: true,
  persistentCacheEnabled: true,
  reuseExpiredIPEnabled: true,
  preResolveAfterNetworkChanged: true,
  ipRankingDatasource: {'www.aliyun.com': 443},
);
await AliyunHttpdns.init(config);

final res = await AliyunHttpdns.resolveHostSyncNonBlocking(
  'www.aliyun.com',
  ipType: 'both',
);
final ipv4s = res['ipv4'] ?? [];
final ipv6s = res['ipv6'] ?? [];

final result = await AliyunHttpdns.resolveHostSyncNonBlocking(
  'www.aliyun.com',
  ipType: HttpdnsIpType.auto,
);
final ipv4s = result?.ips ?? [];
final ipv6s = result?.ipv6s ?? [];

await AliyunHttpdns.setPreResolveHosts(['www.aliyun.com']);

await AliyunHttpdns.setPreResolveHosts(['www.aliyun.com']);

AliyunHttpdns.setLogHandler((message) {
  print(message);
});

await AliyunHttpdns.cleanAllHostCache();

// すべてのキャッシュをクリア
await AliyunHttpdns.cleanHostCache(null);

// 指定されたドメイン名のキャッシュをクリア（新規）
await AliyunHttpdns.cleanHostCache(['www.aliyun.com']);

API アップグレードマッピングテーブル (1.x → 2.0)

詳細なアップグレード手順

dependencies:aliyun_httpdns: ^1.0.0

flutter pub upgrade aliyun_httpdns

// 旧バージョン：シングルトンパターン + 1段階の初期化
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"]
);

// 新しいバージョン: 静的メソッド + 2 段階の初期化

// ステージ 1: 基本構成を初期化する
await AliyunHttpdns.init(
  accountId: your_account_id,            // int 型、必須
  secretKey: "your_secret_key",          // 任意
  aesSecretKey: "your_aes_key",          // 任意
);

// ステージ 2: 機能オプションを設定する
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 に置き換え

// ステージ 3: サービスをビルドする (必ず呼び出す必要があります)
await AliyunHttpdns.build();

// 同期非ブロッキング、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',           // ホスト名 (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"
);

await _aliyunHttpDns.setPreResolveHosts(
  "YOUR_ACCOUNT_ID",                     // accountId
  ["www.aliyun.com"],
  kRequestIpv4AndIpv6                    // requestIpType
);

await AliyunHttpdns.setPreResolveHosts(
  ["www.aliyun.com"],                     // accountId は不要です
  ipType: 'both'                          // kRequestIpv4AndIpv6 を置き換えます
);

await _aliyunHttpDns.enableLog(true);

await AliyunHttpdns.setLogEnabled(true);

String sessionId = await _aliyunHttpDns.getSessionId("YOUR_ACCOUNT_ID");

String? sessionId = await AliyunHttpdns.getSessionId();

await AliyunHttpdns.cleanAllHostCache();

await AliyunHttpdns.setPersistentCacheIPEnabled(true);

API アップグレードマッピングテーブル