Android Hilt Retrofit Paging3使用实例

宣燕楠

效果视频

简述

本Demo采用Hilt+Retrofit+Paging3完成，主要为了演示paging3分页功能的使用，下列为Demo所需要的相关依赖

1. //retrofit
   
2.     implementation 'com.squareup.retrofit2:retrofit:2.9.0'
   
3.     implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
   
4.     //paging
   
5.     implementation 'androidx.paging:paging-runtime:3.1.1'
   
6.     implementation 'androidx.paging:paging-compose:1.0.0-alpha14'
   
7.     //Dagger - Hilt
   
8.     implementation("com.google.dagger:hilt-android:2.44")
   
9.     kapt("com.google.dagger:hilt-android-compiler:2.44")
   
10.     // Compose dependencies
    
11.     implementation "androidx.lifecycle:lifecycle-viewmodel-compose:2.5.1"
    
12.     implementation "androidx.hilt:hilt-navigation-compose:1.0.0"
    
13.     // Coroutines
    
14.     implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1'
    
15.     implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4'

复制代码

Hilt+Retrofit


访问接口

定义需要访问的接口，此接口是Github api，

1. suspend

复制代码

字段用于提示后续引用，此内容需要在协程中使用

1. interface GithubService {
   
2.     @GET("search/repositories?sort=stars&q=Android")
   
3.     suspend fun queryGithubAsync(@Query("per_page")number:Int, @Query("page") page:Int):DetailsBean
   
4. }

复制代码

网络实例

提供三个实例，最终外部需要引用的的为

1. UseCase

复制代码

的实例，具体

1. Hilt

复制代码

依赖注入此处不予说明，有意者可参考Hilt依赖注入

1. @Module
   
2. @InstallIn(SingletonComponent::class)
   
3. object AppModule {
   
4.     const val BASE_URL:String = "https://api.github.com/"
   
5.     @Singleton
   
6.     @Provides
   
7.     fun providerRetrofit():Retrofit{
   
8.         return Retrofit.Builder()
   
9.             .baseUrl(BASE_URL)
   
10.             .addConverterFactory(GsonConverterFactory.create())
    
11.             .build()
    
12.     }
    
13.     @Singleton
    
14.     @Provides
    
15.     fun providerGithubService(retrofit: Retrofit): GithubService {
    
16.         return retrofit.create(GithubService::class.java)
    
17.     }
    
18.     @Singleton
    
19.     @Provides
    
20.     fun providerUseCase(service: GithubService):UseCase{
    
21.         return UseCase(GetProjects(service))
    
22.     }
    
23. }

复制代码

在Hilt提供的实例中，

1. UseCase

复制代码

中实现了访问网络接口的任务

1. data class UseCase(
   
2.     val getProjects: GetProjects
   
3. )

复制代码

1. class GetProjects(private val service: GithubService) {
   
2.     suspend operator fun invoke(number:Int,page:Int): DetailsBean {
   
3.         return service.queryGithubAsync(number, page)
   
4.     }
   
5. }

复制代码

PagingSource

我们主要实现

1. load

复制代码

方法；其中

1. page

复制代码

为当前内容页数，

1. pageSize

复制代码

为每页需要加载的内容数量(可在外部进行定义),

1. repository

复制代码

为获取的网络数据实体,

1. previousPage

复制代码

为前一页，此处做了一个判断，如果为第一页时，则返回null，否则进行滑动至上一页；

1. nextPage

复制代码

为下一页，

1. LoadResult.Page

复制代码

为分页加载所需的内容；

1. LoadResult.Error

复制代码

可捕获异常

1. class DataPagingSource(private val useCase: UseCase):PagingSource<Int,DetailBean>() {
   
2.     override fun getRefreshKey(state: PagingState<Int, DetailBean>): Int? = null
   
3.     override suspend fun load(params: LoadParams<Int>): LoadResult<Int, DetailBean> {
   
4.        return try {
   
5.            val page = params.key ?: 1 //当前页，默认第一页
   
6.            val pageSize = params.loadSize //每页数据条数
   
7.            val repository = useCase.getProjects(page,pageSize) //获取的数据源
   
8.            val repositoryItem = repository.beans //获取的数据列表
   
9.            val previousPage = if (page > 1) page - 1 else null //前一页
   
10.            val nextPage = if (repositoryItem.isNotEmpty()) page+1 else null //下一页
    
11.            Log.d("hiltViewModel","page=$page size=$pageSize")
    
12.            LoadResult.Page(repositoryItem,previousPage,nextPage)
    
13.        }catch (e:Exception){
    
14.            LoadResult.Error(e)
    
15.        }
    
16.     }
    
17. }

