friendly-query v1.1.0

friendly-query

一个配合url的query参数使用的工具

Table of Contents

• Background
• Install
• Usage
  • 初始化url参数的对应的数据类型
  • url参数转换为具体数据类型
  • 具体数据类型转换为url的字符串类型
• More Usage
  • 更改数据类型配置
  • 自定义数据类型
• Default support data type
• API
  • 全局方法
    • init
    • extend
    • generateUrl
  • 实例方法
    • load
    • convert
    • destroy
• License

Background

通常路由库可以处理从：/path1 => path2的跳转切换不同的页面；但是对/path1?foo=1切换到/path2?foo=2这种情况支持不是很好。如果页面对应的参数不增加到url中，用户在页面更改部分参数后，刷新页面，用户之前选择的这一部分参数就会被重置而不会选中后的页面处理；

另一种情况，如果用户从/path1?foo=1 => /path1?foo=2 => ... => /path1?foo=5，跳转多次，触发浏览器前进/后退按钮的情况；如果没有对popstate监听事件，则不能呈现url参数对应的不同页面显示。

这个工具总体来是处理这些情况，只要定义需要监听的url参数，在url发生变化后，触发对应的回调函数；能够将url的字符串参数与设定的数据类型更灵活的转换，也能够灵活将不同数据类型转换为字符串后，作为异步请求的参数，减少手动转换类型。

Install

yarn add friendly-query
# or
npm install friendly-query

Usage

初始化url参数的对应的数据类型

import { init } from 'friendly-query'

let instance = init({
  type: {
    foo: {
        type: 'String',
        value: 'foo' // value 值为默认的数据
    },
    bar: {
        type: 'IntArray',
        value: []
    },
    baz: {
        type: 'Date',
        value: new Date()
    }
  },
  // popstate 事件触发后，如果对应的url参数发生变化，则会触发该函数
  callback () {
    console.log('query update')
  }
})

url参数转换为具体数据类型

// instance 为初始化的实例
// 例子1: url为；www.example/
let queryData = instance.load()
console.log(queryData)
// 因为url的参数都为空，所以赋值为默认值
// [{
//     foo: 'foo',
//     bar: [],
//     baz: new Date()
// }]

// 例子2: url为：www.example/?foo=foovalue&bar=101,102&baz=2019-01-01
let queryData = instance.load()
console.log(queryData)
// 因为url对应的参数不为空，会取对应的值，然后经过规则处理，例如 Date 类型，会把url参数转换为 Date 类型，具体类型可以往下看
// [{
//     foo: 'foovalue',
//     bar: [101, 102],
//     baz: new Date('2019-01-01')
// }]

具体数据类型转换为url的字符串类型

// 例子1
let stringQuery = instance.convert({
    foo: 'foovalue',
    bar: [101, 102],
    baz: new Date('2019-01-01')
})
console.log(stringQuery)
// {
//     foo: 'foovalue',
//     bar: '101,102',
//     baz: '2019-01-01'
// }

// 例子2
let stringQuery = instance.convert({
    foo: 'foovalue',
    bar: []
})
console.log(stringQuery)
// {
//     foo: 'foovalue'
// }

More Usage

更改数据类型配置

例如对于IntArr的数据类型，默认根据逗号,分割多个元素，如果更改这个规则，可以在init方法的时候，传入第二个参数

import { init } from 'friendly-query'

let instance = init({
  type: {
    foo: {
        type: 'IntArray',
        value: []
    }
  },
  callback () {}
}, {
  'IntArray': {
    separator: '-' // 分隔符更改为 '-'
  }
})

// 当前url为： www.example.com/?foo=101-102-103
instance.load() // [{ foo: [101, 102, 103] }]
instance.convert({ foo: [101, 102] }) // { foo: '101-102' }

自定义数据类型

如果默认的数据类型不符合需求，可以新增数据类型：

import { init, extend } from 'friendly-query'

extend({
  'myType': {
    parse (str, value, option) {
      if (!str) return option.prefix

      return option.prefix + str
    },
    stringify (value, option) {
      return value + option.suffix
    },
    option: {
      prefix: 'type_',
      suffix: '_sf'
    }
  }
})

let instance = init({
  foo: {
    type: 'myType',
    value: ''
  }
})

// 当前url地址为： www.example.com/?foo=foovalue
instance.load() // [{ foo: 'type_foovalue' }]
instance.convert({ foo: 'foovalue' }) // { foo: 'foovalue_sf' }

