POST Multipart Form Data utilizzando Retrofit 2.0 inclusa l'immagine


148

Sto provando a fare un POST HTTP sul server usando Retrofit 2.0

MediaType MEDIA_TYPE_TEXT = MediaType.parse("text/plain");
MediaType MEDIA_TYPE_IMAGE = MediaType.parse("image/*");

ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
    imageBitmap.compress(Bitmap.CompressFormat.JPEG,90,byteArrayOutputStream);
profilePictureByte = byteArrayOutputStream.toByteArray();

Call<APIResults> call = ServiceAPI.updateProfile(
        RequestBody.create(MEDIA_TYPE_TEXT, emailString),
        RequestBody.create(MEDIA_TYPE_IMAGE, profilePictureByte));

call.enqueue();

Il server restituisce un errore che indica che il file non è valido.

Questo è strano perché ho provato a caricare lo stesso file con lo stesso formato su iOS (usando un'altra libreria), ma si carica correttamente.

Mi chiedo quale sia il modo corretto di caricare un'immagine usando Retrofit 2.0 ?

Devo salvarlo sul disco prima di caricare?

PS: ho usato il retrofit per altre richieste multipart che non includono l'immagine e sono state completate correttamente. Il problema è quando sto cercando di includere un byte nel corpo.



Risposte:


180

Sto evidenziando la soluzione sia in 1.9 che in 2.0 poiché è utile per alcuni

In 1.9, penso che la soluzione migliore sia salvare il file su disco e usarlo come file tipizzato come:

RetroFit 1.9

(Non conosco l'implementazione sul lato server) hanno un metodo di interfaccia API simile a questo

@POST("/en/Api/Results/UploadFile")
void UploadFile(@Part("file") TypedFile file,
                @Part("folder") String folder,
                Callback<Response> callback);

E usalo come

TypedFile file = new TypedFile("multipart/form-data",
                                       new File(path));

Per RetroFit 2 Utilizzare il metodo seguente

RetroFit 2.0 (Questa è stata una soluzione alternativa per un problema in RetroFit 2 che è stato risolto ora, per il metodo corretto fare riferimento alla risposta di jimmy0251 )

Interfaccia API:

public interface ApiInterface {

    @Multipart
    @POST("/api/Accounts/editaccount")
    Call<User> editUser(@Header("Authorization") String authorization,
                        @Part("file\"; filename=\"pp.png\" ") RequestBody file,
                        @Part("FirstName") RequestBody fname,
                        @Part("Id") RequestBody id);
}

Usalo come:

File file = new File(imageUri.getPath());

RequestBody fbody = RequestBody.create(MediaType.parse("image/*"),
                                       file);

RequestBody name = RequestBody.create(MediaType.parse("text/plain"),
                                      firstNameField.getText()
                                                    .toString());

RequestBody id = RequestBody.create(MediaType.parse("text/plain"),
                                    AZUtils.getUserId(this));

Call<User> call = client.editUser(AZUtils.getToken(this),
                                  fbody,
                                  name,
                                  id);

call.enqueue(new Callback<User>() {

    @Override
    public void onResponse(retrofit.Response<User> response,
                           Retrofit retrofit) {

        AZUtils.printObject(response.body());
    }

    @Override
    public void onFailure(Throwable t) {

        t.printStackTrace();
    }
});

5
Sì, beh, penso che sia un problema ( github.com/square/retrofit/issues/1063 ) con retrofit 2.0, potresti voler rimanere con 1.9
insonnia

2
guarda la mia modifica, non l'ho ancora provata, sei il benvenuto
insonnia

1
Ho caricato con successo un'immagine usando l'esempio de Retrofit 2.0.
jerogaren,

3
@Bhargav Puoi cambiare l'interfaccia in @Multipart @POST("/api/Accounts/editaccount") Call<User> editUser(@PartMap Map<String, RequestBody> params);E Quando hai il file: Map<String, RequestBody> map = new HashMap<>(); RequestBody fileBody = RequestBody.create(MediaType.parse("image/jpg"), file); map.put("file\"; filename=\"" + file.getName(), fileBody);
insonnia

2
@insomniac Sì, l'ho appena scoperto, posso anche usareMultiPartBody.Part
Bhargav il

177

Esiste un modo corretto di caricare un file con il suo nome con Retrofit 2 , senza alcun hack :

Definisci interfaccia API:

@Multipart
@POST("uploadAttachment")
Call<MyResponse> uploadAttachment(@Part MultipartBody.Part filePart); 
                                   // You can add other parameters too

Carica il file in questo modo:

File file = // initialize file here

MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", file.getName(), RequestBody.create(MediaType.parse("image/*"), file));

Call<MyResponse> call = api.uploadAttachment(filePart);

Questo dimostra solo il caricamento di file, puoi anche aggiungere altri parametri nello stesso metodo con @Part annotazione.


2
come possiamo inviare più file usando MultipartBody.Part?
Praveen Sharma,

È possibile utilizzare più MultipartBody.Partargomenti nella stessa API.
jimmy0251

Devo inviare raccolte di immagini con "image []" come chiave. Ci ho provato @Part("images[]") List<MultipartBody.Part> imagesma dà un errore@Part parameters using the MultipartBody.Part must not include a part name
Praveen Sharma,

È necessario utilizzare @Body MultipartBody multipartBodye MultipartBody.Builderper inviare la raccolta di immagini.
jimmy0251,

2
come posso aggiungere la chiave a mutipart
andro

23

Ho usato Retrofit 2.0 per i miei utenti registrati, invio immagine e testo di file multipart / form dall'account del registro

Nel mio RegisterActivity, utilizzare un AsyncTask

//AsyncTask
private class Register extends AsyncTask<String, Void, String> {

    @Override
    protected void onPreExecute() {..}

    @Override
    protected String doInBackground(String... params) {
        new com.tequilasoft.mesasderegalos.dbo.Register().register(txtNombres, selectedImagePath, txtEmail, txtPassword);
        responseMensaje = StaticValues.mensaje ;
        mensajeCodigo = StaticValues.mensajeCodigo;
        return String.valueOf(StaticValues.code);
    }

    @Override
    protected void onPostExecute(String codeResult) {..}

E nella mia classe Register.java è dove utilizzare Retrofit con chiamata sincrona

import android.util.Log;
import com.tequilasoft.mesasderegalos.interfaces.RegisterService;
import com.tequilasoft.mesasderegalos.utils.StaticValues;
import com.tequilasoft.mesasderegalos.utils.Utilities;
import java.io.File;
import okhttp3.MediaType;
import okhttp3.MultipartBody;
import okhttp3.RequestBody;
import okhttp3.ResponseBody;
import retrofit2.Call; 
import retrofit2.Response;
/**Created by sam on 2/09/16.*/
public class Register {

public void register(String nombres, String selectedImagePath, String email, String password){

    try {
        // create upload service client
        RegisterService service = ServiceGenerator.createUser(RegisterService.class);

        // add another part within the multipart request
        RequestBody requestEmail =
                RequestBody.create(
                        MediaType.parse("multipart/form-data"), email);
        // add another part within the multipart request
        RequestBody requestPassword =
                RequestBody.create(
                        MediaType.parse("multipart/form-data"), password);
        // add another part within the multipart request
        RequestBody requestNombres =
                RequestBody.create(
                        MediaType.parse("multipart/form-data"), nombres);

        MultipartBody.Part imagenPerfil = null;
        if(selectedImagePath!=null){
            File file = new File(selectedImagePath);
            Log.i("Register","Nombre del archivo "+file.getName());
            // create RequestBody instance from file
            RequestBody requestFile =
                    RequestBody.create(MediaType.parse("multipart/form-data"), file);
            // MultipartBody.Part is used to send also the actual file name
            imagenPerfil = MultipartBody.Part.createFormData("imagenPerfil", file.getName(), requestFile);
        }

        // finally, execute the request
        Call<ResponseBody> call = service.registerUser(imagenPerfil, requestEmail,requestPassword,requestNombres);
        Response<ResponseBody> bodyResponse = call.execute();
        StaticValues.code  = bodyResponse.code();
        StaticValues.mensaje  = bodyResponse.message();
        ResponseBody errorBody = bodyResponse.errorBody();
        StaticValues.mensajeCodigo  = errorBody==null
                ?null
                :Utilities.mensajeCodigoDeLaRespuestaJSON(bodyResponse.errorBody().byteStream());
        Log.i("Register","Code "+StaticValues.code);
        Log.i("Register","mensaje "+StaticValues.mensaje);
        Log.i("Register","mensajeCodigo "+StaticValues.mensaje);
    }
    catch (Exception e){
        e.printStackTrace();
    }
}
}

Nell'interfaccia di RegisterService

public interface RegisterService {
@Multipart
@POST(StaticValues.REGISTER)
Call<ResponseBody> registerUser(@Part MultipartBody.Part image,
                                @Part("email") RequestBody email,
                                @Part("password") RequestBody password,
                                @Part("nombre") RequestBody nombre
);
}

Per l'analisi delle utilità della risposta InputStream

public class Utilities {
public static String mensajeCodigoDeLaRespuestaJSON(InputStream inputStream){
    String mensajeCodigo = null;
    try {
        BufferedReader reader = new BufferedReader(
                new InputStreamReader(
                    inputStream, "iso-8859-1"), 8);
        StringBuilder sb = new StringBuilder();
        String line;
        while ((line = reader.readLine()) != null) {
            sb.append(line).append("\n");
        }
        inputStream.close();
        mensajeCodigo = sb.toString();
    } catch (Exception e) {
        Log.e("Buffer Error", "Error converting result " + e.toString());
    }
    return mensajeCodigo;
}
}

16

Codice di aggiornamento per il caricamento di file immagine in Retrofit2.0

public interface ApiInterface {

    @Multipart
    @POST("user/signup")
    Call<UserModelResponse> updateProfilePhotoProcess(@Part("email") RequestBody email,
                                                      @Part("password") RequestBody password,
                                                      @Part("profile_pic\"; filename=\"pp.png")
                                                              RequestBody file);
}

Cambia MediaType.parse("image/*")inMediaType.parse("image/jpeg")

RequestBody reqFile = RequestBody.create(MediaType.parse("image/jpeg"),
                                         file);
RequestBody email = RequestBody.create(MediaType.parse("text/plain"),
                                       "upload_test4@gmail.com");
RequestBody password = RequestBody.create(MediaType.parse("text/plain"),
                                          "123456789");

Call<UserModelResponse> call = apiService.updateProfilePhotoProcess(email,
                                                                    password,
                                                                    reqFile);
call.enqueue(new Callback<UserModelResponse>() {

    @Override
    public void onResponse(Call<UserModelResponse> call,
                           Response<UserModelResponse> response) {

        String
                TAG =
                response.body()
                        .toString();

        UserModelResponse userModelResponse = response.body();
        UserModel userModel = userModelResponse.getUserModel();

        Log.d("MainActivity",
              "user image = " + userModel.getProfilePic());

    }

    @Override
    public void onFailure(Call<UserModelResponse> call,
                          Throwable t) {

        Toast.makeText(MainActivity.this,
                       "" + TAG,
                       Toast.LENGTH_LONG)
             .show();

    }
});

Stavo provando molti modi per farlo ma non sono riuscito a ottenere i risultati. Ho appena cambiato questo ("Cambia MediaType.parse (" image / * ") in MediaType.parse (" image / jpeg ")") come hai detto e funziona ora, grazie mille.
Gunnar,

vorrei poterti dare più di un voto, grazie.
Rohit Maurya,

se l'API ha @Multipartquindi l' @Partannotazione deve fornire un nome o utilizzare il tipo di parametro MultipartBody.Part.
Rohit,

Buona soluzione! E c'è un'altra citazione in @Part ("profile_pic \"; nomefile = \ "pp.png \" ", dovrebbe essere@Part("profile_pic\"; filename=\"pp.png "
Ninja

15

Aggiungendo alla risposta data da @insomniac . È possibile creare un Mapper inserire il parametro per RequestBodyincludere l'immagine.

Codice per l'interfaccia

public interface ApiInterface {
@Multipart
@POST("/api/Accounts/editaccount")
Call<User> editUser (@Header("Authorization") String authorization, @PartMap Map<String, RequestBody> map);
}

Codice per la classe Java

File file = new File(imageUri.getPath());
RequestBody fbody = RequestBody.create(MediaType.parse("image/*"), file);
RequestBody name = RequestBody.create(MediaType.parse("text/plain"), firstNameField.getText().toString());
RequestBody id = RequestBody.create(MediaType.parse("text/plain"), AZUtils.getUserId(this));

Map<String, RequestBody> map = new HashMap<>();
map.put("file\"; filename=\"pp.png\" ", fbody);
map.put("FirstName", name);
map.put("Id", id);
Call<User> call = client.editUser(AZUtils.getToken(this), map);
call.enqueue(new Callback<User>() {
@Override
public void onResponse(retrofit.Response<User> response, Retrofit retrofit) 
{
    AZUtils.printObject(response.body());
}

@Override
public void onFailure(Throwable t) {
    t.printStackTrace();
 }
});

come posso caricare più file con 2 stringhe?
Jay Dangar,

È possibile per te rispondere a stackoverflow.com/questions/60428238/…
Ranjit,

14

Quindi è un modo molto semplice per realizzare il tuo compito. È necessario seguire il passaggio seguente: -

1. Primo passo

public interface APIService {  
    @Multipart
    @POST("upload")
    Call<ResponseBody> upload(
        @Part("item") RequestBody description,
        @Part("imageNumber") RequestBody description,
        @Part MultipartBody.Part imageFile
    );
}

È necessario effettuare l'intera chiamata come @Multipart request. itemed image numberè solo un corpo di stringa che è avvolto RequestBody. Usiamo il MultipartBody.Part classche ci consente di inviare il nome del file effettivo oltre ai dati del file binario con la richiesta

2. Secondo passaggio

  File file = (File) params[0];
  RequestBody requestFile = RequestBody.create(MediaType.parse("multipart/form-data"), file);

  MultipartBody.Part body =MultipartBody.Part.createFormData("Image", file.getName(), requestBody);

  RequestBody ItemId = RequestBody.create(okhttp3.MultipartBody.FORM, "22");
  RequestBody ImageNumber = RequestBody.create(okhttp3.MultipartBody.FORM,"1");
  final Call<UploadImageResponse> request = apiService.uploadItemImage(body, ItemId,ImageNumber);

Ora hai image pathe devi convertirlo in file. Ora converti filein RequestBodyusando il metodo RequestBody.create(MediaType.parse("multipart/form-data"), file). Ora è necessario convertire il vostro RequestBody requestFilein MultipartBody.Partutilizzando il metodoMultipartBody.Part.createFormData("Image", file.getName(), requestBody); .

ImageNumbered ItemIdè un altro dei miei dati che devo inviare al server, quindi anch'io faccio entrambe le cose RequestBody.

Per maggiori informazioni


3

Caricare file usando Retrofit è abbastanza semplice Devi costruire la tua interfaccia api come

public interface Api {

    String BASE_URL = "http://192.168.43.124/ImageUploadApi/";


    @Multipart
    @POST("yourapipath")
    Call<MyResponse> uploadImage(@Part("image\"; filename=\"myfile.jpg\" ") RequestBody file, @Part("desc") RequestBody desc);

}

nell'immagine di codice sopra è il nome della chiave, quindi se stai usando php scriverai $ _FILES ['image'] ['tmp_name'] per ottenere questo. E nomefile = "myfile.jpg" è il nome del tuo file che viene inviato con la richiesta.

Ora per caricare il file è necessario un metodo che ti dia il percorso assoluto da Uri.

private String getRealPathFromURI(Uri contentUri) {
    String[] proj = {MediaStore.Images.Media.DATA};
    CursorLoader loader = new CursorLoader(this, contentUri, proj, null, null, null);
    Cursor cursor = loader.loadInBackground();
    int column_index = cursor.getColumnIndexOrThrow(MediaStore.Images.Media.DATA);
    cursor.moveToFirst();
    String result = cursor.getString(column_index);
    cursor.close();
    return result;
}

Ora puoi utilizzare il codice seguente per caricare il tuo file.

 private void uploadFile(Uri fileUri, String desc) {

        //creating a file
        File file = new File(getRealPathFromURI(fileUri));

        //creating request body for file
        RequestBody requestFile = RequestBody.create(MediaType.parse(getContentResolver().getType(fileUri)), file);
        RequestBody descBody = RequestBody.create(MediaType.parse("text/plain"), desc);

        //The gson builder
        Gson gson = new GsonBuilder()
                .setLenient()
                .create();


        //creating retrofit object
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(Api.BASE_URL)
                .addConverterFactory(GsonConverterFactory.create(gson))
                .build();

        //creating our api 
        Api api = retrofit.create(Api.class);

        //creating a call and calling the upload image method 
        Call<MyResponse> call = api.uploadImage(requestFile, descBody);

        //finally performing the call 
        call.enqueue(new Callback<MyResponse>() {
            @Override
            public void onResponse(Call<MyResponse> call, Response<MyResponse> response) {
                if (!response.body().error) {
                    Toast.makeText(getApplicationContext(), "File Uploaded Successfully...", Toast.LENGTH_LONG).show();
                } else {
                    Toast.makeText(getApplicationContext(), "Some error occurred...", Toast.LENGTH_LONG).show();
                }
            }

            @Override
            public void onFailure(Call<MyResponse> call, Throwable t) {
                Toast.makeText(getApplicationContext(), t.getMessage(), Toast.LENGTH_LONG).show();
            }
        });
    }

Per una spiegazione più dettagliata è possibile visitare questo tutorial di caricamento del file di retrofit .


Questo è un trucco, è stato corretto in retrofit 2.0 per un po '. Vedi la risposta jimmy0251 di seguito.
Matt Wolfe,

1

Versione di Kotlin con aggiornamento per la privazione di RequestBody.create:

Interfaccia di retrofit

@Multipart
@POST("uploadPhoto")
fun uploadFile(@Part file: MultipartBody.Part): Call<FileResponse>

e per caricare

fun uploadFile(fileUrl: String){
    val file = File(fileUrl)
    val fileUploadService = RetrofitClientInstance.retrofitInstance.create(FileUploadService::class.java)
    val requestBody = file.asRequestBody(file.extension.toMediaTypeOrNull())
    val filePart = MultipartBody.Part.createFormData(
        "blob",file.name,requestBody
    )
    val call = fileUploadService.uploadFile(filePart)

    call.enqueue(object: Callback<FileResponse>{
        override fun onFailure(call: Call<FileResponse>, t: Throwable) {
            Log.d(TAG,"Fckd")
        }

        override fun onResponse(call: Call<FileResponse>, response: Response<FileResponse>) {
            Log.d(TAG,"success"+response.toString()+" "+response.body().toString()+"  "+response.body()?.status)
        }

    })
}

Grazie a @ jimmy0251


0

Non utilizzare più parametri nel nome della funzione, basta andare con una semplice convenzione args che aumenterà la leggibilità dei codici , per questo puoi fare come:

// MultipartBody.Part.createFormData("partName", data)
Call<SomReponse> methodName(@Part MultiPartBody.Part part);
// RequestBody.create(MediaType.get("text/plain"), data)
Call<SomReponse> methodName(@Part(value = "partName") RequestBody part); 
/* for single use or you can use by Part name with Request body */

// add multiple list of part as abstraction |ease of readability|
Call<SomReponse> methodName(@Part List<MultiPartBody.Part> parts); 
Call<SomReponse> methodName(@PartMap Map<String, RequestBody> parts);
// this way you will save the abstraction of multiple parts.

Non ci può essere più eccezioni che si possono incontrare durante l'utilizzo di retrofit, tutte le eccezioni documentate come codice , avere una guida aretrofit2/RequestFactory.java . puoi abilitare due funzioni parseParameterAnnotatione parseMethodAnnotationdove puoi lanciare un'eccezione, per favore vai attraverso questo, ti farà risparmiare molto tempo di googling / stackoverflow


0

in kotlin è abbastanza semplice, usando i metodi di estensione di toMediaType , asRequestBody e toRequestBody ecco un esempio:

qui sto pubblicando un paio di campi normali insieme a un file pdf e un file immagine usando multipart

questa è la dichiarazione API usando retrofit:

    @Multipart
    @POST("api/Lesson/AddNewLesson")
    fun createLesson(
        @Part("userId") userId: RequestBody,
        @Part("LessonTitle") lessonTitle: RequestBody,
        @Part pdf: MultipartBody.Part,
        @Part imageFile: MultipartBody.Part
    ): Maybe<BaseResponse<String>>

ed ecco come chiamarlo effettivamente:

api.createLesson(
            userId.toRequestBody("text/plain".toMediaType()),
            lessonTitle.toRequestBody("text/plain".toMediaType()),
            startFromRegister.toString().toRequestBody("text/plain".toMediaType()),
            MultipartBody.Part.createFormData(
                "jpeg",
                imageFile.name,
                imageFile.asRequestBody("image/*".toMediaType())
            ),
            MultipartBody.Part.createFormData(
                "pdf",
                pdfFile.name,
                pdfFile.asRequestBody("application/pdf".toMediaType())
            )
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.