Arbeiten POST Multipart Request mit Volley und ohne HttpEntity

106

Dies ist nicht wirklich eine Frage, ich möchte jedoch einen Teil meines Arbeitscodes hier als Referenz für Sie freigeben, wenn Sie dies benötigen.

Wie wir wissen, HttpEntityist das von API22 veraltet und seit API23 vollständig entfernt. Derzeit können wir auf Android Developer (404) nicht mehr auf HttpEntity Reference zugreifen . Das Folgende ist mein Arbeitsbeispielcode für POST Multipart Request mit Volley und ohne HttpEntity . Es funktioniert, getestet mit Asp.Net Web API. Natürlich ist der Code vielleicht nur ein grundlegendes Beispiel, in dem zwei vorhandene zeichnbare Dateien veröffentlicht werden. Er ist auch nicht in allen Fällen die beste Lösung und keine gute Optimierung.

MultipartActivity.java:

package com.example.multipartvolley;

import android.app.Activity;
import android.content.Context;
import android.graphics.Bitmap;
import android.graphics.drawable.BitmapDrawable;
import android.graphics.drawable.Drawable;
import android.os.Bundle;
import android.support.v4.content.ContextCompat;
import android.view.Menu;
import android.view.MenuItem;
import android.widget.Toast;

import com.android.volley.NetworkResponse;
import com.android.volley.Response;
import com.android.volley.VolleyError;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.IOException;


public class MultipartActivity extends Activity {

    private final Context context = this;
    private final String twoHyphens = "--";
    private final String lineEnd = "\r\n";
    private final String boundary = "apiclient-" + System.currentTimeMillis();
    private final String mimeType = "multipart/form-data;boundary=" + boundary;
    private byte[] multipartBody;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_multipart);

        byte[] fileData1 = getFileDataFromDrawable(context, R.drawable.ic_action_android);
        byte[] fileData2 = getFileDataFromDrawable(context, R.drawable.ic_action_book);

        ByteArrayOutputStream bos = new ByteArrayOutputStream();
        DataOutputStream dos = new DataOutputStream(bos);
        try {
            // the first file
            buildPart(dos, fileData1, "ic_action_android.png");
            // the second file
            buildPart(dos, fileData2, "ic_action_book.png");
            // send multipart form data necesssary after file data
            dos.writeBytes(twoHyphens + boundary + twoHyphens + lineEnd);
            // pass to multipart body
            multipartBody = bos.toByteArray();
        } catch (IOException e) {
            e.printStackTrace();
        }

        String url = "http://192.168.1.100/api/postfile";
        MultipartRequest multipartRequest = new MultipartRequest(url, null, mimeType, multipartBody, new Response.Listener<NetworkResponse>() {
            @Override
            public void onResponse(NetworkResponse response) {
                Toast.makeText(context, "Upload successfully!", Toast.LENGTH_SHORT).show();
            }
        }, new Response.ErrorListener() {
            @Override
            public void onErrorResponse(VolleyError error) {
                Toast.makeText(context, "Upload failed!\r\n" + error.toString(), Toast.LENGTH_SHORT).show();
            }
        });

        VolleySingleton.getInstance(context).addToRequestQueue(multipartRequest);
    }

    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        // Inflate the menu; this adds items to the action bar if it is present.
        getMenuInflater().inflate(R.menu.menu_multipart, menu);
        return true;
    }

    @Override
    public boolean onOptionsItemSelected(MenuItem item) {
        // Handle action bar item clicks here. The action bar will
        // automatically handle clicks on the Home/Up button, so long
        // as you specify a parent activity in AndroidManifest.xml.
        int id = item.getItemId();

        //noinspection SimplifiableIfStatement
        if (id == R.id.action_settings) {
            return true;
        }

        return super.onOptionsItemSelected(item);
    }

    private void buildPart(DataOutputStream dataOutputStream, byte[] fileData, String fileName) throws IOException {
        dataOutputStream.writeBytes(twoHyphens + boundary + lineEnd);
        dataOutputStream.writeBytes("Content-Disposition: form-data; name=\"uploaded_file\"; filename=\""
                + fileName + "\"" + lineEnd);
        dataOutputStream.writeBytes(lineEnd);

        ByteArrayInputStream fileInputStream = new ByteArrayInputStream(fileData);
        int bytesAvailable = fileInputStream.available();

        int maxBufferSize = 1024 * 1024;
        int bufferSize = Math.min(bytesAvailable, maxBufferSize);
        byte[] buffer = new byte[bufferSize];

        // read file and write it into form...
        int bytesRead = fileInputStream.read(buffer, 0, bufferSize);

        while (bytesRead > 0) {
            dataOutputStream.write(buffer, 0, bufferSize);
            bytesAvailable = fileInputStream.available();
            bufferSize = Math.min(bytesAvailable, maxBufferSize);
            bytesRead = fileInputStream.read(buffer, 0, bufferSize);
        }

        dataOutputStream.writeBytes(lineEnd);
    }

    private byte[] getFileDataFromDrawable(Context context, int id) {
        Drawable drawable = ContextCompat.getDrawable(context, id);
        Bitmap bitmap = ((BitmapDrawable) drawable).getBitmap();
        ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
        bitmap.compress(Bitmap.CompressFormat.PNG, 0, byteArrayOutputStream);
        return byteArrayOutputStream.toByteArray();
    }
}

