Httpheaders with resttemplate java

The Guide to RestTemplate

announcement - icon

As always, the writeup is super practical and based on a simple application that can work with documents with a mix of encrypted and unencrypted fields.

We rely on other people’s code in our own work. Every day.

It might be the language you’re writing in, the framework you’re building on, or some esoteric piece of software that does one thing so well you never found the need to implement it yourself.

The problem is, of course, when things fall apart in production — debugging the implementation of a 3rd party library you have no intimate knowledge of is, to say the least, tricky.

Lightrun is a new kind of debugger.

It’s one geared specifically towards real-life production environments. Using Lightrun, you can drill down into running applications, including 3rd party dependencies, with real-time logs, snapshots, and metrics.

Learn more in this quick, 5-minute Lightrun tutorial:

announcement - icon

Slow MySQL query performance is all too common. Of course it is. A good way to go is, naturally, a dedicated profiler that actually understands the ins and outs of MySQL.

The Jet Profiler was built for MySQL only, so it can do things like real-time query performance, focus on most used tables or most frequent queries, quickly identify performance issues and basically help you optimize your queries.

Critically, it has very minimal impact on your server’s performance, with most of the profiling work done separately — so it needs no server changes, agents or separate services.

Basically, you install the desktop application, connect to your MySQL server, hit the record button, and you’ll have results within minutes:

Читайте также:  Color image in python

announcement - icon

DbSchema is a super-flexible database designer, which can take you from designing the DB with your team all the way to safely deploying the schema.

The way it does all of that is by using a design model, a database-independent image of the schema, which can be shared in a team using GIT and compared or deployed on to any database.

And, of course, it can be heavily visual, allowing you to interact with the database using diagrams, visually compose queries, explore the data, generate random data, import data or build HTML5 database reports.

Get started with Spring 5 and Spring Boot 2, through the Learn Spring course:

1. Overview

In this tutorial, we’re going to illustrate the broad range of operations where the Spring REST Client — RestTemplate — can be used, and used well.

For the API side of all examples, we’ll be running the RESTful service from here.

Further reading:

Basic Authentication with the RestTemplate

RestTemplate with Digest Authentication

Exploring the Spring Boot TestRestTemplate

2. Deprecation Notice

As of Spring Framework 5, alongside the WebFlux stack, Spring introduced a new HTTP client called WebClient.

WebClient is a modern, alternative HTTP client to RestTemplate. Not only does it provide a traditional synchronous API, but it also supports an efficient nonblocking and asynchronous approach.

That said, if we’re developing new applications or migrating an old one, it’s a good idea to use WebClient. Moving forward, RestTemplate will be deprecated in future versions.

3. Use GET to Retrieve Resources

3.1. Get Plain JSON

Let’s start simple and talk about GET requests, with a quick example using the getForEntity() API:

RestTemplate restTemplate = new RestTemplate(); String fooResourceUrl = "http://localhost:8080/spring-rest/foos"; ResponseEntity response = restTemplate.getForEntity(fooResourceUrl + "/1", String.class); Assertions.assertEquals(response.getStatusCode(), HttpStatus.OK); 

Notice that we have full access to the HTTP response, so we can do things like check the status code to make sure the operation was successful or work with the actual body of the response:

ObjectMapper mapper = new ObjectMapper(); JsonNode root = mapper.readTree(response.getBody()); JsonNode name = root.path("name"); Assertions.assertNotNull(name.asText());

We’re working with the response body as a standard String here and using Jackson (and the JSON node structure that Jackson provides) to verify some details.

3.2. Retrieving POJO Instead of JSON

We can also map the response directly to a Resource DTO:

public class Foo implements Serializable < private long id; private String name; // standard getters and setters >

Now we can simply use the getForObject API in the template:

Foo foo = restTemplate .getForObject(fooResourceUrl + "/1", Foo.class); Assertions.assertNotNull(foo.getName()); Assertions.assertEquals(foo.getId(), 1L); 

4. Use HEAD to Retrieve Headers

Let’s now have a quick look at using HEAD before moving on to the more common methods.

Читайте также:  Php id после insert

We’re going to be using the headForHeaders() API here:

HttpHeaders httpHeaders = restTemplate.headForHeaders(fooResourceUrl); Assertions.assertTrue(httpHeaders.getContentType().includes(MediaType.APPLICATION_JSON));

5. Use POST to Create a Resource

In order to create a new Resource in the API, we can make good use of the postForLocation(), postForObject() or postForEntity() APIs.

The first returns the URI of the newly created Resource, while the second returns the Resource itself.

5.1. The postForObject() API

RestTemplate restTemplate = new RestTemplate(); HttpEntity request = new HttpEntity<>(new Foo("bar")); Foo foo = restTemplate.postForObject(fooResourceUrl, request, Foo.class); Assertions.assertNotNull(foo); Assertions.assertEquals(foo.getName(), "bar");

5.2. The postForLocation() API

Similarly, let’s have a look at the operation that instead of returning the full Resource, just returns the Location of that newly created Resource:

HttpEntity request = new HttpEntity<>(new Foo("bar")); URI location = restTemplate .postForLocation(fooResourceUrl, request); Assertions.assertNotNull(location);

