HTTP DAPATKAN dengan badan permintaan

Saya sedang mengembangkan layanan web RESTful baru untuk aplikasi kita.

Saat melakukan GET pada entitas tertentu, klien dapat meminta konten entitas. Jika mereka ingin menambahkan beberapa parameter (misalnya mengurutkan daftar) mereka dapat menambahkan parameter ini dalam string kueri.

Atau saya ingin orang dapat menentukan parameter ini di badan permintaan. HTTP / 1.1 tampaknya tidak secara eksplisit melarang ini. Ini akan memungkinkan mereka untuk menentukan lebih banyak informasi, mungkin membuatnya lebih mudah untuk menentukan permintaan XML yang kompleks.

Pertanyaan saya:

• Apakah ini ide yang bagus?
• Apakah klien HTTP akan mengalami masalah dengan menggunakan badan permintaan dalam permintaan GET?

http://tools.ietf.org/html/rfc2616

Komentar Roy Fielding tentang memasukkan badan dengan permintaan GET .

Iya. Dengan kata lain, pesan permintaan HTTP apa pun diizinkan mengandung badan pesan, dan karenanya harus mem-parsing pesan dengan itu. Semantik server untuk GET, bagaimanapun, dibatasi sedemikian rupa sehingga suatu badan, jika ada, tidak memiliki makna semantik terhadap permintaan tersebut. Persyaratan parsing terpisah dari persyaratan semantik metode.

Jadi, ya, Anda dapat mengirim tubuh dengan GET, dan tidak, itu tidak pernah berguna untuk melakukannya.

Ini adalah bagian dari desain berlapis HTTP / 1.1 yang akan menjadi jelas kembali setelah spesifikasi dipartisi (sedang dalam proses pengerjaan).

.... Roy

Ya, Anda dapat mengirim badan permintaan dengan GET tetapi itu tidak memiliki arti. Jika Anda memberi makna dengan menguraikannya di server dan mengubah respons Anda berdasarkan isinya , maka Anda mengabaikan rekomendasi ini dalam spec HTTP / 1.1, bagian 4.3 :

[...] jika metode permintaan tidak menyertakan semantik yang ditentukan untuk badan-entitas, maka badan pesan HARUS diabaikan ketika menangani permintaan.

Dan deskripsi metode GET dalam spec HTTP / 1.1, bagian 9.3 :

Metode GET berarti mengambil informasi apa pun ([...]) yang diidentifikasi oleh Request-URI.

yang menyatakan bahwa badan permintaan bukan bagian dari identifikasi sumber daya dalam permintaan GET, hanya URI permintaan.

Pembaruan RFC2616 yang dirujuk sebagai "HTTP / 1.1 spec" sekarang sudah usang. Pada 2014 itu digantikan oleh RFCs 7230-7237. Kutipan "badan pesan HARUS diabaikan ketika menangani permintaan" telah dihapus. Sekarang hanya "Membingkai pesan permintaan tidak tergantung pada semantik metode, bahkan jika metode tersebut tidak mendefinisikan penggunaan untuk badan pesan" Kutipan kedua "Metode GET berarti mengambil informasi apa pun ... yang diidentifikasi oleh Request-URI" telah dihapus. - Dari komentar

Meskipun Anda dapat melakukannya, sejauh itu tidak secara eksplisit dikecualikan oleh spesifikasi HTTP, saya sarankan menghindarinya hanya karena orang tidak mengharapkan sesuatu berfungsi seperti itu. Ada banyak fase dalam rantai permintaan HTTP dan sementara mereka "sebagian besar" sesuai dengan spesifikasi HTTP, satu-satunya hal yang Anda yakini adalah mereka akan berperilaku seperti yang biasa digunakan oleh browser web. (Saya memikirkan hal-hal seperti proksi transparan, akselerator, toolkit A / V, dll.)

Ini adalah semangat di balik Prinsip Robustness yang secara kasar "menjadi liberal dalam apa yang Anda terima, dan konservatif dalam apa yang Anda kirim", Anda tidak ingin memaksakan batasan spesifikasi tanpa alasan yang kuat.

