okhttp3使用总结

okhttp简介

    okhttp是一个封装URL,比HttpClient更友好易用的工具.

特点

1.支持http和https协议,api相同,易用;
2.http使用线程池,https使用多路复用;
3.okhttp支持同步和异步调用;
4.支持普通form和文件上传form;
5.提供了拦截器,操作请求和响应(日志,请求头,body等);
6.okhttp可以设置缓存;

使用

1.创建OkHttpClient对象;
2.设置timeout时间,包括连接超时,读超市,写超时;
3.可选(拦截器);
4.创建RequestBody对象,即请求体;
5.创建Request对象,发送请求;
6.创建Response对象,接受响应内容;

源码链接

链接:http://pan.baidu.com/s/1miJVETa 密码:ldsc

封装的工具类

import com.alibaba.fastjson.JSON;
import com.google.common.collect.Maps;
import okhttp3.*;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.TimeUnit;

/**
 * @author lcj
 * @version 1.0
 * @description okhttp get post工具类
 * @Create 2017-06-16
 */
public class OkHttpUtil {
    private static final Logger LOGGER = LoggerFactory.getLogger(OkHttpUtil.class);
    private static final OkHttpClient CLIENT;

    static {
        CLIENT = new OkHttpClient.Builder()
                .connectTimeout(10, TimeUnit.SECONDS) //连接超时
                .writeTimeout(10, TimeUnit.SECONDS) //写超时
                .readTimeout(30, TimeUnit.SECONDS) //读超时
                .build();

    }

   public enum OkHttpMethod {
        POST,
        PUT,
        DELETE
    }

    /**
     * get请求,支持http和https
     * @param url 地址,比如: http://wwww.baidu.com
     * @param params 参数,可以为null
     * @param headers 请求头,可以为null
     * @return
     */
    public static String get(String url,Map<String,Object> params,Map<String,String> headers){
        //Builder对象
        Request.Builder builder = new Request.Builder();

        //处理参数
        if(null != params && params.size() > 0){
            StringBuilder stringBuilder = new StringBuilder("?");
            params.forEach((k,v) -> {
                stringBuilder.append(k).append("=").append(v).append("&");
            });
            String param = stringBuilder.toString();
            url += param.substring(0,param.lastIndexOf("&"));
        }

        //处理请求头
        if(null != headers && headers.size() > 0){
            headers.forEach((k,v) -> builder.header(k,v));
        }

        //LOGGER.info("url:{}",url);

        Request request = builder.url(url).build();

        //LOGGER.info("所有的请求头: ");
        //request.headers().toMultimap().forEach((k,v) -> {
        //    LOGGER.info("{} : {}",k,v);
        //});

        //创建响应对象
        try {
            Response response = CLIENT.newCall(request).execute();
            if(!response.isSuccessful()){
                LOGGER.error("发送get请求失败,状态码:{}",response.code());
                return "";
            }
            return response.body().string();
        } catch (IOException e) {
            LOGGER.error("发送get请求失败,原因:{}",e.getCause());
            return "";
        }
    }

