helper对象

在自定义函数中，可以通过 helper 对象调用平台提供的各种 API 方法，用于实现复杂业务逻辑。

概述

helper 是注入到自定义函数执行上下文中的全局对象，提供了参数操作、缓存管理、存储访问、组件通信、日志输出、数据处理等能力。

API 方法列表

组件局域参数操作

方法	说明	参数	返回值
`hasParam(key)`	判断是否存在指定参数	`key` (string): 参数名	`boolean`
`getParam(key)`	获取指定参数值	`key` (string): 参数名	参数值，不存在时返回 `undefined`
`setParam(key, value)`	设置参数值	`key` (string): 参数名 `value`: 参数值	无

数据缓存（事件级别）

方法	说明	参数	返回值
`getDataCache(key)`	获取数据缓存	`key` (string): 缓存键名	缓存值
`setDataCache(key, value)`	设置数据缓存	`key` (string): 缓存键名 `value`: 缓存值	无
`getRuleDataCache(key)`	获取规则数据缓存	`key` (string): 缓存键名	缓存值
`setRuleDataCache(key, value, replace)`	设置规则数据缓存	`key` (string): 缓存键名 `value`: 缓存值 `replace` (boolean): 是否替换已有值，默认 `false`	无

容器参数

方法	说明	参数	返回值
`getContainerParam(key)`	获取容器参数	`key` (string): 参数名	参数值

存储操作

方法	说明	参数	返回值
`setSessionParam(key, value)`	设置 SessionStorage	`key` (string): 键名 `value`: 值	无
`getSessionParam(key)`	获取 SessionStorage	`key` (string): 键名	存储值
`setLocalParam(key, value)`	设置 LocalStorage	`key` (string): 键名 `value`: 值	无
`getLocalParam(key)`	获取 LocalStorage	`key` (string): 键名	存储值

方法	说明	参数	返回值
`setJsCookie(key, value, expires)`	设置 Cookie	`key` (string): 键名 `value`: 值 `expires` (number): 过期天数，默认 30 天	无
`getJsCookie(key)`	获取 Cookie	`key` (string): 键名	Cookie 值
`removeJsCookie(key)`	删除 Cookie	`key` (string): 键名	无

组件通信

方法	说明	参数	返回值
`callCompMethod(id, methodName, param)`	调用组件方法	`id` (string): 组件 ID `methodName` (string): 方法名 `param` (object): 参数，默认 `{}`	无
`callCompWrapMethod(id, methodName, param)`	调用组件包装方法（带返回值）	`id` (string): 组件 ID `methodName` (string): 方法名 `param` (object): 参数，默认 `{}`	组件方法返回值
`hideAndShowComp(id, flag, options)`	隐藏/显示组件	`id` (string): 组件 ID `flag` (boolean): `true` 显示，`false` 隐藏 `options` (object): 额外选项，默认 `{}`	无
`closeDialog(id)`	关闭弹窗	`id` (string): 弹窗组件 ID	无

日志输出

方法	说明	参数	返回值
`log(type, msg)`	输出日志到控制台	`type` (string): 日志类型，可选 `'log'`、`'info'`、`'warn'`、`'error'`，默认 `'log'` `msg`: 日志内容	无

数据校验

方法	说明	参数	返回值
`isNotEmptyStr(val)`	判断字符串是否非空	`val`: 待判断的值	`boolean`

加密与哈希

方法	说明	参数	返回值
`md5(val)`	计算 MD5 哈希值	`val`: 待加密的字符串	MD5 字符串

日期时间

方法	说明	参数	返回值
`getDate(_date)`	获取日期对象	`_date`: 日期字符串或时间戳	Date 对象
`formatDate(_date, format)`	格式化日期	`_date`: 日期对象或字符串 `format` (string): 格式，默认 `'yyyy-MM-dd'`	格式化后的日期字符串
`addYears(_date, _years)`	日期加年份	`_date`: 原日期 `_years` (number): 增加的年数	新日期
`addMonths(_date, _months)`	日期加月份	`_date`: 原日期 `_months` (number): 增加的月数	新日期
`addDays(_date, _days)`	日期加天数	`_date`: 原日期 `_days` (number): 增加的天数	新日期
`addHours(_date, _hours)`	日期加小时	`_date`: 原日期 `_hours` (number): 增加的小时数	新日期
`getStartOfDay(_date)`	获取日期当天的开始时间	`_date`: 原日期	当天 00:00:00
`getStartOfMonth(_date)`	获取日期所在月份的开始时间	`_date`: 原日期	当月 1 日 00:00:00
`getStartOfYear(_date)`	获取日期所在年份的开始时间	`_date`: 原日期	当年 1 月 1 日 00:00:00

数字格式化

方法	说明	参数	返回值
`getNumberFormat()`	获取数字格式化工具	无	NumberFormat 对象
`formatNum(val, minDecimals, maxDecimals, useGrouping)`	格式化数字	`val`: 数字值 `minDecimals` (number): 最小小数位数，默认 0 `maxDecimals` (number): 最大小数位数，默认 3 `useGrouping` (boolean): 是否使用千分位分隔，默认 `false`	格式化后的数字字符串

JSON 处理

方法	说明	参数	返回值
`getJsonObject(_obj, _expReturnVal)`	安全获取 JSON 对象	`_obj`: 待处理对象 `_expReturnVal`: 异常时返回的默认值	JSON 对象或默认值
`toJsonStr(_obj)`	将对象转换为 JSON 字符串	`_obj`: 待转换对象	JSON 字符串

自定义函数扩展

方法	说明	参数	返回值
`customFunction(functionName, ...args)`	调用注册的自定义函数	`functionName` (string): 函数名 `...args`: 可变参数列表	返回 `{ flag, msg, data }` 结构 - `flag`: 是否执行成功 - `msg`: 错误信息 - `data`: 函数返回值

WARNING

customFunction时接入方扩展的方法，可以调用哪些函数及其参数和返回，需要参考接入方的文档说明

组件属性操作

方法	说明	参数	返回值
`setPropValue(key, value)`	设置组件 Prop 属性值	`key` (string): 属性名 `value`: 属性值	无
`getPropValue(key)`	获取组件 Prop 属性值	`key` (string): 属性名	属性值

组件样式操作

方法	说明	参数	返回值
`setStyleValue(key, value)`	设置组件 Style 样式值	`key` (string): 样式属性名 `value`: 样式值	无
`getStyleValue(key)`	获取组件 Style 样式值	`key` (string): 样式属性名	样式值

路由操作

方法	说明	参数	返回值
`routerPush(name, params)`	按名称跳转路由	`name` (string): 路由名称 `params` (object): 路由参数	无
`routerPush2(path, params)`	按路径跳转路由	`path` (string): 路由路径 `params` (object): 路由参数	无
`routerReplace(path)`	替换当前路由	`path` (string): 路由路径	无

TIP

除了以上方法外，当前组件可能提供特有的方法，需要参考业务组件详细的说明