分享组件使说明文档


title: 分享组件-2.0.1
type: guide
date: 2017-04-20 17:00:00
order: 7


分享流程图

  • 暂缺, 后继补充

分享效果图

  • 暂缺, 后继补充

git目录

。。。

快速使用

一. 加载依赖库; 如果已有引入无需再次引入. 依赖库有:
zepto.js
aladdin.js (口袋3.0库文件, 在口袋3.0内分享里需要,如不投到放口袋可不引入)

注意:
1.share、aladdin、zepto有依赖关系。 依次顺序为zepto--->aladdin--->share
2.aladdin需要更新最新版

二. 加载分享组件; 分享组件最新版本地址:
直接引用:
测试: /app_com/share/2.0.0/js/share.js
生产: /app_com/share/2.0.0/js/share.js

umd版依赖zepto、aladdin、jWeixin、rymApp
jWeixin与rymApp下载

三. 初始化分享参数
页面加载完后调用window.shareMode.shareInit(options), options为对象, 具体参数请参考初始化参数说明

四. 订制特殊场景分享; 如与正常流程有差异,需与产品经理于翠翠对接。

初始化参数说明

初始化参数是一个对象,主要包含“自定义分享文案”、“业务统计系列参数”、“ucp微信授权参数”、“控制UI参数”、“其他参数”5部分
一、 自定义分享文案

{
  // 自定义分享4项, title, content, picture, url
  shareObj: {
    // 分享title 必传
    title: '分享测试title',
    // 分享简介 必传
    content: '分享测试content',
    // 分享缩略图 必传
    picture: '/brop-cmp/act/assets/share/img/paBankLogo.png'
  },
  // 分享url, 折分为3部分
  shareUrlObj: {
    // 分享url, 包含请求协议,域名,目录,文件名 必传
    url: location.origin + location.pathname,
    // 分享页面需求参数, 可以为空, 如果有值以"?"开头 umMode userType 破冰业务等逻辑字段,非公共,在此传递
    search: '',
    // 分享页面需求hash值 可以为空 如果有值以"#"开头
    hash: ''
  }
}

二、业务统计系列参数

{
  // 业绩统计8大项, 根据实际需求传值
  paramObj: {
    // 反显推荐人信息使用,根据实际需要传。反显优化级:登录态用户信息 > options入参 > url上rec_no值 > 口袋sessionStorage > 记忆功能(localStorage)
    rec_no: '',
    // 推荐人类型
    rec_type: '',
    // 外部媒体来源, 取来源(url)media_source的值
    media_source: '',
    // 渠道来源, 取来源(url)channel_source的值
    channel_source: '',
    // 获客渠道, 取来源(url)source的值
    source: '',
    // 获客路径, 取来源(url)outerSource的值
    outerSource: '',
    // 活动ID号, 取来源(url)activity_Id的值
    activity_Id: '',
    // 活动的订单流水号。空值,由mgm平台随机生成
    activity_FlowId: ''
  }
}

三、控制UI参数

{
  // UI展示与隐藏。 0-不展示 1-展示 必传
  sharChannelArr: {
    // 分享按钮 0-不展示 1-展示
    btn: "0",
    // 微信好友及朋友圈
    wx: "1",
    // QQ空间
    qqZone: "1",
    // 新浪微博
    sina: "1",
    // 二维码
    erweima: "1"
  }
}

四、ucp微信授权参数

{
  // 调用ucp需求参数,
  ucpParamObj: {
    // 公众号appId 必传
    appId: '',
    // 微应用号 必传
    weappNo: '',
    // 请求ucp接口地址 必传
    ucp_url: '',
    // 页面域名 必传
    backUrl: location.origin,
     // 必传
    openid: ''
  }
}

五、其他参数

{
  // 其他统计参数; 非必传, 有实际统计需求时使用
  otherObj: {
    // 意向客户
    intentCust: '',
    // 产品编码
    productCode: '',
    // 推广单位代码
    pubOrgCode: '',
    // 分享页面类型;1-产品页; 2-活动页; 3-资讯页; 4-名片; 5-直播
    sceneCode: '',
    // 推荐人姓名
    recName: ''
  },
  // 是否自定义样式 1-自定义; 默认为空
  customCSS: '1',
  // 埋点页面title 建议传值; 默认为document.title
  webtrendsTitle: '',
  // 运行环境, stg, prd 建议传值; 初始值为prd, 如域名中带stg强制修改为stg
  environment: 'stg',
  // 是否是口袋APP2.0  建议传值; 初始值为false,如ua中能取到'paebank_app_running_anchor'强制修改为true
  isKDAPP2: false,
  // 当前活动ID, 必传 产品经理包兴丽分配
  pactivityId: ''
}

全部参数示例

