用 RxJS、RxWX 编写微信小程序

2018-02-06 11:07:36 浏览数 (1)

RxJS

RxJS是微软推出的ReactiveX系列,符合纯函数特点的第三方开源库有非常著名underscore和lodash,以及更加强大的RxJS。它可以用来优雅地处理异步和事件。主要通过它的核心类型Observable,以及强大的操作符 (map、filter、reduce、every等,其中大部分都是纯函数)来实现。

官方给它最直白的定义是:可以把 RxJS 当做是用来处理事件的 Lodash 。

使用RxJS的代码消除了一些中间变量,使用操作符来分步执行逻辑,可读性更强、耦合性更低,更方便测试和修改。关于RxJS在web端和node.js服务端的应用都不乏文章,这一次突破常规,来讲一讲在微信小程序开发中的使用。

小程序

直接在小程序中使用RxJS是会报错的,所以我建立了一个开源项目来解决这个问题:RxWX(项目地址:https://github.com/yalishizhude/RxJS )。

封装了两个js文件。

  • Rx.js。对Rx.js进行了一些修改使其能在小程序中运行。
  • RxWX.js。基于Rx.js对微信的api进行了封装,调用同名API不再使用回调,而是返回Observalbe对象。

安装

提供两种安装途径

  • Github
  • git clone https://github.com/yalishizhude/RxWX.git

可以直接下载项目,将根目录的Rx.js和RxWX.js复制到小程序项目中,也可以访问该网址复制粘贴这两个文件内容。

npm npm i rxjs-wx 将node_modules/rxjs-wx目录下的Rx.js和RxWX.js复制到小程序项目中。

使用

小程序的API大多数都不是按照纯函数的思想设计的,把返回结果赋值给入参的success、fail、complete属性。

在逻辑简单复杂的情况下很容堕入“回调地狱”,而且同步和异步的接口调用方式也不一致。而使用RxJS就可以解决这些问题,下面来看几个例子。

处理回调

假设有这样一个需求,先通过 wx.getUserInfo 获取用户信息,然后传给后端服务获取该用户其它信息,显示在页面上。

代码语言:js复制
// 普通代码let self = thiswx.getUserInfo({  success: (res) => {
    wx.request({      method: 'GET',      url: 'xxx/user',      data: res.userInfo,
      success(r) {
        self.setData({userInfo:r})
      },
      fail(e) {
        self.setData({userInfo:'not found'})
      }
    })
  },
  fail(e) {    console.error(e)
  }
})// 使用RxWXimport obs from './RxWX'obs.getUserInfo()
  .catch(e => console.error(e))
  .switchMap(({ userInfo }) => obs.request({ method: 'GET', url: 'xxx/user', data: user }))
  .subscribe(userInfo => self.setData({ userInfo: r }), e => self.setData({ userInfo: 'not found' }))

处理事件

曾经在开发小程序的时候使用navigator组件碰到一个比较严重的问题:快速多次点击的时候会发生多次页面跳转,跳转完成后需要多次点击“返回”才能退回到原页面。

为了解决这个问题,一般可以手动绑定事件,然后进行一个防抖操作。

代码语言:js复制
// 普通代码let tapping = false...
tap(e) {  if(!tapping) {
    wx.navigateTo({ url: '../demo/demo' })
    tapping = true
    setTimeout(() => tapping=false, 1000)
  }
}// 使用RxWXimport obs from './RxWX'tap(e) {
  obs.navigateTo({ url: '../demo/demo' })
  .debounce(1000)
  .subscribe()
}

RxWX使用场景

微信小程序SDK版本:1.7.0 微信开发者工具版本:1.01

演示项目下载地址: https://github.com/yalishizhude/RxWX/tree/master/example

Get started 按照RxWX说明,把Rx.js和RxWX.js文件放入到utils目录下。 其中Rx.js是可运行在小程序中的Rx.js模块,RxWX.js是利用Rx.js对小程序API进行的封装,封装后API函数将返回Observable对象,属性值不变。 使用时必须引入该文件,比如import rxwx from '../../utils/RxWX.js'同步API与异步API

代码语言:js复制
// 原写法
try {
  let result = wx.removeStorageSync('xx')
  console.log(result) 
} catch(e) {
  console.error('小程序API发现错误')
}
// 使用RxWX
import rxwx from '../../utils/RxWX.js'
rxwx.removeStorageSync('xx')
  .catch((e) => console.error('RxWX发现错误'))
  .subscribe((resp) => console.log(resp))

看上去好像没太大区别。别着急,接着我们来继续看看异步API的调用~

代码语言:js复制
// 原写法
wx.removeStorage({
  key: 'xx',
  success: function(res) {
    console.log(res)
  },
  error: function(e) {
    console.error('小程序API发现错误')
  }
})
// 引用RxWX,rxwx具有wx的所有函数和值,但是调用函数返回的是Observable对象
import rxwx from '../../utils/RxWX.js'
rxwx.removeStorage({key: 'xx'})
  .catch((e) => console.error('RxWX发现错误'))
  .subscribe((resp) => console.log(resp)

在调用同步时RxWX没有太大优势,但在调用异步API的时候以流的方式来处理结果和异常,显然优于回调。而且代码内容和同步调用方式相比并无变化(只修改了函数名和入参)。

这种统一的操作方式可以让开发者更好的关注业务逻辑,而不需要去分辨API到底是异步还是同步,执行结果到底是在回调中获取还是返回值获取。

这种处理方式是不是让你想起点什么?欢迎留言讨论~

嵌套登录后获取用户信息

代码语言:js复制
// 调用小程序原生API
wx.login({
  success(res) {
    wx.getUserInfo({
      success(res) {
        console.log(res.userInfo)
      },
      fail(e) {
        console.error(e)
      }
    })
  },
  fail(e) {
    console.error(e)
  }
})
// 调用RxWX
import rxwx from '../../utils/RxWX.js'
rxwx.login()
  .switchMap(() => rxwx.getUserInfo())
  .catch(e => console.error(e))
  .subscribe(res => console.log(res.userInfo))

原生写法很容易坠入回调地狱,而利用RxWx的代码直观易读。

合并 同时获取用户信息和系统信息后进行操作。

代码语言:js复制
// 调用小程序API
let getUser =  new Promise((success, fail) => {
  wx.getUserInfo({
    success,
    fail
  })
})
let getSystem =  new Promise((success, fail) => {
  wx.getSystemInfo({
    success,
    fail
  })
})
Promise.all([getUser, getSystem])
.then((resp) => console.log(resp), e => console.error(e))
// 调用RxWX
import rxwx, {Rx} from '../../utils/RxWX.js'
Rx.Observable.zip(rxwx.getUserInfo(), rxwx.getSystemInfo())
  .catch(e => console.error(e))
  .subscribe(resp => console.log(resp)

其他

RxWX同时还支持wx对象的其它非函数属性,比如:

代码语言:js复制
import obs from './RxWX'console.log(obs.version) 
// {info:"", updateTime:"2017.7.10 19:35:05", version:"1.4.0"}

最后

RxJS和RxWX是第三方库,也是进入纯函数世界的大门,更是一种编写更好代码的思维方式。

0 人点赞