How to Upload a File using Retrofit 2.0

[vivekkiran]

How to upload a file using multipart/form-data upload in Retrofit 2.0, I am unable to upload and there is no proper documentation anywhere on uploading file using retrofit 2.0, I followed the docs in retrofit website but I was not able to make it work.

All the examples I see used TypedFile. It is not clear how to use RequestBody. Please post sample code.

[JakeWharton]

Same as v1. Use the Multipart annotation on the method and Part annotation
on parameters.

On Mon, Sep 7, 2015, 7:06 AM Vivek Kiran notifications@github.com wrote:

How to upload a file using multipart upload in Retrofit 2.0

—
Reply to this email directly or view it on GitHub
#1063.

[JakeWharton]

Oh for the file itself, use RequestBody for the type.

On Mon, Sep 7, 2015, 10:50 AM Jake Wharton jakewharton@gmail.com wrote:

Same as v1. Use the Multipart annotation on the method and Part annotation
on parameters.

On Mon, Sep 7, 2015, 7:06 AM Vivek Kiran notifications@github.com wrote:

How to upload a file using multipart upload in Retrofit 2.0

—
Reply to this email directly or view it on GitHub
#1063.

[VadimWelldone]

Hi,

I am getting following exception while executing:

@Headers("User-Agent: " + Constants.CLIENT_NAME)
@Multipart
@POST(Constants.Urls.SYNC_URL)
Call<BaseResponseDto> uploadFile(@Part("file") RequestBody song, @Part("file_path") String fileName, @Part("method") String method, @Part("user_id") String userId, @Part("token") String token);

09-07 17:49:38.072 13562-13582/? W/EGL_emulation﹕ eglSurfaceAttrib not implemented

java.lang.IllegalStateException: JSON must start with an array or an object.
at com.google.gson.stream.JsonWriter.beforeValue(JsonWriter.java:609)
at com.google.gson.stream.JsonWriter.value(JsonWriter.java:418)
at com.google.gson.internal.bind.TypeAdapters$13.write(TypeAdapters.java:362)
at com.google.gson.internal.bind.TypeAdapters$13.write(TypeAdapters.java:346)
at com.google.gson.TypeAdapter.toJson(TypeAdapter.java:142)
at retrofit.GsonConverter.toBody(GsonConverter.java:55)
at retrofit.RequestBuilderAction$Part.perform(RequestBuilderAction.java:204)
at retrofit.RequestFactory.create(RequestFactory.java:62)
at retrofit.OkHttpCall.createRawCall(OkHttpCall.java:116)
at retrofit.OkHttpCall.execute(OkHttpCall.java:106)
at retrofit.ExecutorCallAdapterFactory$ExecutorCallbackCall.execute(ExecutorCallAdapterFactory.java:59)
at com.ibroadcast.mediasynclite.api.upload.UploadRunnable.run(UploadRunnable.java:49)
at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1112)
at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:587)
at java.lang.Thread.run(Thread.java:818)

Everything worked until I migrated to Retrofit 2.0. Is anything wrong with my request?

Thanks in advance.

[JakeWharton]

Retrofit 2 is not released so I'll assume you mean the beta1. This is
already fixed in master and will be in the next release.

On Mon, Sep 7, 2015, 6:06 PM Vadim Oleynik notifications@github.com wrote:

Hi,

I am getting following exception while executing:

@headers("User-Agent: " + Constants.CLIENT_NAME)
@multipart
@post(Constants.Urls.SYNC_URL)
Call uploadFile(@part("file") RequestBody song, @part("file_path") String fileName, @part("method") String method, @part("user_id") String userId, @part("token") String token);

09-07 17:49:38.072 13562-13582/? W/EGL_emulation﹕ eglSurfaceAttrib not
implemented

java.lang.IllegalStateException: JSON must start with an array or an
object.
at com.google.gson.stream.JsonWriter.beforeValue(JsonWriter.java:609)
at com.google.gson.stream.JsonWriter.value(JsonWriter.java:418)
at
com.google.gson.internal.bind.TypeAdapters$13.write(TypeAdapters.java:362)
at
com.google.gson.internal.bind.TypeAdapters$13.write(TypeAdapters.java:346)
at com.google.gson.TypeAdapter.toJson(TypeAdapter.java:142)
at retrofit.GsonConverter.toBody(GsonConverter.java:55)
at
retrofit.RequestBuilderAction$Part.perform(RequestBuilderAction.java:204)
at retrofit.RequestFactory.create(RequestFactory.java:62)
at retrofit.OkHttpCall.createRawCall(OkHttpCall.java:116)
at retrofit.OkHttpCall.execute(OkHttpCall.java:106)
at
retrofit.ExecutorCallAdapterFactory$ExecutorCallbackCall.execute(ExecutorCallAdapterFactory.java:59)
at
com.ibroadcast.mediasynclite.api.upload.UploadRunnable.run(UploadRunnable.java:49)
at
java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1112)
at
java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:587)
at java.lang.Thread.run(Thread.java:818)

