Spring 3.0 making JSON response using jackson message converter

68,881

Solution 1

You need the following:

  1. Set annotation-driven programming model: put <mvc:annotation-driven /> in spring.xml
  2. Place jaskson jar (Maven artifactId is org.codehaus.jackson:jackson-mapper-asl) in classpath.
  3. Use as the following:

    @RequestMapping(method = { RequestMethod.GET, RequestMethod.POST })
    public @ResponseBody Foo method(@Valid Request request, BindingResult result){
    return new Foo(3,4)
    }
    

This works for me.

Please note, that

  1. @ResponseBody is applied to return type, not to the method definition.
  2. You need @RequestMapping annotation, so that Spring will detect it.

Solution 2

This worked for me:

@RequestMapping(value = "{p_LocationId}.json", method = RequestMethod.GET)
protected void getLocationAsJson(@PathVariable("p_LocationId") Integer p_LocationId,
     @RequestParam("cid") Integer p_CustomerId, HttpServletResponse response) {
        MappingJacksonHttpMessageConverter jsonConverter = 
                new MappingJacksonHttpMessageConverter();
        Location requestedLocation = new Location(p_LocationId);
        MediaType jsonMimeType = MediaType.APPLICATION_JSON;
        if (jsonConverter.canWrite(requestedLocation.getClass(), jsonMimeType)) {
        try {
            jsonConverter.write(requestedLocation, jsonMimeType,
                                   new ServletServerHttpResponse(response));
            } catch (IOException m_Ioe) {
                // TODO: announce this exception somehow
            } catch (HttpMessageNotWritableException p_Nwe) {
                // TODO: announce this exception somehow
            }
        }
}

Note that the method doesn't return anything: MappingJacksonHttpMessageConverter#write() does the magic.

Solution 3

The MessageConverter interface http://static.springsource.org/spring/docs/3.0.x/javadoc-api/ defines a getSupportedMediaTypes() method, which in case of the MappingJacksonMessageCoverter returns application/json

public MappingJacksonHttpMessageConverter() {
    super(new MediaType("application", "json", DEFAULT_CHARSET));
}

I assume a Accept: application/json request header is missing.

Solution 4

A HTTP 404 error just means that the resource cannot be found. That can have 2 causes:

  1. Request URL is wrong (client side error or wrong URL in given link/button).
  2. Resource is not there where you expect it is (server side error).

To fix 1, ensure you're using or providing the correct request URL (casesensitive!). To fix 2, check the server startup logs for any startup errors and fix them accordingly.

This all goes beyond the as far posted code and information.

Solution 5

I found that I need jackson-core-asl.jar too, not only jackson-mapper-asl.jar

Share:
68,881
dupdup
Author by

dupdup

Updated on August 13, 2020

Comments

  • dupdup
    dupdup almost 4 years

    i configure my messageconverter as Jackson's then

    class Foo{int x; int y}
    

    and in controller

    @ResponseBody
    public Foo method(){
       return new Foo(3,4)
    }
    

    from that i m expecting to return a JSON string {x:'3',y:'4'} from server without any other configuration. but getting 404 error response to my ajax request

    If the method is annotated with @ResponseBody, the return type is written to the response HTTP body. The return value will be converted to the declared method argument type using HttpMessageConverters.

    Am I wrong ? or should I convert my response Object to Json string myself using serializer and then returning that string as response.(I could make string responses correctly) or should I make some other configurations ? like adding annotations for class Foo

    here is my conf.xml

    <bean id="jacksonMessageConverter" class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
    

      <bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
    <property name="messageConverters">
      <list>
        <ref bean="jacksonMessageConverter"/>
      </list>
    </property>