3、集合和分页的处理
在很多接口里面,我们都需要用到分页的处理,Web API也不例外,这样可以提交数据检索效率,减少服务器数据处理的压力,同时也提交客户端的数据显示速度。
一般的集合接口定义如下所示(通用性基类接口)。
/// 《summary》
/// 返回数据库所有的对象集合
/// 《/summary》
/// 《returns》指定对象的集合《/returns》
[HttpGet]
public virtual List《T》 GetAll(string token)
{
//检查用户是否有权限,否则抛出MyDenyAccessException异常
base.CheckAuthorized(AuthorizeKey.ListKey, token);
List《T》 list = baseBLL.GetAll();
return list;
}
但是这样的返回记录会比较多,一般情况下需要分页,那么分页的处理接口定义如下所示。
/// 《summary》
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// 《/summary》
/// 《returns》指定对象的集合《/returns》
[HttpPost]
public virtual PagedList《T》 FindWithPager(string condition, PagerInfo pagerInfo, string token)
分页接口,在这里返回的结果里面,用了一个PageList的泛型类,这个方便我们获取当前的记录及总数,它的定义如下所示。
/// 《summary》
/// 分页集合
/// 《/summary》
/// 《typeparam name=“T”》对象《/typeparam》
public class PagedList《T》
{
/// 《summary》
/// 返回记录的总数
/// 《/summary》
public int total_count { get; set; }
/// 《summary》
/// 列表集合
/// 《/summary》
public List《T》 list { get; set; }
}
最后整个分页的处理Web API接口实现如下所示。
/// 《summary》
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// 《/summary》
/// 《returns》指定对象的集合《/returns》
[HttpPost]
public virtual PagedList《T》 FindWithPager(string condition, PagerInfo pagerInfo, string token)
{
//检查用户是否有权限,否则抛出MyDenyAccessException异常
base.CheckAuthorized(AuthorizeKey.ListKey, token);
List《T》 list = baseBLL.FindWithPager(condition, pagerInfo);
//构造成Json的格式传递
var result = new PagedList《T》() { total_count = pagerInfo.RecordCount, list = list };
return result;
}
最后客户端调用分页的Web API代码如下所示。
/// 《summary》
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// 《/summary》
/// 《param name=“condition”》查询的条件《/param》
/// 《param name=“pagerInfo”》分页实体《/param》
/// 《returns》指定对象的集合《/returns》
public virtual List《T》 FindWithPager(string condition, ref PagerInfo pagerInfo)
{
var action = “FindWithPager”;
string url = GetTokenUrl(action) + string.Format(“&condition={0}”, condition);
var postData = pagerInfo.ToJson();
List《T》 result = new List《T》();
PagedList《T》 list = JsonHelper《PagedList《T》》.ConvertJson(url, postData);
if (list != null)
{
pagerInfo.RecordCount = list.total_count;//修改总记录数
result = list.list;
}
return result;
}
4、混合框架界面整合Web API接口
在整个Web API的平台构建以及在混合框架的整合过程中,我把各个模块还是遵循相对独立的方式进行开发和整合,它们实现了从直接访问数据库、以WCF服务获取数据,以及通过WebAPI调用方式获取数据几种方式的统一,从而实现了整个混合框架的高度整合。
整个混合框架的核心是以相对独立的方式,整合各个可重用的模块,我们可以遵循一定的基础上,快速构建统一的应用平台。
搭建完毕的整个WebAPI平台,其中包括了服务端内容,以API控制器的方式,发布了对应的Web API接口。
在每个混合框架的独立模块里面,我们封装了对应的Web API客户端调用处理,从而实现了Web API的调用方式。
在Win10下,使用Web API模式运行混合框架,获得的主体界面效果如下所示。
独立模块权限管理系统界面如下所示。
评论
查看更多