Spring RequestMapping for controllers that produce and consume JSON

by

As of Spring 4.2.x, you can create custom mapping annotations, using @RequestMapping as a meta-annotation. So:

Is there a way to produce a “composite/inherited/aggregated”
annotation with default values for consumes and produces, such that I
could instead write something like:

@JSONRequestMapping(value = "/foo", method = RequestMethod.POST)

Yes, there is such a way. You can create a meta annotation like following:

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@RequestMapping(consumes = "application/json", produces = "application/json")
public @interface JsonRequestMapping {
    @AliasFor(annotation = RequestMapping.class, attribute = "value")
    String[] value() default {};

    @AliasFor(annotation = RequestMapping.class, attribute = "method")
    RequestMethod[] method() default {};

    @AliasFor(annotation = RequestMapping.class, attribute = "params")
    String[] params() default {};

    @AliasFor(annotation = RequestMapping.class, attribute = "headers")
    String[] headers() default {};

    @AliasFor(annotation = RequestMapping.class, attribute = "consumes")
    String[] consumes() default {};

    @AliasFor(annotation = RequestMapping.class, attribute = "produces")
    String[] produces() default {};
}

Then you can use the default settings or even override them as you want:

@JsonRequestMapping(method = POST)
public String defaultSettings() {
    return "Default settings";
}

@JsonRequestMapping(value = "/override", method = PUT, produces = "text/plain")
public String overrideSome(@RequestBody String json) {
    return json;
}

You can read more about AliasFor in spring’s javadoc and github wiki.

More Related Contents:

  1. JQuery, Spring MVC @RequestBody and JSON – making it work together
  2. Spring MVC – How to return simple String as JSON in Rest Controller
  3. How does the Spring @ResponseBody annotation work?
  4. JSON parameter in spring MVC controller
  5. Serializing enums with Jackson
  6. Jackson 2.0 with Spring 3.1
  7. In Spring MVC, how can I set the mime type header when using @ResponseBody
  8. Parsing JSON in Spring MVC using Jackson JSON
  9. How do I obtain the Jackson ObjectMapper in use by Spring 4.1?
  10. How to return JSON data from spring Controller using @ResponseBody
  11. Spring 3.0 making JSON response using jackson message converter
  12. HTTP Status 406. Spring MVC 4.0, jQuery, JSON
  13. Why does Jackson 2 not recognize the first capital letter if the leading camel case word is only a single letter long?
  14. Spring MVC 4: “application/json” Content Type is not being set correctly
  15. Spring @RequestBody containing a list of different types (but same interface)
  16. Spring-MVC 406 Not Acceptable instead of JSON Response
  17. Spring MVC PATCH method: partial updates
  18. Spring MVC: How to modify json response sent from controller
  19. Spring Boot Configure and Use Two DataSources
  20. Only using @JsonIgnore during serialization, but not deserialization
  21. Filter invoke twice when register as Spring bean
  22. Spring MVC @PathVariable getting truncated
  23. How to configure embedded Tomcat integrated with Spring to listen requests to IP address, besides localhost?
  24. How to Implement HTTP byte-range requests in Spring MVC
  25. Strange Jackson exception being thrown when serializing Hibernate object
  26. How to add bean instance at runtime in spring WebApplicationContext?
  27. Spring MVC – Binding a Date Field
  28. Return a stream with Spring MVC’s ResponseEntity
  29. What are annotations and how do they actually work for frameworks like Spring?
  30. java.lang.ClassNotFoundException: org.springframework.web.servlet.DispatcherServlet error

Leave a Comment