Pengonversi Pesan Http dengan Spring Framework

1. Ikhtisar

Artikel ini menjelaskan cara mengkonfigurasi HttpMessageConverters di Spring .

Sederhananya, kita dapat menggunakan pengonversi pesan untuk mengatur dan melepaskan Objek Java ke dan dari JSON, XML, dll - melalui HTTP.

2. Dasar-dasar

2.1. Aktifkan MVC Web

Untuk memulainya, Aplikasi Web perlu dikonfigurasi dengan dukungan Spring MVC. Cara mudah dan sangat dapat disesuaikan untuk melakukannya adalah dengan menggunakan anotasi @EnableWebMvc :

@EnableWebMvc @Configuration @ComponentScan({ "com.baeldung.web" }) public class WebConfig implements WebMvcConfigurer { ... }

Perhatikan bahwa kelas ini mengimplementasikan WebMvcConfigurer - yang memungkinkan kita mengubah daftar default Pengonversi Http dengan milik kita sendiri.

2.2. Pengonversi Pesan Default

Secara default, contoh HttpMessageConverter berikut sudah diaktifkan sebelumnya:

  • ByteArrayHttpMessageConverter - mengubah array byte
  • StringHttpMessageConverter - mengubah Strings
  • ResourceHttpMessageConverter - mengonversi org.springframework.core.io.Resource untuk semua jenis aliran oktet
  • SourceHttpMessageConverter - mengubah javax.xml.transform.Source
  • FormHttpMessageConverter - mengubah data formulir ke / dari MultiValueMap .
  • Jaxb2RootElementHttpMessageConverter - mengonversi objek Java ke / dari XML (ditambahkan hanya jika JAXB2 ada di classpath)
  • MappingJackson2HttpMessageConverter - mengubah JSON (hanya ditambahkan jika Jackson 2 ada di classpath)

  • MappingJacksonHttpMessageConverter - mengubah JSON (hanya ditambahkan jika Jackson ada di classpath)
  • AtomFeedHttpMessageConverter - mengubah umpan Atom (hanya ditambahkan jika Roma ada di jalur kelas)
  • RssChannelHttpMessageConverter - mengubah RSS feed (ditambahkan hanya jika Roma ada di classpath)

3. Komunikasi Server-Klien - Hanya JSON

3.1. Negosiasi Konten Tingkat Tinggi

Setiap implementasi HttpMessageConverter memiliki satu atau beberapa Jenis MIME yang terkait.

Saat menerima permintaan baru, Spring akan menggunakan header " Terima " untuk menentukan jenis media yang perlu ditanggapi .

Kemudian akan mencoba menemukan konverter terdaftar yang mampu menangani jenis media tertentu itu. Akhirnya, ini akan menggunakan ini untuk mengubah entitas dan mengirim kembali tanggapan.

Prosesnya serupa untuk menerima permintaan yang berisi informasi JSON. Kerangka kerja akan menggunakan header " Jenis Konten " untuk menentukan jenis media dari badan permintaan .

Ini kemudian akan mencari HttpMessageConverter yang dapat mengubah tubuh yang dikirim oleh klien ke Objek Java.

Mari kita perjelas ini dengan contoh singkat:

  • Klien mengirim permintaan GET ke / foos dengan header Terima disetel ke application / json - untuk mendapatkan semua sumber daya Foo sebagai JSON
  • yang Foo musim semi Controller adalah hit dan mengembalikan sesuai Foo entitas Java
  • Spring kemudian menggunakan salah satu pengonversi pesan Jackson untuk mengatur entitas ke JSON

Sekarang mari kita lihat secara spesifik cara kerjanya - dan bagaimana kita dapat memanfaatkan anotasi @ResponseBody dan @ RequestBody .

3.2. @Tokopedia

@ResponseBody pada metode Pengontrol menunjukkan ke Spring bahwa nilai kembalian metode tersebut diserialkan langsung ke isi Respons HTTP . Seperti yang dibahas di atas, header " Terima " yang ditentukan oleh Klien akan digunakan untuk memilih Konverter Http yang sesuai untuk mengatur entitas.

