扩展Spring MVC 用以支持Controller对Ajax的处理

Spring Mvc中没有特别针对于Ajax请求的处理Controller.但是AbstractController和
SimpleFormController也是可以针对Ajax的请求给与相应的.但显得有一点点的不自然.

	@Override
	protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object cmd,
			BindException ex) {
		String userId=request.getParamater("userId");
                  Map userInfoMap=userDao.getUserBaseInfo(userId);
                  JSONObject object = new JSONObject();
                  object.put("userInfoMap",userInfoMap);
		response.setContentType("text/Xml;charset=gbk");
		PrintWriter out = null;
		try {
			out = response.getWriter();
		         out.println(object.toString());
		         
		}
		catch (IOException ex1) {
			ex1.printStackTrace();
		}finally{
                            out.close();
                   }
		return null;
	}

说明一下我向客户端页面response的是一个JSon对象,选择JSon这种数据格式的两个原因是:

1. 体积小可降低流量.
2. Js端解码十分方便,Js对JSon格式数据有原生的支持.

使用Spring Mvc原有的SimpleFormController,从上边的例子上看是可以实现的,但是每次都要写"将JSonObject写入流,关流的代码.很累,很麻纺."
所以,扩展了两个新的Controller,以简化对Ajax请求的处理.
JSONObjectAbstractController 用于简单的从request.getParamater参数的情况.
JSONObjectAbstractController 的原代码:

package com.javaest.ext.spring.mvc.controller;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import net.sf.json.JSONObject;

import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.AbstractController;

public abstract class JSONObjectAbstractController extends AbstractController {

	@Override
	protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response)
			throws Exception {
		JSONObject jsonObject = handleAjaxRequestInternal(request, response);
		response.setContentType("text/Xml;charset=gbk");
		PrintWriter out = null;
		try {
			out = response.getWriter();
			out.println(jsonObject.toString());
		}
		catch (IOException ex1) {
			ex1.printStackTrace();
		}
		finally {
			out.close();
		}

		return null;
	}

	protected abstract JSONObject handleAjaxRequestInternal(HttpServletRequest httpServletRequest,
			HttpServletResponse httpServletResponse) throws Exception;

}

JSONObjectSimpleFormController 用于自动将请求参数绑定到Command对象的情况.
JSONObjectSimpleFormController 的代码:

package com.javaest.ext.spring.mvc.controller;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import net.sf.json.JSONObject;

import org.springframework.validation.BindException;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.SimpleFormController;

public abstract class JSONObjectSimpleFormController extends SimpleFormController {

	@Override
	protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object cmd,
			BindException ex) {
		JSONObject object = onAjaxSubmit(request, response, cmd, ex);

		response.setContentType("text/Xml;charset=gbk");
		PrintWriter out = null;
		try {
			out = response.getWriter();
			out.println(object.toString());
		}
		catch (IOException ex1) {
			ex1.printStackTrace();
		}
		finally {
			out.close();
		}

		return null;
	}

	public abstract JSONObject onAjaxSubmit(HttpServletRequest request, HttpServletResponse response, Object cmd,
			BindException ex);

}

以下就是我为了支持Ajax请求的处理所扩展的SpringMvc Controller.
作者来自长春,一直在基于J2EE架构开发税务方面的应用.

评论

21 楼 ccitkao 2008-09-08  

我们这的方法是直接扩展view.controller只负责获得数据,具体是jsp还是ajax都让view去决定.这样controller的耦合度就更低了.

20 楼 javaest 2008-08-07  

dakulaliu
的写法也不错。
我认为扩展出JSonController和JSonView的方法都是可以的，但JSonController这种方法不用在SPRINGMVC中加视图的配置了。

19 楼 dakulaliu 2008-08-07  

stworthy 写道

谢谢，我现在知道怎么做了，大体有二种方法，一是定义一个json view，二是按照Saro说的方法。
另外，在处理控制映射上，是http://www.sf.net/index.do?method=testIt的形式好些，还是http://www.sf.net/index/testIt.do的形式好些。目前大家是使用那种形式多些？

其实不需要单独实现一个controller,而只需要定义一个JsonView class就可以，当然SourceForge里面好像有人已经提交了一个JsonView的实现，你可以拿过来用的"http://sourceforge.net/project/showfiles.php?group_id=171425&abmode=1".

在Controller里面代码和一般的Controller代码没什么区别:

	@RequestMapping("/login_ajax.do")
	public String handleAjaxLogin(Model model) {
		model.addAttribute(JsonFieldNaming.PARA_UNLOGIN, Boolean.TRUE);
		return "jsonView";
	}

View Config in views.properties:

jsonView.(class)=net.sf.json.spring.web.servlet.view.JsonView
jsonView.contentType=application/json;charset=UTF-8

18 楼 stworthy 2008-08-05  

觉得扩展写个JsonView，然后在控制器中直接返回这个JsonView，似乎更好些。

17 楼 former 2008-08-04  

