SNS平台与第三方APP的JS通信实现

旺旺旺旺旺仔
1 评论 6327 浏览 1 收藏 12 分钟

先看一下我们遇到了什么问题？

在我们的白社会里，需要嵌入第三方应用，而嵌入的方式是使用iframe，为了页面美观，这里就有一个最简单的需求：iframe的高度需要跟随其本身内容的变化而实时变化，这就要求主页面根据iframe的内容实时的去设置其样式height值，但是因为第三方应用和白社会不属于同一个域，所以给实现带来了一点小小的麻烦，所以才有以下的一些讨论…

仔细分析一下问题的实质是什么呢？

其实这里需要解决的是，在一个页面 A 中嵌入一个iframe 名字叫 B，A 和 B 不属于同一个域，但是 A 和 B 需要进行一些必要的通信，传递少量的数据信息，所以问题的实质就是主页面与跨域 iframe 之间怎么通信，也就是怎么传递数据信息

下面就针对两种不同的需求，总结一些比较简单，常用和稳定的解决方案。

  • 主页面A 怎么向 iframe B 传递数据
  • iframe B 怎么与 主页面A 传递数据

需求一：主页面A 与 iframe B 的怎么传数据呢？

这种方式，是主页面需要给 iframe B 传递数据，然后 iframe B 获得到数据后进行特定的处理

实现方式

实现的技巧就是利用 location 对象的 hash 值，通过它传递通信数据，我们只需要在主页面A中设置 iframe B 的 src 后面多加个 #data 字符串（data就是你要传递的数据），如下图所示：

然后在 iframe B 中通过某种方式能即时的获取到这儿 data 就可以了，其实常用的一种方式就是：

  • 1. 在 iframe B 中通过 setInterval 方法设置定时器， 监听 location.href 的变化即可获得上面的 data 信息
  • 2. 然后 iframe B 就能根据这个 data 信息进行相应的逻辑处理

需求二：iframe B 与 主页面A 的又怎么传数据呢？

这种方式，是 iframe B 需要给主页面传递数据，然后主页面根据获得到数据后进行特定的处理

实现方式

实现的技巧就是利用一个代理 IframeC，它嵌入到 iframe B 中，并且和主页面A必须保持是同域，然后我们通过它充分利用上面第一种通信方式的实现原理就能把 iframe B 的数据传递给 iframeC，接下来的问题就是怎么让iframeC把数据传递给主页面A ，如下图所示：

iframe B 向 主页面A 传递数据

因为，iframeC 和主页面是同域的，所以它们之间传递数据就变得简单多了，我们这里的方式就是使用一个经常使用的属性 window.top (也可以使用window.parent.parent)，它返回对载入浏览器得最顶层 window 对象的引用，这样我们就能直接条用主页面A中方法啦，哈哈哈，简单吧。

到此，我们做个简单分析总结

当然还有其他一些方式，也都测试过，不是浏览器兼容性不好，就是实现起来复杂，通过以上方式就能很方便的在跨域的 iframe 和主页面之间传递数据了，当然也就能解决上面提到的设置 iframe 高度的问题了，但是这种实现方式的前提也是最大的缺点就是 iframe 中的内容必须是我们可控的，但是至少我们这种实现方式是建立在浏览器的安全规则之上的，没有破坏应用本身的安全性。

进一步叨叨，实现时需要考虑的一些细节

上面的分析，其实只是一个简单的原理，在白社会里，虽然我们目前的需求还仅仅是实现第三方 iframe 形式的 App 的高度自适应，但是我们在实现的时候尽量考虑到了易用，可扩展性和可维护性，比如：

  • 让第三方 App 只需加载一个我们提供的JS种子文件就能很方便的使用我们为其提供的各种工具
  • 上面的各种工具，我们采用包的形式进行组织，最大化的实现按需加载
  • 第一条中的JS种子文件只提供基础的方法实现，并且把最常用的工具包放在里面，比如高度自适应
  • 通过种子文件，我们还提供给第三方 App 一些常用的JS工具包，而且直接使用的类似YUI3模块的动态加载机制就可使用指定的工具包
  • 对第三方 App 和 主页面传递的数据进行分类（自我调用，登录验证，传递数据等等）
  • 传递的数据使用满足特定规范的JSON格式，并通过统一的服务出口发出去，主页面提供一个统一服务接口解析数据，并根据规范调用相应的方法
  • 还有，就是版本控制的问题，为了尽量减少给第三方App带来影响，以上所有这些JS文件的版本都是采用向后兼容的策略，小版本使用服务器设置SQUID缓存特定频率的实效时间实现，大版本更新根据用户自己的需求手动更改
  • 当然，以上可能不是最优的解决方案，只是希望能给你一些帮助和引导，我们也在逐步的改进我们的一些实现方式，比如版本控制这块儿，我们也有一些问题需要解决

