Как скачать PDF файл с сопрограммами Retrofit и Kotlin? - PullRequest
0 голосов
/ 10 июля 2019

Я видел такие темы, как Как загрузить файл в Android с помощью библиотеки Retrofit? , они используют @Streaming и RxJava / callbacks.

У меня есть Kotlin, сопрограммы, Retrofit 2.6.0и запросы как в https://stackoverflow.com/a/56473934/2914140:

@FormUrlEncoded
@Streaming
@POST("export-pdf/")
suspend fun exportPdf(
    @Field("token") token: String
): ExportResponse

У меня есть клиент Retrofit:

retrofit = Retrofit.Builder()
    .baseUrl(SERVER_URL)
    .client(okHttpClient)
    .build()

service = retrofit.create(Api::class.java)

Если параметр токена верен, запрос возвращает файл PDF:

%PDF-1.4
%����
...

Если это не так, он вернет JSON с описанием ошибки:

{
    "success": 0,
    "errors": {
        "message": "..."
    }
}

Итак, ExportResponse - это класс данных, содержащий поля JSON, POJO.

Я не могу получить доступ к данным файла с

Response response = restAdapter.apiRequest();

try {
    //you can now get your file in the InputStream
    InputStream is = response.getBody().in();
} catch (IOException e) {
    e.printStackTrace();
}

, поскольку ExportResponse является классом данных, поэтому val response: ExportResponse = interactor.exportPdf(token) будет возвращать данные, а не объект Retrofit.

Ответы [ 2 ]

1 голос
/ 13 июля 2019

Вы можете изменить тип возврата exportPdf на Call<ResponseBody>, а затем проверить код ответа.Если все в порядке, тогда читайте тело как поток.Если это не так, попробуйте десериализовать ExportResponse.Я думаю, это будет выглядеть примерно так:

val response = restAdapter.apiRequest().execute()
if (response.isSuccessful) {
    response.body()?.byteStream()//do something with stream
} else {
    response.errorBody()?.string()//try to deserialize json from string
}

Обновление

Вот полный список моего теста:

import okhttp3.HttpUrl
import okhttp3.OkHttpClient
import okhttp3.ResponseBody
import retrofit2.Call
import retrofit2.Retrofit
import retrofit2.http.GET
import retrofit2.http.Url
import java.io.File
import java.io.InputStream

fun main() {
    val queries = buildQueries()
    check(queries, "http://127.0.0.1:5000/error")
    check(queries, "http://127.0.0.1:5000/pdf")
}

private fun check(queries: Queries, url: String) {
    val response = queries.exportPdf(HttpUrl.get(url)).execute()
    if (response.isSuccessful) {
        response.body()?.byteStream()?.saveToFile("${System.currentTimeMillis()}.pdf")
    } else {
        println(response.errorBody()?.string())
    }
}

private fun InputStream.saveToFile(file: String) = use { input ->
    File(file).outputStream().use { output ->
        input.copyTo(output)
    }
}

private fun buildRetrofit() = Retrofit.Builder()
    .baseUrl("http://127.0.0.1:5000/")
    .client(OkHttpClient())
    .build()

private fun buildQueries() = buildRetrofit().create(Queries::class.java)

interface Queries {
    @GET
    fun exportPdf(@Url url: HttpUrl): Call<ResponseBody>
}

иВот простой сервер, созданный с помощью Flask:

from flask import Flask, jsonify, send_file

app = Flask(__name__)


@app.route('/')
def hello():
    return 'Hello, World!'


@app.route('/error')
def error():
    response = jsonify(error=(dict(body='some error')))
    response.status_code = 400
    return response


@app.route('/pdf')
def pdf():
    return send_file('pdf-test.pdf')

у меня все отлично работает

Обновление 2

Похоже, вы должны написать это вваш Api:

@FormUrlEncoded
@Streaming // You can also comment this line.
@POST("export-pdf/")
fun exportPdf(
    @Field("token") token: String
): Call<ResponseBody>
0 голосов
/ 16 июля 2019

Благодаря @AndreiTanana я обнаружил ошибку.Проблема была в suspend в определении запроса.Все остальные запросы сохраняют свой модификатор suspend, но этот запрос удалил его.Я изменил код так.

interface Api {
    @FormUrlEncoded
    @Streaming
    @POST("export-pdf/")
    fun exportPdf(
        @Field("token") token: String
    ): Call<ResponseBody>

    // Any another request. Note 'suspend' here.
    @FormUrlEncoded
    @POST("reject/")
    suspend fun reject(): RejectResponse
}

Затем в его реализации ApiImpl:

class ApiImpl : Api {

    private val retrofit by lazy { ApiClient.getRetrofit().create(Api::class.java) }

    override fun exportPdf(
        token: String
    ): Call<ResponseBody> =
        retrofit.exportPdf(token)

    override suspend fun reject(): RejectResponse =
        // Here can be another instance of Retrofit.
        retrofit.reject()
}

Модифицированный клиент:

class ApiClient {

