RESTful design

This commit is contained in:
Timi
2026-10-01 21:27:50 +08:00
parent 113cdeb0d9
commit 8287d6eedd
7 changed files with 220 additions and 4 deletions
+12 -1
View File
@@ -1,3 +1,14 @@
# timi-network
Java 网络操作工具
Java 网络操作工具
静态工厂方法按 HTTP 方法命名,支持 `get`、`post`、`put`、`patch`、`delete`、`head` 和 `options`,分别用于读取、创建、替换、部分更新、删除资源、获取响应头和查询支持的请求方法
`CommonRequest`、`JacksonRequest`、`FileRequest` 和 `TimiRequest` 的工厂方法均返回对应类型,`ProgressiveRequest` 的工厂方法额外接收进度回调
```java
JacksonRequest.put("https://example.com/users/1").body(user).execute();
JacksonRequest.patch("https://example.com/users/1").body(changes).execute();
CommonRequest.delete("https://example.com/users/1").execute();
long length = FileRequest.head("https://example.com/files/1").length();
```
@@ -39,6 +39,46 @@ public class CommonRequest {
return new CommonRequest(Request.post(url));
}
/// 创建 PUT 请求,用于替换资源
///
/// @param url 请求地址
/// @return CommonRequest 请求
public static CommonRequest put(String url) {
return new CommonRequest(Request.put(url));
}
/// 创建 PATCH 请求,用于部分更新资源
///
/// @param url 请求地址
/// @return CommonRequest 请求
public static CommonRequest patch(String url) {
return new CommonRequest(Request.patch(url));
}
/// 创建 DELETE 请求,用于删除资源
///
/// @param url 请求地址
/// @return CommonRequest 请求
public static CommonRequest delete(String url) {
return new CommonRequest(Request.delete(url));
}
/// 创建 HEAD 请求,用于获取响应头
///
/// @param url 请求地址
/// @return CommonRequest 请求
public static CommonRequest head(String url) {
return new CommonRequest(Request.head(url));
}
/// 创建 OPTIONS 请求,用于查询支持的请求方法
///
/// @param url 请求地址
/// @return CommonRequest 请求
public static CommonRequest options(String url) {
return new CommonRequest(Request.options(url));
}
public CommonRequest timeout(long ms) {
if (0 < ms) {
request.connectTimeout(Timeout.ofMilliseconds(ms)).responseTimeout(Timeout.ofMilliseconds(ms));
@@ -36,6 +36,46 @@ public class FileRequest extends JacksonRequest {
return new FileRequest(Request.post(url));
}
/// 创建 PUT 请求,用于替换资源
///
/// @param url 请求地址
/// @return FileRequest 请求
public static FileRequest put(String url) {
return new FileRequest(Request.put(url));
}
/// 创建 PATCH 请求,用于部分更新资源
///
/// @param url 请求地址
/// @return FileRequest 请求
public static FileRequest patch(String url) {
return new FileRequest(Request.patch(url));
}
/// 创建 DELETE 请求,用于删除资源
///
/// @param url 请求地址
/// @return FileRequest 请求
public static FileRequest delete(String url) {
return new FileRequest(Request.delete(url));
}
/// 创建 HEAD 请求,用于获取响应头
///
/// @param url 请求地址
/// @return FileRequest 请求
public static FileRequest head(String url) {
return new FileRequest(Request.head(url));
}
/// 创建 OPTIONS 请求,用于查询支持的请求方法
///
/// @param url 请求地址
/// @return FileRequest 请求
public static FileRequest options(String url) {
return new FileRequest(Request.options(url));
}
@Override
public FileRequest timeout(long ms) {
super.timeout(ms);
@@ -31,7 +31,7 @@ public class JacksonRequest extends CommonRequest {
static {
OBJECT_MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
OBJECT_MAPPER.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
OBJECT_MAPPER.setSerializationInclusion(JsonInclude.Include.NON_NULL);
OBJECT_MAPPER.setDefaultPropertyInclusion(JsonInclude.Include.NON_NULL);
}
private ObjectMapper objectMapper = null;
@@ -82,6 +82,46 @@ public class JacksonRequest extends CommonRequest {
return new JacksonRequest(Request.post(url));
}
/// 创建 PUT 请求,用于替换资源
///
/// @param url 请求地址
/// @return JacksonRequest 请求
public static JacksonRequest put(String url) {
return new JacksonRequest(Request.put(url));
}
/// 创建 PATCH 请求,用于部分更新资源
///
/// @param url 请求地址
/// @return JacksonRequest 请求
public static JacksonRequest patch(String url) {
return new JacksonRequest(Request.patch(url));
}
/// 创建 DELETE 请求,用于删除资源
///
/// @param url 请求地址
/// @return JacksonRequest 请求
public static JacksonRequest delete(String url) {
return new JacksonRequest(Request.delete(url));
}
/// 创建 HEAD 请求,用于获取响应头
///
/// @param url 请求地址
/// @return JacksonRequest 请求
public static JacksonRequest head(String url) {
return new JacksonRequest(Request.head(url));
}
/// 创建 OPTIONS 请求,用于查询支持的请求方法
///
/// @param url 请求地址
/// @return JacksonRequest 请求
public static JacksonRequest options(String url) {
return new JacksonRequest(Request.options(url));
}
/**
* 指定对象映射器。
*
@@ -43,6 +43,51 @@ public class ProgressiveRequest extends FileRequest {
return new ProgressiveRequest(Request.post(url), callback);
}
/// 创建 PUT 请求,用于替换资源
///
/// @param url 请求地址
/// @param callback 进度回调
/// @return ProgressiveRequest 请求
public static ProgressiveRequest put(String url, ProgressiveCallback callback) {
return new ProgressiveRequest(Request.put(url), callback);
}
/// 创建 PATCH 请求,用于部分更新资源
///
/// @param url 请求地址
/// @param callback 进度回调
/// @return ProgressiveRequest 请求
public static ProgressiveRequest patch(String url, ProgressiveCallback callback) {
return new ProgressiveRequest(Request.patch(url), callback);
}
/// 创建 DELETE 请求,用于删除资源
///
/// @param url 请求地址
/// @param callback 进度回调
/// @return ProgressiveRequest 请求
public static ProgressiveRequest delete(String url, ProgressiveCallback callback) {
return new ProgressiveRequest(Request.delete(url), callback);
}
/// 创建 HEAD 请求,用于获取响应头
///
/// @param url 请求地址
/// @param callback 进度回调
/// @return ProgressiveRequest 请求
public static ProgressiveRequest head(String url, ProgressiveCallback callback) {
return new ProgressiveRequest(Request.head(url), callback);
}
/// 创建 OPTIONS 请求,用于查询支持的请求方法
///
/// @param url 请求地址
/// @param callback 进度回调
/// @return ProgressiveRequest 请求
public static ProgressiveRequest options(String url, ProgressiveCallback callback) {
return new ProgressiveRequest(Request.options(url), callback);
}
@Override
public ProgressiveRequest timeout(long ms) {
super.timeout(ms);
@@ -33,6 +33,46 @@ public class TimiRequest extends JacksonRequest {
return new TimiRequest(Request.post(url));
}
/// 创建 PUT 请求,用于替换资源
///
/// @param url 请求地址
/// @return TimiRequest 请求
public static TimiRequest put(String url) {
return new TimiRequest(Request.put(url));
}
/// 创建 PATCH 请求,用于部分更新资源
///
/// @param url 请求地址
/// @return TimiRequest 请求
public static TimiRequest patch(String url) {
return new TimiRequest(Request.patch(url));
}
/// 创建 DELETE 请求,用于删除资源
///
/// @param url 请求地址
/// @return TimiRequest 请求
public static TimiRequest delete(String url) {
return new TimiRequest(Request.delete(url));
}
/// 创建 HEAD 请求,用于获取响应头
///
/// @param url 请求地址
/// @return TimiRequest 请求
public static TimiRequest head(String url) {
return new TimiRequest(Request.head(url));
}
/// 创建 OPTIONS 请求,用于查询支持的请求方法
///
/// @param url 请求地址
/// @return TimiRequest 请求
public static TimiRequest options(String url) {
return new TimiRequest(Request.options(url));
}
@Override
public TimiRequest timeout(long ms) {
super.timeout(ms);
@@ -28,7 +28,7 @@ public class ProgressRequestTest {
@Test
public void testLength() throws Exception {
long length = FileRequest.wrap(Request.head(URL2)).length();
long length = FileRequest.head(URL2).length();
System.out.println(IOSize.format(length));
}
@@ -38,4 +38,4 @@ public class ProgressRequestTest {
final Header contentLengthHeader = response.getHeader("Content-Length");
System.out.println(contentLengthHeader.getValue());
}
}
}