Everything worked until I migrated to Retrofit 2.0. Is anything wrong with
my request?

Thanks in advance.

—
Reply to this email directly or view it on GitHub
#1063 (comment).

[JakeWharton]

Use the latest snapshot for the fix, or wait until the next release.

[VadimWelldone]

Actually, I have downloaded the latest version using:

1. maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
2. compile 'com.squareup.retrofit:retrofit:2.0.0-SNAPSHOT'
3. gradle clean
4. rebuild project

But issue still exists :(

On Mon, Sep 7, 2015 at 7:25 PM, Jake Wharton notifications@github.com
wrote:

Closed #1063 #1063.

—
Reply to this email directly or view it on GitHub
#1063 (comment).

[CBGallarno]

I have also tried the same as VadimWelldone, and experienced no change or fix of the problem.

Edit: After some messing around this seems to be a problem with multi parts and not the use of RequestBody's

[VadimWelldone]

Thanks Ashig. I'll try it a little bit later. Hope your approach will
resolve existing issue.

On Mon, Sep 14, 2015, 7:30 AM Ashiq Uz Zoha notifications@github.com
wrote:

I have a tested solution about this issue. You'll need to send to all
parameters as RequestBody.

@multipart
@post("/api/Accounts/addaccount")
Call signup(
@part("FirstName") RequestBody fname,
@part("LastName") RequestBody lname,
@part("email") RequestBody email,
@part("password") RequestBody password,
@part("username") RequestBody uname,
@part("Newsletter") RequestBody nl
);

And we need to call the method like this...

Call call = client.signup(
RequestBody.create(MediaType.parse("text"),firstNameField.getText().toString().getBytes()),
RequestBody.create(MediaType.parse("text"), lastNameField.getText().toString().getBytes()),
RequestBody.create(MediaType.parse("text"), emailField.getText().toString().getBytes()),
RequestBody.create(MediaType.parse("text"), passwordField.getText().toString().getBytes()),
RequestBody.create(MediaType.parse("text"), userNameField.getText().toString().getBytes()),
RequestBody.create(MediaType.parse("text"), toByteArray(bits))
);

Hope it helps.

—
Reply to this email directly or view it on GitHub
#1063 (comment).

[ayon115]

Hello @VadimWelldone , I deleted that comment because after spending some more time, I noticed that for doing that approach I get status code 200 as response (may be because of my backend) but those parameters don't actually gets stored to my database correctly. So, thats not actually a solution.

But here is my real finding why. I am almost sure that, the Multipart request (file upload) is from okhttp. Retrofit probably has nothing to do with it. My Multipart request has both text and image data. When I pack all my text data into a PartMap and use @PartMap in Retrofit, these things gets Posted to backend correctly.

But there's problem with image or file upload. Retrofit 2.0 tells to use okhttp RequestBody to send file. I tried that both with Retrofit and Standalone okhttp library. None of my attempt could successfully upload the file to backend. So, I guess, this problem is from okhttp and we know Retrofit 2.0 uses it as default client. And I confirm that my API is fine as I can POST image and texts in single Multipart request with Android Volley.

[jimxj]

I had problem to upload file using Retrofit 2.0-SNAPSHOT before and found out the multipart format is not compatible with my server which accepts multipart/form-data. Here is my fix : jimxj@b44ab36

[wKovacs64]

Still getting java.lang.IllegalStateException: JSON must start with an array or an object. from Gson when trying to post a multipart request where one of the parts is a file.

Retrofit 1.9.0 (using OkHttp 2.5.0):

    @Multipart
    @POST("/image/upload")
    Observable<UploadImageResponse>
    uploadImage(@Header(HEADER_AUTH_KEY) String token,
                @Part("userId") String userId,
                @Part("images") TypedFile file);

Where the file parameter is constructed as follows:

TypedFile file = new TypedFile("image/*", new File(path));

Retrofit 2.0.0-SNAPSHOT:

    @Multipart
    @POST("image/upload")
    Observable<UploadImageResponse>
    uploadImage(@Header(HEADER_AUTH_KEY) String token,
                @Part("userId") String userId,
                @Part("images") RequestBody file);

Where the file parameter is constructed as follows:

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

Am I doing something incorrectly, or is this not the same thing that @JakeWharton said was fixed in master? Did you get it to work, @VadimWelldone?

I did notice Gson can serialize TypedFile to JSON, but trying the same thing on RequestBody returns null. Related? I might be barking up the wrong tree here.

[tevjef]

A fixed was recently merged #1092 (comment). Is it already in the snapshot?

[JakeWharton]

snapshots are automatically deployed

On Thu, Sep 24, 2015 at 10:27 PM Tevin Jeffrey notifications@github.com
wrote:

A fixed was recently merged #1092 (comment)
#1092 (comment). Is it
already in the snapshot?

—
Reply to this email directly or view it on GitHub
#1063 (comment).