  /**
     * post,put,delete请求,支持httphttps
     * @param url 地址,比如: http://wwww.baidu.com
     * @param params 参数,可以为null
     * @param headers 请求头,可以为null
     * @param okHttpMethod 请求方式
     * @return
     */
    public static String postOrPutOrDelete(String url,Map<String,Object> params,Map<String,String> headers,OkHttpMethod okHttpMethod){
        //Builder对象
        Request.Builder builder = new Request.Builder();

        //处理请求头
        if(null != headers && headers.size() > 0){
            headers.forEach((k,v) -> builder.header(k,v));
        }

        //处理参数
        if(null != params && params.size() > 0){
            RequestBody body = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), JSON.toJSONString(params));
            switch (okHttpMethod){
                case POST:
                    builder.post(body);
                    break;
                case PUT:
                    builder.put(body);
                    break;
                case DELETE:
                    builder.delete(body);
                    break;
                default:
                    builder.post(body);
                    break;

            }
        }else {
            switch (okHttpMethod){
                case DELETE:
                default:
                    builder.delete();
                    break;

            }
        }

        //LOGGER.info("url:{}",url);

        Request request = builder.url(url).build();

        //LOGGER.info("所有的请求头: ");
        //request.headers().toMultimap().forEach((k,v) -> {
        //    LOGGER.info("{} : {}",k,v);
        //});

        //创建响应对象
        try {
            Response response = CLIENT.newCall(request).execute();
            if(!response.isSuccessful()){
                LOGGER.error("发送请求失败,状态码:{}",response.code());
                return "";
            }
            return response.body().string();
        } catch (IOException e) {
            LOGGER.error("发送请求失败,原因:{}",e.getCause());
            return "";
        }
    }

    public static void main(String[] args) {
        String url = "http://wwww.baidu.com";

        Map<String,Object> params = Maps.newHashMap();
        params.put("title","title");
        params.put("age",23);
        params.put("sex",true);

        Map<String,String> headers = Maps.newHashMap();
        headers.put("User-Agent","Android");
        headers.put("Content-Type","application/json");

        String result = get(url,params,headers);
        System.out.println(result);

    }
}
### OkHttp3 GET 和 POST 请求的使用方法 #### 发起 GET 请求 通过 `OkHttpClient` 实现 GET 请求非常简单。下面展示了一个完整的 Java 示例代码: ```java import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.Response; public class GetRequestExample { public static void main(String[] args) throws Exception { OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://example.com/api?key=value") // 替换为实际 URL[^2] .build(); try (Response response = client.newCall(request).execute()) { if (!response.isSuccessful()) throw new IOException("Unexpected code " + response); System.out.println(response.body().string()); } } } ``` 上述代码展示了如何创建一个简单的 GET 请求并打印返回的结果。 --- #### 发起 JSON 参数的 POST 请求 对于需要传递 JSON 数据的情况,可以按照如下方式构建请求体并通过 POST 方法发送: ```java import okhttp3.MediaType; import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.RequestBody; import okhttp3.Response; public class PostJsonRequestExample { public static final MediaType JSON = MediaType.get("application/json; charset=utf-8"); public static void main(String[] args) throws Exception { OkHttpClient client = new OkHttpClient(); String jsonBody = "{ \"username\": \"test\", \"password\": \"1234\" }"; // 自定义JSON字符串 RequestBody body = RequestBody.create(jsonBody, JSON); Request request = new Request.Builder() .url("https://example.com/api/login") // 替换为目标URL .post(body) .build(); try (Response response = client.newCall(request).execute()) { if (!response.isSuccessful()) throw new IOException("Unexpected code " + response); System.out.println(response.body().string()); } } } ``` 此代码片段演示了如何向服务器发送带有 JSON 数据的 POST 请求,并接收响应内容。 --- #### 提交 Form 表单的 POST 请求 如果目标 API 需要以表单形式提交数据,则可以通过以下方式进行操作: ```java import okhttp3.FormBody; import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.Response; public class PostFormRequestExample { public static void main(String[] args) throws Exception { OkHttpClient client = new OkHttpClient(); FormBody formBody = new FormBody.Builder() .add("username", "test") .add("password", "1234") .build(); Request request = new Request.Builder() .url("https://example.com/api/form-submit") // 替换为目标URL .post(formBody) .build(); try (Response response = client.newCall(request).execute()) { if (!response.isSuccessful()) throw new IOException("Unexpected code " + response); System.out.println(response.body().string()); } } } ``` 这段代码说明了如何利用 `FormBody.Builder()` 构建键值对的形式来模拟 HTML 表单提交的过程[^1]。 --- ### 总结 以上分别介绍了基于 OkHttp3 的三种常见网络请求场景:GET 请求、带 JSON 参数的 POST 请求以及表单提交类型的 POST 请求。每种情况都提供了具体的实现细节和样例代码供参考。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值