Namun, jika Anda memiliki alasan yang bagus, lakukanlah.

Anda mungkin akan menemui masalah jika mencoba memanfaatkan caching. Proxy tidak akan mencari di badan GET untuk melihat apakah parameter berdampak pada respons.

Baik restclient maupun REST console tidak mendukung ini tetapi curl dapat.

The spesifikasi HTTP mengatakan di bagian 4.3

Badan pesan TIDAK HARUS dimasukkan dalam permintaan jika spesifikasi metode permintaan (bagian 5.1.1) tidak memungkinkan pengiriman badan hukum dalam permintaan.

Bagian 5.1.1 mengarahkan kita ke bagian 9.x untuk berbagai metode. Tak satu pun dari mereka yang secara eksplisit melarang penyertaan badan pesan. Namun...

Bagian 5.2 mengatakan

Sumber daya persis yang diidentifikasi oleh permintaan Internet ditentukan dengan memeriksa bidang Request-URI dan header Host.

dan Bagian 9.3 mengatakan

Metode GET berarti mengambil informasi apa pun (dalam bentuk entitas) yang diidentifikasi oleh Request-URI.

Yang bersama-sama menyarankan bahwa saat memproses permintaan GET, server tidak diharuskan untuk memeriksa hal lain selain bidang header Permintaan-URI dan Host.

Singkatnya, spesifikasi HTTP tidak mencegah Anda mengirim pesan-pesan dengan GET tetapi ada ambiguitas yang cukup sehingga tidak akan mengejutkan saya jika tidak didukung oleh semua server.

Elasticsearch menerima permintaan GET dengan badan. Bahkan sepertinya inilah cara yang lebih disukai: panduan Elasticsearch

Beberapa perpustakaan klien (seperti driver Ruby) dapat mencatat perintah cry ke stdout dalam mode pengembangan dan menggunakan sintaksis ini secara ekstensif.

Apa yang Anda coba capai telah dilakukan sejak lama dengan metode yang jauh lebih umum, dan yang tidak bergantung pada menggunakan muatan dengan GET.

Anda hanya dapat membangun media pencarian spesifik Anda, atau jika Anda ingin lebih tenang, gunakan sesuatu seperti OpenSearch, dan POST permintaan ke URI yang diinstruksikan oleh server, katakan / cari. Server kemudian dapat menghasilkan hasil pencarian atau membangun URI akhir dan mengarahkan kembali menggunakan 303.

Ini memiliki keuntungan mengikuti metode PRG tradisional, membantu perantara cache cache hasil, dll.

Yang mengatakan, URI dikodekan pula untuk apa pun yang bukan ASCII, dan begitu pula aplikasi / x-www-form-urlencoded dan multipart / form-data. Saya sarankan menggunakan ini daripada membuat format json kustom lain jika niat Anda adalah untuk mendukung skenario ReSTful.

Anda dapat mengirim GET dengan badan atau mengirim POST dan menyerah RESTish religiositas (tidak terlalu buruk, 5 tahun yang lalu hanya ada satu anggota dari iman itu - komentarnya terkait di atas).

Tidak ada keputusan besar, tetapi mengirim badan GET dapat mencegah masalah untuk beberapa klien - dan beberapa server.

Melakukan POST mungkin memiliki hambatan dengan beberapa kerangka kerja RESTish.

Julian Reschke menyarankan di atas menggunakan tajuk HTTP non-standar seperti "SEARCH" yang bisa menjadi solusi yang elegan, kecuali bahwa kemungkinannya lebih kecil untuk didukung.

Mungkin paling produktif untuk mendaftar klien yang dapat dan tidak dapat melakukan masing-masing hal di atas.

Klien yang tidak dapat mengirim GET dengan tubuh (yang saya tahu):

• XmlHTTPRequest Fiddler

Klien yang dapat mengirim GET dengan tubuh:

• sebagian besar browser

Server & pustaka yang dapat mengambil tubuh dari GET:

• Apache
• PHP

Server (dan proksi) yang melepaskan tubuh dari GET:

• ?

