android实现okHttp的get和post请求的简单封装与使用
由于Android课程项目需要，特地查阅了okHttp的使用，发现网上找的大多和自己的需求不一样。所以就着团队项目需要，自己简单封装了一个okHttp的get和post请求。
话不多说，直接看代码吧！
一、前期需要用到的属性封装
private static Request request = null;
private static Call call = null;
private static int TimeOut = 120;
//单例获取ohttp3对象
private static OkHttpClient client = null;
/**
* OkHttpClient的构造方法，通过线程锁的方式构造
* @return OkHttpClient对象
*/
private static synchronized OkHttpClient getInstance() {
if (client == null) {
client = new OkHttpClient.Builder()
.readTimeout(TimeOut, TimeUnit.SECONDS)
.connectTimeout(TimeOut, TimeUnit.SECONDS)
.writeTimeout(TimeOut, TimeUnit.SECONDS)
.build();
}
return client;
}
/**
* callback接口
* 异步请求时使用
*/
static class MyCallBack implements Callback {
private OkHttpCallback okHttpCallBack;
public MyCallBack(OkHttpCallback okHttpCallBack) {
this.okHttpCallBack = okHttpCallBack;
}
@Override
public void onFailure(Call call, IOException e) {
okHttpCallBack.onFailure(e);
}
@Override
public void onResponse(Call call, Response response) throws IOException {
okHttpCallBack.onSuccess(response);
}
}
/**
* 获得同步get请求对象Response
* @param url
* @return Response
*/
private static Response doSyncGet(String url) {
//创建OkHttpClient对象
client = getInstance();
request = new Request.Builder()
.url(url)//请求链接
.build();//创建Request对象
try {
//获取Response对象
Response response = client.newCall(request).execute();
return response;
} catch (IOException e) {
e.printStackTrace();
return null;
}
}
/**
* 获得异步get请求对象
* @param url 请求地址
* @param callback 实现callback接口
*/
private static void doAsyncGet(String url,OkHttpCallback callback) {
MyCallBack myCallback = new MyCallBack(callback);
client = getInstance();
request = new Request.Builder()
.url(url)
.get()
.build();
client.newCall(request).enqueue(myCallback);
}
其中，OKHttpCallback接口为：
import java.io.IOException;
import okhttp3.Response;
public interface OkHttpCallback {
void onFailure(IOException e);
void onSuccess(Response response);
}
二、get请求封装
1.项目需求是全程使用json格式的字符串进行交互，所以以下是针对json来封装的。
2.在这里说明一下，返回的是字符串类型，表示后台返回的json字符串，另外，为什么要用list来定义返回值result，result.get(0)为return值，因为直接用String来定义result会报错，具体原因未知。。。。
（1）同步get请求
/**
* 同步get请求
* 例如：请求的最终地址为：http://127.0.0.1:8081/user/getUser/123
* @param url 基本请求地址 例子： http://127.0.0.1:8081
* @param args 请求的参数 args[]=new String[]{"user","getUser","123"}
* @return String
*/
public static String getSyncRequest(String url,String... args) {
List<String> result=new ArrayList<>();//返回值
String address=url;
for(int i=0;i<args.length;i++){
address=address+"/"+args[i];
}
final String finalAddress = address;
new Thread(new Runnable() {
@Override
public void run() {
Response finalResponse = doSyncGet(finalAddress);
String res = null;
try {
Log.d("同步get请求请求地址：",finalAddress);
if (finalResponse.isSuccessful()) {//请求成功
ResponseBody body = finalResponse.body();//拿到响应体
res = body.string();
result.add(res);
Log.d("HttpUtil", "同步get请求成功！");
Log.d("请求对象：", res);
} else {
Log.d("HttpUtil", "同步get请求失败！");
}
} catch (IOException e) {
e.printStackTrace();
}
}
}).start();
/**因为函数返回是立刻执行的，而result要在请求完成之后才能获得
* 所以需要等待result获得返回值之后再执行return*/
while(result.size()==0){
try {
TimeUnit.MILLISECONDS.sleep(10);//等待xx毫秒
} catch (InterruptedException e) {
e.printStackTrace();
}
}
return result.get(0);
}
（2）异步get请求
/**
* 异步get请求
* 例如：请求的最终地址为：http://127.0.0.1:8081/user/getUser/123
* @param url 基本请求地址 例子： http://127.0.0.1:8081
* @param args 请求的参数 args[]=new String[]{"user","getUser","123"}
* @return String
*/
public static String getAsyncRequest(String url,String... args){
List<String> result=new ArrayList<>();
String address=url;
for(int i=0;i<args.length;i++){
address=address+"/"+args[i];
}
final String finalAddress = address;
doAsyncGet(finalAddress, new OkHttpCallback() {
@Override
public void onFailure(IOException e) {
Log.d("异步get请求地址：",finalAddress);
Log.d("HttpUtil", "异步get请求失败！");
}
@Override
public void onSuccess(Response response) {
Log.d("异步get请求地址：",finalAddress);
String res = null;
try {
res = response.body().string();
} catch (IOException e) {
e.printStackTrace();
}
result.add(res);
Log.d("HttpUtil", "异步get请求成功！");
Log.d("请求对象：", res);
}
});
/**因为函数返回是立刻执行的，而result要在请求完成之后才能获得
* 所以需要等待result获得返回值之后再执行return*/
while(result.size()==0){
try {
TimeUnit.MILLISECONDS.sleep(10);//等待xx毫秒
} catch (InterruptedException e) {
e.printStackTrace();
}
}
return result.get(0);
}
三、post请求
在此说明一下，后端接收的是一个name为“json”的字符串，实际就是传了个json字符串作为请求表单中的数据，后端通过解析这个json字符串进行下一步的操作
（1）同步post请求
/**
* 同步post请求
* 例如：请求的最终地址为：http://127.0.0.1:8081/user/getUser/123
* @param url 基本请求地址 例子： http://127.0.0.1:8081
* @param json 提交的json字符串
* @param args 请求的参数 args[]=new String[]{"user","getUser","123"}
* @return
*/
public static String postSyncRequest(String url,String json,String... args){
List<String> result=new ArrayList<>();
String address=url;
for(int i=0;i<args.length;i++){
address=address+"/"+args[i];
}
final String finalAddress = address;
new Thread(new Runnable() {
@Override
public void run() {
client=getInstance();
Log.d("同步post请求地址：",finalAddress);
FormBody.Builder formBody = new FormBody.Builder();
formBody.add("json",json);
request=new Request.Builder()
.url(finalAddress)
.post(formBody.build())
.addHeader("device-platform", "android")
.build();
try{
Response response=client.newCall(request).execute();
String res=response.body().string();
result.add(res);
Log.d("HttpUtil", "同步post请求成功！");
Log.d("请求对象：", res);
}catch (Exception e){
Log.d("HttpUtil", "同步post请求失败！");
e.printStackTrace();
}
}
}).start();
/**因为函数返回是立刻执行的，而result要在请求完成之后才能获得
* 所以需要等待result获得返回值之后再执行return*/
while(result.size()==0){
try {
TimeUnit.MILLISECONDS.sleep(10);//等待xx毫秒
} catch (InterruptedException e) {
e.printStackTrace();
}
}
return result.get(0);
}
（2）异步post请求
/**
* 异步post请求
* 例如：请求的最终地址为：http://127.0.0.1:8081/user/getUser/123
* @param url 基本请求地址 例子： http://127.0.0.1:8081
* @param json 提交的json字符串
* @param args 请求的参数 args[]=new String[]{"user","getUser","123"}
* @return
*/
public static String postAsyncRequest(String url,String json,String... args){
List<String> result=new ArrayList<>();
String address=url;
for(int i=0;i<args.length;i++){
address=address+"/"+args[i];
}
final String finalAddress = address;
Log.d("同步post请求地址：",finalAddress);
client=getInstance();
FormBody.Builder formBody = new FormBody.Builder();//创建表单请求体
formBody.add("json",json);
request = new Request.Builder()
.url(finalAddress)
.post(formBody.build())
.addHeader("device-platform", "android")
.build();
Call call=client.newCall(request);
call.enqueue(new Callback() {
@Override
public void onFailure(@NotNull Call call, @NotNull IOException e) {
new Thread(new Runnable() {
@Override
public void run() {
Log.d("HttpUtil","异步post请求失败！");
}
}).start();
}
@Override
public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException {
new Thread(new Runnable() {
@Override
public void run() {
String res = null;
try {
res = response.body().string();
} catch (IOException e) {
e.printStackTrace();
}
result.add(res);
Log.d("HttpUtil","异步post请求成功！");
Log.d("请求对象",res);
}
}).start();
}
});
/**因为函数返回是立刻执行的，而result要在请求完成之后才能获得
* 所以需要等待result获得返回值之后再执行return*/
while(result.size()==0){
try {
TimeUnit.MILLISECONDS.sleep(10);//等待xx毫秒
} catch (InterruptedException e) {
e.printStackTrace();
}
}
return result.get(0);
}
四、依赖以及相关说明
相关依赖为：（okHttp和Gson）
implementation 'com.squareup.okhttp3:okhttp:4.2.2'
implementation 'com.google.code.gson:gson:2.7'
由于取消掉延时会导致result还没有被赋值就已经进行到return这里了，所以在每个请求方法中在return之前都加了个延时，直到result被赋值了再执行return
下一篇是讲android是如何通过okHttp跟后端交互起来的，以及相关例子。
到此这篇关于android实现okHttp的get和post请求的简单封装与使用的文章就介绍到这了,更多相关android okHttp的get和post请求内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！
相关推荐
-
基于Feign使用okhttp的填坑之旅
1.由于项目需要远程调用http请求 因此就想到了Feign,因为真的非常的方便,只需要定义一个接口就行. 但是feign默认使用的JDK的URLHttpConnection,没有连接池效率不好,从Feign的自动配置类FeignAutoConfiguration中可以看到Feign除了默认的http客户端还支持okhttp和ApacheHttpClient,我这里选择了okhttp,它是有连接池的. 2.看看网络上大部分博客中是怎么使用okhttp的 1).引入feign和okhttp的mav
-
Android Studio OkHttpClient使用教程详解
本次来记录下OkHttpClient的使用,OkHttpClient是用来完成android 客户端对服务端请求的工具. 首先记住,使用网络的时候一定要加入权限,加入到AndroidMainfest.xml中 <uses-permission android:name="android.permission.INTERNET" /> 在初次使用的时候会出现报错.cannot resolve symbol OkHttpClient 这里需要引入 implementation
-
SpringBoot 配置 okhttp3的操作
1. Maven 添加依赖 <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>3.10.0</version> </dependency> 2. application.properties 配置文件 ok.http.connect-timeout=30 ok.http.re
-
Android okhttp的启动流程及源码解析
前言 这篇文章主要讲解了okhttp的主要工作流程以及源码的解析. 什么是OKhttp 简单来说 OkHttp 就是一个客户端用来发送 HTTP 消息并对服务器的响应做出处理的应用层框架. 那么它有什么优点呢? 易使用.易扩展. 支持 HTTP/2 协议,允许对同一主机的所有请求共用同一个 socket 连接. 如果 HTTP/2 不可用, 使用连接池复用减少请求延迟. 支持 GZIP,减小了下载大小. 支持缓存处理,可以避免重复请求. 如果你的服务有多个 IP 地址,当第一次连接失败,OkHt
-
解决Feign切换client到okhttp无法生效的坑(出现原因说明)
提示:如果只看如何解决问题,请看文章的末尾如何解决这个问题 1. 场景描述 最近项目中使用了feign当做http请求工具来使用.相对于httpclient.resttemplate来说,fegin用起来方便很多. 然后项目有httptrace的需求,需要输出请求日志. 所以就开启了feign自己的日志,发现它自带的日志是debug级别才能打印.而且是逐行打印的,看日志非常的不方便.所以需要输出json格式的日志最好. 2.解决步骤 2.1 引入feign依赖 <dependency> <
-
完美解决SpringCloud-OpenFeign使用okhttp替换不生效问题
事发地 原默认的Feign是使用URLConnector进行通信的,当换为okhttp时,直接引入包及配置以下内容根本不生效,还是走原生的. feign: okhttp: enable: true 事件还原 创建项目并引入pom相关的依赖如下: <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xml
-
Android OKHttp使用简介
下面是官网给出的OKHTTP的特点: 支持HTTP/2, HTTP/2通过使用多路复用技术在一个单独的TCP连接上支持并发, 通过在一个连接上一次性发送多个请求来发送或接收数据: 如果HTTP/2不可用, 连接池复用技术也可以极大减少延时: 透明的Gzip处理降低了通信数据的大小 响应缓存完全避免了网络中的重复请求 使用Okio来简化数据的访问与存储,提高性能 如果您的服务器配置了多个IP地址, 当第一个IP连接失败的时候, OkHttp会自动尝试下一个IP OkHttp还处理了代理服务器问题和
-
android 使用okhttp可能引发OOM的一个点
遇到一个问题: 需要给所有的请求加签名校验以防刷接口;传入请求url及body生成一个文本串作为一个header传给服务端;已经有现成的签名检验方法String doSignature(String url, byte[] body);当前网络库基于com.squareup.okhttp3:okhttp:3.14.2. 这很简单了,当然是写一个interceptor然后将request对象的url及body传入就好.于是有: public class SignInterceptor implem
-
SpringCloud Open feign 使用okhttp 优化详解
我就废话不多说了,大家还是直接看代码吧~ <!--web 模块 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <!--排除tomcat依赖 --> <exclusion> <artifactId&
-
Android的简单前后端交互(okHttp+springboot+mysql)
前言 前阵子发现了个有意思又好用的框架--okHttp.由于课程设计需要,无意间发现了这个框架,打算利用此框架与后端交互,可以参考前后端分离的项目,把android当做前端,springboot当做后端,以下是二者的简单交互. okHttp说明 (1)android网络框架之OKhttp 一个处理网络请求的开源项目,是安卓端最火热的轻量级框架,由移动支付Square公司贡献(该公司还贡献了Picasso) 用于替代HttpUrlConnection和Apache HttpClient (2)ok
-
使用SpringBoot+OkHttp+fastjson实现Github的OAuth第三方登录
一.在GitHub上创建一个OAuth 二.OAuth的原理 Spring官方文档 三.OkHttp的使用 OkHttp官方网站 1.Post 代码示例 //官方文档: public static final MediaType JSON // = MediaType.get("application/json; charset=utf-8"); MediaType mediaType = MediaType.get("application/json; charset=ut