jQuery学习之:jqGrid表格插件——从Struts2获得数据
版权声明:原创作品,允许转载,转载时请务必以超链接形式标明文章 原始出处 、作者信息和本声明。否则将追究法律责任。 http://polaris.blog.51cto.com/1146394/264465 |
之前谈到了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的集成。 1、效果图: 2、代码与解释: HTML代码:
JavaScript代码:
注意,JavaScript代码与Servlet例子中的有点不一样,主要是:jsonReader参数,另外增加了prmNames参数。每一项的是什么意思下面Java代码的注释中有详细说明。 Java代码:
这个类是一个抽象基类,为了方便扩展而设计的。需要返回json数据(使用jqGrid插件)的Action应该继承该类。这个类是我为公司写的一个类,拿出来与大家分享。 实际处理JSON数据的Action类代码:
注意看注释。 struts.xml的配置:
说明:1)设置字符编码,否则会乱码;2)package要继承自json-default,json-default在struts2-json-plugin中有定义;3)result的type必须为json,表示返回数据类型为json,然而视图映射留空(即result不能对应一个视图) web.xml的struts2核心过滤器的配置:
你可能会发现,此处配置的过滤器类名和网上很多地方说的不一样。的确,我用的struts2是2.1.8。自从2.1.3开始,原来的过滤器FilterDispatcher被标注为: Deprecated 结语: 至此jqGrid告一段落,不好之处请指正。如有什么问题,可以联系我,我们一起讨论。 本文出自 “徐新华polaris” 博客,请务必保留此出处http://polaris.blog.51cto.com/1146394/264465 |
由于很多人需要com.polaris.jqgrid.util.Page这个类,在此贴出该类代码:
package com.polaris.jqgrid.util;
import java.util.Collections;
import java.util.List;
import org.apache.commons.lang.StringUtils;
/**
* 与具体ORM实现无关的分页参数及查询结果封装.
*
* @param <T> Page中记录的类型.
* @author xuxinhua
*/
public final class Page<T> {
// 公共变量
public static final String ASC = "asc";
public static final String DESC = "desc";
public static final int MIN_PAGESIZE = 1; // 每页显示的最少记录数
public static final int MAX_PAGESIZE = 200; // 每页显示的最大记录数
// 分页参数
protected int curPageNo = 1; // 当前所在页码(在第几页)
protected int pageSize = MIN_PAGESIZE; // 当前每页显示的记录数
protected String orderBy = null; // 排序字段
protected String order = null; // 排序方式(升序或降序)
protected boolean autoCount = false; // 查询对象时是否自动另外执行count查询获取总记录数
// 返回结果
protected List<T> result = Collections.emptyList(); // 当前页的实际记录数
protected int totalCount = -1; // 记录总数
/**
* 默认构造函数
*/
public Page() {
super();
}
/**
* 通过设置每页显示多少条记录来构造对象
* @param pageSize
*/
public Page(final int pageSize) {
setPageSize(pageSize);
}
/**
*
* @param pageSize
* @param autoCount
*/
public Page(final int pageSize, final boolean autoCount) {
setPageSize(pageSize);
this.autoCount = autoCount;
}
// 查询参数函数
/**
* 获得当前页的页号,序号从1开始,默认为1.
*/
public int getCurPageNo() {
return curPageNo;
}
/**
* 设置当前页的页号,序号从1开始,低于1时自动调整为1.
* @param curPageNo
*/
public void setCurPageNo(final int curPageNo) {
this.curPageNo = curPageNo;
if (curPageNo < 1) {
this.curPageNo = 1;
}
}
/**
* 获得每页的记录数量,默认为10.
*/
public int getPageSize() {
return pageSize;
}
/**
* 设置每页的记录数量,超出MIN_PAGESIZE与MAX_PAGESIZE范围时会自动调整.
* @param pageSize
*/
public void setPageSize(final int pageSize) {
this.pageSize = pageSize;
if (pageSize < MIN_PAGESIZE) {
this.pageSize = MIN_PAGESIZE;
}
else if (pageSize > MAX_PAGESIZE) {
this.pageSize = MAX_PAGESIZE;
}
}
/**
* 根据curPageNo和pageSize(每页显示记录数)计算当前页第一条记录在总结果集中的位置,序号从0开始.
*/
public int getFirst() {
return ((curPageNo - 1) * pageSize);
}
/**
* 获得排序字段,无默认值。多个排序字段时用','分隔,仅在Criterion查询时有效.
*/
public String getOrderBy() {
return this.orderBy;
}
/**
* 设置排序字段。多个排序字段时用','分隔.仅在Criterion查询时有效.
* @param orderBy 要排序的字段
*/
public void setOrderBy(final String orderBy) {
this.orderBy = orderBy;
}
/**
* 是否已设置排序字段,仅在Criterion查询时有效.
*/
public boolean isOrderBySetted() {
return StringUtils.isNotBlank(orderBy); // isNotBlank判断:当orderBy不等于null、""或" "时返回true
}
/**
* 获得排序方向,默认为asc,仅在Criterion查询时有效.
*/
public String getOrder() {
return this.order;
}
/**
* 设置排序方式向,仅在Criterion查询时有效.
* @param order 可选值为desc或asc,多个排序字段时用','分隔.
*/
public void setOrder(final String order) {
// 检查order字符串的合法值
String[] orders = StringUtils.split(StringUtils.lowerCase(order), ',');
for (String orderStr : orders) {
if (!StringUtils.equals(DESC, orderStr)
&& !StringUtils.equals(ASC, orderStr))
throw new IllegalArgumentException("排序方向" + orderStr + "不是合法值");
}
this.order = StringUtils.lowerCase(order);
}
/**
* 查询对象时是否自动另外执行count查询获取总记录数,默认为false,仅在Criterion查询时有效.
*/
public boolean isAutoCount() {
return autoCount;
}
/**
* 查询对象时是否自动另外执行count查询获取总记录数,仅在Criterion查询时有效.
* @param autoCount
*/
public void setAutoCount(final boolean autoCount) {
this.autoCount = autoCount;
}
// 查询结果函数
/**
* 取得页内的记录列表.
*/
public List<T> getResult() {
return result;
}
/**
* 设置页内的记录列表.
* @param result
*/
public void setResult(final List<T> result) {
this.result = result;
}
/**
* 取得总记录数,默认值为-1.
*/
public int getTotalCount() {
return totalCount;
}
/**
* 设置总记录数
* @param totalCount
*/
public void setTotalCount(final int totalCount) {
this.totalCount = totalCount;
}
/**
* 根据pageSize与totalCount计算总页数,默认值为-1.
*/
public int getTotalPages() {
if (totalCount < 0)
return -1;
int count = totalCount / pageSize;
if (totalCount % pageSize > 0) {
count++;
}
return count;
}
/**
* 是否还有下一页.
*/
public boolean isHasNext() {
return (curPageNo + 1 <= getTotalPages());
}
/**
* 取得下页的页号,序号从1开始.
*/
public int getNextPage() {
if (isHasNext())
return curPageNo + 1;
else
return curPageNo;
}
/**
* 是否还有上一页.
*/
public boolean isHasPre() {
return (curPageNo - 1 >= 1);
}
/**
* 取得上页的页号,序号从1开始.
*/
public int getPrePage() {
if (isHasPre())
return curPageNo - 1;
else
return curPageNo;
}
}