Wysyłanie pliku i powiązanych danych do usługi RESTful WebService najlepiej jako JSON

To prawdopodobnie będzie głupie pytanie, ale mam jedną z tych nocy. W aplikacji tworzę RESTful API i chcemy, aby klient wysyłał dane jako JSON. Część tej aplikacji wymaga od klienta przesłania pliku (zwykle obrazu) oraz informacji o obrazie.

Trudno mi wyśledzić, jak to się dzieje w jednym żądaniu. Czy możliwe jest Base64 danych pliku w ciągu JSON? Czy będę musiał wykonać 2 posty na serwerze? Czy nie powinienem do tego używać JSON?

Na marginesie, używamy Grails na backendie i do tych usług mają dostęp natywni klienci mobilni (iPhone, Android itp.), Jeśli coś z tego robi różnicę.

Zadałem tutaj podobne pytanie:

Jak przesłać plik z metadanymi przy użyciu usługi sieci Web REST?

Zasadniczo masz trzy możliwości:

1. Base64 koduje plik kosztem zwiększenia rozmiaru danych o około 33% i dodaje koszty przetwarzania zarówno na serwerze, jak i kliencie do kodowania / dekodowania.
2. Najpierw wyślij plik w multipart/form-dataPOST i zwróć identyfikator klientowi. Następnie klient wysyła metadane z identyfikatorem, a serwer ponownie kojarzy plik i metadane.
3. Najpierw wyślij metadane i zwróć identyfikator klientowi. Następnie klient wysyła plik o identyfikatorze, a serwer ponownie kojarzy plik i metadane.

Możesz wysłać plik i dane w jednym żądaniu, używając typu zawartości wieloczęściowej / formularza :

W wielu aplikacjach użytkownik może otrzymać formularz. Użytkownik wypełni formularz, w tym informacje wpisane, wygenerowane na podstawie danych wprowadzonych przez użytkownika lub zawarte w plikach wybranych przez użytkownika. Po wypełnieniu formularza dane z formularza są wysyłane od użytkownika do aplikacji odbierającej.

Definicja MultiPart / Form-Data pochodzi od jednej z tych aplikacji ...

From http://www.faqs.org/rfcs/rfc2388.html :

„multipart / form-data” zawiera serię części. Oczekuje się, że każda część będzie zawierała nagłówek dyspozycji-zawartości [RFC 2183], w którym typ dyspozycji to „dane formularza” i gdzie dyspozycja zawiera (dodatkowy) parametr „nazwa”, gdzie wartość tego parametru jest oryginalna nazwa pola w formularzu. Na przykład część może zawierać nagłówek:

Dyspozycja treści: dane formularza; name = „user”

z wartością odpowiadającą wpisowi w polu „użytkownik”.

Możesz zawrzeć informacje o pliku lub informacje o polu w każdej sekcji między granicami. Z powodzeniem wdrożyłem usługę RESTful, która wymagała od użytkownika przesłania zarówno danych, jak i formularza, a dane wieloczęściowe / dane działały idealnie. Usługa została zbudowana przy użyciu Java / Spring, a klient korzystał z C #, więc niestety nie mam żadnych przykładów Grails, które mogłyby dać ci informacje na temat konfiguracji usługi. W tym przypadku nie musisz używać JSON, ponieważ każda sekcja „dane formularza” zapewnia miejsce do określenia nazwy parametru i jego wartości.

Dobrą rzeczą w korzystaniu z danych wieloczęściowych / formularzy jest to, że używasz nagłówków zdefiniowanych w HTTP, więc trzymasz się filozofii REST polegającej na używaniu istniejących narzędzi HTTP do tworzenia usługi.

Wiem, że ten wątek jest dość stary, brakuje mi jednak jednej opcji. Jeśli masz metadane (w dowolnym formacie), które chcesz wysłać wraz z danymi do przesłania, możesz złożyć pojedyncze multipart/relatedżądanie.

Typ nośnika Multipart / Related jest przeznaczony do obiektów złożonych składających się z kilku powiązanych ze sobą części ciała.

Możesz sprawdzić specyfikację RFC 2387, aby uzyskać bardziej szczegółowe informacje.

Zasadniczo każda część takiego żądania może zawierać treść różnego typu, a wszystkie części są w jakiś sposób powiązane (np. Obraz i jego metadane). Części są identyfikowane za pomocą ciągu granicznego, a po ostatnim ciągu granicznym występują dwa myślniki.

Przykład:

POST /upload HTTP/1.1
Host: www.hostname.com
Content-Type: multipart/related; boundary=xyz
Content-Length: [actual-content-length]