5.3. The exchange() API

Let’s have a look at how to do a POST with the more generic exchange API:

RestTemplate restTemplate = new RestTemplate(); HttpEntity request = new HttpEntity<>(new Foo("bar")); ResponseEntity response = restTemplate .exchange(fooResourceUrl, HttpMethod.POST, request, Foo.class); Assertions.assertEquals(response.getStatusCode(), HttpStatus.CREATED); Foo foo = response.getBody(); Assertions.assertNotNull(foo); Assertions.assertEquals(foo.getName(), "bar"); 

5.4. Submit Form Data

Next, let’s look at how to submit a form using the POST method.

First, we need to set the Content-Type header to application/x-www-form-urlencoded.

This makes sure that a large query string can be sent to the server, containing name/value pairs separated by &:

HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);

We can wrap the form variables into a LinkedMultiValueMap:

MultiValueMap map= new LinkedMultiValueMap<>(); map.add("id", "1");

Next, we build the Request using an HttpEntity instance:

HttpEntity> request = new HttpEntity<>(map, headers);

Finally, we can connect to the REST service by calling restTemplate.postForEntity() on the Endpoint: /foos/form

ResponseEntity response = restTemplate.postForEntity( fooResourceUrl+"/form", request , String.class); Assertions.assertEquals(response.getStatusCode(), HttpStatus.CREATED); 

6. Use OPTIONS to Get Allowed Operations

Next, we’re going to have a quick look at using an OPTIONS request and exploring the allowed operations on a specific URI using this kind of request; the API is optionsForAllow:

Set optionsForAllow = restTemplate.optionsForAllow(fooResourceUrl); HttpMethod[] supportedMethods = ; Assertions.assertTrue(optionsForAllow.containsAll(Arrays.asList(supportedMethods))); 

7. Use PUT to Update a Resource

Next, we’ll start looking at PUT and more specifically the exchange() API for this operation, since the template.put API is pretty straightforward.

7.1. Simple PUT With exchange()

We’ll start with a simple PUT operation against the API — and keep in mind that the operation isn’t returning a body back to the client:

Foo updatedInstance = new Foo("newName"); updatedInstance.setId(createResponse.getBody().getId()); String resourceUrl = fooResourceUrl + '/' + createResponse.getBody().getId(); HttpEntity requestUpdate = new HttpEntity<>(updatedInstance, headers); template.exchange(resourceUrl, HttpMethod.PUT, requestUpdate, Void.class);

7.2. PUT With exchange() and a Request Callback

Next, we’re going to be using a request callback to issue a PUT.

Читайте также:  How to override bootstrap css

Let’s make sure we prepare the callback, where we can set all the headers we need as well as a request body:

RequestCallback requestCallback(final Foo updatedInstance) < return clientHttpRequest ->< ObjectMapper mapper = new ObjectMapper(); mapper.writeValue(clientHttpRequest.getBody(), updatedInstance); clientHttpRequest.getHeaders().add( HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE); clientHttpRequest.getHeaders().add( HttpHeaders.AUTHORIZATION, "Basic " + getBase64EncodedLogPass()); >; >

Next, we create the Resource with a POST request:

ResponseEntity response = restTemplate .exchange(fooResourceUrl, HttpMethod.POST, request, Foo.class); Assertions.assertEquals(response.getStatusCode(), HttpStatus.CREATED); 

And then we update the Resource:

Foo updatedInstance = new Foo("newName"); updatedInstance.setId(response.getBody().getId()); String resourceUrl =fooResourceUrl + '/' + response.getBody().getId(); restTemplate.execute( resourceUrl, HttpMethod.PUT, requestCallback(updatedInstance), clientHttpResponse -> null);

8. Use DELETE to Remove a Resource

To remove an existing Resource, we’ll make quick use of the delete() API:

String entityUrl = fooResourceUrl + "/" + existingResource.getId(); restTemplate.delete(entityUrl); 

9. Configure Timeout

We can configure RestTemplate to time out by simply using ClientHttpRequestFactory:

RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory()); private ClientHttpRequestFactory getClientHttpRequestFactory()

And we can use HttpClient for further configuration options:

private ClientHttpRequestFactory getClientHttpRequestFactory()

10. Conclusion

In this article, we went over the main HTTP Verbs, using RestTemplate to orchestrate requests using all of these.

If you want to dig into how to do authentication with the template, check out our article on Basic Auth with RestTemplate.

The implementation of all these examples and code snippets can be found over on GitHub.

announcement - icon

Slow MySQL query performance is all too common. Of course it is. A good way to go is, naturally, a dedicated profiler that actually understands the ins and outs of MySQL.

The Jet Profiler was built for MySQL only, so it can do things like real-time query performance, focus on most used tables or most frequent queries, quickly identify performance issues and basically help you optimize your queries.

Critically, it has very minimal impact on your server’s performance, with most of the profiling work done separately — so it needs no server changes, agents or separate services.

Basically, you install the desktop application, connect to your MySQL server, hit the record button, and you’ll have results within minutes:

Источник

Оцените статью