OkGo极速上手教程：从配置到发起第一个GET请求
项目地址: https://gitcode.com/gh_mirrors/ok/okhttp-OkGo 你还在为Android网络请求框架的复杂配置烦恼吗？还在纠结如何快速实现一个简单的GET请求吗？本文将带你5分钟内完成OkGo的环境搭建，并成功发起第一个网络请求，让你的开发效率提升300%！读完本文你将掌握：OkGo的基本配置、GET请求的实现步骤、响应数据处理以及常见问题解决方法。
OkGo简介
OkGo是一个基于OkHttp的RESTful风格网络框架，相比Retrofit更简单易用，支持RxJava、RxJava2，提供自定义缓存策略和批量下载/上传管理功能。该项目结构清晰，核心代码位于okgo/src/main/java/com/lzy/okgo/目录下，主要包含请求管理、缓存控制、响应处理等模块。
环境配置
添加依赖
Android Studio用户只需在build.gradle中添加以下依赖：
//必须使用
compile 'com.lzy.net:okgo:3.0.4'
//根据需要选择添加
compile 'com.lzy.net:okrx:1.0.2' //RxJava支持
compile 'com.lzy.net:okrx2:2.0.2' //RxJava2支持
compile 'com.lzy.net:okserver:2.0.5' //下载/上传管理支持
Eclipse用户可直接添加jars目录下的文件，至少需要okhttp、okio和okgo三个基础jar包：
初始化配置
在Application中初始化OkGo是最佳实践，确保全局仅初始化一次：
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
//必须调用初始化
OkGo.init(this);
//以下设置根据需要自行选择
OkGo.getInstance()
.setRetryCount(3) //全局超时重试次数
.setCacheMode(CacheMode.NO_CACHE) //全局缓存模式
.setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE); //缓存过期时间
}
}
核心初始化代码位于OkGo.java的init()方法，该方法接收Application上下文并完成默认配置。
发起第一个GET请求
基本请求步骤
OkGo的GET请求实现只需三步：创建请求、配置参数、执行回调。以下是一个完整示例：
OkGo.<String>get("https://api.example.com/data") // 请求方式和URL
.tag(this) // 请求标记，用于取消请求
.params("page", 1) // 请求参数
.params("count", 10)
.execute(new StringCallback() { // 执行回调
@Override
public void onSuccess(Response<String> response) {
// 请求成功，处理响应数据
String data = response.body();
tvResult.setText(data);
}
@Override
public void onError(Response<String> response) {
// 请求失败，处理错误信息
super.onError(response);
Toast.makeText(MainActivity.this, "请求失败", Toast.LENGTH_SHORT).show();
}
});
响应数据处理
OkGo提供多种回调类型，满足不同数据处理需求：
- StringCallback：直接返回字符串数据
- JsonCallback：自动解析JSON为实体类
- BitmapCallback：返回Bitmap图片对象
- FileCallback：文件下载回调
以JsonCallback为例，解析JSON数据到实体类：
OkGo.<UserModel>get("https://api.example.com/user")
.execute(new JsonCallback<UserModel>() {
@Override
public void onSuccess(Response<UserModel> response) {
UserModel user = response.body();
// 更新UI
tvName.setText(user.getName());
tvAge.setText(String.valueOf(user.getAge()));
}
});
功能演示
OkGo提供了丰富的网络请求功能，demo模块中的CommonActivity.java展示了各类请求的使用示例，包括：
- 请求方法演示：支持GET、HEAD、OPTIONS、POST等HTTP方法
- 图片请求：直接获取Bitmap对象
- 数据上传：支持文本、文件等多种类型上传
- 缓存管理：四种缓存模式的实际应用
- HTTPS支持：证书配置与安全连接
- Cookie管理：自动维护Session
混淆配置
为避免ProGuard混淆破坏OkGo功能，需在proguard-rules.pro中添加以下配置：
#okhttp
-dontwarn okhttp3.**
-keep class okhttp3.**{*;}
#okio
-dontwarn okio.**
-keep class okio.**{*;}
#okgo
-dontwarn com.lzy.okgo.**
-keep class com.lzy.okgo.**{*;}
完整混淆规则可参考proguard-rules.pro文件。
常见问题解决
网络权限问题
确保AndroidManifest.xml中添加了网络权限：
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
主线程异常
网络请求不能在主线程执行，若出现NetworkOnMainThreadException，请检查是否使用了同步请求而未开启子线程。OkGo的异步请求会自动在子线程执行，推荐使用execute()方法而非同步的executeSync()。
超时设置
默认超时时间为60秒，可通过以下方式修改：
OkGo.getInstance().setConnectTimeout(10000); // 连接超时
OkGo.getInstance().setReadTimeOut(10000); // 读取超时
OkGo.getInstance().setWriteTimeOut(10000); // 写入超时
总结与进阶
通过本文你已经掌握了OkGo的基本使用方法，从环境配置到发起GET请求仅需简单几步。OkGo还提供了更多高级功能：
- 缓存策略：四种缓存模式满足不同场景需求
- 批量请求：同时管理多个网络请求
- 断点下载：支持大文件分片下载
- 上传管理：多文件上传与进度监听
更多详细功能请参考官方文档和Demo示例。如果觉得本文对你有帮助，别忘了点赞收藏，关注作者获取更多Android开发技巧！下一篇我们将深入探讨OkGo的缓存机制与RxJava集成，敬请期待。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