<p>我们的做法： <br/>spring2.5的Controller</p>
<p> </p>
<pre name='code' class='java'>@Controller
@RequestMapping("/agentAccount.do")
public class AgentAccountController extends AbstractController{
@RequestMapping(params = "method=preValidate", method = RequestMethod.POST)
public void preValidate(CrmAgentAccount agentAccount, BindingResult results, HttpServletResponse response)
throws IOException
{
new AgentAccountValidator(agentAccount, results).validate();
ajaxOutput(response, convert2JSONString(results.getAllErrors()));
}
}</pre>
<p> </p>
<p>父类中的2个方法处理ajax输出：</p>
<pre name='code' class='java'> protected String convert2JSONString(Object object)
{
JSONArray jsonObject = JSONArray.fromObject(object);
return jsonObject.toString();
}
protected void ajaxOutput(HttpServletResponse response, String outputString) throws IOException
{
response.setContentType("text/html; charset=GBK");
response.getWriter().write(outputString);
response.getWriter().flush();
}</pre>
<p> </p>

16 楼 javaest 2008-08-04  

可以基于这种方式任意扩展，现在我们在搞Flex，所以我也扩展了支持Flex HttpService的Controller。

15 楼 shuai45 2008-07-30  

个人感觉ajax（js＋xml）在action中或者controller中等控制其中处理，即使处理的在完美，终究还要占据一定的代码量．这些代码量包括xml文件的输出和xml节点的输出．楼主的方法很不错．（因为这个问题，我换成了dwr）

14 楼 Saro 2008-07-30  

<div class='quote_title'>stworthy 写道</div>
<div class='quote_div'>
<div class='quote_title'>Saro 写道</div>
<div class='quote_div'>楼主封装的不错。<br/><br/>@Controller<br/>public class DemoController {<br/><br/>   @RequestMapping("list_data.do")<br/>   public void list_data(Writer writer){<br/>       JSONObject obj = new JSONObject();<br/>       //........<br/>       writer.write(obj.toString());<br/>   }<br/>}<br/><br/>其实这样也不麻烦。<br/></div>
<p> </p>
<p>writer直接输出JSON串，是否需要设置encoding，按照UTF-8编码后的输出在浏览器上是乱码，不知有何解决方法，当然每次输出前都设置encoding是个办法，但太麻烦了。</p>
</div>
<p> </p>
<p>用过滤器，spring有现成得。</p>

13 楼 stworthy 2008-07-25  

<div class='quote_title'>Saro 写道</div>
<div class='quote_div'>楼主封装的不错。<br/><br/>@Controller<br/>public class DemoController {<br/><br/>   @RequestMapping("list_data.do")<br/>   public void list_data(Writer writer){<br/>       JSONObject obj = new JSONObject();<br/>       //........<br/>       writer.write(obj.toString());<br/>   }<br/>}<br/><br/>其实这样也不麻烦。<br/></div>
<p> </p>
<p>writer直接输出JSON串，是否需要设置encoding，按照UTF-8编码后的输出在浏览器上是乱码，不知有何解决方法，当然每次输出前都设置encoding是个办法，但太麻烦了。</p>

12 楼 javaest 2008-07-25  

格局千秋啊.

11 楼 stworthy 2008-07-25  

谢谢，我现在知道怎么做了，大体有二种方法，一是定义一个json view，二是按照Saro说的方法。
另外，在处理控制映射上，是http://www.sf.net/index.do?method=testIt的形式好些，还是http://www.sf.net/index/testIt.do的形式好些。目前大家是使用那种形式多些？

10 楼 javaest 2008-07-25  

引用

stworthy 2008-07-15
如果想做成类似MultiActionController一样的AJAX支持，不知在SPRING中如何实现。即一个Controller，多个Action都是支持AJAX，都能返回JSON串的。

这是可以的,但你需要在这个基础之上继续扩展,明确一下你需要根据什么分发指定的方法.
是根据URL,还是request中的一个参数?很好扩展的.

9 楼 stworthy 2008-07-15  

如果想做成类似MultiActionController一样的AJAX支持，不知在SPRING中如何实现。即一个Controller，多个Action都是支持AJAX，都能返回JSON串的。

8 楼 kidd3166 2008-07-09  

引用

引用

[/b][b][/i][i][i][/i]

7 楼 ysy861 2008-05-12  

    

6 楼 raychl 2008-05-01  

Pdf、excel都有对应的view来做处理，是不是也可以为Json写一个专门处理Json的view呢？

5 楼 javaest 2008-04-29  

1456996541 10 小时前
不知道Spring的MVC可以与JS直接通信么?

JS直接通信?通信是指什么?是直接调用返回的Json对象?

4 楼 laiseeme 2008-04-29  

也可以在视图解析器里面writer.write(obj.toString());

3 楼 1456996541 2008-04-29  

不知道Spring的MVC可以与JS直接通信么?

2 楼 Saro 2008-04-28  

楼主封装的不错。

@Controller
public class DemoController {

   @RequestMapping("list_data.do")
   public void list_data(Writer writer){
       JSONObject obj = new JSONObject();
       //........
       writer.write(obj.toString());
   }
}

其实这样也不麻烦。