复制代码

ViewModel

在构造函数中调用Hilt构造的实例；其中

1. getData

复制代码

方法为获取分页的数据，返回为

1. Flow<PagingData<DetailBean>>

复制代码

类型，其中

1. Flow<PagingData<...>>

复制代码

外部为固定写法，内部可根据需要自行定义，然后

1. PagingConfig

复制代码

的配置中，我们需要配置

1. pageSize

复制代码

和

1. initialLoadSize

复制代码

，如果不定义后者，则通过每页内容数量会是

1. pageSize

复制代码

的三倍，然后添加我们上述创建的

1. PagingSource

复制代码

；最后转化为流，然后置于协程中，它缓存PagingData，以便此流的任何下游集合都将共享相同的数据

1. @HiltViewModelclass HomeViewModel @Inject constructor(private val useCase: UseCase):ViewModel() {    val PAGE_SIZE = 10    fun getData():Flow<PagingData<DetailBean>>{        return Pager(            config = PagingConfig(pageSize = PAGE_SIZE, initialLoadSize = PAGE_SIZE),            pagingSourceFactory = { DataPagingSource(useCase) }        ).flow.cachedIn(viewModelScope)    }}

复制代码

View

获取ViewModel中的数据

1. val datas = viewModel.getData().collectAsLazyPagingItems()

复制代码

同时如果需要添加底部刷新状态栏、数据错误等标识，需要监听

1. loadState

复制代码

，其状态总共分为五种：

• refresh:第一次加载数据触发
  
• prepend:滑动上一页触发
  
• append：滑动下一页触发
  
• source：对应于[PagingSource]中的加载
  
• mediator：对应于来自[RemoteMediator]的加载
  

我们此处主要使用

1. refresh

复制代码

和

1. append

复制代码

；
其中，在

1. refresh

复制代码

中进行监听，如果然后数据为null,则显示全屏错误提示，此处为第一次加载数据；
然后，在

1. append

复制代码

中监听

1. loading

复制代码

和

1. Error

复制代码

两种状态，在其

1. loading

复制代码

是显示底部加载状态，在

1. Error

复制代码

中显示底部错误提示，此处不同于

1. refresh

复制代码

的

1. Error

复制代码

状态，因为有了数据，就不在需要显示全屏错误提示，在数据列表底部显示错误状态栏即可

1. @Composable
   
2. fun GithubList(viewModel: HomeViewModel = hiltViewModel()){
   
3.     val datas = viewModel.getData().collectAsLazyPagingItems()
   
4.     LazyColumn(
   
5.         verticalArrangement = Arrangement.spacedBy(10.dp),
   
6.         modifier = Modifier
   
7.             .background(grey)
   
8.             .fillMaxSize()
   
9.             .padding(10.dp)
   
10.     ){
    
11.         when(datas.loadState.refresh){
    
12.             is LoadState.Loading-> {item {  loading() }}
    
13.             is LoadState.Error-> {
    
14.                 if (datas.itemCount <= 0){
    
15.                     item{
    
16.                         /**
    
17.                          * 全屏显示错误*/
    
18.                         failedScreen() {
    
19.                             datas.retry()
    
20.                         }
    
21.                     }
    
22.                 }
    
23.             }
    
24.         }
    
25.         itemsIndexed(datas){ _, value ->
    
26.             if (value != null){
    
27.                 GithubItem(value)
    
28.             }else{
    
29.                 empty {
    
30.                     datas.retry()
    
31.                 }
    
32.             }
    
33.         }
    
34.         when(datas.loadState.append){
    
35.             is LoadState.NotLoading-> {}
    
36.             is LoadState.Loading-> {
    
37.                 item {
    
38.                     loading()
    
39.                 }
    
40.             }
    
41.             is LoadState.Error-> {
    
42.                 if (datas.itemCount > 0){
    
43.                     /**
    
44.                      * 底部显示加载错误*/
    
45.                     item { failed(){datas.retry()} }
    
46.                 }
    
47.             }
    
48.         }
    
49.     }
    
50. }

复制代码

到此这篇关于Android Hilt Retrofit Paging3使用实例的文章就介绍到这了,更多相关Android Hilt Retrofit Paging3内容请搜索晓枫资讯以前的文章或继续浏览下面的相关文章希望大家以后多多支持晓枫资讯！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！