[关闭]
@linux1s1s 2016-11-18T11:06:13.000000Z 字数 11988 阅读 1772

Android 开源库 - OkHttp

AndroidRefine 2016-11

系列博文
Android 开源库 - OkHttp
Android 开源库 - Retrofit
Android 开源库 - Okio
Android 开源库 - Fresco

Demo

这里仅仅涉及如何使用OkHttp，并做了简单的工具封装，测试用例适用于okhttp:3.4.2

配置文件

  1. dependencies {
  2.     compile fileTree(dir: 'libs', include: ['*.jar'])
  3.     androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
  4.         exclude group: 'com.android.support', module: 'support-annotations'
  5.     })
  6.     compile 'com.android.support:appcompat-v7:24.2.1'
  8.     // OkHttp
  9.     compile 'com.squareup.okhttp3:okhttp:3.4.2'
  10.     // OkIo
  11.     compile 'com.squareup.okio:okio:1.11.0'
  13.     testCompile 'junit:junit:4.12'
  14. }

资源文件

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <ScrollView xmlns:android="http://schemas.android.com/apk/res/android"
  3.     xmlns:tools="http://schemas.android.com/tools"
  4.     android:id="@+id/activity_main"
  5.     android:layout_width="match_parent"
  6.     android:layout_height="match_parent"
  7.     tools:context="okhttp.mutex.com.okhttpdemo.MainActivity">
  9.     <RelativeLayout
  10.         android:layout_width="match_parent"
  11.         android:layout_height="wrap_content"
  12.         android:paddingBottom="@dimen/activity_vertical_margin"
  13.         android:paddingLeft="@dimen/activity_horizontal_margin"
  14.         android:paddingRight="@dimen/activity_horizontal_margin"
  15.         android:paddingTop="@dimen/activity_vertical_margin">
  17.         <Button
  18.             android:id="@+id/send_get"
  19.             android:layout_width="200dp"
  20.             android:layout_height="70dp"
  21.             android:layout_centerHorizontal="true"
  22.             android:onClick="sendGet"
  23.             android:text="Get" />
  25.         <Button
  26.             android:id="@+id/send_get_header"
  27.             android:layout_width="200dp"
  28.             android:layout_height="70dp"
  29.             android:layout_below="@id/send_get"
  30.             android:layout_centerHorizontal="true"
  31.             android:layout_marginTop="10dp"
  32.             android:onClick="sendGetWithHeader"
  33.             android:text="Get Header" />
  35.         <Button
  36.             android:id="@+id/send_get_async"
  37.             android:layout_width="200dp"
  38.             android:layout_height="70dp"
  39.             android:layout_below="@id/send_get_header"
  40.             android:layout_centerHorizontal="true"
  41.             android:layout_marginTop="10dp"
  42.             android:onClick="sendGetAsync"
  43.             android:text="Get Async" />
  45.         <Button
  46.             android:id="@+id/send_get_header_async"
  47.             android:layout_width="200dp"
  48.             android:layout_height="70dp"
  49.             android:layout_below="@id/send_get_async"
  50.             android:layout_centerHorizontal="true"
  51.             android:layout_marginTop="10dp"
  52.             android:onClick="sendGetWithHeaderAsync"
  53.             android:text="Get Async Header" />
  56.         <Button
  57.             android:id="@+id/send_post"
  58.             android:layout_width="200dp"
  59.             android:layout_height="70dp"
  60.             android:layout_below="@id/send_get_header_async"
  61.             android:layout_centerHorizontal="true"
  62.             android:onClick="sendPost"
  63.             android:text="Post" />
  65.         <Button
  66.             android:id="@+id/send_post_header"
  67.             android:layout_width="200dp"
  68.             android:layout_height="70dp"
  69.             android:layout_below="@id/send_post"
  70.             android:layout_centerHorizontal="true"
  71.             android:layout_marginTop="10dp"
  72.             android:onClick="sendPostWithHeader"
  73.             android:text="Post Header" />
  75.         <Button
  76.             android:id="@+id/send_post_async"
  77.             android:layout_width="200dp"
  78.             android:layout_height="70dp"
  79.             android:layout_below="@id/send_post_header"
  80.             android:layout_centerHorizontal="true"
  81.             android:layout_marginTop="10dp"
  82.             android:onClick="sendPostAsync"
  83.             android:text="post Async" />
  85.         <Button
  86.             android:id="@+id/send_post_header_async"
  87.             android:layout_width="200dp"
  88.             android:layout_height="70dp"
  89.             android:layout_below="@id/send_post_async"
  90.             android:layout_centerHorizontal="true"
  91.             android:layout_marginTop="10dp"
  92.             android:onClick="sendPostWithHeaderAsync"
  93.             android:text="Post Async Header" />
  94.     </RelativeLayout>
  96. </ScrollView>

