Сервис отложенных запросов для Retrofit на Android

/**
 * Представляет сервис выполнения отложженых запросов к серверу.
 * @param context Контекст приложения.
 * @param deferredRequestStorage Кэш для хранения отложенных запросов.
 * @param deferredRequestsMap Карта с отложенными запросами.
 */
class DeferredRequestsService(
    private val context: Context,
    private val deferredRequestStorage: IDeferredRequestStorage,
    private val deferredRequestsMap: IDeferredRequestsMap
) : IDeferredRequestsService {
    private val _repeatJob = CoroutineScope(Dispatchers.IO).launch {
        while (true) {
            repeatRequest()
            delay(5000)
        }
    }

    private suspend fun repeatRequest(): Boolean {
        if (deferredRequestStorage.countElements > 0) {
            val requestModel = deferredRequestStorage.getRequestModel(0)
            if (requestModel != null && handleRequest(requestModel)) {
                deferredRequestStorage.removeRequestModel(requestModel)
                repeatRequest()
            } else {
                return false
            }
        } else {
            return true
        }
        return true
    }

    override suspend fun handleRequest(
        requestModel: IDeferredRequestModel
    ): Boolean {
        //Если не был указан id пользователя
        if (requestModel.userId == null) {
            requestModel.userId = UUID.fromString("12eb6997-6c60-4828-84e1-d4e211ba00a6")
        }
        //Если не было указано имя пользователя
        if (requestModel.userName == null) {
            requestModel.userName = "Иванов Иван Иванович"
        }
        //Если не был указан id запроса
        if (requestModel.requestId == null) {
            requestModel.requestId = UUID.randomUUID()
        }
        //Если не было указано время запроса
        if (requestModel.date == null) {
            requestModel.date = SimpleDateFormat("dd.MM.yyyy HH:mm", Locale.getDefault()).format(Date())
        }

        var isSuccess = true
        try {
            deferredRequestsMap.getRequestExecutor(requestModel).execute(requestModel)
        } catch (e: Exception) {
            when (e) {
                //По эти ошибкам определяем, что запрос не был выполнен
                is SocketTimeoutException, is ConnectException, is UnknownHostException -> {
                    isSuccess = false
                }
                else -> throw e
            }
        }

        return if (isSuccess) {
            true
        } else {
            if (deferredRequestStorage.addRequestModel(requestModel)) {
                Toast.makeText(context, "Запрос был добавлен в кэш", Toast.LENGTH_LONG).show()
            }
            false
        }
    }

    override suspend fun retryHandleRequests():Boolean {
        _repeatJob.cancel()
        val success = repeatRequest()
        _repeatJob.start()
        return success
    }

    override fun registerDeferredExecutorMap(deferredRequestExecutorMap: Map<Class<out IDeferredRequestModel>, IDeferredRequestExecutor<IDeferredRequestModel>>) {
        deferredRequestsMap.addRequestExecutor(deferredRequestExecutorMap)
    }
}

/**
 * Описывает методы выполнения отложенных запросов к серверу.
 */
interface IDeferredRequestsService {
    /**
     * Выполняет запрос на сервер.
     * @param deferredRequestModel Данные для запроса к серверу.
     */
    suspend fun handleRequest(
        deferredRequestModel: IDeferredRequestModel
    ): Boolean

    /**
     * Пытается выполнить все запросы.
     */
    suspend fun retryHandleRequests(): Boolean

    /**
     * Запускает сервис.
     */
    fun startService()

    /**
     * Останавливает сервис.
     */
    fun stopService()

    /*
     * Регистрирует карту для отложенного запроса.
     */
    fun registerDeferredExecutorMap(deferredRequestExecutorMap: Map<Class<out IDeferredRequestModel>, IDeferredRequestExecutor<IDeferredRequestModel>>)
}

/**
 * Представляет хранилище для отложенных запросов.
 */
class DeferredRequestStorage : IDeferredRequestStorage {
    private val _requests = mutableListOf<IDeferredRequestModel>()
    private val _requestsFlow = MutableSharedFlow<List<IDeferredRequestModel>>(extraBufferCapacity = 1, replay = 1)

