本文仅为简单demo，最后显示结果如下：
image.png
使用Jetpack的框架一般如下
MVVM
LiveData 和 ViewModel一般结合起来使用。
LiveData：基于生命周期的消息订阅
ViewModel：数据共享
本篇忽略Repository，和异常处理，仅涉及Activity + ViewModel + LiveData + Retrofit。
本篇架构主要参考这篇，但有删减。
Jetpack第五篇：实战Retrofit+协程+LiveData+ViewMode写一个简单的网络请求组件
1.添加依赖,开启viewBinding 。
plugins {
id 'com.android.application'
id 'org.jetbrains.kotlin.android'
}
android {
namespace 'com.example.retrofit'
compileSdk 32
defaultConfig {
applicationId "com.example.retrofit"
minSdk 21
targetSdk 32
versionCode 1
versionName "1.0"
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
kotlinOptions {
jvmTarget = '1.8'
}
viewBinding {
enabled = true
}
}
dependencies {
implementation 'androidx.core:core-ktx:1.7.0'
implementation 'androidx.appcompat:appcompat:1.5.1'
implementation 'com.google.android.material:material:1.6.1'
implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
testImplementation 'junit:junit:4.13.2'
androidTestImplementation 'androidx.test.ext:junit:1.1.3'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
/*添加retrofit依赖库*/
implementation 'com.squareup.retrofit2:retrofit:2.9.0'
implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
// liveData
implementation 'androidx.lifecycle:lifecycle-livedata-ktx:2.4.0'
// ViewModel
implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.0'
}
2.manifest中添加网络权限
<uses-permission android:name="android.permission.INTERNET"/>
3.修改xml
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">
<TextView
android:id="@+id/textView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:padding="30dp"
android:background="@color/teal_200"
android:text="Hello World!"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
<Button
android:id="@+id/getRandomCommentButton"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="随机获取评论"
app:layout_constraintBottom_toBottomOf="@+id/getRandomMusicButton"
app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintHorizontal_bias="0.5"
app:layout_constraintStart_toEndOf="@+id/getRandomMusicButton"
app:layout_constraintTop_toTopOf="@+id/getRandomMusicButton"
app:layout_constraintVertical_bias="0.0" />
<Button
android:id="@+id/getRandomMusicButton"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="随机获取歌曲"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toStartOf="@+id/getRandomCommentButton"
app:layout_constraintHorizontal_bias="0.5"
app:layout_constraintHorizontal_chainStyle="spread"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintVertical_bias="0.023" />
</androidx.constraintlayout.widget.ConstraintLayout>
4.创建接受服务器返回数据的类
在正式的请求网络数据中，返回的数据的外嵌套部分都是一样的，携带状态码、状态信息、实体数据一起返回，我们可以将它封装一个统一的数据回调类。
get的请求地址为：
https://api.uomg.com/api/rand.music?sort=热歌榜&format=json
post请求链接：
https://api.uomg.com/api/comments.163?format=JSON
get请求之后，使用在线代码格式化 https://tool.oschina.net/codeformat/json
请求之后，返回数据如下：
返回的数据如下
{
"code": 1,
"data": {
"name": "你还好吗",
"url": "http://music.163.com/song/media/outer/url?id=1985080502",
"picurl": "http://p3.music.126.net/Hr54Q0qzquMfp3xVLOnMQw==/109951167914933261.jpg",
"artistsname": "陈钰羲"
}
}
返回参数说明：
名称 类型 说明
code string 返回的状态码
data string 返回歌曲数据
msg string 返回错误提示信息！
因此需要一个类，存放这个结果。
新建一个ResponseResult如下所示。
class ResponseResult<T>(val code:Int, val msg: String, val data: T?)
而data中的数据，需要JavaBean类去存放这些数据。
可直接新建一个kotlin file：DataBean.kt，在其中定义data 数据类：RandomMusicDataBean 和 RandomCommentDataBean 。
//网易云音乐随机歌曲 https://api.uomg.com/doc-rand.music.html
/*
https://api.uomg.com/api/rand.music?sort=热歌榜&format=json
定义的参数名要与返回的数据命名一致，否则解析失败
"data": {
"name": "你还好吗",
"url": "http://music.163.com/song/media/outer/url?id=1985080502",
"picurl": "http://p3.music.126.net/Hr54Q0qzquMfp3xVLOnMQw==/109951167914933261.jpg",
"artistsname": "陈钰羲"
}
* */
data class RandomMusicDataBean(
val name: String,
val url: String,
val picurl: String,
val artistsname: String)
//网易云音乐热门评论 https://api.uomg.com/doc-comments.163.html
/*
https://api.uomg.com/api/comments.163?format=JSON
{
"code": 1,
"data": {
"name": "可乐",
"url": "http://music.163.com/song/media/outer/url?id=29759733.mp3",
"picurl": "http://p4.music.126.net/qOfVT6izV4mBe4IyQn489Q==/18190320370401891.jpg",
"artistsname": "赵紫骅",
"avatarurl": "http://p4.music.126.net/b4fKe5gUrqD1rJzG5EZUbQ==/109951163130998723.jpg",
"nickname": "陈可乐cola",
"content": "儿子问父亲结婚是什么感受 , 父亲说就是把你手机里所有的音乐都删掉,只留下最喜欢的一首,然后无限循环,由喜欢到厌倦再到习惯"
}
}
*
* */
data class RandomCommentDataBean(
val name: String,
val url: String,
val picurl: String,
val artistsname: String,
val nickname: String,
val content: String)
5.创建用于描述网络接口的类: Api。
用suspend修饰，返回值没有Call。
interface Api {
//Url的组成，retrofit把网络请求的Url分成两部分设置：
//第一部分在创建Retrofit实例时通过.baseUrl()设置，
//第二部分在接口注解中设置
// 网络请求的完整地址Url = Retrofit实例.baseUrl()+网络请求接口注解()
// baseUrl : https://api.uomg.com/
//https://api.uomg.com/api/rand.music?sort=热歌榜&format=json
// 协程 get 请求 需加suspend 返回值去掉call
@GET("api/rand.music")
suspend fun getRandomMusicByCoroutine(
@Query("sort") sort: String,
@Query("format") format: String
): ResponseResult<RandomMusicDataBean>
// https://api.uomg.com/api/comments.163?format=text
// 协程 post 请求 需加suspend 返回值去掉call
@FormUrlEncoded
@POST("api/comments.163")
suspend fun getRandomCommentByCoroutine(
@Field("format")format: String
):ResponseResult<RandomCommentDataBean>
}
6.在ViewModel中使用LiveData 和 Retrofit。
kotlin中要尽量用val。
新建RandomViewModel.kt，继承ViewModel，在RandomViewModel中使用LiveData 和 Retrofit。
import androidx.lifecycle.MutableLiveData
import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import kotlinx.coroutines.withContext
import retrofit2.Retrofit
import retrofit2.converter.gson.GsonConverterFactory
class RandomViewModel: ViewModel() {
private val retrofit: Retrofit by lazy {
Retrofit.Builder()
//设置网络请求BaseUrl地址
.baseUrl("https://api.uomg.com/")
//设置数据解析器
.addConverterFactory(GsonConverterFactory.create())
.build();
}
var randomMusicLiveData: MutableLiveData<RandomMusicDataBean> = MutableLiveData()
var randomCommentLiveData: MutableLiveData<RandomCommentDataBean> = MutableLiveData()
fun getRandomMusicData(){
// viewmodel-ktx 库中launch开启协程 获取数据 retrofit2.6 版本及以上 支持
viewModelScope.launch {
try {
val response = getRandomMusicByCoroutine()
randomMusicLiveData.postValue(response.data!!)
}catch (e : Exception){
e.printStackTrace()
}
}
}
fun getRandomCommentData(){
viewModelScope.launch {
try {
val response = getRandomCommentByCoroutine()
randomCommentLiveData.postValue(response.data!!)
}catch (e : Exception){
e.printStackTrace()
}
}
}
// 处理耗时任务 网络请求
private suspend fun getRandomMusicByCoroutine():ResponseResult<RandomMusicDataBean>{
return withContext(Dispatchers.Default){
val api: Api = retrofit.create<Api>(Api::class.java)
// withContext 默认返回最后一行
api.getRandomMusicByCoroutine("新歌榜", "json")
}
}
private suspend fun getRandomCommentByCoroutine():ResponseResult<RandomCommentDataBean>{
return withContext(Dispatchers.Default){
val api: Api = retrofit.create<Api>(Api::class.java)
api.getRandomCommentByCoroutine("JSON")
}
}
}
AndroidX lifecycle v2.1.0在 ViewModel 类中引入了扩展属性viewModelScope，直接使用即可。
关于协程的理解，可参考这篇：
Kotlin Jetpack 实战 | 09. 图解协程原理
7.Activity中使用。
通过LiveData.observe注册观察者并监听数据变化。
const val TAG = "MainActivity"
class MainActivity : AppCompatActivity() {
private val randomViewModel by lazy {
ViewModelProvider(this).get(RandomViewModel::class.java)
}
private val binDing by lazy {
ActivityMainBinding.inflate(layoutInflater)
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
//setContentView(R.layout.activity_main)
setContentView(binDing.root)
startObserver()
binDing.getRandomMusicButton.setOnClickListener {
randomViewModel.getRandomMusicData()
}
binDing.getRandomCommentButton.setOnClickListener {
randomViewModel.getRandomCommentData()
}
}
private fun startObserver() {
randomViewModel.randomMusicLiveData.observe(this) {
binDing.textView.text =
it.run {
"""返回的数据：
name : $name
url : $url
picurl : $picurl
artistsname : $artistsname
"""
}
}
randomViewModel.randomCommentLiveData.observe(this) {
binDing.textView.text =
it.run {
"""返回的数据：
name : $name
url : $url
picurl : $picurl
artistsname : $artistsname
nickname : $nickname
content : $content
"""
}
}
}
}
运行结果如下所示
image.png
project下只有5个类，而且代码量很少，编译器会自动生成大量代码（例如data数据类，suspend修饰的函数）。
image.png
使用协程的话，就不用写回调了，如果不使用协程，只使用retrofit的话，就需要写回调，用suspend修饰，会执行CPS 转换，就是将原本的同步挂起函数转换成CallBack 异步代码的过程。这个转换是编译器在背后做的。
fun getRandomMusicData(){
//创建网络请求接口对象实例
val api: Api = retrofit.create<Api>(Api::class.java)
//对发送请求进行封装，传入接口参数
val randomMusicCall: Call<ResponseResult<RandomMusicDataBean>> =
api.getRandomMusic("新歌榜", "json")
//发送网络请求(异步)
Log.e(TAG, "get == url：" + randomMusicCall.request().url())
// object定义的匿名内部类
randomMusicCall.enqueue(object: Callback<ResponseResult<RandomMusicDataBean>> {
override fun onResponse(
call: Call<ResponseResult<RandomMusicDataBean>>,
response: Response<ResponseResult<RandomMusicDataBean>>
) {
randomMusicLiveData.postValue(response.body()?.data!!)
}
override fun onFailure(call: Call<ResponseResult<RandomMusicDataBean>>, t: Throwable) {
}
})
}
参考链接：
Retrofit2 详解和使用（一）
Retrofit2 实战（一、使用详解篇）
在线代码格式化
Jetpack第五篇：实战Retrofit+协程+LiveData+ViewMode写一个简单的网络请求组件
LiveData与ViewModel基础使用篇
重学Android Jetpack(七)之— LiveData & ViewModel
ViewModel中的简易协程：viewModelScope
Kotlin中的协程在Android端的使用
官方文档：
LiveData 概览
