{{announcement.body}}
{{announcement.title}}

Spring Boot REST Template URI Encoding

DZone 's Guide to

Spring Boot REST Template URI Encoding

Use Spring's Rest Template to consume encoded endpoints compared to hard coded endpoints. Hard coded endpoints are prone to ResourceAccessExceptions.

· Java Zone ·
Free Resource

Hard coding a URI endpoint for the Rest template interface is preferably the first point of reference when implementing a micro service or a monolith application.

There is no easy way to do this!

URI variables are usually meant for path elements, query string parameters, or when you decouple your application from your front-end. Ideally, you'd find a better solution for constructing your URI to access data on various endpoints. But, after doing a couple of endpoint hits, you'll probably run into a funny looking error like

org.springframework.web.client.ResourceAccessException: I/O error: http://localhost:8080%api%users

 Regardless of all the research, the URI  package comes in quite handy with String Builder to Query a API. There are a few ways of implementing this:

Java
 







This returns a list of users on a GET request in the Rest Template. If you're using the POST request, append your parameters in a string builder like in the snippet below:

Java
 







If using special characters, you might want to use the URL encoder on specific charsets. In this case, we're using UTF_8. This is a huge question mark around just submitting a hard coded URL or how the Rest template behaves.

OR the easiest way is to simply just submit an object on a hard coded URI for your POST Query. 

Java
 




xxxxxxxxxx
1
34


1
@RequestMapping(value = "/addNewUser", method = RequestMethod.POST)
2
    public ModelAndView processRequest(HttpServletRequest request, HttpSession session, @RequestParam("username")String username, @RequestParam("password")String password, @RequestParam("phone")String phone) {
3
                
4
        RestTemplate restTemplate = new RestTemplate();
5
 
          
6
        Users user = new Users();
7
        user.setUsername(username);
8
        user.setPassword(password);
9
        user.setPhone(phone);
10
        user.setEnabled(true);
11
                
12
        restTemplate.postForObject("http://localhost:8080/api/adduser", user, Users.class);
13
        
14
        StringBuilder builder = new StringBuilder("http://localhost:8080/api/users");
15
        
16
        URI uri = URI.create(builder.toString());
17
        
18
        List<Users> updatedUsers = restTemplate.getForObject(uri, List.class);
19
        
20
        session = request.getSession(false);
21
        ModelAndView model = new ModelAndView();
22
 
          
23
        if(session != null){
24
            model.setViewName("welcome");
25
            
26
            model.addObject("users", updatedUsers);
27
            model.addObject("user", (Users)session.getAttribute("user"));
28
            model.addObject("sessiontracker", sessiontracker.getList());
29
            model.addObject("sumValidSessions", sessiontracker.getSizeSessionList());
30
        
31
            return model;
32
        }
33
        return new ModelAndView("login");
34
    }



The GUI sample i'm using adds a user and displays it in a user table.

Adding a user gui


So, it all depends on which version of Spring you're using. If you're using an old version of Spring, the UriComponentsBuilder with your spring-web jar wont be included. For more information on standard URI 's and encoding click on this link: Java URL Encoding.

Delving into URI 's can get quite complex with Rest Template. Nevertheless, I'll recommend this for a monolithic application or If you want a quick metrics GUI around your microservices data. Don't disregard that Spring allows you to develop two Controller types, a standard MVC Controller, and a Rest Controller, which gives you the capabilities of exposing an API. 

It is favorable nonetheless to use an HTTP client for B2B communications on URLs in a microservice environment, which adds much more customization around exceptions and Response codes. 

I hope this helps to find traction on the route to take and I hope this gives you some variance around Spring Boot Rest API.

Thank you! 

Topics:
high-perf, java, microservice, spring boot, spring mvc, tips & tricks, url encoder / decoder

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}