Merge pull request 'v0.0.14' (#19) from dev into master

Reviewed-on: #19

pom.xml

@@ -6,7 +6,7 @@
 
 	<groupId>com.imyeyu.network</groupId>
 	<artifactId>timi-network</artifactId>
-	<version>0.0.12</version>
+	<version>0.0.14</version>
 	<packaging>jar</packaging>
 
 	<properties>

src/main/java/com/imyeyu/network/ArgMap.java

@@ -1,5 +1,6 @@
 package com.imyeyu.network;
 
+import com.imyeyu.java.TimiJava;
 import com.imyeyu.utils.Encoder;
 import org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder;
 import org.apache.hc.client5.http.fluent.Form;
@@ -29,7 +30,7 @@ public class ArgMap<K, V> {
 	private final List<Map.Entry<K, V>> entries = new ArrayList<>();
 
 	/**
-	 * 追加一个参数。
+	 * 追加一个参数
 	 *
 	 * @param key   参数名
 	 * @param value 参数值
@@ -41,7 +42,7 @@ public class ArgMap<K, V> {
 	}
 
 	/**
-	 * 按插入顺序遍历全部参数。
+	 * 按插入顺序遍历全部参数
 	 *
 	 * @param consumer 处理逻辑
 	 */
@@ -50,29 +51,29 @@ public class ArgMap<K, V> {
 	}
 
 	/**
-	 * 按插入顺序遍历全部非空参数。
+	 * 按插入顺序遍历全部非空参数
 	 *
 	 * @param consumer 处理逻辑
 	 */
 	private void forEachNonNull(BiConsumer<? super K, ? super V> consumer) {
 		entries.forEach(entry -> {
-			if (entry.getValue() != null) {
+			if (TimiJava.isNotEmpty(entry.getValue())) {
 				consumer.accept(entry.getKey(), entry.getValue());
 			}
 		});
 	}
 
 	/**
-	 * 是否存在可输出的非空参数。
+	 * 是否存在可输出的非空参数
 	 *
-	 * @return 是否存在非空参数
+	 * @return true 为存在非空参数
 	 */
 	private boolean hasNonNullValue() {
-		return entries.stream().anyMatch(entry -> entry.getValue() != null);
+		return entries.stream().anyMatch(entry -> TimiJava.isNotEmpty(entry.getValue()));
 	}
 
 	/**
-	 * 返回参数数量。
+	 * 参数数量
 	 *
 	 * @return 参数数量
 	 */
@@ -81,23 +82,21 @@ public class ArgMap<K, V> {
 	}
 
 	/**
-	 * 判断参数列表是否为空。
+	 * 判断参数列表是否为空
 	 *
-	 * @return 是否为空
+	 * @return true 为空
 	 */
 	public boolean isEmpty() {
 		return entries.isEmpty();
 	}
 
-	/**
+	/** 清空全部参数 */
-	 * 清空全部参数。
-	 */
 	public void clear() {
 		entries.clear();
 	}
 
 	/**
-	 * 返回只读参数视图。
+	 * 返回只读参数视图
 	 *
 	 * @return 参数条目列表
 	 */
@@ -106,7 +105,7 @@ public class ArgMap<K, V> {
 	}
 
 	/**
-	 * 转换为 multipart 实体。
+	 * 转换为 multipart 实体
 	 *
 	 * @return multipart 请求体
 	 */
@@ -125,7 +124,7 @@ public class ArgMap<K, V> {
 	}
 
 	/**
-	 * 转换为表单参数列表。
+	 * 转换为表单参数列表
 	 *
 	 * @return 表单参数列表
 	 */
@@ -136,9 +135,9 @@ public class ArgMap<K, V> {
 	}
 
 	/**
-	 * 转换为 query string。
+	 * 转换为 URL 查询参数
 	 *
-	 * @return query string
+	 * @return URL 查询参数
 	 */
 	public String toURL() {
 		if (!hasNonNullValue()) {
@@ -151,7 +150,7 @@ public class ArgMap<K, V> {
 	}
 
 	/**
-	 * 将参数拼接到指定 URL。
+	 * 将参数拼接到指定 URL
 	 *
 	 * @param url 原始 URL
 	 * @return 拼接后的 URL
@@ -173,7 +172,7 @@ public class ArgMap<K, V> {
 	}
 
 	/**
-	 * 使用一组参数创建对象。
+	 * 使用一组参数创建对象
 	 *
 	 * @param key   参数名
 	 * @param value 参数值
@@ -186,7 +185,7 @@ public class ArgMap<K, V> {
 	}
 
 	/**
-	 * 使用两组参数创建对象。
+	 * 使用两组参数创建对象
 	 *
 	 * @param key1   参数名 1
 	 * @param value1 参数值 1
@@ -201,7 +200,7 @@ public class ArgMap<K, V> {
 	}
 
 	/**
-	 * 使用三组参数创建对象。
+	 * 使用三组参数创建对象
 	 *
 	 * @param key1   参数名 1
 	 * @param value1 参数值 1

src/main/java/com/imyeyu/network/CommonRequest.java

@@ -1,7 +1,12 @@
 package com.imyeyu.network;
 
+import com.imyeyu.java.TimiJava;
+import com.imyeyu.java.bean.CallbackArg;
+import org.apache.hc.client5.http.fluent.ContentResponseHandler;
 import org.apache.hc.client5.http.fluent.Request;
 import org.apache.hc.core5.http.HttpEntity;
+import org.apache.hc.core5.http.HttpResponse;
+import org.apache.hc.core5.http.io.HttpClientResponseHandler;
 import org.apache.hc.core5.util.Timeout;
 
 import java.io.IOException;
@@ -15,6 +20,9 @@ public class CommonRequest {
 
 	protected final Request request;
 
+	/// 响应回调
+	protected CallbackArg<HttpResponse> responseCallback;
+
 	protected CommonRequest(Request request) {
 		this.request = request;
 	}
@@ -32,22 +40,33 @@ public class CommonRequest {
 	}
 
 	public CommonRequest timeout(long ms) {
+		if (0 < ms) {
 			request.connectTimeout(Timeout.ofMilliseconds(ms)).responseTimeout(Timeout.ofMilliseconds(ms));
+		}
 		return this;
 	}
 
 	public CommonRequest header(String key, String value) {
+		if (TimiJava.isNotEmpty(value)) {
 			request.addHeader(key, value);
+		}
 		return this;
 	}
 
 	public CommonRequest token(String token) {
-		request.addHeader("Token", token);
+		return header("Token", token);
-		return this;
 	}
 
 	public CommonRequest language(String langHeader) {
-		request.addHeader("Accept-Language", langHeader);
+		return header("Accept-Language", langHeader);
+	}
+
+	/// 设置响应回调，回调在响应体读取前执行
+	///
+	/// @param callback 响应回调，传入 null 表示移除回调
+	/// @return 当前请求
+	public CommonRequest responseCallback(CallbackArg<HttpResponse> callback) {
+		this.responseCallback = callback;
 		return this;
 	}
 
@@ -57,7 +76,7 @@ public class CommonRequest {
 	}
 
 	public String asString() throws IOException {
-		return request.execute().returnContent().asString();
+		return handleResponse(response -> new ContentResponseHandler().handleResponse(response).asString());
 	}
 
 	public Number asNumber() throws IOException {
@@ -65,14 +84,29 @@ public class CommonRequest {
 	}
 
 	public byte[] asBytes() throws IOException {
-		return request.execute().returnContent().asBytes();
+		return handleResponse(response -> new ContentResponseHandler().handleResponse(response).asBytes());
 	}
 
 	public InputStream asStream() throws IOException {
-		return request.execute().returnContent().asStream();
+		return handleResponse(response -> new ContentResponseHandler().handleResponse(response).asStream());
 	}
 
 	public void execute() throws IOException {
-		request.execute();
+		handleResponse(response -> null);
+	}
+
+	/// 使用统一入口处理响应，子类的自定义响应处理必须调用此方法
+	///
+	/// @param handler 响应处理器
+	/// @param <T> 返回值类型
+	/// @return 响应处理结果
+	/// @throws IOException 请求或响应处理失败
+	protected <T> T handleResponse(HttpClientResponseHandler<T> handler) throws IOException {
+		return request.execute().handleResponse(response -> {
+			if (responseCallback != null) {
+				responseCallback.handler(response);
+			}
+			return handler.handleResponse(response);
+		});
 	}
 }

src/main/java/com/imyeyu/network/FileRequest.java

@@ -1,6 +1,7 @@
 package com.imyeyu.network;
 
 import com.imyeyu.io.IO;
+import com.imyeyu.java.bean.CallbackArg;
 import org.apache.hc.client5.http.fluent.Request;
 import org.apache.hc.core5.http.Header;
 import org.apache.hc.core5.http.HttpEntity;
@@ -43,19 +44,25 @@ public class FileRequest extends JacksonRequest {
 
 	@Override
 	public FileRequest header(String key, String value) {
-		request.addHeader(key, value);
+		super.header(key, value);
 		return this;
 	}
 
 	@Override
 	public FileRequest token(String token) {
-		request.addHeader("Token", token);
+		super.token(token);
 		return this;
 	}
 
 	@Override
 	public FileRequest language(String langHeader) {
-		request.addHeader("Accept-Language", langHeader);
+		super.language(langHeader);
+		return this;
+	}
+
+	@Override
+	public FileRequest responseCallback(CallbackArg<HttpResponse> callback) {
+		super.responseCallback(callback);
 		return this;
 	}
 
@@ -84,7 +91,7 @@ public class FileRequest extends JacksonRequest {
 	}
 
 	public long length() throws IOException, ProtocolException {
-		HttpResponse response = request.execute().returnResponse();
+		return handleResponse(response -> {
 			final int status = response.getCode();
 			if (status < 200 || 300 <= status) {
 				throw new IOException("HTTP error status: " + status);
@@ -94,5 +101,6 @@ public class FileRequest extends JacksonRequest {
 				throw new IOException("Content-Length header missing");
 			}
 			return Long.parseLong(contentLengthHeader.getValue());
+		});
 	}
 }

src/main/java/com/imyeyu/network/JacksonRequest.java

@@ -8,9 +8,11 @@ import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.imyeyu.java.bean.CallbackArg;
 import org.apache.hc.client5.http.fluent.Request;
 import org.apache.hc.core5.http.ContentType;
 import org.apache.hc.core5.http.HttpEntity;
+import org.apache.hc.core5.http.HttpResponse;
 
 import java.io.IOException;
 import java.lang.reflect.Type;
@@ -99,24 +101,30 @@ public class JacksonRequest extends CommonRequest {
 
 	@Override
 	public JacksonRequest header(String key, String value) {
-		request.addHeader(key, value);
+		super.header(key, value);
 		return this;
 	}
 
 	@Override
 	public JacksonRequest token(String token) {
-		request.addHeader("Token", token);
+		super.token(token);
 		return this;
 	}
 
 	@Override
 	public JacksonRequest language(String langHeader) {
-		request.addHeader("Accept-Language", langHeader);
+		super.language(langHeader);
+		return this;
+	}
+
+	@Override
+	public JacksonRequest responseCallback(CallbackArg<HttpResponse> callback) {
+		super.responseCallback(callback);
 		return this;
 	}
 
 	/**
-	 * 设置 JSON 请求体。
+	 * 设置 JSON 请求体
 	 *
 	 * @param object 要序列化的对象
 	 * @return 当前请求

src/main/java/com/imyeyu/network/ProgressiveRequest.java

@@ -2,9 +2,10 @@ package com.imyeyu.network;
 
 import com.imyeyu.io.IO;
 import com.imyeyu.java.TimiJava;
+import com.imyeyu.java.bean.CallbackArg;
 import org.apache.hc.client5.http.fluent.Request;
-import org.apache.hc.client5.http.fluent.Response;
 import org.apache.hc.core5.http.HttpEntity;
+import org.apache.hc.core5.http.HttpResponse;
 import org.apache.hc.core5.http.io.HttpClientResponseHandler;
 import org.apache.hc.core5.http.io.entity.EntityUtils;
 
@@ -50,19 +51,25 @@ public class ProgressiveRequest extends FileRequest {
 
 	@Override
 	public ProgressiveRequest header(String key, String value) {
-		request.addHeader(key, value);
+		super.header(key, value);
 		return this;
 	}
 
 	@Override
 	public ProgressiveRequest token(String token) {
-		request.addHeader("Token", token);
+		super.token(token);
 		return this;
 	}
 
 	@Override
 	public ProgressiveRequest language(String langHeader) {
-		request.addHeader("Accept-Language", langHeader);
+		super.language(langHeader);
+		return this;
+	}
+
+	@Override
+	public ProgressiveRequest responseCallback(CallbackArg<HttpResponse> callback) {
+		super.responseCallback(callback);
 		return this;
 	}
 
@@ -80,12 +87,12 @@ public class ProgressiveRequest extends FileRequest {
 
 	@Override
 	public void toFile(Path outputPath) throws IOException, NoPermissionException {
-		processResponse(request.execute(), IO.getOutputStream(outputPath.toFile()));
+		processResponse(IO.getOutputStream(outputPath.toFile()));
 	}
 
 	@Override
 	public void toFile(File file) throws IOException, NoPermissionException {
-		processResponse(request.execute(), IO.getOutputStream(file));
+		processResponse(IO.getOutputStream(file));
 	}
 
 	@Override
@@ -96,17 +103,17 @@ public class ProgressiveRequest extends FileRequest {
 	@Override
 	public byte[] asBytes() throws IOException {
 		ByteArrayOutputStream os = new ByteArrayOutputStream();
-		processResponse(request.execute(), os);
+		processResponse(os);
 		return os.toByteArray();
 	}
 
-	private void processResponse(Response response, OutputStream os) throws IOException {
+	private void processResponse(OutputStream os) throws IOException {
-		response.handleResponse((HttpClientResponseHandler<Void>) resp -> {
+		handleResponse((HttpClientResponseHandler<Void>) response -> {
-			HttpEntity entity = resp.getEntity();
+			HttpEntity entity = response.getEntity();
 			if (entity == null) {
 				throw new IOException("not found response entity");
 			}
-			int code = resp.getCode();
+			int code = response.getCode();
 			if (400 <= code) {
 				throw new IOException("response error: %s".formatted(code));
 			}

src/main/java/com/imyeyu/network/TimiRequest.java

@@ -2,9 +2,11 @@ package com.imyeyu.network;
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.JavaType;
+import com.imyeyu.java.bean.CallbackArg;
 import com.imyeyu.java.bean.timi.TimiResponse;
 import org.apache.hc.client5.http.fluent.Request;
 import org.apache.hc.core5.http.HttpEntity;
+import org.apache.hc.core5.http.HttpResponse;
 
 import java.io.IOException;
 import java.lang.reflect.Type;
@@ -39,19 +41,25 @@ public class TimiRequest extends JacksonRequest {
 
 	@Override
 	public TimiRequest header(String key, String value) {
-		request.addHeader(key, value);
+		super.header(key, value);
 		return this;
 	}
 
 	@Override
 	public TimiRequest token(String token) {
-		request.addHeader("Token", token);
+		super.token(token);
 		return this;
 	}
 
 	@Override
 	public TimiRequest language(String langHeader) {
-		request.addHeader("Accept-Language", langHeader);
+		super.language(langHeader);
+		return this;
+	}
+
+	@Override
+	public TimiRequest responseCallback(CallbackArg<HttpResponse> callback) {
+		super.responseCallback(callback);
 		return this;
 	}