Baas平台内,同一区块链底层接口数据可能会被应用在不同的业务场景下,因此需要进行筛选或者排序等操作。为满足此类需求,通常后端需要开发新的接口或增加新的字段以满足业务诉求。但随着需求业务不断变更,往往不可避免地导致接口的修改、新增,相应的接口文档和代码的维护成本也随之骤增。
为此,趣链BaaS在实践中总结了一套标准的客户端与服务端间自定义查询语法,使客户端能便捷对数据库进行分页与筛选,从而获取满足不同业务场景的数据,同时可保障服务端接口的可扩展性。
传统接口设计的痛点
用户使用过程中,列表可能存在大量的数据,以链列表为例,一旦用户需要对自己感兴趣的信息进行筛选搜索排序,则该数据接口需要输出供用户模糊查询链名、对链状态筛选、按照创建时间排序等能力。在此场景下,典型的接口设计做法可能是:
func getChainList(string name, int state, string time) {
if len(name) != 0 {
//追加SQL条件
}
if state(name) != 0 {
//追加SQL条件
}
if len(time) != 0 && time == "desc" {
//追加SQL条件
}
}
毫无疑问,随着业务的变更接口的参数越来越多,即便封装成一个对象也会不断膨胀,无法避免重复代码问题。
最佳实践方案
对于任何一个接口而言,搜索和筛选是非常基础的功能,系统期望能够有效地向客户端应用程序提供数据,因此必须以灵活的方式构建接口,支持快速响应查询操作。
为此