MultipartRequest.java:

package com.example.multipartvolley;

import com.android.volley.AuthFailureError;
import com.android.volley.NetworkResponse;
import com.android.volley.ParseError;
import com.android.volley.Request;
import com.android.volley.Response;
import com.android.volley.VolleyError;
import com.android.volley.toolbox.HttpHeaderParser;

import java.util.Map;

class MultipartRequest extends Request<NetworkResponse> {
    private final Response.Listener<NetworkResponse> mListener;
    private final Response.ErrorListener mErrorListener;
    private final Map<String, String> mHeaders;
    private final String mMimeType;
    private final byte[] mMultipartBody;

    public MultipartRequest(String url, Map<String, String> headers, String mimeType, byte[] multipartBody, Response.Listener<NetworkResponse> listener, Response.ErrorListener errorListener) {
        super(Method.POST, url, errorListener);
        this.mListener = listener;
        this.mErrorListener = errorListener;
        this.mHeaders = headers;
        this.mMimeType = mimeType;
        this.mMultipartBody = multipartBody;
    }

    @Override
    public Map<String, String> getHeaders() throws AuthFailureError {
        return (mHeaders != null) ? mHeaders : super.getHeaders();
    }

    @Override
    public String getBodyContentType() {
        return mMimeType;
    }

    @Override
    public byte[] getBody() throws AuthFailureError {
        return mMultipartBody;
    }

    @Override
    protected Response<NetworkResponse> parseNetworkResponse(NetworkResponse response) {
        try {
            return Response.success(
                    response,
                    HttpHeaderParser.parseCacheHeaders(response));
        } catch (Exception e) {
            return Response.error(new ParseError(e));
        }
    }

    @Override
    protected void deliverResponse(NetworkResponse response) {
        mListener.onResponse(response);
    }

    @Override
    public void deliverError(VolleyError error) {
        mErrorListener.onErrorResponse(error);
    }
}

AKTUALISIEREN:

Für den Textteil lesen Sie bitte die Antwort von @ Oscar unten.

BNK
quelle
1
Ich habe gerade @ Kevin Kommentar auf die folgende Frage kopiert : Einige Server sind sehr wählerisch. Wenn Sie Probleme haben, fügen Sie ein Leerzeichen zwischen ";" und "filename =" beim Erstellen von Content-Disposition und "multipart / form-data; border =" + border; :)
BNK
1
wenn Sie mimtype hinzufügen möchten: dataOutputStream.writeBytes ("Inhaltstyp: image / jpeg" + lineEnd);
Maor Hadad
1
@ MaorHadad: Danke für Ihren Kommentar :)
BNK
1
Vielen Dank für diese großartige Lösung. Nach dem Update auf Appcompat 23 war dieses Problem ein Schmerz in der a **
Maor Hadad
1
Lieber BNK, funktioniert das zum Hochladen von Videos?
Mok