Saya mengajukan pertanyaan ini ke WET IETF HTTP. Komentar dari Roy Fielding (penulis http / 1.1 dokumen pada tahun 1998) adalah itu

"... sebuah implementasi akan rusak untuk melakukan apa saja selain mengurai dan membuang tubuh itu jika diterima"

Status RFC 7213 (HTTPbis):

"Muatan dalam pesan permintaan GET tidak memiliki semantik yang ditentukan;"

Tampaknya jelas sekarang bahwa maksudnya adalah bahwa makna semantik pada badan permintaan GET dilarang, yang berarti bahwa badan permintaan tidak dapat digunakan untuk mempengaruhi hasilnya.

Ada proksi di luar sana yang pasti akan merusak permintaan Anda dengan berbagai cara jika Anda menyertakan sebuah badan di GET.

Jadi secara ringkas, jangan lakukan itu.

Server mana yang akan mengabaikannya? - fijiaaron 30 Agustus '12 pada 21:27

Google misalnya melakukan lebih buruk daripada mengabaikannya, itu akan menganggapnya sebagai kesalahan !

Cobalah sendiri dengan netcat sederhana:

$ netcat www.google.com 80
GET / HTTP/1.1
Host: www.google.com
Content-length: 6

1234

(konten 1234 diikuti oleh CR-LF, sehingga totalnya adalah 6 byte)

dan Anda akan mendapatkan:

HTTP/1.1 400 Bad Request
Server: GFE/2.0
(....)
Error 400 (Bad Request)
400. That’s an error.
Your client has issued a malformed or illegal request. That’s all we know.

Anda juga mendapatkan 400 Permintaan Buruk dari Bing, Apple, dll ... yang dilayani oleh AkamaiGhost.

Jadi saya tidak akan menyarankan menggunakan permintaan GET dengan entitas tubuh.

Dari RFC 2616, bagian 4.3 , "Badan Pesan":

Server HARUS membaca dan meneruskan badan pesan atas permintaan apa pun; jika metode permintaan tidak termasuk semantik yang ditentukan untuk badan-badan, maka badan pesan HARUS diabaikan ketika menangani permintaan.

Artinya, server harus selalu membaca badan permintaan yang disediakan dari jaringan (periksa Content-Length atau membaca badan yang terpotong, dll). Juga, proksi harus meneruskan badan permintaan yang mereka terima. Kemudian, jika RFC mendefinisikan semantik untuk tubuh untuk metode yang diberikan, server benar-benar dapat menggunakan tubuh permintaan dalam menghasilkan respons. Namun, jika RFC tidak mendefinisikan semantik untuk tubuh, maka server harus mengabaikannya.

Ini sesuai dengan kutipan dari Fielding di atas.

Bagian 9.3 , "GET", menjelaskan semantik metode GET, dan tidak menyebutkan badan permintaan. Oleh karena itu, server harus mengabaikan badan permintaan apa pun yang diterimanya atas permintaan GET.

Menurut XMLHttpRequest, itu tidak valid. Dari standar :

4.5.6 send()Metode

client . send([body = null])

Memulai permintaan. Argumen opsional menyediakan badan permintaan. Argumen diabaikan jika metode permintaan adalah GETatau HEAD.

Melempar InvalidStateErrorpengecualian jika salah satu negara tidak dibuka atau send()bendera ditetapkan.

The Metode harus menjalankan langkah-langkah ini:send(body)

1. Jika status tidak dibuka , berikan InvalidStateErrorpengecualian.
2. Jika send()bendera diatur, lempar InvalidStateErrorpengecualian.
3. Jika metode permintaan adalah GETatau HEAD, setel badan ke nol.
4. Jika badan adalah nol, lanjutkan ke langkah berikutnya.

Meskipun, saya tidak berpikir itu harus karena permintaan GET mungkin memerlukan konten tubuh besar.

Jadi, jika Anda mengandalkan XMLHttpRequest dari browser, kemungkinan itu tidak akan berfungsi.

