From 6427d6fb133cea4515acbbc5b79f6def2ba7ae78 Mon Sep 17 00:00:00 2001 From: Looly Date: Mon, 28 Mar 2022 01:14:03 +0800 Subject: [PATCH] add GlobalInterceptor --- CHANGELOG.md | 1 + .../java/cn/hutool/http/GlobalHeaders.java | 6 +-- .../cn/hutool/http/GlobalInterceptor.java | 44 +++++++++++++++++++ .../java/cn/hutool/http/HttpInterceptor.java | 12 ++++- .../main/java/cn/hutool/http/HttpRequest.java | 5 ++- .../java/cn/hutool/http/HttpRequestTest.java | 13 ++++++ 6 files changed, 75 insertions(+), 6 deletions(-) create mode 100644 hutool-http/src/main/java/cn/hutool/http/GlobalInterceptor.java diff --git a/CHANGELOG.md b/CHANGELOG.md index b5587845b..e2c7fae40 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -47,6 +47,7 @@ * 【db 】 DruidDataSource构建时支持自定义参数（issue#I4ZKCW@Gitee） * 【poi 】 ExcelWriter增加addImg重载（issue#2218@Github） * 【bloomFilter】 增加FuncFilter +* 【http 】 增加GlobalInterceptor（issue#2217） ### 🐞Bug修复 * 【core 】 修复ObjectUtil.hasNull传入null返回true的问题（pr#555@Gitee） diff --git a/hutool-http/src/main/java/cn/hutool/http/GlobalHeaders.java b/hutool-http/src/main/java/cn/hutool/http/GlobalHeaders.java index 3dabe6288..210d17d60 100644 --- a/hutool-http/src/main/java/cn/hutool/http/GlobalHeaders.java +++ b/hutool-http/src/main/java/cn/hutool/http/GlobalHeaders.java @@ -113,7 +113,7 @@ public enum GlobalHeaders { * @param isOverride 是否覆盖已有值 * @return this */ - public GlobalHeaders header(String name, String value, boolean isOverride) { + synchronized public GlobalHeaders header(String name, String value, boolean isOverride) { if (null != name && null != value) { final List values = headers.get(name.trim()); if (isOverride || CollectionUtil.isEmpty(values)) { @@ -192,7 +192,7 @@ public enum GlobalHeaders { * @param name Header名 * @return this */ - public GlobalHeaders removeHeader(String name) { + synchronized public GlobalHeaders removeHeader(String name) { if (name != null) { headers.remove(name.trim()); } @@ -224,7 +224,7 @@ public enum GlobalHeaders { * @return this * @since 5.7.13 */ - public GlobalHeaders clearHeaders() { + synchronized public GlobalHeaders clearHeaders() { this.headers.clear(); return this; } diff --git a/hutool-http/src/main/java/cn/hutool/http/GlobalInterceptor.java b/hutool-http/src/main/java/cn/hutool/http/GlobalInterceptor.java new file mode 100644 index 000000000..6fc518efe --- /dev/null +++ b/hutool-http/src/main/java/cn/hutool/http/GlobalInterceptor.java @@ -0,0 +1,44 @@ +package cn.hutool.http; + +/** + * 全局的拦截器 + * + * @author looly + * @since 5.8.0 + */ +public enum GlobalInterceptor { + INSTANCE; + + private final HttpInterceptor.Chain interceptors = new HttpInterceptor.Chain(); + + /** + * 设置拦截器，用于在请求前重新编辑请求 + * + * @param interceptor 拦截器实现 + */ + synchronized public GlobalInterceptor addInterceptor(HttpInterceptor interceptor) { + this.interceptors.addChain(interceptor); + return this; + } + + /** + * 清空 + * @return this + */ + synchronized public GlobalInterceptor clear(){ + interceptors.clear(); + return this; + } + + /** + * 复制过滤器列表 + * @return {@link cn.hutool.http.HttpInterceptor.Chain} + */ + HttpInterceptor.Chain getCopied(){ + final HttpInterceptor.Chain copied = new HttpInterceptor.Chain(); + for (HttpInterceptor interceptor : this.interceptors) { + copied.addChain(interceptor); + } + return copied; + } +} diff --git a/hutool-http/src/main/java/cn/hutool/http/HttpInterceptor.java b/hutool-http/src/main/java/cn/hutool/http/HttpInterceptor.java index 308cc85dc..6e754f9cf 100644 --- a/hutool-http/src/main/java/cn/hutool/http/HttpInterceptor.java +++ b/hutool-http/src/main/java/cn/hutool/http/HttpInterceptor.java @@ -29,7 +29,6 @@ public interface HttpInterceptor { class Chain implements cn.hutool.core.lang.Chain { private final List interceptors = new LinkedList<>(); - @Override public Chain addChain(HttpInterceptor element) { interceptors.add(element); @@ -40,5 +39,16 @@ public interface HttpInterceptor { public Iterator iterator() { return interceptors.iterator(); } + + /** + * 清空 + * + * @return this + * @since 5.8.0 + */ + public Chain clear() { + interceptors.clear(); + return this; + } } } diff --git a/hutool-http/src/main/java/cn/hutool/http/HttpRequest.java b/hutool-http/src/main/java/cn/hutool/http/HttpRequest.java index 73883f0c7..ea8b5b03d 100644 --- a/hutool-http/src/main/java/cn/hutool/http/HttpRequest.java +++ b/hutool-http/src/main/java/cn/hutool/http/HttpRequest.java @@ -206,7 +206,7 @@ public class HttpRequest extends HttpBase { /** * 请求前的拦截器，用于在请求前重新编辑请求 */ - private final HttpInterceptor.Chain interceptors = new HttpInterceptor.Chain(); + private final HttpInterceptor.Chain interceptors = GlobalInterceptor.INSTANCE.getCopied(); /** * 默认连接超时 @@ -967,8 +967,9 @@ public class HttpRequest extends HttpBase { * @param interceptor 拦截器实现 * @since 5.7.16 */ - public void addInterceptor(HttpInterceptor interceptor) { + public HttpRequest addInterceptor(HttpInterceptor interceptor) { this.interceptors.addChain(interceptor); + return this; } /** diff --git a/hutool-http/src/test/java/cn/hutool/http/HttpRequestTest.java b/hutool-http/src/test/java/cn/hutool/http/HttpRequestTest.java index 1f00f4ba8..9c146e6bf 100644 --- a/hutool-http/src/test/java/cn/hutool/http/HttpRequestTest.java +++ b/hutool-http/src/test/java/cn/hutool/http/HttpRequestTest.java @@ -167,4 +167,17 @@ public class HttpRequestTest { execute = HttpRequest.get(url).setMaxRedirectCount(1).execute(); Console.log(execute.getStatus(), execute.header(Header.LOCATION)); } + + @Test + @Ignore + public void addInterceptorTest() { + HttpUtil.createGet("https://hutool.cn").addInterceptor(Console::log).execute(); + } + + @Test + @Ignore + public void addGlobalInterceptorTest() { + GlobalInterceptor.INSTANCE.addInterceptor(Console::log); + HttpUtil.createGet("https://hutool.cn").execute(); + } }