org.apache.httpcomponents.client5
httpclient5-fluent
diff --git a/src/main/java/com/imyeyu/network/ArgMap.java b/src/main/java/com/imyeyu/network/ArgMap.java
index bbb8631..26dc051 100644
--- a/src/main/java/com/imyeyu/network/ArgMap.java
+++ b/src/main/java/com/imyeyu/network/ArgMap.java
@@ -1,40 +1,143 @@
package com.imyeyu.network;
import com.imyeyu.utils.Encoder;
+import org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder;
import org.apache.hc.client5.http.fluent.Form;
+import org.apache.hc.core5.http.ContentType;
+import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.core5.http.NameValuePair;
-import java.util.HashMap;
+import java.io.File;
+import java.io.InputStream;
+import java.util.AbstractMap;
+import java.util.ArrayList;
+import java.util.Collections;
import java.util.List;
import java.util.Map;
+import java.util.function.BiConsumer;
/**
- * HashMap 构建 {@link org.apache.hc.client5.http.fluent.Form} 参数列表
+ * 请求参数列表。
+ *
+ * 该实现允许同名 key 重复出现，适用于 query 参数和表单参数场景。
*
* @author 夜雨
* @since 2025-06-26 15:41
*/
-public class ArgMap extends HashMap {
+public class ArgMap {
+ private final List> entries = new ArrayList<>();
+
+ /**
+ * 追加一个参数。
+ *
+ * @param key 参数名
+ * @param value 参数值
+ * @return 当前对象
+ */
+ public ArgMap put(K key, V value) {
+ entries.add(new AbstractMap.SimpleImmutableEntry<>(key, value));
+ return this;
+ }
+
+ /**
+ * 按插入顺序遍历全部参数。
+ *
+ * @param consumer 处理逻辑
+ */
+ public void forEach(BiConsumer consumer) {
+ entries.forEach(entry -> consumer.accept(entry.getKey(), entry.getValue()));
+ }
+
+ /**
+ * 返回参数数量。
+ *
+ * @return 参数数量
+ */
+ public int size() {
+ return entries.size();
+ }
+
+ /**
+ * 判断参数列表是否为空。
+ *
+ * @return 是否为空
+ */
+ public boolean isEmpty() {
+ return entries.isEmpty();
+ }
+
+ /**
+ * 清空全部参数。
+ */
+ public void clear() {
+ entries.clear();
+ }
+
+ /**
+ * 返回只读参数视图。
+ *
+ * @return 参数条目列表
+ */
+ public List> entries() {
+ return Collections.unmodifiableList(entries);
+ }
+
+ /**
+ * 转换为 multipart 实体。
+ *
+ * @return multipart 请求体
+ */
+ public HttpEntity toEntity() {
+ MultipartEntityBuilder builder = MultipartEntityBuilder.create();
+ forEach((k, v) -> {
+ String key = k.toString();
+ switch (v) {
+ case File file -> builder.addBinaryBody(key, file);
+ case byte[] bytes -> builder.addBinaryBody(key, bytes);
+ case InputStream stream -> builder.addBinaryBody(key, stream, ContentType.APPLICATION_OCTET_STREAM, key);
+ default -> builder.addTextBody(key, v.toString());
+ }
+ });
+ return builder.build();
+ }
+
+ /**
+ * 转换为表单参数列表。
+ *
+ * @return 表单参数列表
+ */
public List toNameValuePair() {
Form form = Form.form();
- for (Map.Entry item : entrySet()) {
- form.add(item.getKey().toString(), item.getValue().toString());
- }
+ forEach((k, v) -> form.add(k.toString(), v.toString()));
return form.build();
}
+ /**
+ * 转换为 query string。
+ *
+ * @return query string
+ */
public String toURL() {
- StringBuilder sb = new StringBuilder();
- for (Map.Entry item : entrySet()) {
- sb.append(item.getKey().toString()).append('=').append(Encoder.urlArg(item.getValue().toString()));
- sb.append('&');
+ if (isEmpty()) {
+ return "";
}
+ StringBuilder sb = new StringBuilder();
+ forEach((k, v) -> sb.append(k.toString()).append('=').append(Encoder.urlArg(v.toString())).append('&'));
sb.deleteCharAt(sb.length() - 1);
return sb.toString();
}
+ /**
+ * 将参数拼接到指定 URL。
+ *
+ * @param url 原始 URL
+ * @return 拼接后的 URL
+ */
public String toURL(String url) {
+ if (isEmpty()) {
+ return url;
+ }
StringBuilder sb = new StringBuilder(url);
if (url.contains("?")) {
if (!url.endsWith("?") && !url.endsWith("&")) {
@@ -42,29 +145,52 @@ public class ArgMap extends HashMap {
}
sb.append(toURL());
return sb.toString();
- } else {
- return url + "?" + toURL();
}
+ return url + "?" + toURL();
}
+ /**
+ * 使用一组参数创建对象。
+ *
+ * @param key 参数名
+ * @param value 参数值
+ * @param key 类型
+ * @param value 类型
+ * @return 参数对象
+ */
public static ArgMap of(K key, V value) {
- ArgMap map = new ArgMap<>();
- map.put(key, value);
- return map;
+ return new ArgMap().put(key, value);
}
+ /**
+ * 使用两组参数创建对象。
+ *
+ * @param key1 参数名 1
+ * @param value1 参数值 1
+ * @param key2 参数名 2
+ * @param value2 参数值 2
+ * @param key 类型
+ * @param value 类型
+ * @return 参数对象
+ */
public static ArgMap of(K key1, V value1, K key2, V value2) {
- ArgMap map = new ArgMap<>();
- map.put(key1, value1);
- map.put(key2, value2);
- return map;
+ return new ArgMap().put(key1, value1).put(key2, value2);
}
+ /**
+ * 使用三组参数创建对象。
+ *
+ * @param key1 参数名 1
+ * @param value1 参数值 1
+ * @param key2 参数名 2
+ * @param value2 参数值 2
+ * @param key3 参数名 3
+ * @param value3 参数值 3
+ * @param key 类型
+ * @param value 类型
+ * @return 参数对象
+ */
public static ArgMap of(K key1, V value1, K key2, V value2, K key3, V value3) {
- ArgMap map = new ArgMap<>();
- map.put(key1, value1);
- map.put(key2, value2);
- map.put(key3, value3);
- return map;
+ return new ArgMap().put(key1, value1).put(key2, value2).put(key3, value3);
}
}
diff --git a/src/main/java/com/imyeyu/network/CommonRequest.java b/src/main/java/com/imyeyu/network/CommonRequest.java
index 58b64a6..bfb9531 100644
--- a/src/main/java/com/imyeyu/network/CommonRequest.java
+++ b/src/main/java/com/imyeyu/network/CommonRequest.java
@@ -3,6 +3,7 @@ package com.imyeyu.network;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import org.apache.hc.client5.http.fluent.Request;
+import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.core5.util.Timeout;
import java.io.IOException;
@@ -49,6 +50,11 @@ public class CommonRequest {
return this;
}
+ public CommonRequest bodyEntity(HttpEntity entity) {
+ request.body(entity);
+ return this;
+ }
+
public String asString() throws IOException {
return request.execute().returnContent().asString();
}
diff --git a/src/main/java/com/imyeyu/network/FileRequest.java b/src/main/java/com/imyeyu/network/FileRequest.java
index a75dd2d..d237676 100644
--- a/src/main/java/com/imyeyu/network/FileRequest.java
+++ b/src/main/java/com/imyeyu/network/FileRequest.java
@@ -3,6 +3,7 @@ package com.imyeyu.network;
import com.imyeyu.io.IO;
import org.apache.hc.client5.http.fluent.Request;
import org.apache.hc.core5.http.Header;
+import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.core5.http.HttpResponse;
import org.apache.hc.core5.http.ProtocolException;
@@ -16,7 +17,7 @@ import java.nio.file.Path;
* @author 夜雨
* @since 2025-06-26 13:03
*/
-public class FileRequest extends CommonRequest {
+public class FileRequest extends GsonRequest {
protected FileRequest(Request request) {
super(request);
@@ -58,6 +59,18 @@ public class FileRequest extends CommonRequest {
return this;
}
+ @Override
+ public FileRequest body(Object object) {
+ super.body(object);
+ return this;
+ }
+
+ @Override
+ public FileRequest bodyEntity(HttpEntity entity) {
+ super.bodyEntity(entity);
+ return this;
+ }
+
public void toFile(String path, String fileName) throws IOException, NoPermissionException {
toFile(new File(IO.fitPath(path) + fileName));
}
diff --git a/src/main/java/com/imyeyu/network/GsonRequest.java b/src/main/java/com/imyeyu/network/GsonRequest.java
index 7bcdee6..935e8f0 100644
--- a/src/main/java/com/imyeyu/network/GsonRequest.java
+++ b/src/main/java/com/imyeyu/network/GsonRequest.java
@@ -8,6 +8,7 @@ import com.google.gson.reflect.TypeToken;
import com.imyeyu.java.TimiJava;
import org.apache.hc.client5.http.fluent.Request;
import org.apache.hc.core5.http.ContentType;
+import org.apache.hc.core5.http.HttpEntity;
import java.io.IOException;
@@ -75,6 +76,12 @@ public class GsonRequest extends CommonRequest {
return this;
}
+ @Override
+ public GsonRequest bodyEntity(HttpEntity entity) {
+ super.bodyEntity(entity);
+ return this;
+ }
+
public T resultAs(Class clazz) throws IOException {
return getGson().fromJson(super.asString(), clazz);
}
diff --git a/src/main/java/com/imyeyu/network/ProgressiveRequest.java b/src/main/java/com/imyeyu/network/ProgressiveRequest.java
index cd24c3f..539669b 100644
--- a/src/main/java/com/imyeyu/network/ProgressiveRequest.java
+++ b/src/main/java/com/imyeyu/network/ProgressiveRequest.java
@@ -66,6 +66,18 @@ public class ProgressiveRequest extends FileRequest {
return this;
}
+ @Override
+ public ProgressiveRequest body(Object object) {
+ super.body(object);
+ return this;
+ }
+
+ @Override
+ public ProgressiveRequest bodyEntity(HttpEntity entity) {
+ super.bodyEntity(entity);
+ return this;
+ }
+
@Override
public void toFile(Path outputPath) throws IOException, NoPermissionException {
processResponse(request.execute(), IO.getOutputStream(outputPath.toFile()));
diff --git a/src/main/java/com/imyeyu/network/TimiRequest.java b/src/main/java/com/imyeyu/network/TimiRequest.java
index 43a4a25..c05d6f3 100644
--- a/src/main/java/com/imyeyu/network/TimiRequest.java
+++ b/src/main/java/com/imyeyu/network/TimiRequest.java
@@ -3,6 +3,7 @@ package com.imyeyu.network;
import com.google.gson.reflect.TypeToken;
import com.imyeyu.java.bean.timi.TimiResponse;
import org.apache.hc.client5.http.fluent.Request;
+import org.apache.hc.core5.http.HttpEntity;
import java.io.IOException;
@@ -58,6 +59,12 @@ public class TimiRequest extends GsonRequest {
return this;
}
+ @Override
+ public TimiRequest bodyEntity(HttpEntity entity) {
+ super.bodyEntity(entity);
+ return this;
+ }
+
@Override
public String asString() throws IOException {
return resultAs(String.class);
diff --git a/src/test/java/com/imyeyu/network/test/ArgMapTest.java b/src/test/java/com/imyeyu/network/test/ArgMapTest.java
index 6ff5bbe..c62d6ad 100644
--- a/src/test/java/com/imyeyu/network/test/ArgMapTest.java
+++ b/src/test/java/com/imyeyu/network/test/ArgMapTest.java
@@ -24,4 +24,13 @@ public class ArgMapTest {
String url = ArgMap.of("newKey", "newValue").toURL("http://localhost/test" + uri);
assert url.equals("http://localhost/test/detail?id=123&key=value&newKey=newValue");
}
+
+ @Test
+ public void duplicateKeyTest() {
+ ArgMap argMap = new ArgMap<>();
+ argMap.put("id", "1");
+ argMap.put("id", "2");
+ assert argMap.toURL().equals("id=1&id=2");
+ assert argMap.toURL("/detail").equals("/detail?id=1&id=2");
+ }
}