--xyz
Content-Type: application/json; charset=UTF-8

{
    "name": "Sample image",
    "desc": "...",
    ...
}

--xyz
Content-Type: image/jpeg

[image data]
[image data]
[image data]
...
--foo_bar_baz--

Wiem, że to pytanie jest stare, ale w ostatnich dniach szukałem w całej sieci rozwiązania tego samego pytania. Mam serwisy internetowe REST grails i klienta iPhone, które wysyłają zdjęcia, tytuł i opis.

Nie wiem, czy moje podejście jest najlepsze, ale jest takie łatwe i proste.

Robię zdjęcie za pomocą UIImagePickerController i przesyłam do serwera NSData za pomocą tagów nagłówka żądania wysłania danych obrazu.

NSMutableURLRequest *request = [[NSMutableURLRequest alloc] initWithURL:[NSURL URLWithString:@"myServerAddress"]];
[request setHTTPMethod:@"POST"];
[request setHTTPBody:UIImageJPEGRepresentation(picture, 0.5)];
[request setValue:@"image/jpeg" forHTTPHeaderField:@"Content-Type"];
[request setValue:@"myPhotoTitle" forHTTPHeaderField:@"Photo-Title"];
[request setValue:@"myPhotoDescription" forHTTPHeaderField:@"Photo-Description"];

NSURLResponse *response;

NSError *error;

[NSURLConnection sendSynchronousRequest:request returningResponse:&response error:&error];

Po stronie serwera otrzymuję zdjęcie za pomocą kodu:

InputStream is = request.inputStream

def receivedPhotoFile = (IOUtils.toByteArray(is))

def photo = new Photo()
photo.photoFile = receivedPhotoFile //photoFile is a transient attribute
photo.title = request.getHeader("Photo-Title")
photo.description = request.getHeader("Photo-Description")
photo.imageURL = "temp"    

if (photo.save()) {    

    File saveLocation = grailsAttributes.getApplicationContext().getResource(File.separator + "images").getFile()
    saveLocation.mkdirs()

    File tempFile = File.createTempFile("photo", ".jpg", saveLocation)

    photo.imageURL = saveLocation.getName() + "/" + tempFile.getName()

    tempFile.append(photo.photoFile);

} else {

    println("Error")

}

Nie wiem, czy mam problemy w przyszłości, ale teraz działa dobrze w środowisku produkcyjnym.

Oto moje podejście API (korzystam z przykładu) - jak widać, nie używam żadnego file_id(przesłanego identyfikatora pliku na serwer) w API:

1. Utwórz photoobiekt na serwerze:

   POST: /projects/{project_id}/photos   
   body: { name: "some_schema.jpg", comment: "blah"}
   response: photo_id

2. Prześlij plik (uwaga, że filejest w formie pojedynczej, ponieważ jest tylko jeden na zdjęcie):

   POST: /projects/{project_id}/photos/{photo_id}/file
   body: file to upload
   response: -

A potem na przykład:

3. Przeczytaj listę zdjęć

   GET: /projects/{project_id}/photos
   response: [ photo, photo, photo, ... ] (array of objects)

4. Przeczytaj szczegóły zdjęcia

   GET: /projects/{project_id}/photos/{photo_id}
   response: { id: 666, name: 'some_schema.jpg', comment:'blah'} (photo object)

5. Przeczytaj plik ze zdjęciem

   GET: /projects/{project_id}/photos/{photo_id}/file
   response: file content

Wniosek jest taki, że najpierw tworzysz obiekt (zdjęcie) za pomocą POST, a następnie wysyłasz drugie żądanie z plikiem (ponownie POST).

Obiekty FormData: przesyłanie plików za pomocą Ajax

XMLHttpRequest poziom 2 dodaje obsługę nowego interfejsu FormData. Obiekty FormData umożliwiają łatwe tworzenie zestawu par klucz / wartość reprezentujących pola formularza i ich wartości, które można następnie łatwo przesłać za pomocą metody send () XMLHttpRequest.

function AjaxFileUpload() {
    var file = document.getElementById("files");
    //var file = fileInput;
    var fd = new FormData();
    fd.append("imageFileData", file);
    var xhr = new XMLHttpRequest();
    xhr.open("POST", '/ws/fileUpload.do');
    xhr.onreadystatechange = function () {
        if (xhr.readyState == 4) {
             alert('success');
        }
        else if (uploadResult == 'success')
             alert('error');
    };
    xhr.send(fd);
}

https://developer.mozilla.org/en-US/docs/Web/API/FormData

