Penukar Mesej Http dengan Spring Framework

1. Gambaran keseluruhan

Artikel ini menerangkan cara mengkonfigurasi HttpMessageConverters pada musim bunga .

Sederhananya, kita dapat menggunakan penukar pesan ke marshall dan unmarshall Java Objects ke dan dari JSON, XML, dll - melalui HTTP.

2. Asasnya

2.1. Dayakan MVC Web

Sebagai permulaan, Aplikasi Web perlu dikonfigurasikan dengan sokongan Spring MVC. Cara yang mudah dan boleh disesuaikan untuk melakukannya adalah dengan menggunakan anotasi @EnableWebMvc :

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

Perhatikan bahawa kelas ini mengimplementasikan WebMvcConfigurer - yang akan membolehkan kita mengubah senarai lalai Http Converter dengan yang kita sendiri.

2.2. Penukar Mesej Lalai

Secara lalai, contoh HttpMessageConverter berikut telah diaktifkan sebelumnya:

  • ByteArrayHttpMessageConverter - menukar tatasusunan bait
  • StringHttpMessageConverter - menukar String
  • ResourceHttpMessageConverter - menukar org.springframework.core.io. Sumber untuk sebarang jenis aliran oktet
  • SourceHttpMessageConverter - menukar javax.xml.transform.Source
  • FormHttpMessageConverter - menukar data bentuk ke / dari MultiValueMap .
  • Jaxb2RootElementHttpMessageConverter - menukar objek Java ke / dari XML (ditambahkan hanya jika JAXB2 hadir di classpath)
  • MappingJackson2HttpMessageConverter - menukar JSON (ditambahkan hanya jika Jackson 2 hadir di classpath)

  • MappingJacksonHttpMessageConverter - menukar JSON (ditambahkan hanya jika Jackson hadir di classpath)
  • AtomFeedHttpMessageConverter - menukar suapan Atom (ditambahkan hanya jika Rome ada di classpath)
  • RssChannelHttpMessageConverter - menukar suapan RSS (ditambahkan hanya jika Rom hadir di lorong kelas)

3. Komunikasi Pelayan Pelanggan - Hanya JSON

3.1. Rundingan Kandungan Peringkat Tinggi

Setiap pelaksanaan HttpMessageConverter mempunyai satu atau beberapa Jenis MIME yang berkaitan.

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

Ia kemudian akan berusaha mencari penukar berdaftar yang mampu menangani jenis media tertentu. Akhirnya, ia akan menggunakan ini untuk menukar entiti dan menghantar balik respons.

Prosesnya serupa untuk menerima permintaan yang mengandungi maklumat JSON. Kerangka kerja akan menggunakan tajuk " Jenis Kandungan " untuk menentukan jenis media badan permintaan .

Ia kemudian akan mencari HttpMessageConverter yang dapat mengubah badan yang dihantar oleh klien ke Objek Java.

Mari jelaskan ini dengan contoh ringkas:

  • Pelanggan menghantar permintaan GET ke / lawan dengan header Terima set ke aplikasi / json - untuk mendapatkan semua sumber Foo sebagai JSON
  • yang Foo Spring Controller adalah hit dan pulangan yang sepadan yang Foo entiti Java
  • Spring kemudian menggunakan salah satu penukar mesej Jackson untuk mengumpulkan entiti ke JSON

Sekarang mari kita melihat khusus bagaimana kerja-kerja ini - dan bagaimana kita boleh memanfaatkan @ResponseBody dan @ RequestBody penjelasan.

3.2. @ResponseBody

Kaedah @ResponseBody pada Controller menunjukkan kepada Spring bahawa nilai pengembalian kaedah diselaraskan terus ke badan Respons HTTP . Seperti yang dibincangkan di atas, header " Terima " yang ditentukan oleh Pelanggan akan digunakan untuk memilih Http Converter yang sesuai untuk menguruskan entiti.

Mari lihat contoh ringkas :

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

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

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

The Foo kelas:

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

Dan Badan Respons Http:

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

3.3. @RestestBody

Kita boleh menggunakan anotasi @RequestBody pada argumen kaedah Pengawal untuk menunjukkan bahawa badan Permintaan HTTP terdesialisasikan ke entiti Java tertentu . Untuk menentukan penukar yang sesuai, Spring akan menggunakan tajuk "Content-Type" dari permintaan klien.

Mari lihat contoh:

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

Seterusnya, mari kita gunakan ini dengan objek JSON - kami menentukan "Content-Type " menjadi aplikasi / json :

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

Kami mendapat 200 OK - tindak balas yang berjaya:

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

4. Konfigurasi Penukar Khusus

Kami juga dapat menyesuaikan penukar mesej dengan menerapkan antara muka WebMvcConfigurer dan mengesampingkan kaedah 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, kod yang disajikan dalam artikel ini terdapat di Github.