测试源码

OkHttpUtil.java

这里将基本的OKHttp如何使用简单粗暴的封装为一个工具类，包含了get/post 分别带Header以及同步和异步请求8个简单的请求方法。

  1. import android.text.TextUtils;
  3. import java.io.IOException;
  4. import java.util.Map;
  6. import okhttp3.Callback;
  7. import okhttp3.FormBody;
  8. import okhttp3.MediaType;
  9. import okhttp3.OkHttpClient;
  10. import okhttp3.Request;
  11. import okhttp3.RequestBody;
  12. import okhttp3.Response;
  14. public class OkHttpUtil {
  16.     private static final MediaType JSON_TYPE = MediaType.parse("application/json; charset=utf-8");
  18.     private OkHttpUtil() {
  19.         //Do nothing
  20.     }
  22.     private static OkHttpClient sOkHttpClient = new OkHttpClient();
  24.     //********************Http Get Sync*************************//
  25.     public static String okHttpGetSync(String url) {
  26.         if (TextUtils.isEmpty(url))
  27.             return null;
  29.         Request request = new Request.Builder().url(url).build();
  31.         try {
  32.             Response response = sOkHttpClient.newCall(request).execute();
  34.             if (response.isSuccessful()) {
  35.                 return response.body().string();
  36.             }
  37.         } catch (IOException e) {
  38.             e.printStackTrace();
  39.         }
  41.         return null;
  42.     }
  44.     //********************Http Get Async*************************//
  45.     public static void okHttpGetAsync(String url, Callback callback) {
  46.         if (TextUtils.isEmpty(url))
  47.             return;
  49.         Request request = new Request.Builder().url(url).build();
  51.         sOkHttpClient.newCall(request).enqueue(callback);
  52.     }
  55.     //********************Http Get Sync With Headers*************************//
  56.     public static String okHttpGetSync(String url, Map<String, String> headers) {
  58.         if (TextUtils.isEmpty(url))
  59.             return null;
  61.         Request.Builder build = new Request.Builder().url(url);
  63.         Request request = fillBuild(build, headers).build();
  65.         try {
  66.             Response response = sOkHttpClient.newCall(request).execute();
  68.             if (response.isSuccessful()) {
  69.                 return response.body().string();
  70.             }
  71.         } catch (IOException e) {
  72.             e.printStackTrace();
  73.         }
  75.         return null;
  76.     }
  78.     //********************Http Get Async With Headers*************************//
  79.     public static void okHttpGetAsync(String url, Map<String, String> headers, Callback callback) {
  80.         if (TextUtils.isEmpty(url))
  81.             return;
  83.         Request.Builder build = new Request.Builder().url(url);
  85.         Request request = fillBuild(build, headers).build();
  87.         sOkHttpClient.newCall(request).enqueue(callback);
  88.     }
  90.     //********************Http Post Sync*************************//
  91.     public static String okHttpPostSyncWithForm(String url, Map<String, String> form) {
  92.         return okHttpPostSyncWithHeaderForm(url, null, form);
  93.     }
  95.     //********************Http Post Sync With Header Form*************************//
  96.     public static String okHttpPostSyncWithHeaderForm(String url, Map<String, String> headers, Map<String, String> form) {
  97.         if (TextUtils.isEmpty(url))
  98.             return null;
  100.         FormBody body = null;
  101.         if (form != null && !form.isEmpty()) {
  102.             FormBody.Builder builder = new FormBody.Builder();
  104.             for (Map.Entry<String, String> entry : form.entrySet()) {
  105.                 if (entry == null) continue;
  107.                 builder.add(entry.getKey(), entry.getValue());
  108.             }
  110.             body = builder.build();
  111.         }
  113.         Request.Builder requestBuilder = new Request.Builder().url(url);
  115.         Request request;
  116.         if (body != null) {
  117.             request = fillBuild(requestBuilder, headers).post(body).build();
  118.         } else {
  119.             request = fillBuild(requestBuilder, headers).build();
  120.         }
  122.         try {
  123.             Response response = sOkHttpClient.newCall(request).execute();
  125.             if (response.isSuccessful()) {
  126.                 return response.body().string();
  127.             }
  128.         } catch (IOException e) {
  129.             e.printStackTrace();
  130.         }
  132.         return null;
  133.     }
  135.     //********************Http Post Async With Form*************************//
  136.     public static void okHttpPostAsyncWithForm(String url, Map<String, String> form, Callback callback) {
  137.         okHttpPostAsyncWithHeaderForm(url, null, form, callback);
  138.     }
  140.     //********************Http Post Async With Headers Form*************************//
  141.     public static void okHttpPostAsyncWithHeaderForm(String url, Map<String, String> headers, Map<String, String> form, Callback callback) {
  143.         if (TextUtils.isEmpty(url))
  144.             return;
  146.         FormBody body = null;
  147.         if (form != null && !form.isEmpty()) {
  148.             FormBody.Builder builder = new FormBody.Builder();
  150.             for (Map.Entry<String, String> entry : form.entrySet()) {
  151.                 if (entry == null) continue;
  153.                 builder.add(entry.getKey(), entry.getValue());
  154.             }
  156.             body = builder.build();
  157.         }
  159.         Request.Builder requestBuilder = new Request.Builder().url(url);
  161.         Request request;
  162.         if (body != null) {
  163.             request = fillBuild(requestBuilder, headers).post(body).build();
  164.         } else {
  165.             request = fillBuild(requestBuilder, headers).build();
  166.         }
  168.         sOkHttpClient.newCall(request).enqueue(callback);
  169.     }
  171.     //********************Http Post Sync With Json*************************//
  172.     public static String okHttpPostSyncWithJson(String url, String json) {
  173.         return okHttpPostSyncWithHeaderJson(url, null, json);
  174.     }
  176.     private static String okHttpPostSyncWithHeaderJson(String url, Map<String, String> headers, String json) {
  177.         if (TextUtils.isEmpty(url))
  178.             return null;
  180.         RequestBody body = RequestBody.create(JSON_TYPE, json);
  182.         Request.Builder builder = new Request.Builder().url(url);
  184.         Request request = fillBuild(builder, headers).post(body).build();
  187.         try {
  188.             Response res = sOkHttpClient.newCall(request).execute();
  189.             if (res.isSuccessful()) {
  190.                 return res.body().string();
  191.             }
  192.         } catch (IOException e) {
  193.             e.printStackTrace();
  194.         }
  195.         return null;
  196.     }
  198.     //********************Http Post Async With Json*************************//
  199.     public static void okHttpPostAsyncWithJson(String url, String json, Callback callback) {
  200.         okHttpPostAsyncWithHeaderJson(url, null, json, callback);
  201.     }
  203.     private static void okHttpPostAsyncWithHeaderJson(String url, Map<String, String> headers, String json, Callback callback) {
  204.         if (TextUtils.isEmpty(url))
  205.             return;
  207.         RequestBody body = RequestBody.create(JSON_TYPE, json);
  209.         Request.Builder builder = new Request.Builder().url(url);
  211.         Request request = fillBuild(builder, headers).post(body).build();
  213.         sOkHttpClient.newCall(request).enqueue(callback);
  214.     }
  216.     /**
  217.      * 填充header
  218.      *
  219.      * @param input
  220.      * @param headers
  221.      * @return
  222.      */
  223.     private static Request.Builder fillBuild(Request.Builder input, Map<String, String> headers) {
  224.         if (headers == null)
  225.             return input;
  227.         for (Map.Entry<String, String> entry : headers.entrySet()) {
  228.             String key = entry.getKey();
  229.             String value = entry.getValue();
  231.             input.header(key, value);
  232.         }
  233.         return input;
  234.     }
  235. }
