jQuery学习之：jqGrid表格插件——从Struts2得到数据
以前谈到了jqGrid与Serlvet/JSP集成，实际上就是Servlet按jqGrid对数据的要求返回相应的数据，Servlet中是经过PrintWriter输出数据的，那时，咱们用到了json-lib来构建Json数据。如今来谈谈jqGrid如何与Struts2集成。
对于Struts2，一样须要按jqGrid的要求返回相应的json数据格式。固然，咱们能够在Struts2的Action中经过返回null来干Servlet同样的事情，这样也可以同Servlet同样实现与jqGrid集成。然而，此时Struts2实际上至关于没有。既然用到了Struts2，咱们就应该用Struts2为咱们提供的方法。并且，在Struts的Action中应该尽可能避免使用request之类的Servlet对象，用Struts2更是如此。在struts1.x中，request直接就有的，于是在开发中总会有人“打着struts的旗帜，干着Servlet的勾当”。咱们知道，request等是依赖于Servlet容器的，Struts2把这些屏蔽了，Struts2的Action能够直接是POJO，于是咱们更不该该违反Struts2的设计原则，硬是去“干Servlet的勾当”。闲话不说，开始我们的正题。
在Struts2的jar包中，有一个struts2-json-plugin.jar，它就是用于处理json数据的（Struts2提供了不少插件），咱们就是应用它来实现struts2与jqGrid的集成。
一、效果图：
二、代码与解释：
HTML代码：
<
body
>
< table id ="gridTable" > </table>
< div id ="gridPager" > </div>
</body>
< table id ="gridTable" > </table>
< div id ="gridPager" > </div>
</body>
JavaScript代码：
$(
function()
{
$( "#gridTable").jqGrid({
url:'json/jqgrid.action',
datatype: "json",
height: 250,
colNames:['编号','用户名', '性别', '邮箱', 'QQ','手机号','出生日期'],
colModel:[
{name:'id',index:'id', sorttype: "int"},
{name:'userName',index:'userName',
{name:'gender',index:'gender',
{name:'email',index:'email', ;string"},
{name:'QQ',index:'QQ', ;
{name:'mobilePhone',index:'mobilePhone', ;
{name:'birthday',index:'birthday', sorttype: "date"}
],
sortname:'id',
sortorder:'asc',
viewrecords: true,
rowNum:10,
rowList:[10,20,30],
jsonReader: {
root: "dataRows", // 数据行（默认为：rows）
page: "curPage", // 当前页
total: "totalPages", // 总页数
records: "totalRecords", // 总记录数
repeatitems : false // 设置成false，在后台设置值的时候，能够乱序。且并不是每一个值都得设
},
prmNames:{rows: "page.pageSize",page: "page.curPageNo",sort: "page.orderBy",order: "page.order"},
pager: "#gridPager",
caption: "jqGrid与Struts2集成"
}).navGrid('#gridPager',{edit: false,add: false,del: false});
})
{
$( "#gridTable").jqGrid({
url:'json/jqgrid.action',
datatype: "json",
height: 250,
colNames:['编号','用户名', '性别', '邮箱', 'QQ','手机号','出生日期'],
colModel:[
{name:'id',index:'id', sorttype: "int"},
{name:'userName',index:'userName',
{name:'gender',index:'gender',
{name:'email',index:'email', ;string"},
{name:'QQ',index:'QQ', ;
{name:'mobilePhone',index:'mobilePhone', ;
{name:'birthday',index:'birthday', sorttype: "date"}
],
sortname:'id',
sortorder:'asc',
viewrecords: true,
rowNum:10,
rowList:[10,20,30],
jsonReader: {
root: "dataRows", // 数据行（默认为：rows）
page: "curPage", // 当前页
total: "totalPages", // 总页数
records: "totalRecords", // 总记录数
repeatitems : false // 设置成false，在后台设置值的时候，能够乱序。且并不是每一个值都得设
},
prmNames:{rows: "page.pageSize",page: "page.curPageNo",sort: "page.orderBy",order: "page.order"},
pager: "#gridPager",
caption: "jqGrid与Struts2集成"
}).navGrid('#gridPager',{edit: false,add: false,del: false});
})
Java代码：
package com.polaris.jqgrid.struts2;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import com.opensymphony.xwork2.ActionSupport;
import com.polaris.jqgrid.util.Page;
/**
* <p>
* 该类是全部须要返回json数据的Action的<b>抽象基类</b>。在展现数据时，使用了jQuery的插件jqGrid，
* 它对返回的json数据格式有必定的要求。该基类就处理了这些统一的格式要求。
* 须要返回json格式数据被jqGrid使用的，应该继承该类。<br/>
* <b><font color='red'>注意：全部子类应该实现如下get方法，并只简单的返回相应的属性值。</font></b>
* <ul>
* <li>{@link JsoBaseAction#getTotalPages()}</li>
* <li>{@link JsoBaseAction#getCurPage()}</li>
* <li>{@link JsoBaseAction#getTotalRecords()}</li>
* <li>{@link JsoBaseAction#getDataRows()}</li>
* </ul>
* 之因此将这些get方法定义为抽象的，是由于struts2的json插件只会序列化Action类，而不会序列化其父类。
* </p>
*
* <p><font color='red'>
* 继承该类的Action方法，除了搜索（它须要返回JSON数据，所以能够返回SUCCESS)，其余操做都应该返回null而不是SUCCESS之类的。
* 这意味着struts配置中，result什么也不用配，即没有相应的视图资源——这是AJAX请求。
* </font></p>
*
* <p>
* 该类定义了如下几个字段：totalPages、curPage、totalRecords和dataRows。
* 这几个字段是jqGrid格式的要求，而此处是自定义的。所以，在配置jqGrid接收服务器
* 返回的数据格式时，应该配置成这几个名字。(由于默认名字不是这样的，默认名字为：page,total,records,rows）
* 固然，也能够经过@JSON注解来指定与默认同样的名字
* </p>
*
* <p>
* 另一个字段page，则是一个分页类。由于jqGrid会向服务器端传递分页参数，
* 用一个分页类接收这些参数。一样，为使Struts可以为page赋值，须要修改jqGrid默认的分页参数名。
* jqGrid默认分页名为：（默认定义在options参数中的prmNames数组中）
* <ul>
* <li>page->显示第几页</li>
* <li>rows->每页显示几条记录</li>
* <li>sidx->排序字段</li>
* <li>sord->排序方式（asc/desc)</li>
* </ul>
* 应用中应该根据{@link 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}
* </p>
*
* @author xuxinhua
* @version 1.0
*/
@SuppressWarnings( "unchecked")
public abstract class JsonBaseAction extends ActionSupport
{
private static final long serialVersionUID = 1L;
/**
* 该属性专门用于接收删除的数据的ID（主键）。注意，当支持一次删除多记录时，id的值是经过','号分隔的多个
*/
protected String id;
/**
* 分页类
*/
protected Page page = new Page();
/**
* 如下属性用于序列化成json格式的数据。名称不能改。若是要改，客户端页面对应的地方也要改；
* 或经过@JSON来指定序列化的名字
*/
/**
* 总页数
*/
protected int totalPages;
/**
* 显示第几页
*/
protected int curPage;
/**
* 总记录数
*/
protected int totalRecords;
/**
* 保存实际的数据
*/
protected List<Map<String,Object>> dataRows = new ArrayList<Map<String,Object>>();
public JsonBaseAction() {
super();
}
public Page getPage() {
return page;
}
public void setPage(Page page) {
this.page = page;
}
public void setId(String id) {
this.id = id;
}
public String getId() {
return id;
}
public abstract int getTotalPages();
public void setTotalPages( int totalPages) {
this.totalPages = totalPages;
}
public abstract int getCurPage();
public void setCurPage( int curPage) {
this.curPage = curPage;
}
public abstract int getTotalRecords();
public void setTotalRecords( int totalRecords) {
this.totalRecords = totalRecords;
}
/**
* 注意该方法的返回值：List。实际上包含了实际的数据，
* 而这些数据是放在Map<String, Object>中的。
* 于是，子类在action方法如：execute中，应该构建一个
* Map<String, Object>对象，将数据放入其中，并把该对象放入
* List中。
* @return
*/
public abstract List<Map<String, Object>> getDataRows();
public void setDataRows(List<Map<String, Object>> dataRows) {
this.dataRows = dataRows;
}
}
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import com.opensymphony.xwork2.ActionSupport;
import com.polaris.jqgrid.util.Page;
/**
* <p>
* 该类是全部须要返回json数据的Action的<b>抽象基类</b>。在展现数据时，使用了jQuery的插件jqGrid，
* 它对返回的json数据格式有必定的要求。该基类就处理了这些统一的格式要求。
* 须要返回json格式数据被jqGrid使用的，应该继承该类。<br/>
* <b><font color='red'>注意：全部子类应该实现如下get方法，并只简单的返回相应的属性值。</font></b>
* <ul>
* <li>{@link JsoBaseAction#getTotalPages()}</li>
* <li>{@link JsoBaseAction#getCurPage()}</li>
* <li>{@link JsoBaseAction#getTotalRecords()}</li>
* <li>{@link JsoBaseAction#getDataRows()}</li>
* </ul>
* 之因此将这些get方法定义为抽象的，是由于struts2的json插件只会序列化Action类，而不会序列化其父类。
* </p>
*
* <p><font color='red'>
* 继承该类的Action方法，除了搜索（它须要返回JSON数据，所以能够返回SUCCESS)，其余操做都应该返回null而不是SUCCESS之类的。
* 这意味着struts配置中，result什么也不用配，即没有相应的视图资源——这是AJAX请求。
* </font></p>
*
* <p>
* 该类定义了如下几个字段：totalPages、curPage、totalRecords和dataRows。
* 这几个字段是jqGrid格式的要求，而此处是自定义的。所以，在配置jqGrid接收服务器
* 返回的数据格式时，应该配置成这几个名字。(由于默认名字不是这样的，默认名字为：page,total,records,rows）
* 固然，也能够经过@JSON注解来指定与默认同样的名字
* </p>
*
* <p>
* 另一个字段page，则是一个分页类。由于jqGrid会向服务器端传递分页参数，
* 用一个分页类接收这些参数。一样，为使Struts可以为page赋值，须要修改jqGrid默认的分页参数名。
* jqGrid默认分页名为：（默认定义在options参数中的prmNames数组中）
* <ul>
* <li>page->显示第几页</li>
* <li>rows->每页显示几条记录</li>
* <li>sidx->排序字段</li>
* <li>sord->排序方式（asc/desc)</li>
* </ul>
* 应用中应该根据{@link 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}
* </p>
*
* @author xuxinhua
* @version 1.0
*/
@SuppressWarnings( "unchecked")
public abstract class JsonBaseAction extends ActionSupport
{
private static final long serialVersionUID = 1L;
/**
* 该属性专门用于接收删除的数据的ID（主键）。注意，当支持一次删除多记录时，id的值是经过','号分隔的多个
*/
protected String id;
/**
* 分页类
*/
protected Page page = new Page();
/**
* 如下属性用于序列化成json格式的数据。名称不能改。若是要改，客户端页面对应的地方也要改；
* 或经过@JSON来指定序列化的名字
*/
/**
* 总页数
*/
protected int totalPages;
/**
* 显示第几页
*/
protected int curPage;
/**
* 总记录数
*/
protected int totalRecords;
/**
* 保存实际的数据
*/
protected List<Map<String,Object>> dataRows = new ArrayList<Map<String,Object>>();
public JsonBaseAction() {
super();
}
public Page getPage() {
return page;
}
public void setPage(Page page) {
this.page = page;
}
public void setId(String id) {
this.id = id;
}
public String getId() {
return id;
}
public abstract int getTotalPages();
public void setTotalPages( int totalPages) {
this.totalPages = totalPages;
}
public abstract int getCurPage();
public void setCurPage( int curPage) {
this.curPage = curPage;
}
public abstract int getTotalRecords();
public void setTotalRecords( int totalRecords) {
this.totalRecords = totalRecords;
}
/**
* 注意该方法的返回值：List。实际上包含了实际的数据，
* 而这些数据是放在Map<String, Object>中的。
* 于是，子类在action方法如：execute中，应该构建一个
* Map<String, Object>对象，将数据放入其中，并把该对象放入
* List中。
* @return
*/
public abstract List<Map<String, Object>> getDataRows();
public void setDataRows(List<Map<String, Object>> dataRows) {
this.dataRows = dataRows;
}
}
这个类是一个抽象基类，为了方便扩展而设计的。须要返回json数据（使用jqGrid插件）的Action应该继承该类。这个类是我为公司写的一个类，拿出来与你们分享。java
实际处理JSON数据的Action类代码：
package com.polaris.jqgrid.struts2;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* 该Struts2向客户端返回一个json对象。为了简便，数据不是从数据库得到的。
* jqGrid默认指望返回的json对象格式要求以下：
* {"page":"1","total":"2","records":"13",
* "rows":[
* {id:"1",cell:["1","polaris","男","polaris@gmail.com","772618379","18329382732","1985-10-2"]},
* {id:"2",cell:["2","张三","女","zhangsan@163.com","272618382","15329382732","1986-10-12"]},
* {id:"3",cell:["3","王五","女","wangwu@yahoo.com","172635372","13329389832","1987-12-21"]},
* {id:"4",cell:["4","赵六","男","zhaoliu@sina.com","372618332","18929343731","1988-09-22"]}
* ]
* }
* 固然，在js中，能够经过jqGrid的jsonReader属性来修改默认格式
* 由于默认的格式，rows的数据要求顺序不能变，且每一个字段都得有值（空也得有"")。于是，
* 在jsonReader中定义repeatitems : false。这样，rows就变成了：
* "rows":[
* {id:"1",userName:"polaris",gender:" 男",email:"polaris@gmail.com",QQ:"772618379",mobilePhone:"18329382732",birthday:"1985-10-2"]},
* {id:"2",userName:"徐新华",gender:" 男",email:"xh.xu@163.com",QQ:"272618382",mobilePhone:"15329382732",birthday:"1986-10-12"]},
* {id:"3",userName:"王五",gender:" 女",email:"wangwu@yahoo.com",QQ:"172635372",mobilePhone:"13329389832",birthday:"1987-12-21"]},
* {id:"4",userName:"赵六",gender:" 女",email:"zhaoliu@sina.com",QQ:"372618332",mobilePhone:"18929343731",birthday:"1988-09-22"]}
* ]
* @author xuxinhua
*
*/
public class JqGridForJSONAction extends JsonBaseAction
{
private static final long serialVersionUID = 132383828833L;
/**
* 该方法获得数据并构造json对象以便返回给客户端
* @return
* @throws Exception
*/
public String execute() throws Exception
{
// 构建几条数据
int i = 0;
for(i=0;i<4;++i)
{
// 定义一个Map<String,Object>存放一行行数据。（跟从Servlet得到数据相似，只不过此处不须要用json-lib）
Map<String, Object> row = new HashMap<String, Object>();
row.put( "id", i);
if(i%2==0)
{
row.put( "userName", "polaris");
row.put( "gender", "女");
}
else
{
row.put( "userName", "徐新华");
row.put( "gender", "男");
}
row.put( "email", "polaris@gmail.com");
row.put( "QQ", "772"+i+ "1837"+i);
row.put( "mobilePhone", "132"+i+ "1837"+i+ "3"+i);
row.put( "birthday", "198"+i+ "-10-"+ "1"+i);
dataRows.add(row);
}
// 给另外三个返回参数设值
setTotalPages(1); // 总页数
setCurPage(1); // 当前页
setTotalRecords(i); // 总记录数
return SUCCESS;
}
/*
* 如下getter方法必须实现，struts2-json插件会将这些getter方法序列化，以便输出json对象。
* 这些getter方法只需返回相应的属性便可。如getCurPage应该返回curPage
* （curPage在JsonBaseAction中有定义）
*/
@Override
public int getCurPage()
{
return this.curPage;
}
@Override
public List<Map<String, Object>> getDataRows()
{
return this.dataRows;
}
@Override
public int getTotalPages()
{
return this.totalPages;
}
@Override
public int getTotalRecords()
{
return this.totalRecords;
}
}
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* 该Struts2向客户端返回一个json对象。为了简便，数据不是从数据库得到的。
* jqGrid默认指望返回的json对象格式要求以下：
* {"page":"1","total":"2","records":"13",
* "rows":[
* {id:"1",cell:["1","polaris","男","polaris@gmail.com","772618379","18329382732","1985-10-2"]},
* {id:"2",cell:["2","张三","女","zhangsan@163.com","272618382","15329382732","1986-10-12"]},
* {id:"3",cell:["3","王五","女","wangwu@yahoo.com","172635372","13329389832","1987-12-21"]},
* {id:"4",cell:["4","赵六","男","zhaoliu@sina.com","372618332","18929343731","1988-09-22"]}
* ]
* }
* 固然，在js中，能够经过jqGrid的jsonReader属性来修改默认格式
* 由于默认的格式，rows的数据要求顺序不能变，且每一个字段都得有值（空也得有"")。于是，
* 在jsonReader中定义repeatitems : false。这样，rows就变成了：
* "rows":[
* {id:"1",userName:"polaris",gender:" 男",email:"polaris@gmail.com",QQ:"772618379",mobilePhone:"18329382732",birthday:"1985-10-2"]},
* {id:"2",userName:"徐新华",gender:" 男",email:"xh.xu@163.com",QQ:"272618382",mobilePhone:"15329382732",birthday:"1986-10-12"]},
* {id:"3",userName:"王五",gender:" 女",email:"wangwu@yahoo.com",QQ:"172635372",mobilePhone:"13329389832",birthday:"1987-12-21"]},
* {id:"4",userName:"赵六",gender:" 女",email:"zhaoliu@sina.com",QQ:"372618332",mobilePhone:"18929343731",birthday:"1988-09-22"]}
* ]
* @author xuxinhua
*
*/
public class JqGridForJSONAction extends JsonBaseAction
{
private static final long serialVersionUID = 132383828833L;
/**
* 该方法获得数据并构造json对象以便返回给客户端
* @return
* @throws Exception
*/
public String execute() throws Exception
{
// 构建几条数据
int i = 0;
for(i=0;i<4;++i)
{
// 定义一个Map<String,Object>存放一行行数据。（跟从Servlet得到数据相似，只不过此处不须要用json-lib）
Map<String, Object> row = new HashMap<String, Object>();
row.put( "id", i);
if(i%2==0)
{
row.put( "userName", "polaris");
row.put( "gender", "女");
}
else
{
row.put( "userName", "徐新华");
row.put( "gender", "男");
}
row.put( "email", "polaris@gmail.com");
row.put( "QQ", "772"+i+ "1837"+i);
row.put( "mobilePhone", "132"+i+ "1837"+i+ "3"+i);
row.put( "birthday", "198"+i+ "-10-"+ "1"+i);
dataRows.add(row);
}
// 给另外三个返回参数设值
setTotalPages(1); // 总页数
setCurPage(1); // 当前页
setTotalRecords(i); // 总记录数
return SUCCESS;
}
/*
* 如下getter方法必须实现，struts2-json插件会将这些getter方法序列化，以便输出json对象。
* 这些getter方法只需返回相应的属性便可。如getCurPage应该返回curPage
* （curPage在JsonBaseAction中有定义）
*/
@Override
public int getCurPage()
{
return this.curPage;
}
@Override
public List<Map<String, Object>> getDataRows()
{
return this.dataRows;
}
@Override
public int getTotalPages()
{
return this.totalPages;
}
@Override
public int getTotalRecords()
{
return this.totalRecords;
}
}
注意看注释。web
struts.xml的配置：
<
constant
name
="struts.i18n.encoding"
value
="utf-8"
>
</
constant
>
< package name ="json" namespace ="/json" extends ="json-default" >
< action name ="jqgrid" class ="com.polaris.jqgrid.struts2.JqGridForJSONAction" >
< result type ="json" > </ result >
</ action >
</ package >
< package name ="json" namespace ="/json" extends ="json-default" >
< action name ="jqgrid" class ="com.polaris.jqgrid.struts2.JqGridForJSONAction" >
< result type ="json" > </ result >
</ action >
</ package >
说明：1）设置字符编码，不然会乱码；2）package要继承自json-default，json-default在struts2-json-plugin中有定义；3）result的type必须为json，表示返回数据类型为json，然而视图映射留空（即result不能对应一个视图）数据库
web.xml的struts2核心过滤器的配置：
<
filter
>
< filter-name >struts2 </ filter-name >
< filter-class >
org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter
</ filter-class >
</ filter >
< filter-mapping >
< filter-name >struts2 </ filter-name >
< url-pattern >/* </ url-pattern >
</ filter-mapping >
< filter-name >struts2 </ filter-name >
< filter-class >
org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter
</ filter-class >
</ filter >
< filter-mapping >
< filter-name >struts2 </ filter-name >
< url-pattern >/* </ url-pattern >
</ filter-mapping >
你可能会发现，此处配置的过滤器类名和网上不少地方说的不同。的确，我用的struts2是2.1.8。自从2.1.3开始，原来的过滤器FilterDispatcher被标注为：Deprecated
apache
结语：
至此jqGrid告一段落，很差之处请指正。若有什么问题，能够联系我，咱们一块儿讨论。
因为不少人问我要例子的源代码，polaris也都发给了你们，如今不多上51CTO，须要的关注我微博 http://weibo.com/beijixing001，私信我。
相关文章
- 1. jQuery学习之：jqGrid表格插件——从Struts2获得数据
- 2. jQuery学习之：jqGrid表格插件——从servlet得到数据
- 3. jQuery学习之：jqGrid表格插件——从servlet获得数据
- 4. jQuery学习之：jqGrid表格插件——参数配置
- 5. jQuery学习之：jqGrid表格插件——第一个Demo
- 6. jQuery学习之：jqGrid表格插件——第一个Demo 转
- 7. jquery得到表格当前行数据
- 8. 导出jqgrid表格数据为EXCEL文件，经过tableExport.js插件。
- 9. jquery插件之jqGrid入门（一）：新手demo学习
- 10. JQuery插件jqGrid的使用
- 更多相关文章...
- • jQuery Mobile 表格 - jQuery Mobile 教程
- • Markdown 表格 - Markdown 教程
- • IntelliJ IDEA安装代码格式化插件
- • Flink 数据传输及反压详解
相关标签/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
欢迎关注本站公众号,获取更多信息
相关文章
- 1. jQuery学习之：jqGrid表格插件——从Struts2获得数据
- 2. jQuery学习之：jqGrid表格插件——从servlet得到数据
- 3. jQuery学习之：jqGrid表格插件——从servlet获得数据
- 4. jQuery学习之：jqGrid表格插件——参数配置
- 5. jQuery学习之：jqGrid表格插件——第一个Demo
- 6. jQuery学习之：jqGrid表格插件——第一个Demo 转
- 7. jquery得到表格当前行数据
- 8. 导出jqgrid表格数据为EXCEL文件，经过tableExport.js插件。
- 9. jquery插件之jqGrid入门（一）：新手demo学习
- 10. JQuery插件jqGrid的使用