diff --git a/ApiDoc/foudations/commons/allclasses-frame.html b/ApiDoc/foudations/commons/allclasses-frame.html new file mode 100644 index 0000000..1ff56f3 --- /dev/null +++ b/ApiDoc/foudations/commons/allclasses-frame.html @@ -0,0 +1,28 @@ + + + +
+ + +public class Sample
+public static class NetConstants.Companion
+public class NetConstants
+created by wujifei on 2021/1/20 10:46 +describe:
public static int NO_DATA+
无数据
public static int OK+
数据返回正常
public static long READ_TIMEOUT+
public static long WRITE_TIMEOUT+
public static long CONNECT_TIMEOUT+
public static int HTTP_DNS_ADDRESS_TYPE_HTTP+
public static int HTTP_DNS_ADDRESS_TYPE_WS+
public static int HTTP_DNS_ADDRESS_TYPE_IM+
public static com.mogo.cloud.commons.network.NetConstants.Companion Companion+
public static class OkHttpFactory.Companion
+public class OkHttpFactory
+public class RetrofitFactory
+public static RetrofitFactory INSTANCE+
@Synchronized + @Nullable +public retrofit2.Retrofit getInstance(@NotNull + java.lang.String baseUrl)+
@Synchronized + @Nullable +public retrofit2.Retrofit getInstanceNoCallAdapter(@NotNull + java.lang.String baseUrl)+
public class HeaderNetworkInterceptor
+created by wujifei on 2021/1/20 15:18 +describe:
| 类 | +说明 | +
|---|---|
| HeaderNetworkInterceptor | +
+ created by wujifei on 2021/1/20 15:18
+describe:
+ |
+
| 类 | +说明 | +
|---|---|
| NetConstants | +
+ created by wujifei on 2021/1/20 10:46
+describe:
+ |
+
| OkHttpFactory | ++ |
| RetrofitFactory | ++ |
| 类 | +说明 | +
|---|---|
| Sample | ++ |
public class CoordinateUtils
+public static kotlin.Array[] transformFromWGSToGCJ(double lat, + double lon)+
手机GPS坐标转火星坐标
public static double transformLat(double x, + double y)+
public static double transformLon(double x, + double y)+
public static boolean outOfChina(double lat, + double lon)+
public static kotlin.Array[] transformGcj02toWgs84(double lat, + double lng)+
public static float calculateLineDistance(double lon1, + double lat1, + double lon2, + double lat2)+
lon1 - lat1 - lon2 - lat2 - public class NetworkUtilsKt
+| 类 | +说明 | +
|---|---|
| CoordinateUtils | ++ |
| NetworkUtilsKt | ++ |
| 限定符和类型 | +常量字段 | +值 | +
|---|---|---|
+
+public static long |
+CONNECT_TIMEOUT |
+15000 |
+
+
+public static int |
+HTTP_DNS_ADDRESS_TYPE_HTTP |
+0 |
+
+
+public static int |
+HTTP_DNS_ADDRESS_TYPE_IM |
+2 |
+
+
+public static int |
+HTTP_DNS_ADDRESS_TYPE_WS |
+1 |
+
+
+public static int |
+NO_DATA |
+-800 |
+
+
+public static int |
+OK |
+0 |
+
+
+public static long |
+READ_TIMEOUT |
+20000 |
+
+
+public static long |
+WRITE_TIMEOUT |
+20000 |
+
概览 页面是此 API 文档的首页, 提供了所有程序包的列表及其概要。此页面也可能包含这些程序包的总体说明。
+每个程序包都有一个页面, 其中包含它的类和接口的列表及其概要。此页面可以包含六个类别:
+每个类, 接口, 嵌套类和嵌套接口都有各自的页面。其中每个页面都由三部分 (类/接口说明, 概要表, 以及详细的成员说明) 组成:
+每个概要条目都包含该项目的详细说明的第一句。概要条目按字母顺序排列, 而详细说明则按其在源代码中出现的顺序排列。这样保持了程序员所建立的逻辑分组。
+每个注释类型都有各自的页面, 其中包含以下部分:
+每个枚举都有各自的页面, 其中包含以下部分:
+对于所有程序包, 有一个类分层结构页面, 以及每个程序包的分层结构。每个分层结构页面都包含类的列表和接口的列表。从java.lang.Object开始, 按继承结构对类进行排列。接口不从java.lang.Object继承。
已过时的 API 页面列出了所有已过时的 API。一般由于进行了改进并且通常提供了替代的 API, 所以建议不要使用已过时的 API。在将来的实现过程中, 可能会删除已过时的 API。
+索引 包含按字母顺序排列的所有类, 接口, 构造器, 方法和字段的列表。
+这些链接使您可以转至下一个或上一个类, 接口, 程序包或相关页面。
+这些链接用于显示和隐藏 HTML 框架。所有页面均具有有框架和无框架两种显示方式。
+所有类链接显示所有类和接口 (除了非静态嵌套类型)。
+每个可序列化或可外部化的类都有其序列化字段和方法的说明。此信息对重新实现者有用, 而对使用 API 的开发者则没有什么用处。尽管导航栏中没有链接, 但您可以通过下列方式获取此信息: 转至任何序列化类, 然后单击类说明的 "另请参阅" 部分中的 "序列化表格"。
+常量字段值页面列出了静态最终字段及其值。
++ + diff --git a/ApiDoc/foudations/commons/overview-summary.html b/ApiDoc/foudations/commons/overview-summary.html new file mode 100644 index 0000000..4f78fa0 --- /dev/null +++ b/ApiDoc/foudations/commons/overview-summary.html @@ -0,0 +1,147 @@ + + + + + + +
| 程序包 | +说明 | +
|---|---|
| com.mogo.cloud.commons | ++ |
| com.mogo.cloud.commons.network | ++ |
| com.mogo.cloud.commons.network.interceptor | ++ |
| com.mogo.cloud.commons.utils | ++ |
public class MogoHttpDnsClient +implements IMogoHttpDns+
public static MogoHttpDnsClient INSTANCE+
public void init(@NotNull + MogoHttpDnsConfig config)+
@Nullable +public java.lang.String getHttpDnsAddressUseCacheIfNecessary(int type, + @NotNull + java.lang.String _host)+
先从本地缓存中根据type和host获取ip:port,如果本地缓存中没有,再通过网络获取
@Nullable +public java.lang.String getHttpDnsAddress(int type, + @NotNull + java.lang.String _host)+
根据类型和host获取IP,直接通过网络请求获取全部路由表 +同时多线程多次请求会忽略部分网络请求,一定程度减少接口请求次数
type - HTTP_DNS_TYPE_HTTP用于请求http接口 HTTP_DNS_TYPE_WS用于webSocket长连接 若增加新类型,可自行设置@Nullable +public java.lang.String getHttpDnsCachedAddress(int type, + @NotNull + java.lang.String _host)+
根据类型和host获取本地cache的路由表
type - HTTP_DNS_TYPE_HTTP用于请求http接口 HTTP_DNS_TYPE_WS用于webSocket长连接 若增加新类型,可自行设置@Nullable +public java.util.Map<java.lang.String,java.lang.String> getAllAddress()+
获取全部路由表
public void release()+
public static class MogoHttpDnsConfig.Companion
+public class MogoHttpDnsConfig
+public static int HTTP_DNS_ENV_DEV+
研发环境
public static int HTTP_DNS_ENV_QA+
测试环境
public static int HTTP_DNS_ENV_DEMO+
演示环境
public static int HTTP_DNS_ENV_RELEASE+
线上环境
public static com.mogo.cloud.httpdns.MogoHttpDnsConfig.Companion Companion+
@NotNull +public MogoHttpDnsConfig setContext(@NotNull + android.content.Context context)+
@Nullable +public android.content.Context getContext()+
@NotNull +public MogoHttpDnsConfig setSn(@NotNull + java.lang.String sn)+
@Nullable +public java.lang.String getSn()+
@NotNull +public MogoHttpDnsConfig setShowDebugLog(boolean showDebugLog)+
public boolean showDebugLog()+
@NotNull +public MogoHttpDnsConfig setLoopCheckDelay(long loopCheckDelay)+
public long getLoopCheckDelay()+
@NotNull +public MogoHttpDnsConfig setCurrentLocation(@NotNull + IHttpDnsCurrentLocation currentLocation)+
@Nullable +public IHttpDnsCurrentLocation getCurrentLocation()+
@NotNull +public MogoHttpDnsConfig setEnv(int env)+
public int getEnv()+
@NotNull +public MogoHttpDnsConfig setDefaultUrl(@NotNull + java.lang.String defaultUrl)+
@Nullable +public java.lang.String getDefaultUrl()+
@NotNull +public MogoHttpDnsConfig setAppKey(@NotNull + java.lang.String appKey)+
@NotNull +public java.lang.String getAppKey()+
public class HttpDnsSimpleLocation
+httpDns需要的定位信息,需要使用高德定位的经纬度坐标和cityCode
public HttpDnsSimpleLocation(@NotNull + java.lang.String cityCode, + double lat, + double lon)+
httpDns需要的定位信息,需要使用高德定位的经纬度坐标和cityCode
@NotNull +public java.lang.String getCityCode()+
public double getLat()+
public double getLon()+
@NotNull +public java.lang.String component1()+
public double component2()+
public double component3()+
@NotNull +public HttpDnsSimpleLocation copy(@NotNull + java.lang.String cityCode, + double lat, + double lon)+
httpDns需要的定位信息,需要使用高德定位的经纬度坐标和cityCode
@NotNull +public java.lang.String toString()+
httpDns需要的定位信息,需要使用高德定位的经纬度坐标和cityCode
public int hashCode()+
httpDns需要的定位信息,需要使用高德定位的经纬度坐标和cityCode
public boolean equals(@Nullable + java.lang.Object p)+
httpDns需要的定位信息,需要使用高德定位的经纬度坐标和cityCode
| 类 | +说明 | +
|---|---|
| HttpDnsSimpleLocation | +
+ httpDns需要的定位信息,需要使用高德定位的经纬度坐标和cityCode
+ |
+
public IHttpDnsCurrentLocation
+@Nullable +HttpDnsSimpleLocation getCurrentLocation()+
public IMogoHttpDns
+@Nullable +java.lang.String getHttpDnsAddress(int type, + @NotNull + java.lang.String _host)+
根据类型和host获取IP,直接通过网络请求获取全部路由表 +同时多线程多次请求会忽略部分网络请求,一定程度减少接口请求次数
type - HTTP_DNS_TYPE_HTTP用于请求http接口 HTTP_DNS_TYPE_WS用于webSocket长连接 若增加新类型,可自行设置@Nullable +java.lang.String getHttpDnsCachedAddress(int type, + @NotNull + java.lang.String _host)+
根据类型和host获取本地cache的路由表
type - HTTP_DNS_TYPE_HTTP用于请求http接口 HTTP_DNS_TYPE_WS用于webSocket长连接 若增加新类型,可自行设置@Nullable +java.util.Map<java.lang.String,java.lang.String> getAllAddress()+
获取全部路由表
void release()+
public OnAddressChangedListener
+| 接口 | +说明 | +
|---|---|
| IHttpDnsCurrentLocation | ++ |
| IMogoHttpDns | ++ |
| OnAddressChangedListener | ++ |
| 类 | +说明 | +
|---|---|
| MogoHttpDnsClient | ++ |
| MogoHttpDnsConfig | ++ |
public class ApiManager
+接口请求管理类
public ApiManager(@NotNull + java.lang.String sn, + int env, + @NotNull + java.lang.String appKey)+
接口请求管理类
@Nullable +public java.util.Map<java.lang.String,java.lang.String> requestHttpDns(@NotNull + IHttpDnsCurrentLocation _location)+
public class ApiManagerKt
+public class L
+简单实现日志工具类
public boolean isDebug()+
public void setDebug(boolean p)+
public void d(@NotNull + java.lang.String tag, + @NotNull + java.lang.String msg)+
public void e(@NotNull + java.lang.String tag, + @NotNull + java.lang.String msg)+
public class NetWorkUtil
+网络状态工具类 +监听和获取网络状态
public class NetWorkUtilKt
+| 类 | +说明 | +
|---|---|
| ApiManager | +
+ 接口请求管理类
+ |
+
| ApiManagerKt | ++ |
| L | +
+ 简单实现日志工具类
+ |
+
| NetWorkUtil | +
+ 网络状态工具类
+监听和获取网络状态
+ |
+
| NetWorkUtilKt | ++ |
| 限定符和类型 | +常量字段 | +值 | +
|---|---|---|
+
+public static int |
+HTTP_DNS_ENV_DEMO |
+4 |
+
+
+public static int |
+HTTP_DNS_ENV_DEV |
+1 |
+
+
+public static int |
+HTTP_DNS_ENV_QA |
+2 |
+
+
+public static int |
+HTTP_DNS_ENV_RELEASE |
+3 |
+
概览 页面是此 API 文档的首页, 提供了所有程序包的列表及其概要。此页面也可能包含这些程序包的总体说明。
+每个程序包都有一个页面, 其中包含它的类和接口的列表及其概要。此页面可以包含六个类别:
+每个类, 接口, 嵌套类和嵌套接口都有各自的页面。其中每个页面都由三部分 (类/接口说明, 概要表, 以及详细的成员说明) 组成:
+每个概要条目都包含该项目的详细说明的第一句。概要条目按字母顺序排列, 而详细说明则按其在源代码中出现的顺序排列。这样保持了程序员所建立的逻辑分组。
+每个注释类型都有各自的页面, 其中包含以下部分:
+每个枚举都有各自的页面, 其中包含以下部分:
+对于所有程序包, 有一个类分层结构页面, 以及每个程序包的分层结构。每个分层结构页面都包含类的列表和接口的列表。从java.lang.Object开始, 按继承结构对类进行排列。接口不从java.lang.Object继承。
已过时的 API 页面列出了所有已过时的 API。一般由于进行了改进并且通常提供了替代的 API, 所以建议不要使用已过时的 API。在将来的实现过程中, 可能会删除已过时的 API。
+索引 包含按字母顺序排列的所有类, 接口, 构造器, 方法和字段的列表。
+这些链接使您可以转至下一个或上一个类, 接口, 程序包或相关页面。
+这些链接用于显示和隐藏 HTML 框架。所有页面均具有有框架和无框架两种显示方式。
+所有类链接显示所有类和接口 (除了非静态嵌套类型)。
+每个可序列化或可外部化的类都有其序列化字段和方法的说明。此信息对重新实现者有用, 而对使用 API 的开发者则没有什么用处。尽管导航栏中没有链接, 但您可以通过下列方式获取此信息: 转至任何序列化类, 然后单击类说明的 "另请参阅" 部分中的 "序列化表格"。
+常量字段值页面列出了静态最终字段及其值。
+请使用框架功能查看此文档。如果看到此消息, 则表明您使用的是不支持框架的 Web 客户机。链接到非框架版本。
++ + diff --git a/ApiDoc/foudations/httpdns/overview-summary.html b/ApiDoc/foudations/httpdns/overview-summary.html new file mode 100644 index 0000000..133e642 --- /dev/null +++ b/ApiDoc/foudations/httpdns/overview-summary.html @@ -0,0 +1,147 @@ + + + + + + +
| 程序包 | +说明 | +
|---|---|
| com.mogo.cloud.httpdns | ++ |
| com.mogo.cloud.httpdns.bean | ++ |
| com.mogo.cloud.httpdns.listener | ++ |
| com.mogo.cloud.httpdns.util | ++ |