Spring MVC Controller with JSON and JSP - spring

Question

Can the same method in a controller be used for both JSP and other MIME types (like XML and JSON)?
I know of the following ways to resolve views in Spring MVC.
Return a String with the view name and add attributes to the Model or ModelMap
Return a ModelAndView with the view name and model
Return an Object with a #ResponseBody annotation
I use 1 or 2 when I am dealing with JSP and 3 when I want to return JSON or XML.
I know I can use two methods and with the #RequestMapping(headers="accept=application/xml") or #produces annotations to define which MIME types they handle, but is it possible to do this in just one method?
The controller logic is pretty simple and it seems like unnecessary duplication to have two different methods mapped which return the same exact model, or is this just simply the way it's done?

Answer 1

Yes, this is straight forward in Spring MVC 3.x...
You basically write your controller methods for just normal JSP page views and then you configure a ContentNegotiatingViewResolver bean in your Dispatcher servlet config., which looks at the requested mime-type (or file extension) and returns the appropriate output type.
Follow the instructions here: Spring 3 MVC ContentNegotiatingViewResolver Example

Answer 2

I had the very same requirement recently, and below is my code. validateTicket returns jsp name and sendForgotPassword mail returns json. My spring version is 4.0.0.RELEASE. Of course, if I need to return complex json then I'd definitely register Jackson converter - http://docs.spring.io/spring/docs/4.0.x/javadoc-api/org/springframework/http/converter/json/MappingJackson2HttpMessageConverter.html
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">
<context:component-scan base-package="foo.bar" />
<bean id="viewResolver"
class="org.springframework.web.servlet.view.UrlBasedViewResolver">
<property name="viewClass"
value="org.springframework.web.servlet.view.JstlView" />
<property name="prefix" value="/WEB-INF/jsp/" />
<property name="suffix" value=".jsp" />
</bean>
</beans>
#Controller
#RequestMapping("/forgot-password")
public class ForgotPasswordController {
#RequestMapping(value="/reset-password", method = RequestMethod.GET)
public String validateTicket(#RequestParam String ticket, #RequestParam String emailAddress) {
return "resetPassword";
}
#RequestMapping(value="/send-mail", method = RequestMethod.POST, produces="application/json")
public #ResponseBody String sendForgotPasswordMail(#RequestParam String emailAddress) throws LoginException {
return "{\"success\":\"true\"}";
}
}