var options = {
  // 自定义分享4项, title, content, picture, url
  shareObj: {
    // 分享title 必传
    title: '分享测试title',
    // 分享简介 必传
    content: '分享测试content',
    // 分享缩略图 必传
    picture: '/brop-cmp/act/assets/share/img/paBankLogo.png'
  },
  // 分享url, 折分为3部分
  shareUrlObj: {
    // 分享url, 包含请求协议,域名,目录,文件名 必传
    url: location.origin + location.pathname,
    // 分享页面需求参数, 可以为空, 如果有值以"?"开头 umMode userType 破冰业务等逻辑字段,非公共,在此传递
    search: '',
    // 分享页面需求hash值 可以为空 如果有值以"#"开头
    hash: ''
  },
  // 业绩统计8大项, 根据实际需求传值
  paramObj: {
    // 反显推荐人信息使用,根据实际需要传。反显优化级:登录态用户信息 > options入参 > url上rec_no值 > 口袋sessionStorage > 记忆功能(localStorage)
    rec_no: '',
    // 推荐人类型
    rec_type: '',
    // 外部媒体来源, 取来源(url)media_source的值
    media_source: '',
    // 渠道来源, 取来源(url)channel_source的值
    channel_source: '',
    // 获客渠道, 取来源(url)source的值
    source: '',
    // 获客路径, 取来源(url)outerSource的值
    outerSource: '',
    // 活动ID号, 取来源(url)activity_Id的值
    activity_Id: '',
    // 活动的订单流水号。空值,由mgm平台随机生成
    activity_FlowId: ''
  },
  // 调用ucp需求参数
  ucpParamObj: {
    // 公众号appId 必传
    appId: '',
    // 微应用号 必传
    weappNo: '',
    // 请求ucp接口地址 必传
    ucp_url: '',
    // 页面域名 必传
    backUrl: location.origin,
     // 必传
    openid: ''
  },
  // 调用ucp需求参数, ucp系统提供 必传
  ucpParamObj: {
    //  公众号appId 必传
    appId: '',
    // 微应用号 必传
    weappNo: '',
    //  请求ucp接口地址 必传
    ucp_url: '',
    // 页面域名
    backUrl: location.origin,
     // 必传
    openid: ''
  },
  // 其他统计参数; 非必传, 有实际统计需求时使用
  otherObj: {
    // 意向客户
    intentCust: '',
    // 产品编码
    productCode: '',
    // 推广单位代码
    pubOrgCode: '',
    // 分享页面类型;1-产品页; 2-活动页; 3-资讯页; 4-名片; 5-直播
    sceneCode: '',
    // 推荐人姓名
    recName: ''
  },
  // 是否自定义样式 1-自定义; 默认为空
  customCSS: '1',
  // 埋点页面title 建议传值; 默认为document.title
  webtrendsTitle: '',
  // 运行环境, stg, prd 建议传值; 初始值为prd, 如域名中带stg强制修改为stg
  environment: 'stg',
  // 是否是口袋APP2.0  建议传值; 初始值为false,如ua中能取到'paebank_app_running_anchor'强制修改为true
  isKDAPP2: false,
  // 当前活动ID, 必传 产品经理包兴丽分配
  pactivityId: ''
}

使用案例

请参考:
/bank/test/share/shareDemo.html

使用建议

一、 使用分享组件加一下中间层
因为分享组件需适配各特性团队不同需求,造成初始参数过多,不易理解维护。
但同一个项目调用分享组件的入参应该是一致的。因此,建议各特性团队对使用分享组件做一次封装,减少各页面调用分享组件的入参。
参考demo: bank/test/act/demo.shtml
中间层代码:activity-public.js(请自行维护更新,分享组件不维护activity-public.js)

二、 参数的传进行公共封装调用
由于8个业绩统计参数字段即有驼峰又有下划线,命名不规范,并需要在所有页面传递。故建议对此功能做统一处理
功能分两部分:

  1. 跳转到其他页面。建议封装统一跳转页面函数,统一处理业绩统计参数。
  2. 提交给后台。对请求进行统一封,增加公共业绩统计参数,字段名与数据平台sdc保持一致;参数值优先取url,没值后取cookie

常见问题

1、 3.0场景,使3.0测试包配置运行环境不是stg,造成获取不到登录态,分享流程中断
2、 环境跨域问题。需要获取登录态的场景要能正常访问到rsb 域名,登录态要与统一认证中心打通
3、 直接使用微信右上角分享将统计不到业务
4、 分享url长度超过255个字符造成任意门、微博分享失败
5、 分享文案触发微信诱导分享规则造成分享展示不正常
诱导分享请参考: http://blog.sina.com.cn/s/blog_a0d71a9d0102wkok.html


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,898评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,401评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,058评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,539评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,382评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,319评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,706评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,370评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,664评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,715评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,476评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,326评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,730评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,003评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,275评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,683评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,877评论 2 335

推荐阅读更多精彩内容

  • 目录: 1-------- 走进前端2-------- jQuery3-------- CSS4---...
    RossWen阅读 6,602评论 25 334
  • 前些日子从@张鑫旭微博处得一份推荐(Front-end-tutorial),号称最全的资源教程-前端涉及的所有知识...
    谷子多阅读 4,145评论 0 44
  • 第九篇生活忆笔,有时,自己并没有想明白做一件事情的目的是什么,就迫不及待的去干了,这让我常常犯错误。 星期四,听到...
    陌乐阅读 230评论 0 0