OKHttp的基本使用
1.准备
引入OKHttp
implementation ‘com.squareup.okhttp3:okhttp:4.9.0’
添加权限
<uses-permission android:name="android.permission.INTERNET"/>
以下是Okhttp官方提供的标准demo稍作修改而来
2.get请求
private void doOKHttpGet() {
Runnable runnable = () -> {
String response = "";
try {
response = getRequest("https://raw.github.com/square/okhttp/master/README.md");
} catch (IOException e) {
Log.d(TAG, e.getMessage());
e.printStackTrace();
}
Log.d(TAG, "doOKHttpGet: " + response);
};
Thread thread = new Thread(runnable);
thread.start();
}
String getRequest(String url) throws IOException {
Request request = new Request.Builder()
.url(url)
.build();
try (Response response = client.newCall(request).execute()) {
return response.body().string();
}
}
3.post请求
private void doOKHttpPost() {
Runnable runnable = () -> {
String json = bowlingJson("Jesse", "Jake111");
String response = "";
try {
response = post("http://www.roundsapp.com/post", json);
} catch (IOException e) {
Log.d(TAG, e.getMessage());
e.printStackTrace();
}
Log.d(TAG, "doOKHttpPost: " + response);
};
Thread thread = new Thread(runnable);
thread.start();
}
public static final MediaType JSON = MediaType.get("application/json; charset=utf-8");
String post(String url, String json) throws IOException {
RequestBody body = RequestBody.create(json, JSON);
Request request = new Request.Builder()
.url(url)
.post(body)
.build();
try (Response response = client.newCall(request).execute()) {
return response.body().string();
}
}
//模拟json数据
String bowlingJson(String player1, String player2) {
return "{'winCondition':'HIGH_SCORE',"
+ "'name':'Bowling',"
+ "'round':4,"
+ "'lastSaved':1367702411696,"
+ "'dateStarted':1367702378785,"
+ "'players':["
+ "{'name':'" + player1 + "','history':[10,8,6,7,8],'color':-13388315,'total':39},"
+ "{'name':'" + player2 + "','history':[6,10,5,10,10],'color':-48060,'total':41}"
+ "]}";
}
测试结果可以通过log和log中的url查看
对http框架进行封装
本节目的是对OKHttp进行封装，如果不进行封装，我们可能在业务逻辑到处使用到OKHttp，如果我们想切换http引擎，则变成非常繁重的工作
PS：由于内涵段子服务器已经不可访问 因此本文的测试链接改为baidu,因此返回类型不能返回为Json对象，另外 本节的主要关注点应该是框架部分，即是如何让OKHttp可以被其他引擎替换的，代码部分有些不太好懂的部分可以先行跳过
大致类图
代码部分
public interface EngineCallBack {
// 调用http接口时最开始回调的方法
public void onPreExecute(Context context, Map<String, Object> params);
// 错误时的回调
public void onError(Exception e);
// 成功时的回调
// 为什么不返回对象而返回String 除非成功失败返回同一种对象，否则返回对象会出问题，例如成功返回data对象的json数组 失败返回字符串 那么解析的时候会出问题
// 返回对象可以在子类中实现
public void onSuccess(String result);
// 默认的回调 什么都不处理(相当于没有回调)
public final EngineCallBack DEFAULT_CALL_BACK = new EngineCallBack() {
@Override
public void onPreExecute(Context context, Map<String, Object> params) {
}
@Override
public void onError(Exception e) {
}
@Override
public void onSuccess(String result) {
}
};
}
interface IHttpEngine {
// get请求
void get(Context context, String url, Map<String, Object> params, EngineCallBack callBack);
// post请求
void post(Context context, String url, Map<String, Object> params, EngineCallBack callBack);
// 优化空间
// 1下载文件
// 2上传文件
// 3 https 添加证书
}
public class OkHttpEngine implements IHttpEngine {
private static final String TAG = "OkHttpEngine";
private static OkHttpClient mOkHttpClient = new OkHttpClient();
@Override
public void post(Context context, String url, Map<String, Object> params, EngineCallBack callBack) {
// 拼装参数
final String jointUrl = HttpUtils.jointParams(url, params);
Log.e("TAG", "post 请求Url" + jointUrl);
RequestBody requestBody = appendBody(params);
// OKHttp官网标准request构造request方法
Request request = new Request.Builder()
.url(url)
.tag(context)
.post(requestBody)
.build();
// OKHttp官方标准调用方式
mOkHttpClient.newCall(request).enqueue(
new Callback() {
// 注意，两个回调方法都不是在主线程中 不要在这里直接操作UI
@Override
public void onFailure(okhttp3.Call call, IOException e) {
callBack.onError(e);
}
@Override
public void onResponse(okhttp3.Call call, Response response) throws IOException {
String result = response.body().string();
Log.e(TAG, "Post返回结果：" + jointUrl);
callBack.onSuccess(result);
}
}
);
}
protected RequestBody appendBody(Map<String, Object> params) {
MultipartBody.Builder builder = new MultipartBody.Builder()
.setType(MultipartBody.FORM);
addParams(builder, params);
return builder.build();
}
// 添加参数
private void addParams(MultipartBody.Builder builder, Map<String, Object> params) {
if (params != null && !params.isEmpty()) {
for (String key : params.keySet()) {
builder.addFormDataPart(key, params.get(key) + "");
Object value = params.get(key);
if (value instanceof File) {
// 处理文件 --> Object File
File file = (File) value;
builder.addFormDataPart(key, file.getName(), RequestBody
.create(MediaType.parse(guessMimeType(file
.getAbsolutePath())), file));
} else if (value instanceof List) {
// 代表提交的是 List集合 //为什么说List里面一定是File?
try {
List<File> listFiles = (List<File>) value;
for (int i = 0; i < listFiles.size(); i++) {
// 获取文件
File file = listFiles.get(i);
builder.addFormDataPart(key + i, file.getName(), RequestBody
.create(MediaType.parse(guessMimeType(file
.getAbsolutePath())), file));
}
} catch (Exception e) {
e.printStackTrace();
}
} else {
builder.addFormDataPart(key, value + "");
}
}
}
}
private String guessMimeType(String path) {
FileNameMap fileNameMap = URLConnection.getFileNameMap();
String contentTypeFor = fileNameMap.getContentTypeFor(path);
if (contentTypeFor == null) {
contentTypeFor = "application/octet-stream";
}
return contentTypeFor;
}
@Override
public void get(Context context, String url, Map<String, Object> params, EngineCallBack callBack) {
url = HttpUtils.jointParams(url, params);
Log.e(TAG, "Get请求路径：" + url);
Request request = new Request
.Builder()
.url(url)
.tag(context)
.build();
mOkHttpClient.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(@NotNull Call call, @NotNull IOException e) {
callBack.onError(e);
}
@Override
public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException {
if (response.body() == null) {
Log.e(TAG, "Get返回结果是null");
return;
}
String resultJson = response.body().string();
callBack.onSuccess(resultJson);
Log.e("Get返回结果：", resultJson);
}
});
}
}
public class HttpUtils {
// 直接带参数 都存放在String中
private String mUrl;
// 请求方式
private int mRequestType = GET_TYPE;
private static final int POST_TYPE = 0x0001;
private static final int GET_TYPE = 0x0002;
// 存放参数
private Map<String,Object> mParams;
private Context mContext;
private HttpUtils(Context context){
mContext = context;
mParams = new HashMap<>();
}
// 存放 context
public static HttpUtils with(Context context){
return new HttpUtils(context);
}
//传入url
public HttpUtils url(String url){
this.mUrl = url;
return this;
}
// 传入请求的方式(两种方式)
public HttpUtils post(){
mRequestType = POST_TYPE;
return this;
}
public HttpUtils get(){
mRequestType = GET_TYPE;
return this;
}
// 传入参数(两种方式)
public HttpUtils addParam(String key,Object value){
mParams.put(key, value);
return this;
}
public HttpUtils addParams(Map<String,Object> params){
mParams.putAll(params);
return this;
}
// http请求开始执行
public void execute(EngineCallBack callBack){
if(callBack == null){
callBack = EngineCallBack.DEFAULT_CALL_BACK;
}
// 预执行部分
callBack.onPreExecute(mContext,mParams);
// 判断执行方法
if(mRequestType == POST_TYPE){
post(mUrl,mParams,callBack);
}
if(mRequestType == GET_TYPE){
get(mUrl, mParams, callBack);
}
}
public void execute(){
execute(null);
}
// 默认OkHttpEngine
private static IHttpEngine mHttpEngine;
// 在Application初始化引擎
public static void init(IHttpEngine httpEngine) {
mHttpEngine = httpEngine;
}
// 切换其他引擎
public HttpUtils exchangeEngine(IHttpEngine httpEngine){
mHttpEngine = httpEngine;
return this;
}
private void get(String url, Map<String, Object> params, EngineCallBack callBack) {
mHttpEngine.get(mContext, url, params, callBack);
}
private void post(String url, Map<String, Object> params, EngineCallBack callBack) {
mHttpEngine.post(mContext, url, params, callBack);
}
/**
* 将params中的参数拼接到url上
*/
public static String jointParams(String url, Map<String, Object> params) {
if (params == null || params.size() <= 0) {
return url;
}
StringBuilder stringBuilder = new StringBuilder(url);
// 如果url中没有? 在末尾加一个?
if (!url.contains("?")) {
stringBuilder.append("?");
} else {
// url中已经存在? 如果不是以?结尾 在末尾加上一个&
if (!url.endsWith("?")) {
stringBuilder.append("&");
}
}
//上述操作之后 该url以?或者&结尾
for (Map.Entry<String, Object> entry : params.entrySet()) {
//将参数一个个拼接到Url上
stringBuilder.append(entry.getKey() + "=" + entry.getValue() + "&");
}
//删除最后一个&
stringBuilder.deleteCharAt(stringBuilder.length() - 1);
return stringBuilder.toString();
}
//貌似是获取object的类型
public static Class<?> analysisClazzInfo(Object object) {
Type genType = object.getClass().getGenericSuperclass();
Type[] params = ((ParameterizedType) genType).getActualTypeArguments();
return (Class<?>) params[0];
}
}
public abstract class DefaultHttpCallBack<T> implements EngineCallBack {
@Override
public void onPreExecute(Context context, Map<String, Object> params) {
// 固定参数部分 暂时写死
// params.put("app_name","joke_essay");
// params.put("version_name","5.7.0");
// params.put("ac","wifi");
// params.put("device_id","30036118478");
// params.put("device_brand","Xiaomi");
// params.put("update_version_code","5701");
// params.put("manifest_version_code","570");
// params.put("longitude","113.000366");
// params.put("latitude","28.171377");
// params.put("device_platform","android");
onPreExecute();
}
@Override
public void onSuccess(String result) {
// Gson gson = new Gson();
// // data:{"name","darren"} data:"请求失败"
// T objResult = (T) gson.fromJson(result,
// HttpUtils.analysisClazzInfo(this));
// onSuccess(objResult);
T objResult = (T) result;
onSuccess(objResult);
}
// 以下是三个子类必须实现的方法
// 返回可以直接操作的对象
public abstract void onSuccess(T result);
// 开始执行了
public abstract void onPreExecute();
@Override
public abstract void onError(Exception e);
}
activity中的测试代码
private void doMyHttpRequest(View view) {
HttpUtils.init(new OkHttpEngine());
HttpUtils.with(MainActivity.this)
.exchangeEngine(new OkHttpEngine())
// .addParam("iid", "6152551759")
// .addParam("aid", "7")
// .url("http://is.snssdk.com/2/essay/discovery/v3/")
.url("https://www.baidu.com/")
// .post()
.execute(new DefaultHttpCallBack() {
@Override
public void onSuccess(Object result) {
Log.d(TAG, "onSuccess: " + result);
}
@Override
public void onPreExecute() {
Log.d(TAG, "onPreExecute: ");
}
@Override
public void onError(Exception e) {
Log.d(TAG, "onError: "+e.getStackTrace());
}
});
}
打印如下类似log应该是成功了
2021-03-11 21:19:11.096 22075-22075/com.example.learneassyjoke D/MyActivity: onPreExecute:
2021-03-11 21:19:11.096 22075-22075/com.example.learneassyjoke E/OkHttpEngine: Get请求路径：https://www.baidu.com/
2021-03-11 21:19:16.923 22075-22157/com.example.learneassyjoke D/MyActivity: onSuccess: <!DOCTYPE html>
<!--STATUS OK--><html> <head><meta http-equiv=content-type content=text/html;charset=utf-8><meta http-equiv=X-UA-Compatible content=IE=Edge><meta content=always name=referrer><link rel=stylesheet type=text/css href=https://ss1.bdstatic.com/5eN1bjq8AAUYm2zgoY3K/r/www/cache/bdorz/baidu.min.css><title>百度一下，你就知道</title></head> <body link=#0000cc> <div id=wrapper> <div id=head> <div class=head_wrapper> <div class=s_form> <div class=s_form_wrapper> <div id=lg> <img hidefocus=true src=//www.baidu.com/img/bd_logo1.png width=270 height=129> </div> <form id=form name=f action=//www.baidu.com/s class=fm> <input type=hidden name=bdorz_come value=1> <input type=hidden name=ie value=utf-8> <input type=hidden name=f value=8> <input type=hidden name=rsv_bp value=1> <input type=hidden name=rsv_idx value=1> <input type=hidden name=tn value=baidu><span class="bg s_ipt_wr"><input id=kw name=wd class=s_ipt value maxlength=255 autocomplete=off autofocus=autofocus></span><span class="bg s_btn_wr"><input type=submit id=su value=百度一下 class="bg s_btn" autofocus></span> </form> </div> </div> <div id=u1> <a href=http://news.baidu.com name=tj_trnews class=mnav>新闻</a> <a href=https://www.hao123.com name=tj_trhao123 class=mnav>hao123</a> <a href=http://map.baidu.com name=tj_trmap class=mnav>地图</a> <a href=http://v.baidu.com name=tj_trvideo class=mnav>视频</a> <a href=http://tieba.baidu.com name=tj_trtieba class=mnav>贴吧</a> <noscript> <a href=http://www.baidu.com/bdorz/login.gif?login&tpl=mn&u=http%3A%2F%2Fwww.baidu.com%2f%3fbdorz_come%3d1 name=tj_login class=lb>登录</a> </noscript> <script>document.write('<a href="http://www.baidu.com/bdorz/login.gif?login&tpl=mn&u='+ encodeURIComponent(window.location.href+ (window.location.search === "" ? "?" : "&")+ "bdorz_come=1")+ '" name="tj_login" class="lb">登录</a>');
</script> <a href=//www.baidu.com/more/ name=tj_briicon class=bri style="display: block;">更多产品</a> </div> </div> </div> <div id=ftCon> <div id=ftConw> <p id=lh> <a href=http://home.baidu.com>关于百度</a> <a href=http://ir.baidu.com>About Baidu</a> </p> <p id=cp>©2017 Baidu <a href=http://www.baidu.com/duty/>使用百度前必读</a> <a href=http://jianyi.baidu.com/ class=cp-feedback>意见反馈</a> 京ICP证030173号 <img src=//www.baidu.com/img/gs.gif> </p> </div> </div> </div> </body> </html>
当然 有兴趣的可以自己搭个Apache服务器 访问自己的本地服务器 返回Json对象而后进行解析
235
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
