ScopedQuery: 查询你需要的数据,剪裁无用字段

广告位招租
扫码页面底部二维码联系

作为前端,你肯定经常有这样的烦恼:我明明转载请注明出处:www.tangshuang.net【版权所有】唐霜 www.tangshuang.net只需要这几个字段,结果你全部给我返回了,未经授权,禁止复制转载。未经授权,禁止复制转载。何必呢?今天我发了一个包 scopedq【版权所有】唐霜 www.tangshuang.net【转载请注明来源】uery 以解决这个问题。这里 scop本文作者:唐霜,转载请注明出处。【本文首发于唐霜的博客】ed 的意思是“限定的”,也就是你进行的【版权所有,侵权必究】本文版权归作者所有,未经授权不得转载。查询是在限定的内容里面。它基于一个新的语未经授权,禁止复制转载。转载请注明出处:www.tangshuang.net言,样子大概如下:

未经授权,禁止复制转载。【原创不易,请尊重版权】【未经授权禁止转载】本文版权归作者所有,未经授权不得转载。
query "https://xxx.com/api/articles/:id" -> {
  article_title
  create_time: date('YYYY-MM-DD')
  article_content
  view_count: number
  comments: [
    {
      comment_author
      comment_content
      comment_time: data('YYYY-MM-DD')
    }
  ]
}

上面这段代码所表达的意思是,往 R【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.net20;http….̶【未经授权禁止转载】未经授权,禁止复制转载。1; 发送了一个请求,这个请求要求返回的【未经授权禁止转载】【本文首发于唐霜的博客】结果的形状,以及节点上对节点值的格式,需【未经授权禁止转载】转载请注明出处:www.tangshuang.net要按照 -> 后面的内容进行返回。

【转载请注明来源】未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。原创内容,盗版必究。

它看上去和 graphql 有点像,但又【版权所有】唐霜 www.tangshuang.net本文版权归作者所有,未经授权不得转载。很不同。它是一个描述性语言,类似 JSO【原创内容,转载请注明出处】未经授权,禁止复制转载。N,而非一个编程性语言,即 graphq【未经授权禁止转载】【原创不易,请尊重版权】l。graphql 虽然很好,但是,它依原创内容,盗版必究。本文版权归作者所有,未经授权不得转载。赖底层的建设和比较难理解的语法组织。而 【转载请注明来源】转载请注明出处:www.tangshuang.netScopedQuery 则纯粹是为了解决转载请注明出处:www.tangshuang.net【本文首发于唐霜的博客】数据裁剪而生,不负责底层库的查询,因此,原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.net它更轻量,且开箱即用。

【作者:唐霜】【原创不易,请尊重版权】
npm i scopedquery

安装好后,在业务代码中这样写作:

转载请注明出处:www.tangshua【访问 www.tangshuang.net 获取更多精彩内容】【本文首发于唐霜的博客】ng.net【原创内容,转载请注明出处】【未经授权禁止转载】原创内容,盗版必究。
import { Query } from 'scopedquery'

const data = await Query.run(`
  query "http..." -> {
    // 支持注释
    // 裁剪后的内容
  }
`)

默认情况下,内部会使用全局的 fetch【原创内容,转载请注明出处】【访问 www.tangshuang.net 获取更多精彩内容】 进行 ajax 请求,但是你可以自己定【本文受版权保护】本文版权归作者所有,未经授权不得转载。义:

转载请注明出处:www.tangshua【关注微信公众号:wwwtangshuangnet】本文作者:唐霜,转载请注明出处。ng.net本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshua【版权所有,侵权必究】原创内容,盗版必究。ng.net著作权归作者所有,禁止商业用途转载。
const query = new Query({
  fetch(url, params) {
    // ...
  }
})
const data = await query.run(`...`)

在 node 端,可以使用 Query.【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】parse 方法直接裁剪数据:

【版权所有,侵权必究】未经授权,禁止复制转载。【访问 www.tangshuang.n原创内容,盗版必究。【原创不易,请尊重版权】et 获取更多精彩内容】【本文首发于唐霜的博客】
const data = Query.parse(dataFromBackend, `{
  name: string
  age: number
}`)

冒号后面的 string, number【未经授权禁止转载】【本文首发于唐霜的博客】 看上去是类型,实际上是格式化工具,它们原创内容,盗版必究。【版权所有,侵权必究】可以被自定义,让开发者自己觉得不同情况下【访问 www.tangshuang.net 获取更多精彩内容】【本文受版权保护】怎么返回值。

未经授权,禁止复制转载。【原创不易,请尊重版权】

【本文受版权保护】本文版权归作者所有,未经授权不得转载。

基于 webpack 的能力,我们可以把【版权所有,侵权必究】【关注微信公众号:wwwtangshuangnet】这些 query 文本单独保存,这样我们未经授权,禁止复制转载。未经授权,禁止复制转载。可以极为清晰的了解每一个接口对于前端而言【转载请注明来源】【访问 www.tangshuang.net 获取更多精彩内容】,需要的是哪些内容,且有值描述,对于前后【原创不易,请尊重版权】【版权所有】唐霜 www.tangshuang.net端而言,都可以作为参考,辅助前后端在开发【转载请注明来源】【作者:唐霜】过程中进行沟通。

本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。【版权所有,侵权必究】本文版权归作者所有,未经授权不得转载。