视图参数

View.js 支持 视图参数 和 视图选项 两种数据传递媒介。本文将介绍第一种传递媒介:视图参数。

概述

视图参数,是借助内存传导的,用于在视图之间交换数据,实现跨页面协作的数据传递媒介。

开发者只能在 视图跳转 时指定视图参数。支持指定视图参数的视图跳转 API 包括:

  1. View.navTo()

  2. View.changeTo()

  3. View.back()

  4. View.forward()

视图参数只能使用 js 传导,不能使用 html 指令传导。

参数赋值

视图参数在跳转指令中使用预留关键字:params 指定,例如:

action.js
action.js
/**
* 以“压入堆栈”的方式跳转至 default 命名空间下, ID为 targetVieWId 的视图
*
* 第一个参数指定了跳转目标;
* 第二个参数指定了跳转控制选项,其中,关键字:'params' 用于指定视图参数集合。
*/
View.navTo("targetViewId", {
/**
* 开发者可以在视图参数集合指定任意数量的参数,参数取值可以是
* 任意合法的js类型
*/
params: {
paramName1: "boo",/* 传导字符串 */
paramName2: true,/* 传导枚举值 */
paramName3: ['str', 123, false, new Object()],/* 传导数组 */
paramName4: View.find(".container"),/* 传导DOM元素 */
paramName5: function(data){doSth(data);}/* 传导回调方法 */
}
});

视图参数只能以集合的形式批量设置,不能按参数名分别设置。

参数检索

View.js 提供了如下 API 以供开发者检索视图参数:

  1. view.hasParameter(name: string): boolean 用于判断视图参数中是否含有指定名称的参数

  2. view.getParameter(name?: string): null|any 获取视图参数中指定名称的参数取值。如果没有指定参数名,则返回整个参数集合。

例如:

init.js
init.js
var view = View.ofId("targetViewId");
/**
* 视图进入时检索参数
*/
view.on("enter", function(){
var param1 = view.getParameter("paramName1"); // -> "boo"
var param2 = view.getParameter("paramName2"); // -> true
var param3 = view.getParameter("paramName3"); // -> ['str', 123, false, {}]
var param4 = view.getParameter("paramName4"); // -> HTMLDivElement
var param5 = view.getParameter("paramName5"); // -> function(){...}
var params = view.getParameter();/* 获取整个参数集合 */
console.log(params["paramName1"] === param1); // -> true
console.log(params["paramName2"] === param2); // -> true
console.log(params["paramName3"] === param3); // -> true
console.log(params["paramName4"] === param4); // -> true
console.log(params["paramName5"] === param5); // -> true
});

需要注意的是,视图离开后,getParameter() 方法仍然可以获取到最后一次传入的参数。但重新进入视图时,再次调用将获取到新传入的参数。

如果再次进入时,程序不便于提供参数,此时开发者将得到 null 。对此,开发者可以手动将其存放至 视图上下文 中,然后从上下文中检索。例如:

init.js
init.js
var view = View.ofId("targetViewId");
/**
* 监听事件:“视图进入”,并在参数非空时,更新视图上下文
*/
view.on("enter", function(){
var params = view.getParameter();
if(null != params)
/**
* View 的每个实例都有其自己专用的数据存取上下文,
* 开发者可以使用 viewInstance.context 取得该
* 上下文
*/
view.context.set("params", params);
}
});
/**
* 在视图离开后检索参数
*/
view.on("leave", function(){
var params = view.getParameter();
console.log(params); // -> null
params = view.context.get("params");
console.log(params.paramName1); // -> "boo"
});

由于上述场景是开发者经常遇到的,为简化开发工作,View.js 自 v1.6.3 版本开始默认支持有效视图参数的自动保存(至上下文),结合 view.seekParameter() 方法,开发者无需再手动存取。

参阅方法: 1. view.setIfAutoSaveParamsToContext() 2. view.seekParameter()

参数名区分大小写

回调方法

开发者可以借助视图参数传递任意类型的参数,包括 Funtion,以实现更灵活的页面协作,例如:“选择收货地址”。

实现思路为:

  1. 用户在 “确认订单” 页面点击 “收货人” 时,界面跳转至 “收货地址列表”,并传递回调方法:“用户点选特定收货地址时要执行的方法”,方法内部实现用户选择的收货地址的渲染等

  2. “收货地址列表” 界面监听用户对 “收货地址” DOM 元素的点击事件,并在点击时执行收到的回调方法,并将DOM元素关联的收货地址信息传递进去

代码如下:

确认订单页面
收货地址列表界面
确认订单页面
var view = View.ofId("confirm-order");
/**
* view.find() 方法等同于 view.getDomElement().querySelector(),
* 用于查找视图的DOM骨架中,符合给定选择器的DOM元素
*/
var consigneeObj = view.find(".consignee"),
consigneeNameObj = view.find(".consignee-name"),
consigneePhoneObj = view.find(".consignee-phone"),
consigneeAddressObj = view.find(".consignee-address");
/**
* 点击 收货人 DOM元素时,跳转至收货地址列表界面
*/
Hammer(consigneeObj).on("tap", function(){/* Hammer.js 是一款优秀的第三方框架,用于处理触摸事件 */
View.navTo("consignee-list", {
params: {
/**
* 指定参数:“用户点选特定收货地址时要执行的方法”
*
* 注:
* 1. 参数名:'selectCallback' 由 确认订单 页面
* 与 收货地址列表 界面共同约定
*
* 2. 回调方法的参数:consignee 同样由两个页面共同
* 约定,用于代表用户选择的收货地址信息
*/
selectCallback: function(consignee){
/* 将用户选择的收货地址信息更新至 确认订单 界面中 */
consigneeNameObj.innerHTML = consignee.name;
consigneePhoneObj.innerHTML = consignee.phone;
consigneeAddressObj.innerHTML = consignee.address;
}
}
});
});
收货地址列表界面
var view = View.ofId("consignee-list");
/** 收货地址列表 */
var consigneeListObj = view.find(".list");
/**
* 在整个列表上创建监听,而非每个地址上分别创建,以减少监听器的个数
*/
Hammer(consigneeListObj).on("tap", function(e){
var target = e.srcEvent.target;
/* 如果点击的不是 收货地址上的“选择”按钮,则什么也不做 */
if(!target.classList.contains("select"))
return;
/**
* "data" 属性不是浏览器自带的,而是在构建收货地址的 DOM 元素时,
* 由程序主动附加在“选择”按钮上的,用于关联对应收货地址信息的key
*/
var consigneeData = target.data;
/* 执行收到的回调方法 */
var selectCallback = view.getParameter("selectCallback");
if(typeof selectCallback === "function"){
View.back();/* 返回到“确认订单”页面 */
selectCallback(consigneeData);
}
});