客服电话
APP下载
迪恩网络APP
随时随地掌握行业动态
官方微信
扫描二维码
关注迪恩网络微信公众号
|
一、简介
jqGrid的参数详解：
二、jqGrid的loadonce方式 jqgrid有一种loadonce方式，后台一次提供所有数据，分页、排序都交给客户端自己去实现。这样对于数据量少的可以采用这种方式来提高效率。 前端代码如下： <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="OrderInfro.aspx.cs" Inherits="JqGridDemo.OrderInfro" %>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>jqgrid</title>
<!--引入CSS-->
<link href="themes/jquery-ui-1.9.2.custom.css" rel="stylesheet" />
<link href="themes/ui.jqgrid.css" rel="stylesheet" />
<!--引入JS-->
<script src="scripts/jquery-1.8.3.js"></script>
<script src="scripts/jquery-ui-1.9.2.custom.js"></script>
<script src="scripts/jquery.jqGrid.min.js"></script>
<script src="scripts/grid.locale-cn.js"></script>
<script type="text/javascript">
$(function () {
$("#gridTable").jqGrid({
url: 'MyOrder.ashx',//指定了请求的数据源
datatype: 'json',//数据源的格式-local、javascript、function、json、jsonstring、xml
height: 150,//表格高度
rowNum: 10,//在Grid 显示记录条数，这个参数会被传递到后台
rowList: [10, 20, 30],//一个下拉选择框，用来改变显示记录数，当选择时会覆盖rowNum参数传递到后台
colNames: ['订单ID', '客户ID', '送货人', '下单时间'],//列显示名称，是一个数组对象
colModel: [
{ name: 'OrderID', index: 'OrderID',width:100 },
{ name: 'CustomerID', index: 'CustomerID', width: 100 },
{ name: 'ShipName', index: 'ShipName', width: 160 },
{ name: 'OrderDate', index: 'OrderDate', width: 160 }
],//常用到的属性：name 列显示的名称；index 传到服务器端用来排序用的列名称；width 列宽度；align 对齐方式；sortable 是否可以排序
loadonce: true,//如果为ture则数据只从服务器端抓取一次，之后所有操作都是在客户端执行，翻页功能会被禁用
sortname: 'OrderID',//排序列的名称，此参数会被传到后台
sortorder: 'asc',//排序顺序，升序或者降序（asc or desc）
pager: '#gridPager',//定义翻页用的导航栏，必须是有效的html元素。翻页工具栏可以放置在html页面任意位置
viewrecords: true,//定义是否要显示总记录数
caption:'MyGrid'
});
})
</script>
</head>
<body>
<form >
<table >
</table>
<div >
</div>
</form>
</body>
</html>
后台代码如下： using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using BLL;
using System.Data;
using Newtonsoft.Json;
namespace JqGridDemo
{
/// <summary>
/// MyOrder 的摘要说明
/// </summary>
public class MyOrder : IHttpHandler
{
public void ProcessRequest(HttpContext context)
{
context.Response.ContentType = "text/plain";
Order OrderData=new Order ();
DataTable dt=OrderData.GetOrderInfro();
//每页显示的记录数
int pagesizes=10;
//记录总数
int rowNums=dt.Rows.Count;
//列数
int colNums=dt.Columns.Count;
//总页数
int PageCount=rowNums%pagesizes==0?rowNums/pagesizes:rowNums/pagesizes+1;
IList<object> resultobjs=new List<object>();
int ID=1;
foreach(DataRow dw in dt.Rows)
{
var cellValue=new string[colNums];
for(int i=0;i<cellValue.Length;i++)
{
cellValue[i]=dw[i].ToString();
}
var resultObs=new {
id=ID,
cell=cellValue
};
resultobjs.Add(resultObs);
ID++;
}
var resultobj = new {
total=PageCount, //总页数
page=1,//当前页码
records =rowNums,//总记录数
rows = resultobjs //数据
};
//将resultobj序列化为json数据格式
string json = JsonConvert.SerializeObject(resultobj);
context.Response.Write(json);
}
public bool IsReusable
{
get
{
return false;
}
}
}
}
这里要注意的是： 比较关键的属性出现了，jsonReader 上面的实现方式是采用了默认的json解析方式，后台代码是完全按照默认的格式生成对应的json数据。 默认的格式为
当没有提供jsonReader时，提供的json格式应该是下面这种形式：
这样就必须指定 total、page、records以及rows属性，rows里面还包括id、Cell属性，cell属性里面仅仅是单元格的值，不能包括列名。 最终效果图： 2、接下来 我们来按照自定义的jsonReader格式来加载数据。 通常情况下我们提供的json数据格式如下： {
"pagecount":10,
"pageindex":1,
"total":100,
"rows":[
{
"id":1,
"name":"keepfool"
},
{
"id":2,
"name":"pai"
}
...
]
}
pagecount 表示数据总页数、pageindex 表示单前页码，total表示记录数，rows 表示记录。这样前端的jsonReader格式就得改写，并且后台提供的json数据格式也得做修改。 代码如下： jsonReader: {
root: "rows",
page: "pageindex",
total: "pagecount",
records: "total",
repeatitems: false,
id: "0"
}
请注意这里的repeatitems属性，当repeatitems=false时jqgrid会根据返回的json数据搜索对应的列名，这个列名对应colNames中的name值。 前端： <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="OrderInfro.aspx.cs" Inherits="JqGridDemo.OrderInfro" %>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>jqgrid</title>
<!--引入CSS-->
<link href="themes/jquery-ui-1.9.2.custom.css" rel="stylesheet" />
<link href="themes/ui.jqgrid.css" rel="stylesheet" />
<!--引入JS-->
<script src="scripts/jquery-1.8.3.js"></script>
<script src="scripts/jquery-ui-1.9.2.custom.js"></script>
<script src="scripts/jquery.jqGrid.min.js"></script>
<script src="scripts/grid.locale-cn.js"></script>
<script type="text/javascript">
$(function () {
$("#gridTable").jqGrid({
url: 'MyOrder.ashx',//指定了请求的数据源
datatype: 'json',//数据源的格式-local、javascript、function、json、jsonstring、xml
height: 150,//表格高度
rowNum: 10,//在Grid 显示记录条数，这个参数会被传递到后台
rowList: [10, 20, 30],//一个下拉选择框，用来改变显示记录数，当选择时会覆盖rowNum参数传递到后台
colNames: ['订单ID', '客户ID', '送货人', '下单时间'],//列显示名称，是一个数组对象
colModel: [
{ name: 'OrderID', index: 'OrderID',width:100 },
{ name: 'CustomerID', index: 'CustomerID', width: 100 },
{ name: 'ShipName', index: 'ShipName', width: 160 },
{ name: 'OrderDate', index: 'OrderDate', width: 160 }
],//常用到的属性：name 列显示的名称；index 传到服务器端用来排序用的列名称；width 列宽度；align 对齐方式；sortable 是否可以排序
jsonReader: {
root: 'Data',
page: 'pageindex',
total: 'pagecount',
records: 'total',
repeatitems:false,
id: 0
},
loadonce: true,//如果为ture则数据只从服务器端抓取一次，之后所有操作都是在客户端执行，翻页功能会被禁用
sortname: 'OrderID',//排序列的名称，此参数会被传到后台
sortorder: 'asc',//排序顺序，升序或者降序（asc or desc）
pager: '#gridPager',//定义翻页用的导航栏，必须是有效的html元素。翻页工具栏可以放置在html页面任意位置
viewrecords: true,//定义是否要显示总记录数
caption:'MyGrid'
});
})
</script>
</head>
<body>
<form >
<table >
</table>
<div >
</div>
</form>
</body>
</html>
后台： using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using BLL;
using System.Data;
using Newtonsoft.Json;
using Component.Model;
namespace JqGridDemo
{
/// <summary>
/// MyOrder 的摘要说明
/// </summary>
public class MyOrder : IHttpHandler
{
public void ProcessRequest(HttpContext context)
{
context.Response.ContentType = "text/plain";
Order OrderData=new Order ();
DataTable dt=OrderData.GetOrderInfro();
//每页显示的记录数
int pagesizes=10;
//记录总数
int rowNums=dt.Rows.Count;
//列数
int colNums=dt.Columns.Count;
//总页数
int PageCount=rowNums%pagesizes==0?rowNums/pagesizes:rowNums/pagesizes+1;
var resultobj = new DataResult
{
//总页数
PageCount = PageCount,
//当前页
PageIndex=1,
//总记录数
total = rowNums,
//数据
rows=dt
};
//将resultobj序列化为json数据格式
string objs = JsonConvert.SerializeObject(resultobj);
context.Response.Write(objs);
}
public bool IsReusable
{
get
{
return false;
}
}
}
}
下面再介绍一种jsonReader用法，这种用法是函数形式的： jsonReader: {
repeatitems: false,
root: function (obj) { return obj.rows; },
page: function (obj) { return obj.pageindex; },
total: function (obj) { return obj.pagecount; },
records: function(obj) { return obj.total; }
},
观察一下上面所提供的寻常json写法，你会发现json数据对象里面包含rows, pageindex, pagecount,total属性，而后台输出到前端的function函数中得到的是obj对象，那么用obj.rows, obj.pageindex, obj.pagecount, obj.total就会觉得一目了然。 三、jqGrid的loadonce=false方式 上面的分页和排序都是因为loadOnce=true而让客户端帮助做了很多事，这种方式只适用于数据量少时。可是当数据量比较大时，不仅会让数据加载的很慢还有可能出现Bug。 要解决这个问题，可以把分页的事情交给服务器端来实现，而不是一次性的丢给客户端客，客户端请求那一页的数据就加载哪一页的数据。到这里一个比较关键的属性（prmNames）就起到作用了。 一般不用prmNames默认的格式，而是采用下面的这种形式： prmNames: {
page: 'PageNumber',
rows: 'PageSize',
sort: 'OrderBy',
order: 'Sort'
}
那么客户端发起请求时的链接可能就是这样的：mydata.ashx?PageNumber=1&PageSize=10&OrderBy=OrderID&Sort=desc 在后台就必须有一段代码来获取这些参数值，然后从数据库中读取对应的数据最后加载到客户端。
1、分页存储过程如下： create proc SP_GetOrdersByPage
(
@PageSize int,
@PageIndex int,
@Where nvarchar(1000),
@OrderBy nvarchar(50),
@Sort varchar(4),
@Total int output
)
as
declare @startRow int,@endRow int
--起始行索引
select @startRow = @PageSize*(@PageIndex -1) + 1
--结束行索引
select @endRow = @startRow + @PageSize - 1
--查询结果集sql
declare @query_sql nvarchar(2000)
--查询记录数sql
declare @count_sql nvarchar(2000)
set @query_sql = 'select OrderID,CustomerID,ShipName,OrderDate from
(select row_number() over(order by ' + @OrderBy + ' ' + @Sort +' ) as rowid,
OrderID,CustomerID,ShipName,OrderDate from Orders
where 1 = 1 ' + @Where + ') as Results
where rowid >='+ str(@startRow) + ' and rowid <=' + str(@endRow)
set @count_sql = 'select @Total = count(OrderID) from Orders where 1 = 1' + @Where
print @query_sql
exec sp_executesql @count_sql,N'@Total int output', @Total output
exec sp_executesql @query_sql
go
declare @Total int
exec SP_GetOrdersByPage 10,2,'','OrderID','desc',@Total output
2、还提供了一个类来专门管理参数 using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Data.SqlClient;
using System.Data;
namespace Component.Model
{
public class PageParam
{
//页码
public int PageIndex { get; set;}
//每页显示记录数
public int PageCount { get; set;}
//排序字段
public string SortName { get; set;}
//排序方式
public string SortStyle { get; set;}
//查询条件
public string Where { get; set;}
//存储过程名称
public string ProduceName { get; set;}
//总记录数,为输出参数
public int total {
get {
if(_param.Count>0)
{
return (int)_param[5].Value;
}
return 0;
}
}
//存储过程参数
IList<SqlParameter> _param=new List<SqlParameter>();
public SqlParameter[] ProducePara {
get {
if(_param.Count==0)
{
_param.Add(new SqlParameter("PageIndex", PageIndex));
_param.Add(new SqlParameter("PageSize", PageCount));
_param.Add(new SqlParameter("OrderBy", SortName));
_param.Add(new SqlParameter("Where",Where));
_param.Add(new SqlParameter("Sort", SortStyle));
//输出参数初始化
var OutputTotal = new SqlParameter
{
Direction = ParameterDirection.Output,
ParameterName = "Total",
DbType = DbType.Int32,
Size = 4
};
_param.Add(OutputTotal);
}
return _param.ToArray();
}
}
}
}
3、这里为了体现分层的思想，将业务处理另作为一层 using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data;
using Power.DataProvider;
using Component.Utility;
using Component.Model;
using Newtonsoft.Json;
namespace BLL
{
public class Order
{
//获取数据库连接字符串
string constr = Common.GetSqlConnString();
IProvider db = null;
public Order()
{
try
{
db = new SqlProvider(constr);
}
catch(Exception ex)
{
Common.Log(ex.Message);
}
}
/// <summary>
/// 获取订单信息
/// </summary>
/// <returns></returns>
public string GetOrderInfro(PageParam P)
{
DataTable dt = db.ExecuteDataTable(P.ProduceName,P.ProducePara);
//计算总页数
int pageNum = P.total % P.PageCount == 0 ? P.total / P.PageCount : P.total / P.PageCount + 1;
var dataresult = new
{
Data=dt,
PageIndex=P.PageIndex,
pagecount = pageNum,
total=P.total
};
string obj=JsonConvert.SerializeObject(dataresult);
return obj;
}
}
}
4、用了一般处理程序来处理分页 using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using BLL;
using System.Data;
using Newtonsoft.Json;
using Component.Model;
namespace JqGridDemo
{
/// <summary>
/// MyOrder 的摘要说明
/// </summary>
public class MyOrder : IHttpHandler
{
public void ProcessRequest(HttpContext context)
{
context.Response.ContentType = "text/plain";
//创建一个PagePara对象并用传递过来的参数初始化
var pagePara = new PageParam
{
PageIndex = int.Parse(context.Request["PageIndex"]),//页码
PageCount = int.Parse(context.Request["PageSize"]),//每页显示的数据条数
SortName = context.Request["OrderBy"],//排序字段
SortStyle = context.Request["Sort"],
Where=string.Empty,
ProduceName = context.Request["prodName"]
};
Order OrderInfro = new Order();
context.Response.Write(OrderInfro.GetOrderInfro(pagePara));
}
public bool IsReusable
{
get
{
return false;
}
}
}
}
四、总结 到这里一个简单的使用Jqgrid展示数据并带分页的功能就实现了。
|
请发表评论