Simple string as JSON return value in spring rest controller

Question

Let's take a look at the following simple test controller (Used with Spring 4.0.3):

@RestController
public class TestController
{
    @RequestMapping("/getList")
    public List<String> getList()
    {
        final List<String> list = new ArrayList<>();
        list.add("1");
        list.add("2");
        return list;
    }

    @RequestMapping("/getString")
    public String getString()
    {
        return "Hello World";
    }
}

In theory both controller methods should return valid JSON. Calling the first controller method indeed does return the following JSON array:

$ curl -i -H "Accept: application/json" http://localhost:8080/getList
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

["1","2"]

But the second controller method returns the string without quotes which is not a valid JSON string:

$ curl -i -H "Accept: application/json" http://localhost:8080/getString
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

Hello World

Why is that so? Can it be configured? Is it a bug? Or a feature I don't understand?

Look into StringHttpMessageConverter which ia registered before the jackson converter. — Sotirios Delimanolis
– Sotirios Delimanolis, Commented May 10, 2014 at 14:46

chrylis -cautiouslyoptimistic- · Accepted Answer · 2014-05-10 13:31:10Z

8

When you return a String object, Spring MVC interprets that as the content to put in the response body and doesn't modify it further. If you're wanting an actual string to be the JSON response, you'll need to either quote it yourself or run it through Jackson explicitly.

answered May 10, 2014 at 13:31

chrylis -cautiouslyoptimistic-

77.5k21 gold badges127 silver badges167 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

kayahr Over a year ago

Sounds quite strange to me. According to the Accept header in the request the only valid response must be of content-type application/json so Spring has to use Jackson for the answer and Jackson should produce valid JSON. In this case the response is simply invalid. It has content-type application/json but was not converted to JSON.

chrylis -cautiouslyoptimistic- Over a year ago

@kayahr But what if you wanted to produce your own JSON string without Jackson (maybe a very simple string concatenation)? Then Spring would have to re-parse your response just to check up on you. ResponseBody means ResponseBody, which is ultimately a sequence of bytes, and Spring only performs conversions if it can't match up the Java types in question; String doesn't need conversion.

d0x · Accepted Answer · 2018-09-11 19:31:59Z

5

You can remove the StringHttpMessageConverter which is registered before the jackson converter, - like mentioned in the comment.

/**
 * Unregister the default {@link StringHttpMessageConverter} as we want
 * Strings to be handled by the JSON converter.
 *
 * Our MappingJackson2HttpMessageConverter will deal with strings.
 *
 * @param converters
 *            List of already configured converters
 */
@Override
public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
    converters.removeIf(converter -> converter instanceof StringHttpMessageConverter);
}

edited Sep 11, 2018 at 19:31

answered Nov 16, 2016 at 15:47

d0x

11.7k18 gold badges74 silver badges106 bronze badges

1 Comment

BeneStr Over a year ago

Btw, this can be written as a nice one-liner in java 8: converters.removeIf(converter -> converter instanceof StringHttpMessageConverter);

Gopal · Accepted Answer · 2017-11-17 09:27:22Z

0

If you want to return a String object, Spring MVC interprets that as the content to put in the response body and doesn't modify it further. If you're wanting an actual string to be the JSON response, you'll need to either quote it yourself or run it through Jackson explicitly.

@RestController
public class TestController
{
   @RequestMapping("/getString")
   public String getString()
  {
    return JSONObject.quote("Hello World");
  }
}

answered Nov 17, 2017 at 9:27

Gopal

5708 silver badges26 bronze badges

Comments

EJoshuaS - Stand with Ukraine · Accepted Answer · 2018-01-12 22:38:40Z

0

Here are the steps that I did to achieve this :

Add dependency in pom file:

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.3</version>
</dependency>

Put @ResponseBody annotation on your method like this:

@RequestMapping(value = "/getCountries", method = RequestMethod.GET)    
@ResponseBody    
public List<Country> getCountries() {    
    return countryDAO.list();    
}

edited Jan 12, 2018 at 22:38

EJoshuaS - Stand with Ukraine

12.2k63 gold badges59 silver badges86 bronze badges

answered Jan 5, 2018 at 11:00

S'chn T'gai Spock

1,36618 silver badges17 bronze badges

Collectives™ on Stack Overflow

Simple string as JSON return value in spring rest controller

4 Answers 4

2 Comments

1 Comment

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related