该类是所有需要返回json数据的Action的抽象基类。在展示数据时,使用了jQuery的插件jqGrid, 它对返回的json数据格式有一定的要求。该基类就处理了这些统一的格式要求。 需要返回json格式数据被jqGrid使用的,应该继承该类。
注意:所有子类应该实现以下get方法,并只简单的返回相应的属性值。
JsoBaseAction.getTotalPages()
JsoBaseAction.getCurPage()
JsoBaseAction.getTotalRecords()
JsoBaseAction.getDataRows()
继承该类的Action方法,除了搜索(它需要返回JSON数据,因此可以返回SUCCESS),其他操作都应该返回null而不是SUCCESS之类的。 这意味着struts配置中,result什么也不用配,即没有相应的视图资源——这是AJAX请求。
该类定义了以下几个字段:totalPages、curPage、totalRecords和dataRows。 这几个字段是jqGrid格式的要求,而此处是自定义的。因此,在配置jqGrid接收服务器 返回的数据格式时,应该配置成这几个名字。(因为默认名字不是这样的,默认名字为:page,total,records,rows) 当然,也可以通过@JSON注解来指定与默认一样的名字
另外一个字段page,则是一个分页类。因为jqGrid会向服务器端传递分页参数, 用一个分页类接收这些参数。同样,为使Struts能够为page赋值,需要修改jqGrid默认的分页参数名。 jqGrid默认分页名为:(默认定义在options参数中的prmNames数组中)
- page->显示第几页
- rows->每页显示几条记录
- sidx->排序字段
- sord->排序方式(asc/desc)
com.polaris.jqgrid.util.Page
类中的定义设置。设置为: prmNames:{rows:"page.pageSize",page:"page.curPageNo",sort:"page.orderBy",order:"page.order"} prmNames数组的默认值为: prmNames: {page:"page",rows:"rows", sort: "sidx",order: "sord", search:"_search", nd:"nd", npage:null}