    override val requestsFlow: SharedFlow<List<IDeferredRequestModel>> = _requestsFlow.asSharedFlow()

    override val countElements: Int
        get() = _requests.size

    override fun getRequestModel(position: Int) =
        if(position > -1 && position < countElements) {
            _requests[position]
        } else {
            null
        }

    override fun addRequestModel(requestModel: IDeferredRequestModel): Boolean {
        return if (_requests.contains(requestModel)) {
            false
        } else {
            _requests.add(requestModel)
            _requestsFlow.tryEmit(_requests)
            true
        }
    }

    override fun removeRequestModel(requestModel: IDeferredRequestModel) {
        _requests.remove(requestModel)
        _requestsFlow.tryEmit(_requests)
    }

    override fun removeAllRequestsModel() {
        _requests.clear()
        _requestsFlow.tryEmit(_requests)
    }
}

/**
 * Описывает методы кэширования запросов.
 */
interface IDeferredRequestStorage {
    /**
     * Возвращает список не отправленных запросов.
     */
    val requestsFlow: SharedFlow<List<IDeferredRequestModel>>

    /**
     * Возвращает количество элементов в кэше.
     */
    val countElements: Int

    /**
     * Возвращает модель запроса из кэша.
     * @param position Позиция запроса в кэше.
     */
    fun getRequestModel(position: Int): IDeferredRequestModel?

    /**
     * Добавляет модель запроса в кэш.
     * @param deferredRequestModel Данные запроса.
     * @return Возвращает результат добавления запроса в кэш.
     */
    fun addRequestModel(deferredRequestModel: IDeferredRequestModel): Boolean

    /**
     * Удаляет модель запроса из кэша.
     * @param deferredRequestModel Данные запроса.
     */
    fun removeRequestModel(deferredRequestModel: IDeferredRequestModel)

    /**
     * Удаляет все модели запросов из кэша.
     */
    fun removeAllRequestsModel()
}

/**
 * Описывает модель отложенного запроса.
 */
interface IDeferredRequestModel {
    /**
     * Возвращает заголовок запроса.
     */
    val title: String

    /**
     * Возвращает описание запроса.
     */
    val description: String

    /**
     * Возвращает идентификатор пользователя.
     */
    var userId: UUID?

    /**
     * Возвращает имя пользователя.
     */
    var userName: String?

    /**
     * Возвращает id запроса.
     */
    var requestId: UUID?

    /**
     * Возвращает время запроса.
     */
    var date: String?
}

/**
 * Описывает метод исполнителя на отправку запроса.
 */
interface IDeferredRequestExecutor<T> {
    /**
     * Выполняет запрос.
     * @param deferredRequestModel Данные для запроса.
     */
    suspend fun execute(deferredRequestModel: T): Response<ResponseBody>
}

/**
 * Представляет карту с исполнителями для отложенных запросов.
 */
class DeferredExecutorsMap: IDeferredExecutorsMap {
    private val commandsMap = mutableMapOf<Class<out IDeferredRequestModel>, IDeferredRequestExecutor<IDeferredRequestModel>>()

    override fun getRequestExecutor(
        requestModel: IDeferredRequestModel
    ): IDeferredRequestExecutor<IDeferredRequestModel> =
        commandsMap[requestModel::class.java] ?: throw RuntimeException("Не найден исполнитель для класса модели")

    override fun addRequestExecutor(assuranceCommandMap: Map<Class<out IDeferredRequestModel>, IDeferredRequestExecutor<IDeferredRequestModel>>) {
        commandsMap.putAll(assuranceCommandMap)
    }
}

/**
 * Описывает методы для карты с отложенными запросами.
 */
interface IDeferredExecutorsMap {
    /**
     * Возвращает класс исполнителя.
     * @param deferredRequestDataClass Класс модели с данными для запроса.
     */
    fun getRequestExecutor(
        deferredRequestDataClass: IDeferredRequestModel
    ): IDeferredRequestExecutor<IDeferredRequestModel>

    /**
     * Добавляет карту для гарантированного запроса.
     * @param assuranceCommandMap Карта для гарантированного запроса.
     */
    fun addRequestExecutor(assuranceCommandMap: Map<Class<out IDeferredRequestModel>, IDeferredRequestExecutor<IDeferredRequestModel>>)
}