Jika Anda benar-benar ingin mengirim isi JSON / XML ke aplikasi web, satu-satunya tempat yang masuk akal untuk meletakkan data Anda adalah string kueri yang dikodekan dengan RFC4648: Pangkalan 64 Pengkodean dengan URL dan Nama File Alfabet yang Aman . Tentu saja Anda bisa urlencode JSON dan meletakkannya di nilai param URL, tetapi Base64 memberikan hasil yang lebih kecil Ingatlah bahwa ada batasan ukuran URL, lihat Berapa panjang maksimum URL di berbagai browser? .

Anda mungkin berpikir bahwa =karakter padding Base64 mungkin buruk untuk nilai param URL, namun sepertinya tidak - lihat diskusi ini: http://mail.python.org/pipermail/python-bugs-list/2007-February/037195.html . Namun Anda tidak boleh memasukkan data yang dikodekan tanpa nama param karena string yang dikodekan dengan padding akan ditafsirkan sebagai kunci param dengan nilai kosong. Saya akan menggunakan sesuatu seperti ?_b64=<encodeddata>.

Saya tidak akan menyarankan ini, itu bertentangan dengan praktik standar, dan tidak menawarkan banyak imbalan. Anda ingin menjaga isi konten, bukan opsi.

Bagaimana dengan header yang disandikan base64 yang tidak sesuai? "SOMETHINGAPP-PARAMS: sdfSD45fdg45 / aS"

Pembatasan panjang hm. Tidak bisakah Anda membuat penanganan POST Anda membedakan antara artinya? Jika Anda ingin parameter sederhana seperti penyortiran, saya tidak melihat mengapa ini akan menjadi masalah. Saya kira pasti Anda khawatir tentang hal itu.

Saya kesal karena REST sebagai protokol tidak mendukung OOP dan Getmetode adalah bukti. Sebagai solusi, Anda bisa membuat serial DTO ke JSON dan membuat string kueri. Di sisi server Anda akan dapat membatalkan deserialisasi string kueri ke DTO.

Lihatlah:

• Desain berbasis pesan di ServiceStack
• Membangun RESTful Message Berbasis Web Services dengan WCF

Pendekatan berbasis pesan dapat membantu Anda memecahkan batasan Dapatkan metode. Anda dapat mengirim DTO apa pun dengan badan permintaan

Kerangka kerja layanan web Nelibur menyediakan fungsionalitas yang dapat Anda gunakan

var client = new JsonServiceClient(Settings.Default.ServiceAddress);
var request = new GetClientRequest
    {
        Id = new Guid("2217239b0e-b35b-4d32-95c7-5db43e2bd573")
    };
var response = client.Get<GetClientRequest, ClientResponse>(request);

as you can see, the GetClientRequest was encoded to the following query string

http://localhost/clients/GetWithResponse?type=GetClientRequest&data=%7B%22Id%22:%2217239b0e-b35b-4d32-95c7-5db43e2bd573%22%7D

Misalnya, ini berfungsi dengan Curl, Apache dan PHP.

File PHP:

<?php
echo $_SERVER['REQUEST_METHOD'] . PHP_EOL;
echo file_get_contents('php://input') . PHP_EOL;

Perintah konsol:

$ curl -X GET -H "Content-Type: application/json" -d '{"the": "body"}' 'http://localhost/test/get.php'

Keluaran:

GET
{"the": "body"}

IMHO Anda bisa mengirim yang JSONdisandikan (mis. encodeURIComponent) Di URL, dengan cara ini Anda tidak melanggar HTTPspesifikasi dan membawa Anda JSONke server.

Anda memiliki daftar opsi yang jauh lebih baik daripada menggunakan badan permintaan dengan GET.

Mari kita asumsikan Anda memiliki kategori dan item untuk setiap kategori. Keduanya harus diidentifikasi oleh id ("catid" / "itemid" untuk kepentingan contoh ini). Anda ingin mengurutkan berdasarkan "sortby" parameter lain dalam "urutan" tertentu. Anda ingin memberikan parameter untuk "sortby" dan "order":

Kamu bisa:

