新增网络请求代码日志定位功能

新增 Https 相关证书类及文档优化框架代码逻辑嵌套及代码注释新增支持为单个接口设置请求处理器
getActivity · Dec 31, 2020 · 0b6471f · 0b6471f
1 parent e163f27
commit 0b6471f
Show file tree

Hide file tree

Showing 57 changed files with 1,607 additions and 1,515 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,13 +1,11 @@
-*.iml
-.gradle
-/local.properties
-/.idea/workspace.xml
-/.idea/libraries
-.DS_Store
+/.gradle
+/.idea
 /build
+*/build
 /captures
-/.idea
+/.cxx
+/.externalNativeBuild
 
-/app/*.pro
-
-/library/*.pro
+*.iml
+.DS_Store
+local.properties
diff --git a/EasyHttp.apk b/EasyHttp.apk
diff --git a/HelpDoc.md b/HelpDoc.md
@@ -24,7 +24,7 @@
 * Android P 限制了明文流量的网络请求，非加密的流量请求都会被系统禁止掉。
 如果当前应用的请求是 http 请求，而非 https ,这样就会导系统禁止当前应用进行该请求，如果 WebView 的 url 用 http 协议，同样会出现加载失败，https 不受影响
 
-* 在 res 下新建一个 xml 目录，然后创建一个名为：network_security_config.xml 文件 ，该文件内容如下
+* 在 res 下新建一个 xml 目录，然后创建一个名为：`network_security_config.xml` 文件 ，该文件内容如下
 
 ```xml
 <?xml version="1.0" encoding="utf-8"?>
@@ -65,7 +65,7 @@ public class RequestServer implements IRequestServer {
 
 #### 框架初始化
 
-* 需要配置请求结果处理，具体封装可以参考 [RequestHandler](app/src/main/java/com/hjq/http/demo/http/model/RequestHandler.java)
+* 需要配置请求结果处理，具体封装可以参考 [RequestHandler](app/src/main/java/com/hjq/easy/demo/http/model/RequestHandler.java)
 
 ```java
 OkHttpClient okHttpClient = new OkHttpClient.Builder()
@@ -107,7 +107,7 @@ EasyConfig.getInstance()
 -dontwarn okio.**
 
 # 不混淆这个包下的字段名
--keepclassmembernames class com.hjq.http.demo.http.** {
+-keepclassmembernames class com.xxx.xxx.xxx.xxx.** {
     <fields>;
 }
 ```
@@ -353,7 +353,7 @@ String host = server.getHost();
 String path = server.getPath();
 ```
 
-#### 如何修改服务器配置？
+#### 如何修改接口的服务器配置？
 
 * 先定义一个服务器配置
 
@@ -412,6 +412,85 @@ public final class XxxApi implements IRequestServer, IRequestApi {
 }
 ```
 
+#### 如何配置多域名？
+
+* 先定义一个普通接口的测试服和正式服的配置
+
+```java
+public class TestServer implements IRequestServer {
+
+    @Override
+    public String getHost() {
+        return "https://www.test.xxxxxxx.com/";
+    }
+
+    @Override
+    public String getPath() {
+        return "api/";
+    }
+}
+```
+
+```java
+public class ReleaseServer implements IRequestServer {
+
+    @Override
+    public String getHost() {
+        return "https://www.xxxxxxx.com/";
+    }
+
+    @Override
+    public String getPath() {
+        return "api/";
+    }
+}
+```
+
+* 再将它应用到全局配置中
+
+```java
+IRequestServer server;
+if (BuildConfig.DEBUG) {
+    server = new TestServer();
+} else {
+    server = new ReleaseServer();
+}
+EasyConfig.getInstance().setServer(server);
+```
+
+* 假设要为 H5 业务模块设定特定服务器配置，可以这样做
+
+```java
+public class H5Server implements IRequestServer {
+
+    @Override
+    public String getHost() {
+        IRequestServer server = EasyConfig.getInstance().getServer();
+        if (server instanceof TestServer) {
+            return "https://www.test.h5.xxxxxxx.com/";
+        }
+        return "https://www.h5.xxxxxxx.com/";
+    }
+
+    @Override
+    public String getPath() {
+        return "api/";
+    }
+}
+```
+
+* 在配置接口的时候继承 H5Server 就可以了，其他 H5 模块的配置也是雷同
+
+```java
+public final class UserAgreementApi extends H5Server implements IRequestApi {
+
+    @Override
+    public String getApi() {
+        return "user/agreement";
+    }
+}
+```
+
 #### 如何修改参数的提交方式？
 
 * 以表单的形式提交参数（默认）
@@ -482,6 +561,39 @@ public final class XxxApi implements IRequestApi, IRequestType {
 |   参数嵌套  |  不支持  |   支持  |
 |   文件上传  |   支持  |  不支持  |
 
+#### 如何对整个 Json 字符串进行加密？
+
+* 这块的需求比较奇葩，但是搭配 OkHttp 拦截器仍然是可以实现的，这得益于 EasyHttp 良好的框架设计
+
+```java
+OkHttpClient okHttpClient = new OkHttpClient.Builder()
+        .addInterceptor(new Interceptor() {
+            @Override
+            public Response intercept(Chain chain) throws IOException {
+                Request request = chain.request();
+                RequestBody body = request.body();
+                if (body instanceof JsonBody) {
+                    body = new JsonBody("假装加密了：" + ((JsonBody) body).getJson());
+                    Request.Builder builder = request.newBuilder();
+                    builder.method(request.method(), body);
+                    request = builder.build();
+                }
+                return chain.proceed(request);
+            }
+        })
+        .build();
+```
+
+* 在 Application 初始化 EasyHttp 的时候配置进去
+
+```java
+EasyConfig.with(okHttpClient)
+        //.setXxxx(Xxxx)
+        //.setXxxx(Xxxx)
+        //.setXxxx(Xxxx)
+        .into();
+```
+
 #### 如何忽略某个参数？
 
 ```java
@@ -512,7 +624,7 @@ public final class XxxApi implements IRequestApi {
 }
 ```
 
-#### 如何重命名参数名称？
+#### 如何重命名参数/请求头的名称？
 
 ```java
 public final class XxxApi implements IRequestApi {
@@ -683,6 +795,18 @@ EasyHttp.cancel(Object tag);
 EasyHttp.cancel();
 ```
 
+#### Https 如何配置信任所有证书?
+
+* 在初始化 OkHttp 的时候这样设置，但是不推荐这样做，因为这样是不安全的，意味着每个请求都不会 Https 去校验
+
+```java
+HttpSslConfig sslConfig = HttpSslFactory.generateSslConfig();
+OkHttpClient okHttpClient = new OkHttpClient.Builder()
+        .sslSocketFactory(sslConfig.getsSLSocketFactory(), sslConfig.getTrustManager())
+        .hostnameVerifier(HttpSslFactory.generateUnSafeHostnameVerifier())
+        .build();
+```
+
 #### getHost、getPath、getApi 方法之间的作用和区别？
 
 * Host：服务器主机的地址

diff --git a/README.md b/README.md
@@ -1,24 +1,26 @@
 # 简单易用的网络框架
 
-> 码云地址：[Gitee](https://gitee.com/getActivity/EasyHttp)
+* 码云地址：[Gitee](https://gitee.com/getActivity/EasyHttp)
 
-> [点击此处下载Demo](EasyHttp.apk)
+* 博客地址：[网络请求，如斯优雅](https://www.jianshu.com/p/93cd59dec002)
+
+* [点击此处下载Demo](EasyHttp.apk)
 
 ![](EasyHttp.jpg)
 
-> 另外对 OkHttp 源码感兴趣的同学可以看下面几篇文章
+* 另外对 OkHttp 原理感兴趣的同学推荐你看以下源码分析文章
 
-* [OkHttp 精讲：拦截器执行原理](https://www.jianshu.com/p/e0f324fd9411)
+ * [OkHttp 精讲：拦截器执行原理](https://www.jianshu.com/p/e0f324fd9411)
 
-* [OkHttp 精讲：RetryAndFollowUpInterceptor](https://www.jianshu.com/p/40636d32cb67)
+ * [OkHttp 精讲：RetryAndFollowUpInterceptor](https://www.jianshu.com/p/40636d32cb67)
 
-* [OkHttp 精讲：BridgeInterceptor](https://www.jianshu.com/p/fab2d74de900)
+ * [OkHttp 精讲：BridgeInterceptor](https://www.jianshu.com/p/fab2d74de900)
 
-* [OkHttp 精讲：CacheInterceptor](https://www.jianshu.com/p/44fad764c0ae)
+ * [OkHttp 精讲：CacheInterceptor](https://www.jianshu.com/p/44fad764c0ae)
 
-* [OkHttp 精讲：ConnectInterceptor](https://www.jianshu.com/p/a3a774fdff4f)
+ * [OkHttp 精讲：ConnectInterceptor](https://www.jianshu.com/p/a3a774fdff4f)
 
-* [OkHttp 精讲：CallServerInterceptor](https://www.jianshu.com/p/aa77af6251ff)
+ * [OkHttp 精讲：CallServerInterceptor](https://www.jianshu.com/p/aa77af6251ff)
 
 #### Gradle 集成
 
@@ -33,38 +35,40 @@ android {
 
 dependencies {
     // 网络请求框架：https://github.com/getActivity/EasyHttp
-    implementation 'com.hjq:http:8.9'
+    implementation 'com.hjq:http:9.0'
     // OkHttp 框架：https://github.com/square/okhttp
     // noinspection GradleDependency
     implementation 'com.squareup.okhttp3:okhttp:3.12.12'
 }
 ```
             
 ## [框架的具体用法请点击这里查看](HelpDoc.md)
-
-#### 不同网络请求框架之间的对比
 
-|  功能  | [EasyHttp](https://github.com/getActivity/EasyHttp) | [Retrofit](https://github.com/square/retrofit) | [OkGo](https://github.com/jeasonlzy/okhttp-OkGo) |
+### 不同网络请求框架之间的对比
+
+|  功能或细节  | [EasyHttp](https://github.com/getActivity/EasyHttp) | [Retrofit](https://github.com/square/retrofit) | [OkGo](https://github.com/jeasonlzy/okhttp-OkGo) |
 | :----: | :------: |  :-----: |  :-----: |
-|    对应版本  |  8.9 |  2.9.0  |  3.0.4    |
-|    动态 Host  |  支持  |  不支持  |   支持   |
+|    对应版本  |  9.0 |  2.9.0  |  3.0.4    |
+|    **aar 包大小**  |  [61 KB](https://bintray.com/getactivity/maven/http#files/com/hjq/http)  | [123 KB](https://bintray.com/bintray/jcenter/com.squareup.retrofit2%3Aretrofit#files)  |  [131 KB](https://bintray.com/jeasonlzy/maven/okgo#files/com/lzy/net/okgo)  |
+|    minSdk 要求  |  API 14+ |  API 21+  |  API 14+   |
+|    配置多域名  |  支持  |  不支持  |   支持   |
+|    **动态 Host**  |  支持  |  不支持  |   不支持   |
 |    全局参数   |  支持  |  不支持  |    支持   |
 |    超时重试   |  支持  |  不支持  |    支持   |
-|    下载校验   |  支持  |  不支持  |   不支持  |
-|    极速下载   |  支持  |  不支持  |   不支持  |
-|    注解数量   |  3 个  |  25 个  |   0 个  |
+|    **下载校验**   |  支持  |  不支持  |   不支持  |
+|    **极速下载**   |  支持  |  不支持  |   不支持  |
 |    上传文件类型   | File / InputStream / RequestBody | RequestBody |  File  |
 |    批量上传文件   |  支持  |   不支持   |    支持    |
 |    上传进度监听   |  支持  |   不支持   |    支持    |
-|    Json 参数提交  |  支持  |   不支持   |   支持   |
-|    请求生命周期  | 自动管控 |   需要封装  |   需要封装  |
-|    参数传值方式  |  字段名 + 字段值  | 方法参数名 + 方法参数值 |  定义 Key + Value  |
+|    Json 参数提交  |  支持  |   不支持   |    支持   |
+|    **请求代码定位**   |  支持  |   不支持   |    不支持    |
+|    **请求生命周期**  | 自动管控 |   需要封装  |   需要封装  |
+|    参数传值方式  |  字段名 + 字段值  | 参数名 + 参数值 |  定义 Key + Value  |
 |    参数灵活性  | 不强制传入 | 强制全部传入 |   不强制传入 |
-|    自定义 RequestBody | 支持  | 支持  |   支持    |
-|    minSdk 要求  |  API 14+ |  API 21+  |  API 14+   |
-|    class 文件数量  |  70 个  | 54 个  |  85 个  |
-|    aar 包大小  |  [55 KB](https://bintray.com/getactivity/maven/http#files/com/hjq/http)  | [123 KB](https://bintray.com/bintray/jcenter/com.squareup.retrofit2%3Aretrofit#files)  |  [131 KB](https://bintray.com/jeasonlzy/maven/okgo#files/com/lzy/net/okgo)  |  
-|   框架维护状态 |  维护中  |   维护中   |   停止维护  |
+|    框架学习成本   |    中    |     高    |    低    |
+|    **API 记忆成本**  |    低    |     高    |    低    | 
+|    **接口维护成本**   |   低     |     中    |    高    |
+|    框架维护状态   |  维护中  |   维护中   |   停止维护  |
 
 * Retrofit 在我看来并不是那么好用，因为很多常用的功能实现起来比较麻烦，动态 Host 要写拦截器，日志打印要写拦截器，就连最常用的添加全局参数也要写拦截器，一个拦截器意味着要写很多代码，如果写得不够严谨还有可能出现 Bug，从而影响整个 OkHttp 请求流程，我经常在想这些功能能不能都用一句代码搞定，因为我觉得这些功能是设计框架的时候本应该考虑的，这便是我做这个框架的初心。
 
@@ -76,25 +80,33 @@ dependencies {
 
 #### 极速下载功能介绍
 
-* 其实本质上面和极速秒传的原理是差不多的，只不过一个是上传，一个是下载。而极速上传是将本地文件的 MD5 值和服务器上面的进行比对，如果服务器存在这个 MD5 值的文件，就将这份文件映射一份到这个用户的网盘上面，从而达到了极速秒传的效果。而极速下载也是同理，根据后台给的文件 MD5 值和本地文件进行对比，如果存在这个文件并且 MD5 值一致，证明这个文件和服务器上面的文件是一致的，那么就直接跳过下载，直接回调下载成功监听。
+* 其实本质上面和极速秒传的原理是差不多的，只不过一个是上传，另一个是下载。而极速上传是将本地文件的 MD5 值和服务器上面的进行比对，如果服务器存在这个 MD5 值的文件，就将这份文件映射一份到这个用户的网盘上面，从而达到了极速秒传的效果。而极速下载也是同理，根据后台给的文件 MD5 值和本地文件进行对比，如果存在这个文件并且 MD5 值一致，证明这个文件和服务器上面的文件是一致的，那么就直接跳过下载，直接回调下载成功监听。
 
-* 极速秒传和极速下载两者相同的共同点就是，利用缓存来达到极速的效果，只不过一者通过的是服务器的缓存，另一者使用的是本地的缓存，这两者都有一个共同的特点，就是减少服务器的压力，节省用户的等待时间。
+* 极速秒传和极速下载两者相同的共同点就是，利用缓存来达到极速的效果，只不过一者通过的是服务器的缓存，另一者使用的是本地的缓存，这两者都有一个共同的特点，就是减少服务器的压力，节省用户的等待时间。
+
+#### 代码定位功能介绍
+
+* 框架会在日志打印中输出在网络请求的代码位置，这样开发者可以直接通过点击 Log 来定位代码是在哪个类哪行代码，这样可以极大提升我们排查问题的效率，特别是在请求一多且业务复杂的情况下，我相信没有一个人会拒绝这样的功能。
+
+![](RequestCode.png)
 
 #### 作者的其他开源项目
 
 * 安卓技术中台：[AndroidProject](https://github.com/getActivity/AndroidProject)
 
-* 日志框架：[Logcat](https://github.com/getActivity/Logcat)
+* 权限框架：[XXPermissions](https://github.com/getActivity/XXPermissions)
 
 * 吐司框架：[ToastUtils](https://github.com/getActivity/ToastUtils)
 
-* 权限框架：[XXPermissions](https://github.com/getActivity/XXPermissions)
-
 * 标题栏框架：[TitleBar](https://github.com/getActivity/TitleBar)
 
 * 国际化框架：[MultiLanguages](https://github.com/getActivity/MultiLanguages)
 
-* 悬浮窗框架：[XToast](https://github.com/getActivity/XToast)
+* 悬浮窗框架：[XToast](https://github.com/getActivity/XToast)
+
+* 日志框架：[Logcat](https://github.com/getActivity/Logcat)
+
+* Gson 解析容错：[GsonFactory](https://github.com/getActivity/GsonFactory)
 
 #### Android技术讨论Q群：78797078
 
@@ -125,4 +137,5 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.
+```
diff --git a/RequestCode.png b/RequestCode.png
diff --git a/app/.gitignore b/app/.gitignore