Ponieważ jedynym brakującym przykładem jest ANDROID , dodam go. W tej technice użyto niestandardowego zadania AsyncTask, które powinno być zadeklarowane w klasie aktywności.

private class UploadFile extends AsyncTask<Void, Integer, String> {
    @Override
    protected void onPreExecute() {
        // set a status bar or show a dialog to the user here
        super.onPreExecute();
    }

    @Override
    protected void onProgressUpdate(Integer... progress) {
        // progress[0] is the current status (e.g. 10%)
        // here you can update the user interface with the current status
    }

    @Override
    protected String doInBackground(Void... params) {
        return uploadFile();
    }

    private String uploadFile() {

        String responseString = null;
        HttpClient httpClient = new DefaultHttpClient();
        HttpPost httpPost = new HttpPost("http://example.com/upload-file");

        try {
            AndroidMultiPartEntity ampEntity = new AndroidMultiPartEntity(
                new ProgressListener() {
                    @Override
                        public void transferred(long num) {
                            // this trigger the progressUpdate event
                            publishProgress((int) ((num / (float) totalSize) * 100));
                        }
            });

            File myFile = new File("/my/image/path/example.jpg");

            ampEntity.addPart("fileFieldName", new FileBody(myFile));

            totalSize = ampEntity.getContentLength();
            httpPost.setEntity(ampEntity);

            // Making server call
            HttpResponse httpResponse = httpClient.execute(httpPost);
            HttpEntity httpEntity = httpResponse.getEntity();

            int statusCode = httpResponse.getStatusLine().getStatusCode();
            if (statusCode == 200) {
                responseString = EntityUtils.toString(httpEntity);
            } else {
                responseString = "Error, http status: "
                        + statusCode;
            }

        } catch (Exception e) {
            responseString = e.getMessage();
        }
        return responseString;
    }

    @Override
    protected void onPostExecute(String result) {
        // if you want update the user interface with upload result
        super.onPostExecute(result);
    }

}

Jeśli chcesz przesłać plik, zadzwoń:

new UploadFile().execute();

Chciałem wysłać kilka ciągów do serwera zaplecza. Nie używałem jsona z wieloma częściami, użyłem parametrów żądania.

@RequestMapping(value = "/upload", method = RequestMethod.POST)
public void uploadFile(HttpServletRequest request,
        HttpServletResponse response, @RequestParam("uuid") String uuid,
        @RequestParam("type") DocType type,
        @RequestParam("file") MultipartFile uploadfile)

Url wyglądałby

http://localhost:8080/file/upload?uuid=46f073d0&type=PASSPORT

Mijam dwa parametry (identyfikator UUID i typ) wraz z przesyłaniem pliku. Mam nadzieję, że pomoże to tym, którzy nie mają skomplikowanych danych Json do wysłania.

Możesz spróbować użyć biblioteki https://square.github.io/okhttp/ . Możesz ustawić treść żądania na wieloczęściową, a następnie osobno dodać plik i obiekty json:

MultipartBody requestBody = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
                .addFormDataPart("uploadFile", uploadFile.getName(), okhttp3.RequestBody.create(uploadFile, MediaType.parse("image/png")))
                .addFormDataPart("file metadata", json)
                .build();

        Request request = new Request.Builder()
                .url("https://uploadurl.com/uploadFile")
                .post(requestBody)
                .build();

        try (Response response = client.newCall(request).execute()) {
            if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);

            logger.info(response.body().string());

@RequestMapping(value = "/uploadImageJson", method = RequestMethod.POST)
    public @ResponseBody Object jsongStrImage(@RequestParam(value="image") MultipartFile image, @RequestParam String jsonStr) {
-- use  com.fasterxml.jackson.databind.ObjectMapper convert Json String to Object
}

Upewnij się, że masz następujący import. Oczywiście inne standardowe przywozy

import org.springframework.core.io.FileSystemResource


    void uploadzipFiles(String token) {

        RestBuilder rest = new RestBuilder(connectTimeout:10000, readTimeout:20000)

        def zipFile = new File("testdata.zip")
        def Id = "001G00000"
        MultiValueMap<String, String> form = new LinkedMultiValueMap<String, String>()
        form.add("id", id)
        form.add('file',new FileSystemResource(zipFile))
        def urld ='''http://URL''';
        def resp = rest.post(urld) {
            header('X-Auth-Token', clientSecret)
            contentType "multipart/form-data"
            body(form)
        }
        println "resp::"+resp
        println "resp::"+resp.text
        println "resp::"+resp.headers
        println "resp::"+resp.body
        println "resp::"+resp.status
    }