更多数据类型配置可以看配置表格

Default support data type

API

全局方法

init

• 参数
  • Object|Array dataType
  • Object option（可选）
• 返回值：用于后续处理数据的对象
• 用法

初始化当前页面所有用到的url参数的类型；并全局监听 popstate 事件

import { init } from 'friendly-query'

// dataType 为对象形式
let instance = init({
  type: {
    foo: {
      type: 'Array', // 表示该参数的数据类型
      value: [] // value的值表示，如果url参数为空的时候，则使用该默认值；例如`?foo=`的时候，那么通过 load 方法得到的值，则是设定默认值空数组 []
    }
  },
  callback () {}
})

// dataType 为数组形式，url参数分成多组处理，可以对不同组别内发生改变的参数，调用该组的回调方法
// 当 popstate 事件触发时，foo 若发生变化则对应callbackFoo会被调用；若 bar 发生变化则对应callbackBar会被调用
let instance = init([{
  type: {
    foo: {
      type: 'Array',
      value: []
    }
  },
  callbackFoo () {}
}, {
  type: {
    bar: {
      type: String,
      value: ''
    }
  },
  callbackBar () {}
}])

extend

• 参数
  • Object
• 用法：

自定义参数的数据类型与数据转换方法

import { extend } from 'friendly-query'

extend({
  type1: {
    parse () {},
    stringify () {},
    option: {}
  },
  type2: {
    parse () {},
    stringify () {},
    option: {}
  }
})

其中 parse函数表示把参数从字符串形式转换为需要的数据类型，传入的参数有：

• {String} str url 对应参数的数据
• {Any} value 初始化传入该参数的默认数据
• {Object} option 该参数对应的数据类型的配置

返回值：{Any} 该参数从字符串转换后的数据类型

stringify函数表示从当前数据类型转换为写入到url的字符串类型，传入的参数有：

• {Any} value 当前参数的数据
• {Object} option 该参数的对应数据类型的配置

返回值：String 该参数从设定的数据类型转换为字符串

需要注意的是，若传入的数据类型与默认已支持的类型一致，则默认类型的处理方法会被覆盖；建议对默认支持的类型，在init方法更改对应类型的option

generateUrl

• 参数
  • String baseUrl 基础的url
  • Object formStrData 需要拼接为query参数的对象，对象每个value值都是字符串
• 返回值 String 已基础的url拼接参数的新url
• 用法

import { generateUrl } from 'friendly-query'

generateUrl('/foo', {
  bar: 'barvalue',
  baz: 'baz'
})

// 生成url: /foo?bar=barvalue&baz=baz

generateUrl('/foo?xyz=xxx', {
  bar: 'barvalue',
  baz: 'baz'
})

// 生成url: /foo?xyz=xxx&bar=barvalue&baz=baz

通常情况可以，可以配合实例方法convert来使用：

let newUrl = generateUrl('/foo', instance.convert({
  date: new Date('2019-01-01'),
  bar: [1, 2, 3]
}))
// 更改当前的url
window.history.pushState(null, null, newUrl)

// 生成的url为： /foo?date=2019-01-01&bar=1,2,3

实例方法

实例是指：init()函数返回的对象

load

• 参数： 无
• 返回值：Array 转换后的url参数数据；数组的每个元素为init传入的分组参数对应
• 用法

获取当前url参数转化后的数据类型

instance.load()

convert

• 参数：
  • {Array|Object} groupQuery 需要从设定的数据类型转换为url参数所用的字符串类型
  • {Boolean} isMerged 对转换后的数组字符串数据合并到一个对象中，默认合并
• 返回值：Array|Object 根据参数分组返回对应转换后的字符串数据
• 用法

// 例子1:
instance.convert({
  date: new Date('2019-01-01'),
  fooArray: [101, 102]
})
// [{
//   date: '2019-01-01',
//   fooArray: '101,102'
// }]

// 例子2:
instance.convert([
  {
    date: new Date('2019-01-01')
  },
  {
    fooArray: [101, 102]
  }
])
// [
//   {
//     date: '2019-01-01'
//   },
//   {
//     fooArray: '101,102'
//   }
// ]

destroy

• 参数： 无
• 用法

移除当前页面监听的事件与内部事件

instance.destroy()

注意：当从不同路由切换的时候，需要在路由切换前，先执行destroy方法，否则会重复监听事件

License

MIT