Mari kita lihat contoh sederhana :

@GetMapping("/{id}") public @ResponseBody Foo findById(@PathVariable long id) { return fooService.findById(id); }

Sekarang, klien akan menentukan header "Terima" ke application / json dalam permintaan - perintah contoh curl :

curl --header "Accept: application/json" //localhost:8080/spring-boot-rest/foos/1

Kelas Foo :

public class Foo { private long id; private String name; }

Dan Badan Respons Http:

{ "id": 1, "name": "Paul", }

3.3. @Request

Kita dapat menggunakan anotasi @RequestBody pada argumen metode Controller untuk menunjukkan bahwa isi Permintaan HTTP adalah deserialisasi ke entitas Java tertentu . Untuk menentukan konverter yang sesuai, Spring akan menggunakan header "Content-Type" dari permintaan klien.

Mari kita lihat contohnya:

@PutMapping("/{id}") public @ResponseBody void update(@RequestBody Foo foo, @PathVariable String id) { fooService.update(foo); }

Selanjutnya, mari kita gunakan ini dengan objek JSON - kami menetapkan "Jenis Konten " menjadi application / json :

curl -i -X PUT -H "Content-Type: application/json" -d '{"id":"83","name":"klik"}' //localhost:8080/spring-boot-rest/foos/1

Kami mendapatkan kembali 200 OK - tanggapan yang berhasil:

HTTP/1.1 200 OK Server: Apache-Coyote/1.1 Content-Length: 0 Date: Fri, 10 Jan 2014 11:18:54 GMT

4. Konfigurasi Konverter Kustom

Kami juga dapat menyesuaikan pengonversi pesan dengan mengimplementasikan antarmuka WebMvcConfigurer dan mengganti metode configureMessageConverters :

@EnableWebMvc @Configuration @ComponentScan({ "com.baeldung.web" }) public class WebConfig implements WebMvcConfigurer { @Override public void configureMessageConverters( List
    
      converters) { messageConverters.add(createXmlHttpMessageConverter()); messageConverters.add(new MappingJackson2HttpMessageConverter()); } private HttpMessageConverter createXmlHttpMessageConverter() { MarshallingHttpMessageConverter xmlConverter = new MarshallingHttpMessageConverter(); XStreamMarshaller xstreamMarshaller = new XStreamMarshaller(); xmlConverter.setMarshaller(xstreamMarshaller); xmlConverter.setUnmarshaller(xstreamMarshaller); return xmlConverter; } }
    

In this example, we're creating a new converter – the MarshallingHttpMessageConverter – and using the Spring XStream support to configure it. This allows a great deal of flexibility since we're working with the low-level APIs of the underlying marshalling framework – in this case XStream – and we can configure that however we want.

Note that this example requires adding the XStream library to the classpath.

Also be aware that by extending this support class, we're losing the default message converters which were previously pre-registered.

We can of course now do the same for Jackson – by defining our own MappingJackson2HttpMessageConverter. We can now set a custom ObjectMapper on this converter and have it configured as we need to.

In this case, XStream was the selected marshaller/unmarshaller implementation, but others like CastorMarshaller can be used as well.

At this point – with XML enabled on the back end – we can consume the API with XML Representations:

curl --header "Accept: application/xml" //localhost:8080/spring-boot-rest/foos/1

4.1. Spring Boot Support

If we're using Spring Boot we can avoid implementing the WebMvcConfigurer and adding all the Message Converters manually as we did above.

We can just define different HttpMessageConverter beans in the context, and Spring Boot will add them automatically to the autoconfiguration that it creates:

