Last Updated 2020-05-09 23:23:57

Api导读

虽然concent为实例构造的ctx上注入了很多新特性api，但是一开始你可以不需要全部了解，只需要学会以下几点就可以顺畅的使用concent。

  • 知道使用run中心化的配置模块，configure去中心化的配置模块
  • 知道使用register、registerDumb、useConcent注册组件
  • 知道使用setState、dispatch修改状态
    在此基础上，根据使用场景需要了解其他api从而逐步全盘掌握concent

实例api

在实例上下文ctx里调用的api，点击查看更多关于实例上下文

@register('foo')
class Foo extends React.Component{
  $$setup(ctx){// ctx即实例上下文
  }
  render(){
    const ctx = this.ctx;// ctx即实例上下文
  }
}

const setup = ctx=>{// ctx即实例上下文
  ctx.effect(()=>{
    // do some staff
  }, [])
}

function FooFn(){
  // ctx即实例上下文
  const ctx = useConcent({module:'foo', setup});
}

action上下文api

在reducer函数的第三位参数actionCtx里调用的api，通常我们需要在一个reducer函数里调用其他reducer函数形成调用链时需要用到actionCtx

// code in models/foo/reducer.js
export async function doOtherStaff(age){
  await api.updateAge(age);
  return {age};// 更新模块state里的age字段
}

export function doSomeStaff(payload, moduleState, actionCtx){
  //第3位参数actionCtx即是我们所指的action上下文
  actionCtx.setState({loading:true});
  actionCtx.dispatch(doOtherStaff, payload.age);
  return {name: payload.name};// 更新模块state里的name字段
}

fn上下文api

在模块computed、模块watch、实例computed、实例watch这些地方的回调函数的第三位参数即是函数上下文fnCtx，通常我们在函数体需要再次修改其他模块computed值或者模块state值的时候的时候需要用到fnCtx

  • 模块computed里使用fnCtx
// code in models/foo/computed.js
import {defComputed, defComputedVal} from 'concent';

// 对模块computed结果容器里定义一个静态值，key为bookExceedLimit，value为false
// 它不依赖任何depKeys来触发改变，但可以通过fnCtx.commitCu来修改它
export const bookExceedLimit = defComputedVal(false);

export const validCount = defComputed((newState, oldState, fnCtx)=>{
  const validCount = newState.filter(v=>v.valid).length;

  if(validCount>10){
    fnCtx.commitCu({bookExceedLimit:true});//修改bookExceedLimit值
  }
  if(validCount>20){
    fnCtx.commit({bookNoStock:true});//修改模块state里bookNoStock的值
  }

  return validCount;
}, ['books']);
  • 模块watch里使用fnCtx
// code in models/foo/watch.js
import {defWatch, defWatchImmediate} from 'concent';

export const booksChange = defWatchImmediate((newState, oldState, fnCtx)=>{
  // 此处使用fnCtx动态修改模块computed结果容器里的值
  // ...逻辑略
}, ['books']);
  • 实例computed里使用fnCtx
const setup = ctx=>{
  ctx.computed('books', (newState, oldState, fnCtx)=>{
    // 此处使用fnCtx动态修改模块computed结果容器里的值
  })
}

全局api

从concent包里直接导出，可以在任何地方调用的api

import {
  run,
  register,
  configure,
  getState,
  //... etc
} from 'concent';

除了代码里导出使用，concent将api同时也挂载到了window.cc属性下，读者可以打开浏览器console，输入cc回车，查看或使用api，仅作为开发时的辅助功能，方便通过控制台快速验证和收集反馈。