域名解析接口

同步非阻塞解析域名接口

使用同步非阻塞接口解析域名，不会阻塞当前线程，但可能会返回空结果。

该接口仅查询缓存，返回缓存查询的解析结果。若缓存中没有解析结果或者缓存中的解析结果已经TTL过期，则会在工作线程中进行域名解析，解析成功后更新缓存，供下次调用域名解析使用。

本接口提供了常规版本、使用软件自定义解析的版本。

接口定义

- (nullable HttpdnsResult *)resolveHostSyncNonBlocking:(NSString *)host byIpType:(HttpdnsQueryIPType)queryIpType;

- (nullable HttpdnsResult *)resolveHostSyncNonBlocking:(NSString *)host byIpType:(HttpdnsQueryIPType)queryIpType withSdnsParams:(NSDictionary<NSString *, NSString *> *)sdnsParams sdnsCacheKey:(NSString *)cacheKey;

- (nullable HttpdnsResult *)resolveHostSyncNonBlocking:(HttpdnsRequest *)request;

所属类

HttpDnsService

参数定义

返回说明

同步解析域名接口

使用同步解析接口解析域名，会阻塞当前线程，直到获得有效解析结果并返回。

该接口首先查询缓存，若缓存存在可用的解析结果则立即返回缓存解析结果，若缓存中没有可用的解析结果，则会阻塞当前调用解析的线程并且在工作线程中进行域名解析，等域名解析完成返回解析结果，或达到超时时间返回空值。

本接口提供了常规版本、使用软件自定义解析的版本。

接口定义

- (nullable HttpdnsResult *)resolveHostSync:(NSString *)host byIpType:(HttpdnsQueryIPType)queryIpType;

- (nullable HttpdnsResult *)resolveHostSync:(NSString *)host byIpType:(HttpdnsQueryIPType)queryIpType withSdnsParams:(NSDictionary<NSString *, NSString *> *)sdnsParams sdnsCacheKey:(NSString *)cacheKey;

- (nullable HttpdnsResult *)resolveHostSync:(HttpdnsRequest *)request;

所属类

HttpDnsService

参数定义

返回说明

异步解析域名接口

使用异步解析接口解析域名，不会阻塞当前线程，解析结果会通过回调的形式返回。

该接口首先查询缓存，若缓存存在可用的解析结果则立即通过回调返回缓存解析结果，若缓存中没有可用的解析结果，则会在工作线程中进行域名解析，等域名解析结束或者达到超时时间再通过回调返回解析结果。

本接口提供了常规版本、使用软件自定义解析的版本。

接口定义

- (void)resolveHostAsync:(NSString *)host byIpType:(HttpdnsQueryIPType)queryIpType completionHandler:(void (^)(HttpdnsResult * nullable))handler;

- (void)resolveHostAsync:(NSString *)host byIpType:(HttpdnsQueryIPType)queryIpType withSdnsParams:(NSDictionary<NSString *, NSString *> *)sdnsParams sdnsCacheKey:(NSString *)cacheKey completionHandler:(void (^)(HttpdnsResult * nullable))handler;

- (void)resolveHostAsync:(HttpdnsRequest *)request completionHandler:(void (^)(HttpdnsResult * nullable))handler;

所属类

HttpDnsService

参数定义

回调结果说明

清空域名缓存

使用阿里云域名解析服务的用户，调用该接口主动清除本地缓存，可实现秒级域名配置生效。 例如：假设域名xxx.com，解析IP地址为ip1，当ip1遭受攻击，需要将流量迁移至ip2，实现流程如下：

1. 首先，用户在云解析控制台将域名对应IP修改为ip2，此时在HTTPDNS服务端会立即获取到此变更信息，并清除服务端该域名的ip1缓存。

2. 用户手动调用此接口，清空xxx.com域名的本地缓存。

3. App端清空缓存后的下一次请求，会使得服务端重新请求权威服务器，获取最新解析IP地址ip2，从而使前端解析结果立即生效为ip2。

本接口提供指定域名列表清理缓存，和清理全部域名缓存两种调用形式。

接口定义

- (void)cleanHostCache:(NSArray <NSString *>*)hostArray;

- (void)cleanAllHostCache;

参数说明

解析相关数据结构

HTTPDNS iOS SDK提供的域名解析接口主要涉及两个自定义结构：HttpdnsRequest和HttpdnsResult。

HttpdnsRequest

解析请求类，包装域名解析相关的请求参数。

HttpdnsResult

解析结果类，包装域名解析成功后的返回结果。注意，以下几种情况，会导致解析接口获得空值：

• 域名解析不到地址，如递归解析不到ip记录

• 未在HTTPDNS控制台添加该域名，导致服务端无法解析

• 解析失败，如发生网络异常问题

• 使用同步非阻塞接口时，若在本地缓存没有立即找到缓存记录，也会先返回空值