/**
 * Описывает методы запросов к Vkontakte.
 */
interface IVKApiService {

    /**
     * Возвращает список записей со стены пользователя или сообщества по указанному id.
     */
    @GET("wall.get")
    suspend fun getWall(
        @Query("owner_id") owner_id: String
    ): Response<ResponseBody>
}

/**
 * Представляет данные для запроса к ВКонтакте.
 * @param ownerId Возвращает id группы для запроса.
 */
data class VKontakteRequestModel(
    val ownerId: String,
    override val title: String = "Запрос к ВКонтакте",
    override val description: String = "Запрос на получение записей со стены группы ВК",
    override var userId: UUID? = null,
    override var userName: String? = null,
    override var requestId: UUID? = null,
    override var date: String? = null
) : IDeferredRequestModel

/**
 * Представляет исполнителя для запроса к ВКонтакте.
 * @param vkApiService Сервис запросов к ВКонтакте.
 */
class VKontakteRequestExecutor (
    private val vkApiService: IVKApiService
) : IDeferredRequestExecutor<VKontakteRequestModel> {
    override suspend fun execute(deferredRequestModel: VKontakteRequestModel): Response<ResponseBody> {
        return vkApiService.getWall(deferredRequestModel.ownerId)
    }
}

/**
 * Представляет приложение.
 */
class DeferredRequestApplication : Application() {

    var retrofit = Retrofit.Builder().baseUrl("https://api.vk.com/method/").addConverterFactory(GsonConverterFactory.create()).build()  // Retrofit.
    lateinit var deferredRequestsService: IDeferredRequestsService   // Сервис выполнения отложженых запросов к серверу.
    lateinit var deferredRequestStorage: IDeferredRequestStorage   // Хранилище для отложенных запросов.
    lateinit var deferredExecutorsMap: IDeferredExecutorsMap   // Хранилище для отложенных запросов.

    companion object {
        lateinit var application: DeferredRequestApplication
    }

    override fun onCreate() {
        super.onCreate()
        application = this
        deferredRequestStorage = DeferredRequestStorage()
        deferredExecutorsMap = DeferredExecutorsMap()
        deferredRequestsService = DeferredRequestsService(this, deferredRequestStorage, deferredExecutorsMap)
    }

}

/**
 * Представляет главный экран приложения.
 */
class MainActivity : AppCompatActivity() {

    private val deferredRequestsService = DeferredRequestApplication.application.deferredRequestsService

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val testRequest = DeferredRequestApplication.application.retrofit.create(IVKApiService::class.java)

        //Создаем карту, где ключ это класс нашей моли запроса, а значение это исполнитель для этого запроса
        deferredRequestsService.registerDeferredExecutorMap(mapOf(VKontakteRequestModel::class.java to VKontakteRequestExecutor(testRequest) as IDeferredRequestExecutor<IDeferredRequestModel>))

        findViewById<Button>(R.id.deferredRequestsBtn).setOnClickListener {
            // TODO Переход на экран управления отложенными запросами реализован в примере, который можно скачать по ссылке: https://github.com/AndroidLab/DeferredRequests_Example
        }

        findViewById<Button>(R.id.sendRequestBtn).setOnClickListener {
            lifecycleScope.launch {
                //Создаем модель нашего запроса
                val vkontakteRequestModel = VKontakteRequestModel(
                    ownerId = "-1"   //-1 это id главной группы вк, https://vk.com/club1
                )
                //Пытаемся выполнить запрос через наш сервис, если интернет есть, запрос успешно выполнится, если нет, будет отложен к кэш
                deferredRequestsService.handleRequest(vkontakteRequestModel)
            }
        }
    }
}

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout 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">

    <Button
        android:id="@+id/sendRequestBtn"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="Отправить запрос"
        android:layout_margin="16dp"
        app:layout_constraintBottom_toBottomOf="@id/deferredRequestsBtn"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"/>

    <Button
        android:id="@+id/deferredRequestsBtn"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginTop="72dp"
        android:layout_marginHorizontal="16dp"
        android:text="Отложенные запросы"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintHorizontal_bias="0.0"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="@id/sendRequestBtn" />

</FrameLayout>