MainActivity.java

主界面TestCase

  1. public class MainActivity extends AppCompatActivity {
  3.     private static final String URL = "test api";
  5.     @Override
  6.     protected void onCreate(Bundle savedInstanceState) {
  7.         super.onCreate(savedInstanceState);
  8.         setContentView(R.layout.activity_main);
  9.     }
  11.     /**
  12.      * get方式请求API，同步
  13.      *
  14.      * @param view
  15.      */
  16.     public void sendGet(final View view) {
  17.         new Thread() {
  18.             @Override
  19.             public void run() {
  20.                 final String result = OkHttpUtil.okHttpGetSync(URL);
  22.                 runOnUiThread(new Runnable() {
  23.                     @Override
  24.                     public void run() {
  25.                         Toast.makeText(MainActivity.this, result, Toast.LENGTH_SHORT).show();
  26.                     }
  27.                 });
  28.             }
  29.         }.start();
  31.     }
  33.     /**
  34.      * get方式请求API，异步
  35.      *
  36.      * @param view
  37.      */
  38.     public void sendGetAsync(final View view) {
  39.         final Callback callback = obtainCommonCallback();
  41.         new Thread() {
  42.             @Override
  43.             public void run() {
  44.                 OkHttpUtil.okHttpGetAsync(URL, callback);
  45.             }
  46.         }.start();
  48.     }
  51.     /**
  52.      * get方式请求API，同步，添加Header
  53.      *
  54.      * @param view
  55.      */
  56.     public void sendGetWithHeader(final View view) {
  57.         new Thread() {
  58.             @Override
  59.             public void run() {
  60.                 final String result = OkHttpUtil.okHttpGetSync(URL, obtainCommonHeader());
  62.                 runOnUiThread(new Runnable() {
  63.                     @Override
  64.                     public void run() {
  65.                         Toast.makeText(MainActivity.this, result, Toast.LENGTH_SHORT).show();
  66.                     }
  67.                 });
  68.             }
  69.         }.start();
  71.     }
  73.     /**
  74.      * get方式请求API，异步，添加Header
  75.      *
  76.      * @param view
  77.      */
  78.     public void sendGetWithHeaderAsync(final View view) {
  79.         final Callback callback = obtainCommonCallback();
  81.         new Thread() {
  82.             @Override
  83.             public void run() {
  84.                 OkHttpUtil.okHttpGetAsync(URL, obtainCommonHeader(), callback);
  85.             }
  86.         }.start();
  87.     }
  89.     public void sendPost(final View view) {
  90.         new Thread() {
  91.             @Override
  92.             public void run() {
  93.                 final String result = OkHttpUtil.okHttpPostSyncWithForm(URL, obtainCommonForm());
  95.                 runOnUiThread(new Runnable() {
  96.                     @Override
  97.                     public void run() {
  98.                         Toast.makeText(MainActivity.this, result, Toast.LENGTH_SHORT).show();
  99.                     }
  100.                 });
  101.             }
  102.         }.start();
  103.     }
  105.     public void sendPostWithHeader(final View view) {
  106.         new Thread() {
  107.             @Override
  108.             public void run() {
  109.                 final String result = OkHttpUtil.okHttpPostSyncWithHeaderForm(URL, obtainCommonHeader(), obtainCommonForm());
  111.                 runOnUiThread(new Runnable() {
  112.                     @Override
  113.                     public void run() {
  114.                         Toast.makeText(MainActivity.this, result, Toast.LENGTH_SHORT).show();
  115.                     }
  116.                 });
  117.             }
  118.         }.start();
  119.     }
  121.     public void sendPostAsync(final View view) {
  122.         new Thread() {
  123.             @Override
  124.             public void run() {
  125.                 OkHttpUtil.okHttpPostAsyncWithForm(URL, obtainCommonForm(), obtainCommonCallback());
  126.             }
  127.         }.start();
  128.     }
  130.     public void sendPostWithHeaderAsync(final View view) {
  131.         new Thread() {
  132.             @Override
  133.             public void run() {
  134.                 OkHttpUtil.okHttpPostAsyncWithHeaderForm(URL, obtainCommonHeader(), obtainCommonForm(), obtainCommonCallback());
  135.             }
  136.         }.start();
  137.     }
  140.     private Callback obtainCommonCallback() {
  141.         return new Callback() {
  142.             @Override
  143.             public void onFailure(Call call, final IOException e) {
  144.                 runOnUiThread(new Runnable() {
  145.                     @Override
  146.                     public void run() {
  147.                         Toast.makeText(MainActivity.this, e.getMessage(), Toast.LENGTH_SHORT).show();
  148.                     }
  149.                 });
  150.             }
  152.             @Override
  153.             public void onResponse(Call call, final Response response) throws IOException {
  154.                 if (response.isSuccessful()) {
  155.                     final String rs = response.body().string();
  157.                     runOnUiThread(new Runnable() {
  158.                         @Override
  159.                         public void run() {
  160.                             Toast.makeText(MainActivity.this, rs, Toast.LENGTH_SHORT).show();
  161.                         }
  162.                     });
  163.                 }
  164.             }
  165.         };
  166.     }
  168.     private Map<String, String> obtainCommonHeader() {
  169.         Map<String, String> headers = new HashMap<>();
  170.         headers.put("Atest", "Aheader");
  171.         headers.put("Btest", "Bheader");
  172.         headers.put("Ctest", "Cheader");
  173.         headers.put("Dtest", "Dheader");
  175.         return headers;
  176.     }
  178.     private Map<String, String> obtainCommonForm() {
  179.         Map<String, String> from = new HashMap<>();
  180.         from.put("AFormKey", "FormValueA");
  181.         from.put("BFormKey", "FormValueB");
  182.         from.put("BFormKey", "FormValueC");
  183.         from.put("BFormKey", "FormValueD");
  185.         return from;
  186.     }
  187. }

验证结果

参考文章：
OkHttp GitHub Doc
Retrofit GitHub DocR Doc
Fresco GitHub Doc
Okio GitHub Video

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注