A simple http client framework based on HttpURLConnection wrapper
MiniHttpClient
一：开发环境
Mac OS 10、Java 1.8、IDEA（Gradle工程）
二：介绍
基于Java HttpURLConnection实现Http客户端，支持普通接口请求和表单上传文件及文件下载等。使用线程池实现同步Future和异步请求。
目前判断以下ContentType为文本接收，其余认为文件下载：
| ContentType |
类型 |
说明 |
| 空 |
空 |
没有指明数据类型，默认按文本处理 |
| application/json |
Json文本 |
常见接口请求 |
| text/html |
htm或者html等 |
网页文件 |
| text/plain |
纯文本 |
txt等文件，以文本返回，不按文件下载 |
| text/xml |
xml类文件 |
xml及其衍生文件格式大多数用这种类型 |
三：特点
- 纯Java API实现，轻巧。
- 支持同步和异步两种方式。
- 独立线程发起请求，支持线程池管理。
- 支持POST表单数据和文件上传。
- 方便扩展，自定义功能。
- Maven
<dependency>
<groupId>com.itgowo</groupId>
<artifactId>MiniHttpClient</artifactId>
<version>0.0.43</version>
<type>pom</type>
</dependency>
- Gradle
implementation 'com.itgowo:MiniHttpClient:0.0.43'
五：简单使用(库Jar中有Demo类，可以参考)
Demo.java
1.模拟表单上传，POST方式
public static void testUploadFile() {
String url = "http://127.0.0.1:12111";
List<File> files = new ArrayList<>();
File file = new File("/Users/lujianchao/Desktop/RDC1.png");
files.add(file);
HttpClient.RequestUploadFiles(url, null, files, new onSimpleCallbackListener() {
@Override
public void onError(HttpResponse httpResponse, Exception e) {
System.out.println("httpResponse = [" + httpResponse + "], e = [" + e + "]");
}
@Override
public void onProcess(File file, int countBytes, int processBytes) throws Exception {
System.out.println("file = [" + file + "], countBytes = [" + countBytes + "], processBytes = [" + processBytes + "]");
}
@Override
public void onSuccess(HttpResponse httpResponse) throws Exception {
System.out.println("httpResponse = [" + httpResponse + "]");
}
});
}
2.同步上传文件
public static void testSyncUploadFile() throws Exception {
String url = "http://127.0.0.1:12111/app.js";
List<File> files = new ArrayList<>();
File file = new File("/Users/lujianchao/Desktop/RDC1.png");
files.add(file);
HttpResponse httpResponse = HttpClient.RequestSync(url, HttpMethod.POST, null, files, null);
if (httpResponse.isSuccess()) {
System.out.println("上传成功");
}
}
3.提交数据
public static void testRequest() {
String url = "http://127.0.0.1:12111/app.js";
Map<String, String> headers = new HashMap<>();
headers.put("content-type", "application/json");
String httpBody = "{\"name\":\"张三\"}";
HttpClient.Request(url, HttpMethod.POST, headers, httpBody, new onSimpleCallbackListener() {
@Override
public void onError(HttpResponse response, Exception e) {
e.printStackTrace();
System.out.println("response = [" + response + "], e = [" + e + "]");
}
@Override
public void onSuccess(HttpResponse response) throws Exception {
System.out.println("response = [" + response + "]");
}
});
}
4.同步请求
public static void testRequestSync() {
String url = "http://127.0.0.1:12111/app.js";
Map<String, String> headers = new HashMap<>();
headers.put("content-type", "application/json");
String httpBody = "{\"name\":\"张三\"}";
try {
HttpResponse response = HttpClient.RequestSync(url, HttpMethod.POST, headers, null, httpBody);
System.out.println(response);
} catch (Exception e) {
e.printStackTrace();
}
}
5.文件下载，如果文件已存在，则用时间戳拼在文件名前面，通过DownloadFile的getOriginFileName()方法获取浏览器返回文件名，如果是重定向获取的文件下载十分有意义，不能用原始url判断文件名。
public static void testDownloadFile() {
String downloadUrl = "http://file.itgowo.com/itgowo/RemoteDataController/web_app.zip";
String downloadDir = "temp";
HttpClient.RequestGetFile(downloadUrl, null, new onSimpleCallbackListener() {
@Override
public void onError(HttpResponse response, Exception e) {
e.printStackTrace();
System.out.println("response = [" + response + "], e = [" + e + "]");
}
@Override
public void onSuccess(HttpResponse response) throws Exception {
//下载文件不会触发
System.out.println("response = [" + response + "]");
}
@Override
public void onSuccess(HttpResponse httpResponse, DownloadFile file) throws Exception {
file.saveToFile(downloadDir);
System.out.println("httpResponse = [" + httpResponse + "], file = [" + file.getFile() + "]");
}
@Override
public void onProcess(File file, int countBytes, int processBytes) throws Exception {
System.out.println("file = [" + file + "], countBytes = [" + countBytes + "], processBytes = [" + processBytes + "]");
}
});
}
6.同步方式下载文件，文件对象放在HttpResponse中的downloadFile里
public static void testSyncDownloadFile() {
try {
String url = "http://127.0.0.1:12111/app.js";
HttpResponse response = HttpClient.RequestSync(url, HttpMethod.GET, null, null);
System.out.println(response.getDownloadFile());
} catch (Exception e) {
e.printStackTrace();
}
}
六：说明
1. 回调接口onCallbackListener
- public void onError(HttpResponse response, Exception e)
| 发生错误时回调 |
|
| HttpResponse |
请求结果，当http状态码不是200系列时，body可能包含错误信息 |
| Exception |
异常类 |
- public void onSuccess(HttpResponse response) throws Exception
| 非文件下载请求成功回调 |
|
| HttpRespons |
请求结果，当http状态码是200系列时返回 |
- public void onSuccess(HttpResponse httpResponse, DownloadFile file) throws Exception
| 文件下载请求成功回调 |
|
| HttpResponse |
请求结果，downloadFile为下载文件类，同第二个参数 |
| DownloadFile |
下载文件类，此时只读取了header信息，需要方法saveToFile(downloadDir)去保存文件 |
- public void onProcess(File file, int countBytes, int processBytes) throws Exception
| 下载文件时：saveToFile(downloadDir)方法执行后，触发下载进度；上传文件时：触发上传进度 |
|
| File |
下载文件或上传文件 |
| countBytes |
文件大小 |
| processBytes |
文件大小 |
2. 请求方式
分为同步请求和异步请求，功能全部封装到同步模块，异步调用只是继承封装一层，此库比较简单，按需继承改造。
七：原理解析
- 以HttpURLConnection为基础开发，需要学会简单使用HttpURLConnection才能更好理解这个库。
- 最核心请求类是RequestClient，封装了request()方法开始请求，request()执行先触发prepare(RequestClient requestClient)方法，初始化请求参数。例如：
public static HttpResponse RequestSync(String url, HttpMethod method, Map<String, String> headers1, List<File> uploadFiles1, String requestJson) throws Exception {
RequestClient requestClient = new RequestClient(url, method.getMethod(), timeout, new onSimpleCallbackListener()) {
@Override
protected String prepare(RequestClient requestClient) {
if (headers1 != null) {
requestClient.addHeaders(headers1);
}
requestClient.setUploadFiles(uploadFiles1);
return requestJson;
}
};
return requestClient.request();
}
- 通过prepare()可以设置header和上传文件和下载目录等。返回值是String类型，就是请求的Body部分，通常的接口请求json文本就是放到这里，请求json文本就不要设置上传文件了。如果是文件上传，需要这样定义：
protected String prepare(RequestClient requestClient)) {
if (headers1 != null) {
requestClient.addHeaders(headers1);
}
requestClient.setUploadFiles(uploadFiles1);
return null;
}
- 如果是文件下载，请求的body需不需要看你们接口定义，一般静态资源请求是GET方法，body为null，可以这样定义：
protected String prepare(RequestClient requestClient)) {
if (headers1 != null) {
requestClient.addHeaders(headers1);
}
return null;
}
- 如果用同步方法，只需要RequestClient用HttpResponse接收即可，如下：
RequestClient requestClient = new RequestClient(url, method.getMethod(), timeout, new onSimpleCallbackListener()) {};
return requestClient.request();
- 说说异步类RequestAsyncClient，其实只是实现了runnable接口，在run()方法中触发request(),然后判断执行回调，代码如下：
public abstract class RequestAsyncClient extends RequestClient implements Runnable {
public RequestAsyncClient(String url, String method, int timeout, onCallbackListener listener) {
super(url, method, timeout, listener);
}
@Override
public void run() {
try {
request();
if (httpResponse.isSuccess()) {
if (httpResponse.isDownloadFile()) {
listener.onSuccess(httpResponse, httpResponse.getDownloadFile());
} else {
listener.onSuccess(httpResponse);
}
} else {
listener.onError(httpResponse, new Exception("code:" + httpResponse.getResponseCode() + " msg:" + httpResponse.getResponseMessage()));
}
} catch (Exception e) {
listener.onError(httpResponse.setSuccess(false), e);
}
}
}
- 具体请求内容请看代码，其中有各种判断解析，文件下载只认application/octet-stream，这点算是不足。文件下载还需要注意，执行success()回调不代表文件下载完了，在返回的DownloadFile对象中封装了输入流，需要执行saveToFile(下载目录)才能真正保存到文件，saveToFile()方法也会触发onProcess()进度回调。
八：小期待
以下项目都是我围绕远程控制写的项目和子项目。都给star一遍吧。😍
我的小站：IT狗窝
技术联系QQ:1264957104
网友评论