Antworten:

63

Ich schreibe Ihren Code @RacZo und @BNK modularer und benutzerfreundlicher um

VolleyMultipartRequest multipartRequest = new VolleyMultipartRequest(Request.Method.POST, url, new Response.Listener<NetworkResponse>() {
    @Override
    public void onResponse(NetworkResponse response) {
        String resultResponse = new String(response.data);
        // parse success output
    }
}, new Response.ErrorListener() {
    @Override
    public void onErrorResponse(VolleyError error) {                
        error.printStackTrace();
    }
}) {
    @Override
    protected Map<String, String> getParams() {
        Map<String, String> params = new HashMap<>();
        params.put("api_token", "gh659gjhvdyudo973823tt9gvjf7i6ric75r76");
        params.put("name", "Angga");
        params.put("location", "Indonesia");
        params.put("about", "UI/UX Designer");
        params.put("contact", "[email protected]");
        return params;
    }

    @Override
    protected Map<String, DataPart> getByteData() {
        Map<String, DataPart> params = new HashMap<>();
        // file name could found file base or direct access from real path
        // for now just get bitmap data from ImageView
        params.put("avatar", new DataPart("file_avatar.jpg", AppHelper.getFileDataFromDrawable(getBaseContext(), mAvatarImage.getDrawable()), "image/jpeg"));
        params.put("cover", new DataPart("file_cover.jpg", AppHelper.getFileDataFromDrawable(getBaseContext(), mCoverImage.getDrawable()), "image/jpeg"));

        return params;
    }
};

VolleySingleton.getInstance(getBaseContext()).addToRequestQueue(multipartRequest);

Überprüfen Sie den Code VolleyMultipartRequestin meinem Kern .

Angga Ari Wijaya
quelle
Ich möchte nicht in Byte oder String konvertieren. In meinem Fall erwartet die Serverseite eine Datei und mehrere Texte (Schlüssel-Wert-Paar, mehrteilige Formulardaten), nicht das Byte oder die Zeichenfolge. ist das möglich?
Milon
Ja, Sie können Ihre Daten auf der Serverseite wie mehrteilige Formulardaten im Webformular behandeln. Tatsächlich besteht der Code darin, die http-Header-Anforderung an ein ähnliches Webformular anzupassen, sodass es die Lösung ist, nach der Sie suchen ...
Angga Ari Wijaya
@AhamadullahSaikat Sie haben alles, weil das Gleiche in meinem Projekt mehrere Anfragen mit dem gleichen Namen senden
Ricky Patel
20

Ich möchte nur die Antwort ergänzen. Ich habe versucht herauszufinden, wie Textfelder an den Körper angehängt werden, und die folgende Funktion erstellt, um dies zu tun:

private void buildTextPart(DataOutputStream dataOutputStream, String parameterName, String parameterValue) throws IOException {
    dataOutputStream.writeBytes(twoHyphens + boundary + lineEnd);
    dataOutputStream.writeBytes("Content-Disposition: form-data; name=\"" + parameterName + "\"" + lineEnd);
    dataOutputStream.writeBytes("Content-Type: text/plain; charset=UTF-8" + lineEnd);
    dataOutputStream.writeBytes(lineEnd);
    dataOutputStream.writeBytes(parameterValue + lineEnd);
}

Es funktioniert ziemlich gut.

