新增支持添加动态的全局参数

Author: getActivity

EasyHttp.apk

@@ -1,15 +1,27 @@
 #### 如何添加全局参数？
 
-```
+```java
 // 添加全局请求参数
 EasyConfig.getInstance().addHeader("token", "abc");
 // 添加全局请求头
 EasyConfig.getInstance().addParam("token", "abc");
 ```
 
-#### 如何在请求中忽略某个全局参数？
+#### 如何定义全局的动态参数？
+
+```java
+EasyConfig.getInstance().setInterceptor(new IRequestInterceptor() {
 
+    @Override
+    public void intercept(String url, String tag, HttpParams params, HttpHeaders headers) {
+        headers.put("timestamp", String.valueOf(System.currentTimeMillis()));
+    }
+});
 ```
+
+#### 如何在请求中忽略某个全局参数？
+
+```java
 public final class XxxApi implements IRequestApi {
 
     @Override
@@ -24,7 +36,7 @@ public final class XxxApi implements IRequestApi {
 
 #### 如何获取服务器配置？
 
-```
+```java
 IRequestServer server = EasyConfig.getInstance().getServer();
 // 获取当前全局的服务器主机地址
 String host = server.getHost();
@@ -36,7 +48,7 @@ String path = server.getPath();
 
 * 先定义一个服务器配置
 
-```
+```java
 public class XxxServer implements IRequestServer {
 
     @Override
@@ -53,13 +65,13 @@ public class XxxServer implements IRequestServer {
 
 * 再将它应用到全局配置中
 
-```
+```java
 EasyConfig.getInstance().setServer(new XxxServer());
 ```
 
 * 如果只是针对某个接口可以这样配置
 
-```
+```java
 public final class XxxApi extends XxxServer implements IRequestApi {
 
     @Override
@@ -71,7 +83,7 @@ public final class XxxApi extends XxxServer implements IRequestApi {
 
 * 如果不想单独定义一个类，也可以这样写
 
-```
+```java
 public final class XxxApi implements IRequestServer, IRequestApi {
 
     @Override
@@ -95,7 +107,7 @@ public final class XxxApi implements IRequestServer, IRequestApi {
 
 * 以表单的形式提交参数（默认）
 
-```
+```java
 public class XxxServer implements IRequestServer {
 
     @Override
@@ -117,7 +129,7 @@ public class XxxServer implements IRequestServer {
 
 * 以 Json 的形式提交参数
 
-```
+```java
 public class XxxServer implements IRequestServer {
 
     @Override
@@ -148,7 +160,7 @@ public class XxxServer implements IRequestServer {
 
 #### 如何忽略某个参数？
 
-```
+```java
 public final class XxxApi implements IRequestApi {
 
     @Override
@@ -163,7 +175,7 @@ public final class XxxApi implements IRequestApi {
 
 #### 如何传入请求头？
 
-```
+```java
 public final class XxxApi implements IRequestApi {
 
     @Override
@@ -178,7 +190,7 @@ public final class XxxApi implements IRequestApi {
 
 #### 如何重命名参数名称？
 
-```
+```java
 public final class XxxApi implements IRequestApi {
 
     @Override
@@ -195,7 +207,7 @@ public final class XxxApi implements IRequestApi {
 
 * 使用 File 对象上传
 
-```
+```java
 public final class XxxApi implements IRequestApi {
 
     @Override
@@ -209,7 +221,7 @@ public final class XxxApi implements IRequestApi {
 
 * 使用 InputStream 对象上传
 
-```
+```java
 public final class XxxApi implements IRequestApi {
 
     @Override
@@ -223,7 +235,7 @@ public final class XxxApi implements IRequestApi {
 
 * 使用 RequestBody 对象上传
 
-```
+```java
 public final class XxxApi implements IRequestApi {
 
     @Override
@@ -237,7 +249,7 @@ public final class XxxApi implements IRequestApi {
 
 #### 如何上传文件列表？
 
-```
+```java
 public final class XxxApi implements IRequestApi {
 
     @Override
@@ -251,12 +263,12 @@ public final class XxxApi implements IRequestApi {
 
 #### 如何设置超时重试？
 
-```
+```java
 EasyConfig.getInstance().setRetryCount(3);
 ```
 
 #### 如何设置不打印日志？
 
-```
+```java
 EasyConfig.getInstance().setLogEnabled(false);
 ```

HelpDoc.md

@@ -17,7 +17,7 @@
 	}
 
     dependencies {
-        implementation 'com.hjq:http:8.0'
+        implementation 'com.hjq:http:8.2'
 	    implementation 'com.squareup.okhttp3:okhttp:3.12.10'
 	    implementation 'com.google.code.gson:gson:2.8.5'
     }
@@ -127,8 +127,8 @@
 
     EasyHttp.post(this)
             .api(new LoginApi()
-            .setUserName("Android 轮子哥")
-            .setPassword("123456"))
+                    .setUserName("Android 轮子哥")
+                    .setPassword("123456"))
             .request(new HttpCallback<HttpData<LoginBean>>(activity) {
 
                 @Override
@@ -214,14 +214,15 @@
 
 |  功能  | Retrofit 框架  | EasyHttp 框架 |
 | :----: | :------: |  :-----: |
-|    动态 Host   | 不支持 | 支持 |
+|    动态 Host  | 不支持 | 支持 |
 |    全局参数   |  不支持  | 支持 |
+|    动态参数   |  不支持  | 支持 |
 |    超时重试   | 不支持 | 支持 |
 |    极速下载   | 不支持 | 支持 |
 |    下载校验   | 不支持 | 支持 |
 |    注解数量   |  25 个  | 3 个 |
 |    上传文件   | RequestBody | File / InputStream |
-|    请求管理  |  需要封装  | 自动管控 |
+|    生命周期  |  需要封装  | 自动管控 |
 
 #### 作者的其他开源项目
 

README.md

@@ -13,8 +13,8 @@ android {
         applicationId "com.hjq.http.demo"
         minSdkVersion 14
         targetSdkVersion 28
-        versionCode 80
-        versionName "8.0"
+        versionCode 82
+        versionName "8.2"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
 

app/build.gradle

@@ -3,10 +3,13 @@
 import android.app.Application;
 
 import com.hjq.http.EasyConfig;
+import com.hjq.http.config.IRequestInterceptor;
 import com.hjq.http.config.IRequestServer;
 import com.hjq.http.demo.http.model.RequestHandler;
 import com.hjq.http.demo.http.server.ReleaseServer;
 import com.hjq.http.demo.http.server.TestServer;
+import com.hjq.http.model.HttpHeaders;
+import com.hjq.http.model.HttpParams;
 import com.hjq.toast.ToastUtils;
 
 import okhttp3.OkHttpClient;
@@ -33,6 +36,13 @@ public void onCreate() {
                 .setServer(server)
                 // 设置请求处理策略
                 .setHandler(new RequestHandler(this))
+                // 设置请求参数拦截器
+                .setInterceptor(new IRequestInterceptor() {
+                    @Override
+                    public void intercept(String url, String tag, HttpParams params, HttpHeaders headers) {
+                        headers.put("timestamp", String.valueOf(System.currentTimeMillis()));
+                    }
+                })
                 // 设置请求重试次数
                 .setRetryCount(1)
                 // 添加全局请求参数

app/src/main/java/com/hjq/http/demo/MyApplication.java

@@ -13,8 +13,8 @@ android {
     defaultConfig {
         minSdkVersion 14
         targetSdkVersion 26
-        versionCode 80
-        versionName "8.0"
+        versionCode 82
+        versionName "8.2"
     }
 }
 
@@ -27,7 +27,7 @@ publish {
     userOrg = 'getactivity'
     groupId = 'com.hjq'
     artifactId = 'http'
-    version = '8.0'
+    version = '8.2'
     description = 'Easy-to-use network request framework'
     website = "https://github.com/getActivity/EasyHttp"
 }

library/build.gradle

@@ -2,6 +2,7 @@
 
 import com.hjq.http.config.ILogStrategy;
 import com.hjq.http.config.IRequestHandler;
+import com.hjq.http.config.IRequestInterceptor;
 import com.hjq.http.config.IRequestServer;
 import com.hjq.http.config.LogStrategy;
 import com.hjq.http.config.RequestServer;
@@ -40,8 +41,10 @@ public static EasyConfig with(OkHttpClient client) {
 
     /** 服务器配置 */
     private IRequestServer mServer;
-    /** 请求拦截器 */
+    /** 请求处理器 */
     private IRequestHandler mHandler;
+    /** 请求拦截器 */
+    private IRequestInterceptor mInterceptor;
     /**  日志打印策略 */
     private ILogStrategy mLogStrategy;
 
@@ -83,6 +86,11 @@ public EasyConfig setHandler(IRequestHandler handler) {
         return this;
     }
 
+    public EasyConfig setInterceptor(IRequestInterceptor interceptor) {
+        mInterceptor = interceptor;
+        return this;
+    }
+
     public EasyConfig setClient(OkHttpClient client) {
         mClient = client;
         return this;
@@ -125,7 +133,7 @@ public EasyConfig setLogTag(String tag) {
 
     public EasyConfig setRetryCount(int count) {
         if (count < 0) {
-            // 重试次数必须大于0
+            // 重试次数必须大于等于 0 次
             throw new IllegalArgumentException("The number of retries must be greater than 0");
         }
         mRetryCount = count;
@@ -134,7 +142,7 @@ public EasyConfig setRetryCount(int count) {
 
     public void setRetryTime(long time) {
         if (time < 0) {
-            // 重试时间必须大于0
+            // 重试时间必须大于等于 0 毫秒
             throw new IllegalArgumentException("The retry time must be greater than 0");
         }
         mRetryTime = time;
@@ -148,6 +156,10 @@ public IRequestHandler getHandler() {
         return mHandler;
     }
 
+    public IRequestInterceptor getInterceptor() {
+        return mInterceptor;
+    }
+
     public OkHttpClient getClient() {
         return mClient;
     }

library/src/main/java/com/hjq/http/EasyConfig.java

@@ -24,17 +24,13 @@
  */
 public abstract class BaseCallback implements Callback {
 
-    /**
-     * 请求任务对象
-     */
+    /** 请求任务对象 */
     private CallProxy mCall;
-    /**
-     * 当前重试次数
-     */
+
+    /** 当前重试次数 */
     private int mRetryCount;
-    /**
-     * 生命周期管理
-     */
+
+    /** 生命周期管理 */
     private LifecycleOwner mLifecycleOwner;
 
     BaseCallback(LifecycleOwner lifecycleOwner, CallProxy call) {

library/src/main/java/com/hjq/http/callback/BaseCallback.java

@@ -0,0 +1,23 @@
+package com.hjq.http.config;
+
+import com.hjq.http.model.HttpHeaders;
+import com.hjq.http.model.HttpParams;
+
+/**
+ *    author : Android 轮子哥
+ *    github : https://github.com/getActivity/EasyHttp
+ *    time   : 2020/08/05
+ *    desc   : 请求参数拦截器
+ */
+public interface IRequestInterceptor {
+
+    /**
+     * 开始请求之前调用
+     *
+     * @param url           请求地址
+     * @param tag           请求标记
+     * @param params        请求参数
+     * @param headers       请求头参数
+     */
+    void intercept(String url, String tag, HttpParams params, HttpHeaders headers);
+}

library/src/main/java/com/hjq/http/config/IRequestInterceptor.java

@@ -10,6 +10,7 @@
 import com.hjq.http.annotation.HttpRename;
 import com.hjq.http.config.IRequestApi;
 import com.hjq.http.config.IRequestHost;
+import com.hjq.http.config.IRequestInterceptor;
 import com.hjq.http.config.IRequestPath;
 import com.hjq.http.config.IRequestServer;
 import com.hjq.http.config.IRequestType;
@@ -254,6 +255,10 @@ public Call create() {
         }
 
         String url = mRequestHost.getHost() + mRequestPath.getPath() + mRequestApi.getApi();
+        IRequestInterceptor interceptor = EasyConfig.getInstance().getInterceptor();
+        if (interceptor != null) {
+            interceptor.intercept(url, mTag, params, headers);
+        }
         return mClient.newCall(create(url, mTag, params, headers, type));
     }