Publicando um Arquivo e Dados Associados em um Serviço Web RESTful, preferencialmente como JSON

Provavelmente será uma pergunta estúpida, mas estou tendo uma daquelas noites. Em um aplicativo, estou desenvolvendo a API RESTful e queremos que o cliente envie dados como JSON. Parte desse aplicativo requer que o cliente faça upload de um arquivo (geralmente uma imagem), além de informações sobre a imagem.

Estou com dificuldade para rastrear como isso acontece em uma única solicitação. É possível Base64 os dados do arquivo em uma string JSON? Vou precisar executar 2 postagens no servidor? Não devo usar o JSON para isso?

Como uma observação lateral, estamos usando o Grails no back-end e esses serviços são acessados ​​por clientes móveis nativos (iPhone, Android, etc.), se isso faz alguma diferença.

Fiz uma pergunta semelhante aqui:

Como faço para enviar um arquivo com metadados usando um serviço da web REST?

Você basicamente tem três opções:

1. A Base64 codifica o arquivo, à custa de aumentar o tamanho dos dados em cerca de 33%, e adiciona uma sobrecarga de processamento no servidor e no cliente para codificação / decodificação.
2. Envie o arquivo primeiro em um multipart/form-dataPOST e retorne um ID para o cliente. O cliente envia os metadados com o ID e o servidor associa novamente o arquivo e os metadados.
3. Envie os metadados primeiro e retorne um ID ao cliente. O cliente envia o arquivo com o ID e o servidor associa novamente o arquivo e os metadados.

Você pode enviar o arquivo e os dados em uma solicitação usando o tipo de conteúdo multipart / form-data :

Em muitos aplicativos, é possível que um usuário seja apresentado com um formulário. O usuário preencherá o formulário, incluindo as informações digitadas, geradas pela entrada do usuário ou incluídas nos arquivos que o usuário selecionou. Quando o formulário é preenchido, os dados do formulário são enviados do usuário para o aplicativo de recebimento.

A definição de MultiPart / Form-Data é derivada de um desses aplicativos ...

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

"multipart / form-data" contém uma série de partes. Espera-se que cada parte contenha um cabeçalho de disposição de conteúdo [RFC 2183], onde o tipo de disposição é "formulário-dados" e onde a disposição contém um parâmetro (adicional) de "nome", onde o valor desse parâmetro é o original nome do campo no formulário. Por exemplo, uma peça pode conter um cabeçalho:

Disposição de conteúdo: dados do formulário; name = "usuário"

com o valor correspondente à entrada do campo "usuário".

Você pode incluir informações de arquivo ou campo em cada seção entre limites. Eu implementei com sucesso um serviço RESTful que exigia que o usuário enviasse dados e um formulário, e os dados de várias partes / formulário funcionavam perfeitamente. O serviço foi construído usando Java / Spring e o cliente estava usando C #, então, infelizmente, não tenho exemplos do Grails para dar a você sobre como configurar o serviço. Você não precisa usar JSON nesse caso, pois cada seção "form-data" fornece um local para especificar o nome do parâmetro e seu valor.

A coisa boa sobre o uso de dados de várias partes / formulário é que você está usando cabeçalhos definidos por HTTP; portanto, segue a filosofia REST de usar as ferramentas HTTP existentes para criar seu serviço.

Eu sei que este segmento é bastante antigo, no entanto, estou faltando aqui uma opção. Se você possui metadados (em qualquer formato) que deseja enviar juntamente com os dados a serem enviados, é possível fazer uma única multipart/relatedsolicitação.

O tipo de mídia Multipart / Related é destinado a objetos compostos que consistem em várias partes do corpo inter-relacionadas.

Você pode verificar a especificação RFC 2387 para obter detalhes mais detalhados.

Basicamente, cada parte dessa solicitação pode ter conteúdo de tipo diferente e todas as partes estão de alguma forma relacionadas (por exemplo, uma imagem e seus metadados). As partes são identificadas por uma cadeia de fronteira e a cadeia de fronteira final é seguida por dois hífens.

Exemplo:

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

Sei que essa pergunta é antiga, mas nos últimos dias eu havia pesquisado na Web inteira para solucionar essa mesma pergunta. Tenho serviços web REST grails e iPhone Client que enviam fotos, título e descrição.

Não sei se minha abordagem é a melhor, mas é tão fácil e simples.

Eu tiro uma foto usando o UIImagePickerController e envio ao servidor o NSData usando as tags de cabeçalho de solicitação para enviar os dados da imagem.

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

No lado do servidor, recebo a foto usando o código:

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

}

Não sei se tenho problemas no futuro, mas agora está funcionando bem no ambiente de produção.

Aqui está minha API de abordagem (eu uso o exemplo) - como você pode ver, você não usa nenhum file_id(identificador de arquivo carregado no servidor) na API:

1. Crie um photoobjeto no servidor:

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

2. Carregar arquivo (observe que fileestá no formato singular porque é apenas um por foto):

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

E então, por exemplo:

3. Leia a lista de fotos

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

4. Leia alguns detalhes da foto

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

5. Ler arquivo de foto

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

Portanto, a conclusão é que, primeiro você cria um objeto (foto) pelo POST e depois envia a segunda solicitação com o arquivo (novamente POST).

Objetos FormData: Carregar arquivos usando o Ajax

XMLHttpRequest Nível 2 adiciona suporte para a nova interface FormData. Os objetos FormData fornecem uma maneira de construir facilmente um conjunto de pares de chave / valor representando os campos do formulário e seus valores, que podem ser facilmente enviados usando o método XMLHttpRequest send ().

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

Como o único exemplo que falta é o exemplo do ANDROID , vou adicioná-lo. Essa técnica usa um AsyncTask personalizado que deve ser declarado dentro da sua classe Activity.

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

}

Então, quando você quiser enviar seu arquivo, basta ligar para:

new UploadFile().execute();

Eu queria enviar algumas strings para o servidor back-end. Eu não usei o json com multipart, usei parâmetros de solicitação.

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

O URL pareceria

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

Estou passando dois parâmetros (uuid e tipo) junto com o upload do arquivo. Espero que isso ajude quem não possui os dados complexos do json para enviar.

Você pode tentar usar a https://square.github.io/okhttp/ library. Você pode definir o corpo da solicitação como multipart e adicionar os objetos file e json separadamente da seguinte maneira:

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
}

Verifique se você tem a seguinte importação. Claro que outras importações padrão

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
    }