Oscar Salguero
quelle
Ich habe die @BNK-Lösung in meine App eingebettet. Ich wähle ein Foto in meiner Telefonbibliothek aus und sende es über mehrteilige Formulardaten. Es dauert jedoch einige Sekunden (~ 10-15), bis es an den Server gesendet wird. Gibt es eine Möglichkeit, diesen Overhead zu reduzieren? oder eine andere Empfehlung?
Casillas
1
Nach der Ablehnung von HttpEntity wurden mehrteilige Uploads mit Volley sehr umständlich, und die Implementierung von PATCH-Anforderungen bereitet Kopfschmerzen. Daher habe ich mich von Volley entfernt und RetroFit ( square.github.io/retrofit ) in allen meinen Apps implementiert . Ich würde Ihnen empfehlen, dasselbe zu tun, da RetroFit Ihnen eine bessere Abwärtskompatibilität und Zukunftssicherheit Ihrer App bietet.
Oscar Salguero
Ich stimme @RacZo zu, bevorzuge jedoch OkHttp :), ich verwende Volley immer noch für andere Netzwerkanfragen. Ich habe Googles Volley-Entfernung von Apache lib angepasst, veröffentlicht auf github.com/ngocchung/volleynoapache , jedoch nur auf Get, Post und Multipart getestet.
BNK
Ich muss die PATCH-Anfrage über die Volley-Bibliothek verwenden. Wie kann ich das erreichen?
Jagadesh Seeram
8

Für diejenigen, die Schwierigkeiten haben, utf-8-Parameter zu senden und immer noch kein Glück haben, war das Problem, das ich hatte, im dataOutputStream und ändern Sie den Code von @RacZo in den folgenden Code:

private void buildTextPart(DataOutputStream dataOutputStream, String parameterName, String parameterValue) throws IOException {
        dataOutputStream.writeBytes(twoHyphens + boundary + lineEnd);
        dataOutputStream.writeBytes("Content-Disposition: form-data; name=\"");
        dataOutputStream.write(parameterName.getBytes("UTF-8"));
        dataOutputStream.writeBytes(lineEnd);
        dataOutputStream.writeBytes("Content-Type: text/plain; charset=UTF-8" + lineEnd);
        dataOutputStream.writeBytes(lineEnd);
        dataOutputStream.write(parameterValue.getBytes("UTF-8"));
        dataOutputStream.writeBytes(lineEnd);
    } 
Sepehr Nozaryian
quelle
2

Hier ist eine Kotlin-Version einer Klasse, die eine mehrteilige Anforderung mit Volley 1.1.1 ermöglicht.

Es basiert hauptsächlich auf der Lösung von @ BNK, ist jedoch leicht vereinfacht. Ich habe kein bestimmtes Leistungsproblem festgestellt. Ich habe in ca. 3 Sekunden ein 5-MB-Bild hochgeladen.

class MultipartWebservice(context: Context) {

    private var queue: RequestQueue? = null

    private val boundary = "apiclient-" + System.currentTimeMillis()
    private val mimeType = "multipart/form-data;boundary=$boundary"

    init {
        queue = Volley.newRequestQueue(context)
    }

    fun sendMultipartRequest(
        method: Int,
        url: String,
        fileData: ByteArray,
        fileName: String,
        listener: Response.Listener<NetworkResponse>,
        errorListener: Response.ErrorListener
    ) {

        // Create multi part byte array
        val bos = ByteArrayOutputStream()
        val dos = DataOutputStream(bos)
        buildMultipartContent(dos, fileData, fileName)
        val multipartBody = bos.toByteArray()

        // Request header, if needed
        val headers = HashMap<String, String>()
        headers["API-TOKEN"] = "458e126682d577c97d225bbd73a75b5989f65e977b6d8d4b2267537019ad9d20"

        val request = MultipartRequest(
            method,
            url,
            errorListener,
            listener,
            headers,
            mimeType,
            multipartBody
        )

        queue?.add(request)

    }

    @Throws(IOException::class)
    private fun buildMultipartContent(dos: DataOutputStream, fileData: ByteArray, fileName: String) {

        val twoHyphens = "--"
        val lineEnd = "\r\n"

        dos.writeBytes(twoHyphens + boundary + lineEnd)
        dos.writeBytes("Content-Disposition: form-data; name=\"file\"; filename=\"$fileName\"$lineEnd")
        dos.writeBytes(lineEnd)
        dos.write(fileData)
        dos.writeBytes(lineEnd)
        dos.writeBytes(twoHyphens + boundary + twoHyphens + lineEnd)
    }