1. Gunakan string kueri, mis example.com/category/{catid}/item/{itemid}?sortby=itemname&order=asc
2. Gunakan mod_rewrite (atau serupa) untuk jalur: example.com/category/{catid}/item/{itemid}/{sortby}/{order}
3. Gunakan tajuk HTTP terpisah yang Anda berikan dengan permintaan
4. Gunakan metode yang berbeda, misalnya POST, untuk mengambil sumber daya.

Semua memiliki kelemahan, tetapi jauh lebih baik daripada menggunakan GET dengan tubuh.

Bahkan jika alat populer menggunakan ini, seperti yang sering dikutip di halaman ini, saya pikir itu masih ide yang buruk, terlalu eksotis, meskipun tidak dilarang oleh spek.

Banyak infrastruktur perantara mungkin menolak permintaan semacam itu.

Dengan contoh, melupakan menggunakan beberapa CDN tersedia di depan situs web Anda, seperti ini satu :

Jika GETpermintaan pemirsa menyertakan sebuah badan, CloudFront mengembalikan kode status HTTP 403 (Terlarang) ke pemirsa.

Dan ya, perpustakaan klien Anda mungkin juga tidak mendukung memancarkan permintaan seperti itu, seperti yang dilaporkan dalam komentar ini .

Saya menggunakan RestTemplate kerangka Spring di program klien saya dan, di sisi server, saya mendefinisikan permintaan GET dengan tubuh Json. Tujuan utama saya sama dengan Anda: ketika permintaan memiliki banyak parameter, menempatkannya di tubuh tampak lebih rapi daripada menempatkannya di string URI yang berkepanjangan. Iya?

Tapi, sayangnya, itu tidak berhasil! Sisi server melemparkan pengecualian berikut:

org.springframework.http.converter.HttpMessageNotReadableException: Badan permintaan yang diperlukan tidak ada ...

Tapi saya cukup yakin badan pesan disediakan dengan benar oleh kode klien saya, jadi apa yang salah?

Saya menelusuri metode RestTemplate.exchange () dan menemukan yang berikut:

// SimpleClientHttpRequestFactory.class
public class SimpleClientHttpRequestFactory implements ClientHttpRequestFactory, AsyncClientHttpRequestFactory {
    ...
    protected void prepareConnection(HttpURLConnection connection, String httpMethod) throws IOException {
        ...
        if (!"POST".equals(httpMethod) && !"PUT".equals(httpMethod) && !"PATCH".equals(httpMethod) && !"DELETE".equals(httpMethod)) {
            connection.setDoOutput(false);
        } else {
            connection.setDoOutput(true);
        }
        ...
    }
}

// SimpleBufferingClientHttpRequest.class
final class SimpleBufferingClientHttpRequest extends AbstractBufferingClientHttpRequest {
    ...
    protected ClientHttpResponse executeInternal(HttpHeaders headers, byte[] bufferedOutput) throws IOException {
        ...
        if (this.connection.getDoOutput() && this.outputStreaming) {
            this.connection.setFixedLengthStreamingMode(bufferedOutput.length);
        }

        this.connection.connect();
        if (this.connection.getDoOutput()) {
            FileCopyUtils.copy(bufferedOutput, this.connection.getOutputStream());
        } else {
            this.connection.getResponseCode();
        }
        ...
    }
}

Harap perhatikan bahwa dalam metode executeInternal (), argumen input 'bufferedOutput' berisi isi pesan yang disediakan oleh kode saya. Saya melihatnya melalui debugger.

Namun, karena prepoconnection (), getDoOutput () dalam executeInternal () selalu mengembalikan false yang, pada gilirannya, membuat bufferedOutput benar-benar diabaikan! Itu tidak disalin ke aliran output.

Akibatnya, program server saya tidak menerima isi pesan dan melemparkan pengecualian itu.

Ini adalah contoh tentang kerangka RestTemplate dari Spring. Intinya adalah bahwa, bahkan jika badan pesan tidak lagi dilarang oleh spesifikasi HTTP, beberapa pustaka atau kerangka kerja klien atau server mungkin masih mematuhi spesifikasi lama dan menolak isi pesan dari permintaan GET.