画像を含むRetrofit 2.0を使用したPOSTマルチパートフォームデータ


148

Retrofit 2.0を使用してサーバーにHTTP POSTを実行しようとしています

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();

サーバーは、ファイルが無効であることを示すエラーを返します。

iOSで同じ形式の同じファイルを(他のライブラリを使用して)アップロードしようとしたので、これは奇妙ですが、正常にアップロードされます。

Retrofit 2.0を使用して画像をアップロードする適切な方法は何ですか?

アップロードする前に、まずディスクに保存する必要がありますか?

PS:画像を含まない他のマルチパートリクエストに改造を使用しましたが、正常に完了しました。問題は、本文にバイトを含めようとするときです。



回答:


180

1.9と2.0の両方でソリューションを強調しています。

では1.9、ファイルをディスクに保存し、次のようにタイプ付きファイルとして使用するのがより良い解決策だと思います。

RetroFit 1.9

(私はあなたのサーバー側の実装について知りません)これに似たAPIインターフェースメソッドを持っています

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

そしてそれを

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

RetroFit 2の場合次の方法を使用します

RetroFit 2.0(これは、現在修正されているRetroFit 2の問題の回避策でした。正しい方法については、jimmy0251の回答を参照してください)

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);
}

次のように使用します。

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
はい、まあそれはレトロフィット2.0の問題(github.com/square/retrofit/issues/1063)だと思います。1.9にこだわりたいかもしれません
不眠症

2
私の編集を参照してください。まだ試していません。どういたしまして
不眠症

1
レトロフィット2.0の例を使用して画像をアップロードしました。
jerogaren

3
@Bhargav次@Multipart @POST("/api/Accounts/editaccount") Call<User> editUser(@PartMap Map<String, RequestBody> params);のファイルにインターフェイスを変更できます: Map<String, RequestBody> map = new HashMap<>(); RequestBody fileBody = RequestBody.create(MediaType.parse("image/jpg"), file); map.put("file\"; filename=\"" + file.getName(), fileBody);
insomniac

2
@insomniacはい私はちょうどそれについて知りました、使用することもできますMultiPartBody.Part
Bhargav

177

ハックなしでRetrofit 2でその名前のファイルをアップロードする正しい方法があります:

APIインターフェースを定義します。

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

次のようなファイルをアップロードします。

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);

これはファイルのアップロードのみを示しています@Part。同じメソッドにアノテーションを付けて他のパラメータを追加することもできます。


2
MultipartBody.Partを使用して複数のファイルを送信するにはどうすればよいですか?
Praveen Sharma

MultipartBody.Part同じAPIで複数の引数を使用できます。
jimmy0251 2016

「image []」をキーとして画像のコレクションを送信する必要があります。試しました@Part("images[]") List<MultipartBody.Part> imagesが、エラーが発生します@Part parameters using the MultipartBody.Part must not include a part name
Praveen Sharma '20

とを使用@Body MultipartBody multipartBodyMultipartBody.Builderて、画像のコレクションを送信する必要があります。
jimmy0251 2016

2
私はmutipartにキーを追加する方法
アンドロ

23

登録ユーザーにRetrofit 2.0を使用し、登録アカウントからマルチパート/フォームファイルの画像とテキストを送信しました

私のRegisterActivityで、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) {..}

そして、私のRegister.javaクラスでは、同期呼び出しでRetrofitを使用します

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();
    }
}
}

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
);
}

ユーティリティの場合、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

画像ファイルのアップロード用の更新コード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);
}

変更MediaType.parse("image/*")MediaType.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();

    }
});

私はこれを行うために多くの方法を試みましたが、結果を得ることができませんでした。あなたが言ったようにこれを変更しました( "Change MediaType.parse(" image / * ")をMediaType.parse(" image / jpeg ")"に)。
Gunnar、

私はあなたに複数の投票を与えることができればいいのに、ありがとう。
Rohit Maurya

あなたのAPIがある場合は@Multipart、その後@Part注釈が名を指定するか、MultipartBody.Partのパラメータの型を使用する必要があります。
Rohit

良い解決策!そして、@ Part( "profile_pic \"; filename = \ "pp.png \" "にはもう1つの引用があります。それは次のとおりです@Part("profile_pic\"; filename=\"pp.png "
忍者

15

@insomniacの回答に追加する。画像MapRequestBody含めるためのパラメータを配置するを作成できます。

インターフェイスのコード

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

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();
 }
});

2つの文字列を含む複数のファイルをアップロードするにはどうすればよいですか?
ジェイダンガー


14

だからあなたの仕事を達成するための非常に簡単な方法です。以下の手順に従う必要があります:-

1.最初のステップ

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

呼び出し全体をとして行う必要があり@Multipart requestます。itemimage numberラップされた文字列本体RequestBodyです。MultipartBody.Part classリクエストでバイナリファイルデータ以外に実際のファイル名を送信できるを使用します

2. 2番目のステップ

  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);

今、あなたは持っているimage path、あなたがに変換する必要がfile.NowコンバートfileRequestBodyメソッドを使用してRequestBody.create(MediaType.parse("multipart/form-data"), file)。次に、RequestBody requestFileMultipartBody.Partusingメソッドに変換する必要がありますMultipartBody.Part.createFormData("Image", file.getName(), requestBody);

ImageNumberそしてItemId、私がサーバーに送信する必要がある私のもう1つのデータなので、両方をにも入れRequestBodyます。

詳しくは


3

Retrofitを使用したファイルのアップロードは非常に簡単です次のようにAPIインターフェイスを構築する必要があります

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);

}

上記のコードでは、イメージはキー名です。したがって、phpを使用している場合は、$ _ FILES ['image'] ['tmp_name']記述してこれを取得します。また、filename = "myfile.jpg"は、リクエストで送信されるファイルの名前です。

ここでファイルをアップロードするには、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;
}

これで、以下のコードを使用してファイルをアップロードできます。

 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();
            }
        });
    }

詳細な説明については、このRetrofit Upload File Tutorialをご覧ください。


これはハックであり、しばらくの間レトロフィット2.0で修正されています。以下のjimmy0251の回答を参照してください。
マットウルフ

1

廃止のための更新を含むKotlinバージョンRequestBody.create

後付けインターフェース

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

アップロードする

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)
        }

    })
}

@ jimmy0251に感謝


0

関数名で複数のパラメーターを 使用しないでください。コードの可読性を向上させる単純ないくつかの引数の規則に従ってください。これを行うには、次のようにします-

// 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.

レトロフィットの使用中に発生する可能性のある複数の例外が存在する可能性があります。コードとして文書化されているすべての例外は、へのウォークスルーがありretrofit2/RequestFactory.javaます。2つの関数parseParameterAnnotationparseMethodAnnotation実行でき、例外をスローできる場合は、これを実行してください。googling/ stackoverflowよりも時間を大幅に節約できます。


0

kotlinでは、toMediaTypeasRequestBody、およびtoRequestBodyの拡張メソッドを使用して、非常に簡単です。次に例を示します。

ここでは、マルチパートを使用してpdfファイルと画像ファイルとともにいくつかの通常のフィールドを投稿しています

これはレトロフィットを使用したAPI宣言です。

    @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>>

実際の呼び出し方法は次のとおりです。

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())
            )
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.