自定义解析接口(已过时)

前言

本文档所有接口,需结合编写自定义解析函数,用于基础解析场景不满足需求时,进行自定义解析使用。

每个自定义域名解析的请求都需要携带的通用参数可以通过设置自定义解析全局参数来配置。

自定义解析同步非阻塞解析接口

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

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

getIpsByHostAsync

使用同步非阻塞方式,自定义解析IPv4地址。

接口定义

HTTPDNSResult getIpsByHostAsync(String host, Map<String,String> params, String cacheKey)

所属类

HttpDnsService

引入版本

1.3.0

废弃版本

2.3.2

替代接口

HTTPDNSResult getHttpDnsResultForHostSyncNonBlocking(String host, RequestIpType requestIpType, Map<String, String> params, String cacheKey)

参数说明

参数

类型

是否必填

说明

host

String

待解析域名。

params

Map<String, String>

解析域名携带的额外参数,对应服务端自定义解析函数中的event.parameters参数。

cacheKey

String

域名对应的本地缓存key,如果额外参数变更导致需要重新去服务端解析,则需要变更cacheKey。

返回说明

类型

说明

HTTPDNSResult

解析结果。

getHttpDnsResultForHostAsync

使用同步非阻塞方式,自定义解析IPv4地址。

接口定义

HTTPDNSResult getHttpDnsResultForHostAsync(String host, Map<String, String> params, String cacheKey);

所属类

HttpDnsService

引入版本

2.0.2

废弃版本

2.4.0

替代接口

HTTPDNSResult getHttpDnsResultForHostSyncNonBlocking(String host, RequestIpType requestIpType, Map<String, String> params, String cacheKey)

参数说明

参数

类型

是否必填

说明

host

String

待解析域名。

params

Map<String, String>

解析域名携带的额外参数,对应服务端自定义解析函数中的event.parameters参数。

cacheKey

String

域名对应的本地缓存key,如果额外参数变更导致需要重新去服务端解析,则需要变更cacheKey。

返回说明

类型

说明

HTTPDNSResult

解析结果。

getIpsByHostAsync

使用同步非阻塞方式,自定义解析指定IP类型的IP地址。

接口说明

HTTPDNSResult getIpsByHostAsync(String host, RequestIpType requestIpType, Map<String,String> params, String cacheKey)

所属类

HttpDnsService

引入版本

2.0.2

废弃版本

2.4.0

替代接口

HTTPDNSResult getHttpDnsResultForHostSyncNonBlocking(String host, RequestIpType requestIpType, Map params, String cacheKey)

参数说明

参数

类型

是否必填

说明

host

String

待解析域名。

requestIpType

RequestIpType

待解析的IP类型。推荐使用RequestIpType.both

params

Map<String, String>

解析域名携带的额外参数,对应服务端自定义解析函数中的event.parameters参数。

cacheKey

String

域名对应的本地缓存key,如果额外参数变更导致需要重新去服务端解析,则需要变更cacheKey。

返回说明

类型

说明

HTTPDNSResult

解析结果。

getHttpDnsResultForHostAsync

接口说明

HTTPDNSResult getHttpDnsResultForHostAsync(String host, RequestIpType type, Map<String, String> params, String cacheKey)

所属类

HttpDnsService

引入版本

2.0.2

废弃版本

2.4.0

替代接口

HTTPDNSResult getHttpDnsResultForHostSyncNonBlocking(String host, RequestIpType requestIpType, Map params, String cacheKey)

参数说明

参数

类型

是否必填

说明

host

String

待解析域名。

requestIpType

RequestIpType

待解析的IP类型。推荐使用RequestIpType.both

params

Map<String, String>

解析域名携带的额外参数,对应服务端自定义解析函数中的event.parameters参数。

cacheKey

String

域名对应的本地缓存key,如果额外参数变更导致需要重新去服务端解析,则需要变更cacheKey。

返回说明

类型

说明

HTTPDNSResult

解析结果。