回过头来，我们再看点儿具体的代码

主页面A的源码

  1. /*主页面A*/
  2. <!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Transitional//EN““http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd“>
  3. <html xmlns=“http://www.w3.org/1999/xhtml“>
  4. <head>
  5. <meta http-equiv=“Content-Type“ content=“text/html; charset=utf-8“ />
  6. <title>主页面A</title>
  7. <script type=“text/javascript“ src=“/r/j-src/kola/core/kola.js“></script>
  8. <script type=“text/javascript“>
  9. function init(){
  10. document.domain = ‘bai.sohu.com’;
  12. alert(‘我是主框架，里面嵌入第三方应用的IframeB,下面开始加载第三方应用’);
  14. var iframeTag = document.getElementById(‘frameB’),
  15. iframeSrc = ‘http://10.10.92.117/test/springwang/CrossDomain/autoSetHeight/iframePage.html’;
  17. iframeTag.src = iframeSrc;
  18. iframeTag.style.display = ‘block’;
  19. };
  21. function callback(h){
  22. var iframeB = document.getElementById(‘frameB’);
  24. alert(‘IframeC调用我（主框架）接口，把IframeB的高度传给我，具体值是：’ + h);
  26. iframeB.style.height= h + 10 + ‘px’;
  27. iframeB.src += ‘#’+ h
  28. };
  29. </script>
  30. </head>
  31. <body onload=“init();“>
  32. <p>我是主页框架，我的域是：bai.sohu.com</p>
  33. <iframe id=“frameB“ name=“frameB“ style=“display:none;“ src=“”></iframe>
  35. </body>
  36. </html>

iframeB（iframePage.html）的源码

  1. <!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Transitional//EN““http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd“>
  2. <html xmlns=“http://www.w3.org/1999/xhtml“>
  3. <head>
  4. <meta http-equiv=“Content-Type“ content=“text/html; charset=utf-8“ />
  5. <title>iframeB</title>
  6. <script type=“text/javascript“ src=“/r/j-src/kola/core/kola.js“></script>
  7. </head>
  8. <body onload=“init();“>
  9. <p style=“height:500px;background-color:#EEEEEE;“>我是三方应用，我的域是：10.10.92.117</p>
  10. <iframe id=“frameC“ name=“frameC“ src=“”style=“height:1px;width:1px;display:none;“></iframe>
  11. </body>
  13. </html>
  15. <script type=“text/javascript“>
  16. function init(){
  17. alert(‘我是第三方应用，下面开始创建和主框架同域的通信通道IframC,并设置它的src，用#号传递高度值’);
  19. var iframeTag = document.getElementById(‘frameC’),
  20. iframeSrc = ‘http://bai.sohu.com/test/springwang/CrossDomain/autoSetHeight/iframePageC.html#’,
  21. pageHeight = document.documentElement.scrollHeight || document.body.scrollHeight;
  23. iframeTag.src = iframeSrc + pageHeight;
  24. iframeTag.style.display = ‘block’;
  26. window.setTimeout(function(){
  27. alert(‘主页面设置我（IframeB）的src，通过Hash（#）给我传递它收到的高度：’ + location.hash);
  28. },2000);
  29. };
  30. </script>

iframeC（iframePageC.html）的源码

  1. <script type=“text/javascript“>
  2. document.domain = ‘bai.sohu.com‘;
  3. alert(‘我（IframeC）收到iframeB通过参数（#）给我传递高度值，我现在调用主页面方法去设置IframB的高度‘);
  4. top.callback(window.location.href.split(‘#‘)[1]);
  5. </script>

完结了

希望以上简单的分析能给你当前的项目有一些些帮助，大家多多拍砖啊~~~~~~~~~~~~~~~~~~~~最后一天上班，下周休假，哇哈哈，祝大家新春愉快~~

来源：http://ued.sohu.com/article/518

更多精彩内容，请关注人人都是产品经理微信公众号或下载App
旺旺旺旺旺仔
一直很尊重奶茶，没去冰，没少糖，没少喝。
4320篇作品 34195202总阅读量
产品周报259期 | 华为官宣HarmonyOS 4.0将于8月4日亮相，网易有道正式发布“子曰”大模型
07-282890 浏览
产品周报259期 | 华为官宣HarmonyOS 4.0将于8月4日亮相，网易有道正式发布“子曰”大模型
解密微信读书：如何让用户上瘾
09-016929 浏览
解密微信读书：如何让用户上瘾
产品设计第1步：做好用户假设
04-224455 浏览
产品设计第1步：做好用户假设
重新审视「订阅制」
02-036244 浏览
重新审视「订阅制」
如何进行数据要素制度建设？
11-131912 浏览
如何进行数据要素制度建设？
评论
评论请登录

  1. 好东西

    来自北京 回复