@Bean public HttpMessageConverter createXmlHttpMessageConverter() { MarshallingHttpMessageConverter xmlConverter = new MarshallingHttpMessageConverter(); // ... return xmlConverter; }

5. Using Spring’s RestTemplate With Http Message Converters

As well as with the server side, Http Message Conversion can be configured in the client side on the Spring RestTemplate.

We're going to configure the template with the “Accept” and “Content-Type” headers when appropriate. Then we'll try to consume the REST API with full marshalling and unmarshalling of the Foo Resource – both with JSON and with XML.

5.1. Retrieving the Resource With No Accept Header

@Test public void testGetFoo() { String URI = “//localhost:8080/spring-boot-rest/foos/{id}"; RestTemplate restTemplate = new RestTemplate(); Foo foo = restTemplate.getForObject(URI, Foo.class, "1"); Assert.assertEquals(new Integer(1), foo.getId()); }

5.2. Retrieving a Resource With application/xml Accept Header

Let's now explicitly retrieve the Resource as an XML Representation. We're going to define a set of Converters and set these on the RestTemplate.

Because we're consuming XML, we're going to use the same XStream marshaller as before:

@Test public void givenConsumingXml_whenReadingTheFoo_thenCorrect() { String URI = BASE_URI + "foos/{id}"; RestTemplate restTemplate = new RestTemplate(); restTemplate.setMessageConverters(getMessageConverters()); HttpHeaders headers = new HttpHeaders(); headers.setAccept(Arrays.asList(MediaType.APPLICATION_XML)); HttpEntity entity = new HttpEntity(headers); ResponseEntity response = restTemplate.exchange(URI, HttpMethod.GET, entity, Foo.class, "1"); Foo resource = response.getBody(); assertThat(resource, notNullValue()); } private List
    
      getMessageConverters() { XStreamMarshaller marshaller = new XStreamMarshaller(); MarshallingHttpMessageConverter marshallingConverter = new MarshallingHttpMessageConverter(marshaller); List
     
       converters = ArrayList
      
       (); converters.add(marshallingConverter); return converters; }
      
     
    

5.3. Retrieving a Resource With application/json Accept Header

Similarly, let's now consume the REST API by asking for JSON:

@Test public void givenConsumingJson_whenReadingTheFoo_thenCorrect() { String URI = BASE_URI + "foos/{id}"; RestTemplate restTemplate = new RestTemplate(); restTemplate.setMessageConverters(getMessageConverters()); HttpHeaders headers = new HttpHeaders(); headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON)); HttpEntity entity = new HttpEntity(headers); ResponseEntity response = restTemplate.exchange(URI, HttpMethod.GET, entity, Foo.class, "1"); Foo resource = response.getBody(); assertThat(resource, notNullValue()); } private List
    
      getMessageConverters() { List
     
       converters = new ArrayList
      
       (); converters.add(new MappingJackson2HttpMessageConverter()); return converters; }
      
     
    

5.4. Update a Resource With XML Content-Type

Finally, let's also send JSON data to the REST API and specify the media type of that data via the Content-Type header:

@Test public void givenConsumingXml_whenWritingTheFoo_thenCorrect() { String URI = BASE_URI + "foos/{id}"; RestTemplate restTemplate = new RestTemplate(); restTemplate.setMessageConverters(getMessageConverters()); Foo resource = new Foo(4, "jason"); HttpHeaders headers = new HttpHeaders(); headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON)); headers.setContentType((MediaType.APPLICATION_XML)); HttpEntity entity = new HttpEntity(resource, headers); ResponseEntity response = restTemplate.exchange( URI, HttpMethod.PUT, entity, Foo.class, resource.getId()); Foo fooResponse = response.getBody(); Assert.assertEquals(resource.getId(), fooResponse.getId()); }

What's interesting here is that we're able to mix the media types – we're sending XML data but we're waiting for JSON data back from the server. This shows just how powerful the Spring conversion mechanism really is.

6. Conclusion

In this tutorial, we looked at how Spring MVC allows us to specify and fully customize Http Message Converters to automatically marshall/unmarshall Java Entities to and from XML or JSON. This is, of course, a simplistic definition, and there is so much more that the message conversion mechanism can do – as we can see from the last test example.

We have also looked at how to leverage the same powerful mechanism with the RestTemplate client – leading to a fully type-safe way of consuming the API.

Seperti biasa, kode yang disajikan dalam artikel ini tersedia di Github.