vitality-sdk v2.2.36

vitality-sdk 使用说明

config (配置项)

云开发环境相关

获取云开发环境配置:

const cloudEnv = require('vitality-sdk/config/cloud-env-config')
cloudEnv.DEV // dev环境ID
cloudEnv.RELEASE // release环境ID

utils (辅助工具类)

列表工具

const arrayUtils = require('vitality-sdk/utils/array-utils')
arrayUtils.sortClass(arrObj) // 将对象数组按指定字段分组
arrayUtils.splitArrayByLength(length, step = 10) // 根据总长度切割成二维数组(左闭右开)
arrayUtils.splitArrayByStep(arr, step = 10) // 按照步长切分列表为二维列表

日期工具

const dateUtils = require('vitality-sdk/utils/date-utils)
dateUtils.getWeek(date) // 返回入参日期对象的星期描述, 比如: 周一, 周二

断言工具

使用方式:

const assertUtils = require('vitality-sdk/utils/assertUtils')
assertUtils.strNotEmpty(string, errorMessage) // 字符串不能为 null || undefined || ''
assertUtils.numberNotZero(number)  // 数字不能为0

环境辅助工具

使用方式:

const cloudEnvUtils = require('vitality-sdk/utils/env-utils')
cloudEnvUtils.getCurrectEnv() // 返回当前环境枚举: dev, ppe, prod
cloudEnvUtils.isDevelopment() // 是否是开发环境
cloudEnvUtils.isPPE() // 是否是预发环境(暂时不会用到)
cloudEnvUtils.isProduction() // 是否是线上生产环境
cloudEnvUtils.getEnvId() // 根据当前所在环境返回对应的云环境ID

钱币工具

const moneyUtils = require('vitality-sdk/utils/money-utils')
moneyUtils.transCentToYuan(cent) // 将分单位数值转换为元单位, 并截断保留两位小数

响应体结构工具

使用方式:

const responseUtils = require('vitality-sdk/utils/response-utils')
responseUtils.buildSuccess(data, msg)  // 返回成功结构体
responseUtils.buildFailure(msg, errorCode)  // 返回失败结构体

字符串工具

使用方式:

const stringUtils = require('vitality-sdk/utils/string-utils')
stringUtils.isEmpty(string) // 字符串是否为null || undefined || ''
stringUtils.isNotEmpty(string) // !isEmpty
stringUtils.randomString(length) // 生成指定长度的随机字符串[A-Z][a-z][0-9]
stringUtils.toChineseNum(number) // 将数字转换成中文数字.

缓存工具

接口级缓存

使用方式:

const { apiCache } = require('vitality-sdk/api-cache')
// 定义业务查询函数
async function queryOrders(params) {
  // do something
  return [...]
}
// 配置缓存过期时间
queryOrders.__apiCache__ = {
  expireSec: 10
}
// 包装业务函数对象
const wrapFunction = apiCache(queryOrders)
// 调用包装函数
return wrapFunction(params)

直接使用redis客户端

使用方式:

const { getInstance: getRedisInstance } = require('vitality-sdk/redis')
// 为尽量减少redis实例建立的连接数, 创建redis实例的动作应放在全局, 不要放在业务函数内
const _redis = getRedisInstance()
return _redis.get('key')

异常

异常类型定义

SilenceError (待废弃)

该类型异常不会触发云函数的告警通知, 但依然会导致api返回失败的结果. 适用于预期内的业务异常.

使用方式:

const { SilenceError } = require('vitality-sdk/errors')

throw new SilenceError('库存不足, 扣减失败')

BusinessError (待补充)

SystemError (待补充)

业务枚举

交易类

require('vitality-sdk/enums/trade-enums')

• TourismRefundOrderStatusEnum - 逆向单状态
• TradeOrderStatusEnum - 正向订单状态
• GroupStatusEnums - 拼团状态
• FulfillOrderStatus - 履约单状态
• JoinGroupStatus - 是否参团成功
• RefundResourceTypeEnum - 逆向单资源类型
• PayToolEnum - 支付工具类型
• RefundReason - 退单原因

商品类

require('vitality-sdk/enums/commodity-enums')

• TourismItemCategoryToChinese - 二级类目对应的中文名称
• ScheduleTypeToChinese - 行程类型对应的中文名称
• ItemCategoryEnums - 一级类目对应的二级类目, 以及每个类目的value和中文名称
• TourismItemStatus - 商品状态

营销类

require('vitality-sdk/enums/promotion-enums')

• TourismCouponStatusEnum - 券实例状态
• TourismCouponTemplateStatusEnum - 券模板状态

用户类

require('vitality-sdk/enums/user-enums')

• CreditAccountSourceType - 积分来源类型
• CreditAccountSourceTypeToChinese - 积分来源类型中文说明
• CreditAccountRecordOperationEnum - 积分记录操作类型
• CreditAccountRecordOperationEnumToChinese - 积分记录操作类型中文说明

风采相关等类

require('vitality-sdk/enums/presence-enums')

• PostTypeEnum - 风采类型
• PostStatusEnum - 风采状态
• ReplyStatusEnum - 评论状态
• ReplyBelongTypeEnum - 评论归属对象的类型
• ReplyObjectTypeEnum - 评论对象类型
• ReplyObjectTypeToDataBaseEnum - 评论对象类型对应数据库
• NotifyEventObjectTypeEnum - 通知事件对象类型枚举
• NotifyEventActionEnum - 通知事件动作枚举
• NotifyEventStatusEnum - 通知事件状态枚举
• CreditAccountStatusEnum - 积分账户状态
• ActivityEnrollStatus - 报名记录状态
• VoteRuleLimitCycle - 投票规则中限制的周期
• ActivityParticipantType - 活动报名主体类型
• ActivityVoteSummaryObjectType - 活动内冗余的投票实体类型
• MusicAlbumStatusEnum - 音乐相册状态
• AppraiseEnum - 评价类型

服务通知

require('vitality-sdk/enums/subscribeNotification-enums')

• WxNotificationEnum - 服务通知模板id
• StatusEnum - 服务通知状态
• ErrorMsgEnum - 失败类型枚举