    companion object {

        private val retrofit: Retrofit


        init {

            val okHttpClient = OkHttpClient().newBuilder()
                .connectTimeout(60, TimeUnit.SECONDS)
                .readTimeout(60, TimeUnit.SECONDS)
                .writeTimeout(60, TimeUnit.SECONDS)
                .build()

            val gson = GsonBuilder().setLenient().create()

            retrofit = Retrofit.Builder()
                .baseUrl(SERVER_URL)
                .client(okHttpClient)
                // .addConverterFactory(GsonConverterFactory.create(gson)) - you can add this line, I think.
                .build()
        }

        fun getRetrofit(): Retrofit = retrofit
}

Интерактор:

interface Interactor {
    // Note 'suspend' here. This is for coroutine chain.
    suspend fun exportPdf(
        token: String
    ): Call<ResponseBody>
}

class InteractorImpl(private val api: Api) : Interactor {
    override suspend fun exportPdf(
        token: String
    ): Call<ResponseBody> =
        api.exportPdf(token)
}

Затем во фрагменте:

private fun exportPdf(view: View, token: String) {
    showProgress(view)
    launch(Dispatchers.IO) {
        try {
            val response = interactor.exportPdf(token).execute()
            var error: String? = null
            if (response.headers().get("Content-Type")?.contains(
                    "application/json") == true) {
                // Received JSON with an error.
                val json: String? = response.body()?.string()
                error = json?.let {
                    val export = ApiClient.getGson().fromJson(json,
                        ExportPdfResponse::class.java)
                    export.errors?.common?.firstOrNull()
                } ?: getString(R.string.request_error)
            } else {
                // Received PDF.
                val buffer = response.body()?.byteStream()
                if (buffer != null) {
                    val file = context?.let { createFile(it, "pdf") }
                    if (file != null) {
                        copyStreamToFile(buffer, file)
                        launch(Dispatchers.Main) {
                            if (isAdded) {
                                hideProgress(view)
                            }
                        }
                    }
                }
            }
            if (error != null) {
                launch(Dispatchers.Main) {
                    if (isAdded) {
                        hideProgress(view)
                        showErrorDialog(error)
                    }
                }
            }
        } catch (e: Exception) {
            launch(Dispatchers.Main) {
                if (isAdded) {
                    showErrorDialog(getString(R.string.connection_timeout))
                    hideProgress(view)
                }
            }
        }
    }
}

СТАРЫЙ ОТВЕТ

Этот ответ не применим к двоичным файлам, таким как PDF.Возможно, его можно использовать с текстовыми файлами.

ApiClient:

val okHttpClient = OkHttpClient().newBuilder()
    .connectTimeout(60, TimeUnit.SECONDS)
    .readTimeout(60, TimeUnit.SECONDS)
    .writeTimeout(60, TimeUnit.SECONDS)
    .build()

retrofit = Retrofit.Builder()
    .baseUrl(SERVER_URL)
    .client(okHttpClient)
    .addConverterFactory(ScalarsConverterFactory.create()) // It is used to convert Response<String>.
    // .addConverterFactory(GsonConverterFactory.create(gson)) - you can also add this line.
    .build()

Api:

@FormUrlEncoded
@Streaming // You can also comment this line.
@POST("export-pdf/")
suspend fun exportPdf(
    @Field("token") token: String
): Response<String>

Интегратор:

private val service by lazy {
    ApiClient.getRetrofit().create(Api::class.java)
}

suspend fun exportPdf(
    token: String
): Response<String> =
    service.exportPdf(token)

Фрагмент:

private fun exportPdf(token: String) {
    launch {
        try {
            val response = interactor.exportPdf(token)
            var error: String? = null
            if (response.headers().get("Content-Type")?.contains(
                    "application/json") == true) {
                // Received JSON with an error.
                val json: String? = response.body()
                error = json?.let {
                    val export = gson.fromJson(json, ExportPdfResponse::class.java)
                    export.errors?.message?.firstOrNull()
                } ?: getString(R.string.request_error)
            } else {
                // Received PDF.
                val buffer: ByteArrayInputStream? = response.body()?.byteInputStream()
                if (buffer != null) {
                    val file = context?.let { createFile(it, "pdf") }
                    if (file != null) {
                        copyStreamToFile(buffer, file)
                    }
                }
            }
        } catch (e: Exception) {
            launch(Dispatchers.Main) {
                if (isAdded) {
                    showErrorDialog(getString(R.string.connection_timeout))
                }
            }
        }
    }
}

Я проверяю заголовок ответа, затем определяю, является ли он JSON или PDF.В случае PDF я использую ScalarsConverterFactory для преобразования ответа в поток байтов.copyStreamToFile копирует байты в файл, я нашел его в https://stackoverflow.com/a/56074084/2914140.

Вместо 69 857 байтов он создал файл 113 973 байта, который не отображается.Я видел внутри, он изменил все нелатинские символы с другими кодами.

Я пытался написать Response<Any> в методах, но это привело к ошибке: "java.lang.IllegalArgumentException: Невозможно создать конвертер длякласс java.lang.Object для метода Api.exportPdf ".Я пытался написать свой ConverterFactory for Any, но безуспешно.

Также изменил этот код и получил ошибки:

  • java.lang.IllegalStateException: Невозможно прочитать необработанное тело ответапреобразованное тело.
  • java.lang.IllegalArgumentException: невозможно создать конвертер для класса java.lang.String для метода Api.exportPdf
  • Невозможно создать конвертер для retrofit2.Call для метода Api.exportPdf.
...