    class MultipartRequest(
        method: Int,
        url: String,
        errorListener: Response.ErrorListener?,
        private var listener: Response.Listener<NetworkResponse>,
        private var headers: MutableMap<String, String>,
        private var mimeType: String,
        private var multipartBody: ByteArray
    ) : Request<NetworkResponse>(method, url, errorListener) {

        override fun getHeaders(): MutableMap<String, String> {
            return if (headers.isEmpty()) super.getHeaders() else headers
        }

        override fun getBodyContentType(): String {
            return mimeType
        }

        override fun getBody(): ByteArray {
            return multipartBody
        }

        override fun parseNetworkResponse(response: NetworkResponse?): Response<NetworkResponse> {
            return try {
                Response.success(response, HttpHeaderParser.parseCacheHeaders(response))
            } catch (e: Exception) {
                Response.error(ParseError(e))
            }
        }

        override fun deliverResponse(response: NetworkResponse?) {
            listener.onResponse(response)
        }
    }
}
Ika
quelle
Hallo. Haben Sie weitere Informationen darüber, wie wir die oben genannte Klasse verwenden können? Wie können wir zum Beispiel ein JPG-Bild damit hochladen?
Thanasis
0

Ich habe einen Wrapper der ursprünglichen Volley-Bibliothek gefunden, der für mehrteilige Anfragen einfacher zu integrieren ist. Es unterstützt auch das Hochladen der mehrteiligen Daten zusammen mit anderen Anforderungsparametern. Daher teile ich meinen Code für zukünftige Entwickler, die möglicherweise auf das Problem stoßen, das ich hatte (dh das Hochladen mehrteiliger Daten mit Volley zusammen mit einigen anderen Parametern).

Fügen Sie der build.gradleDatei die folgende Bibliothek hinzu .

dependencies {
    compile 'dev.dworks.libs:volleyplus:+'
}

Bitte beachten Sie, dass ich die ursprüngliche Volley-Bibliothek aus meiner entferntbuild.gradle und stattdessen die obige Bibliothek verwendet habe, die sowohl mehrteilige als auch normale Anforderungen mit ähnlicher Integrationstechnik verarbeiten kann.

Dann musste ich nur noch die folgende Klasse schreiben, die die POST-Anforderungsoperation behandelt.

public class POSTMediasTask {
    public void uploadMedia(final Context context, String filePath) {

        String url = getUrlForPOSTMedia(); // This is a dummy function which returns the POST url for you
        SimpleMultiPartRequest multiPartRequestWithParams = new SimpleMultiPartRequest(Request.Method.POST, url,
                new Response.Listener<String>() {
                    @Override
                    public void onResponse(String response) {
                        Log.d("Response", response);
                        // TODO: Do something on success
                    }
                }, new Response.ErrorListener() {
            @Override
            public void onErrorResponse(VolleyError error) {
                // TODO: Handle your error here
            }
        });

        // Add the file here
        multiPartRequestWithParams.addFile("file", filePath);

        // Add the params here
        multiPartRequestWithParams.addStringParam("param1", "SomeParamValue1");
        multiPartRequestWithParams.addStringParam("param2", "SomeParamValue2");

        RequestQueue queue = Volley.newRequestQueue(context);
        queue.add(multiPartRequestWithParams);
    }
}

Führen Sie nun die Aufgabe wie folgt aus.

new POSTMediasTask().uploadMedia(context, mediaPath);

Mit dieser Bibliothek können Sie jeweils eine Datei hochladen. Es könnte mir jedoch gelingen, mehrere Dateien hochzuladen, indem ich einfach mehrere Aufgaben initiiere.

Hoffentlich hilft das!

Reaz Murshed
quelle