淺談高大上的微信小程序中渲染html內容—技術分享

大部分Web應用的富文本內容都是以HTML字符串的形式存儲的,經過HTML文檔去展現HTML內容天然沒有問題。可是,在微信小程序(下文簡稱爲「小程序」)中,應當如何渲染這部份內容呢?html

解決方案前端

wxParsevue

小程序剛上線那會兒,是沒法直接渲染HTML內容的,因而就誕生了一個叫作「 wxParse 」的庫。它的原理就是把HTML代碼解析成樹結構的數據,再經過小程序的模板把該數據渲染出來。node

rich-textandroid

前端精品教程:百度網盤下載web

後來,小程序增長了「rich-text」組件用於展現富文本內容。然而,這個組件存在一個極大的限制: 組件內屏蔽了全部節點的事件 。也就是說,在該組件內,連「預覽圖片」這樣一個簡單的功能都沒法實現。面試

web-view算法

再後來,小程序容許經過「web-view」組件嵌套網頁,經過網頁展現HTML內容是兼容性最好的解決方案了。然而,由於要多加載一個頁面,性能是較差的。編程

當「WePY」趕上「wxParse」小程序

基於用戶體驗和功能交互上的考慮,咱們拋棄了「rich-text」和「web-view」這兩個原生組件,選擇了「wxParse」。然而,用着用着卻發現,「wxParse」也不能很好地知足須要:

  • 咱們的小程序是基於「WePY」框架開發的,而「wxParse」是基於原生的小程序編寫的。要想讓二者兼容,必須修改「wxParse」的源代碼。
  • 「wxParse」只是簡單地經過image組件對原img元素的圖片進行顯示和預覽。而在實際使用中,可能會用到雲存儲的接口對圖片進行縮小,達到「 用小圖顯示,用原圖預覽 」的目的。
  • 「wxParse」直接使用小程序的video組件展現視頻,可是video組件的 層級問題 常常致使UI異常(例如把某個固定定位的元素給擋了)。

此外,圍觀一下「wxParse」的代碼倉庫能夠發現,它已經兩年沒有迭代了。因此就萌生了基於「WePY」的組件模式從新寫一個富文本組件的想法,其成果就是「WePY HTML」項目。

實現過程

解析HTML

前端精品教程:百度網盤下載

首先仍然是要把HTML字符串解析爲樹結構的數據,我採用的是「特殊字符分隔法」。HTML中的特殊字符是「<」和「>」,前者爲開始符,後者爲結束符。

  • 若是待解析內容以開始符開頭,則截取 開始符到結束符之間 的內容做爲節點進行解析。
  • 若是待解析內容不以開始符開頭,則截取 開頭到開始符以前 (若是開始符不存在,則爲末尾)的內容做爲純文本解析。
  • 剩餘內容進入下一輪解析,直到無剩餘內容爲止。

正以下圖所示:

爲了造成樹結構,解析過程當中要維護一個上下文節點(默認爲根節點):

  • 若是截取出來的內容是開始標籤,則根據匹配出的標籤名和屬性,在當前上下文節點下建立一個子節點。若是該標籤不是自結束標籤(br、img等),就把上下文節點設爲新節點。
  • 若是截取出來的內容是結束標籤,則根據標籤名關閉當前上下文節點(把上下文節點設爲其父節點)。
  • 若是是純文本,則在當前上下文節點下建立一個文本節點,上下文節點不變。

過程正以下面的表格所示:

通過上述流程,HTML字符串就被解析爲節點樹了。

對比

把上述算法與其餘相似的解析算法進行對比(性能以「解析10000長度的HTML代碼」進行測定):

可見,在不考慮容錯性(產生錯誤的結果,而非拋出異常)的狀況下,本組件的算法與其他二者相比有壓倒性的優點,符合小程序「 小而快 」的須要。而通常狀況下,富文本編輯器所生成的代碼也不會出現語法錯誤。所以,即便容錯性較差,問題也不大(但這是須要改進的)。

模板渲染

前端精品教程:百度網盤下載

樹結構的渲染,必然會涉及到子節點的 遞歸 處理。然而,小程序的模板並不支持遞歸,這下彷彿掉入了一個大坑。

看了一下「wxParse」模板的實現,它採用簡單粗暴的方式解決這個問題:經過13個長得幾乎如出一轍的模板進行嵌套調用(1調用2,2調用3,……,12調用13),也就是說最多能夠支持12次嵌套。通常來講,這個深度也足夠了。

因爲「WePY」框架自己是有構建機制的,因此沒必要手寫十來個幾乎如出一轍的模板,經過一個構建的插件去生成便可。

如下爲須要重複嵌套的模板(精簡過),在其代碼的開始前和結束後分別插入特殊註釋進行標識,並在須要嵌入下一層模板的地方以另外一段特殊註釋(「<!-- next template -->」)標識:

?
1
2
3
4
5
6
7
8
9
10
11
12
<!-- wepyhtml-repeat start -->
< template name = "wepyhtml-0" >
   < block wx:if = "{{ content }}" wx:for = "{{ content }}" >
     < block wx:if = "{{ item.type === 'node' }}" >
       < view class = "wepyhtml-tag-{{ item.name }}" >
         <!-- next template -->
       </ view >
     </ block >
     < block wx:else>{{ item.text }}</ block >
   </ block >
</ template >
<!-- wepyhtml-repeat end -->

如下是對應的構建代碼(須要安裝「 wepy-plugin-replace 」):

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
// wepy.config.js
{
   plugins: {
     replace: {
       filter: /\.wxml$/,
       config: {
         find: /<\!-- wepyhtml-repeat start -->([\W\w]+?)<\!-- wepyhtml-repeat end -->/,
         replace(match, tpl) {
           let result = '' ;
           // 反正不要錢,直接寫個20層嵌套
           for (let i = 0; i <= 20; i++) {
             result += '\n' + tpl
               .replace( 'wepyhtml-0' , 'wepyhtml-' + i)
               .replace(/<\!-- next template -->/g, () => {
                 return i === 20 ?
                   '' :
                   `<template is= "wepyhtml-${ i + 1 }" wx: if = "{{ item.children }}" data= "{{ content: item.children" ></template>`;
               });
           }
           return result;
         }
       }
     }
   }
}

然而,運行起來後發現,第二層及更深層級的節點都沒有渲染出來,說明嵌套失敗了。再看一下dist目錄下生成的wxml文件能夠發現,變量名與組件源代碼的並不相同:

?
1
< block wx:if = "{{ $htmlContent$wepyHtml$content }}" wx:for = "{{ $htmlContent$wepyHtml$content }}" >

「WePY」在生成組件代碼時,爲了不組件數據與頁面數據的變量名衝突,會 根據必定的規則給組件的變量名增長前綴 (如上面代碼中的「$htmlContent$wepyHtml$」)。因此在生成嵌套模板時,也必須使用帶前綴的變量名。

先在組件代碼中增長一個變量「thisIsMe」用於識別前綴:

前端精品教程:百度網盤下載

?
1
2
3
4
5
6
7
8
9
10
11
12
13
<!-- wepyhtml-repeat start -->
<template name= "wepyhtml-0" >
   {{ thisIsMe }}
   <block wx: if = "{{ content }}" wx: for = "{{ content }}" >
     <block wx: if = "{{ item.type === 'node' }}" >
       <view class= "wepyhtml-tag-{{ item.name }}" >
         <!-- next template -->
       </view>
     </block>
     <block wx: else >{{ item.text }}</block>
   </block>
</template>
<!-- wepyhtml-repeat end -->

而後修改構建代碼:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
replace(match, tpl) {
   let result = '' ;
   let prefix = '' ;
 
   // 匹配 thisIsMe 的前綴
   tpl = tpl.replace(/\{\{\s*(\$.*?\$)thisIsMe\s*\}\}/, (match, p) => {
     prefix = p;
     return '' ;
   });
 
   for (let i = 0; i <= 20; i++) {
     result += '\n' + tpl
       .replace( 'wepyhtml-0' , 'wepyhtml-' + i)
       .replace(/<\!-- next template -->/g, () => {
         return i === 20 ?
           '' :
           `<template is= "wepyhtml-${ i + 1 }" wx: if = "{{ item.children }}" data= "{{ ${ prefix }content: item.children }}" ></template>`;
       });
   }
 
   return result;
}

至此,渲染問題就解決了。

圖片

爲了節省流量和提升加載速度,展現富文本內容時,通常都會按照所需尺寸對裏面的圖片進行縮小,點擊小圖進行預覽時才展現原圖。這主要涉及節點屬性的修改:

  • 把圖片原路徑(src屬性值)存到自定義屬性(例如「data-src」)中,並將其添加到預覽圖數組。
  • 把圖片的src屬性值修改成縮小後的圖片URL(通常雲服務商都有提供此類URL規則)。
  • 點擊圖片時,使用自定義屬性的值進行預覽。

爲了實現這個需求,本組件在解析節點時提供了一個鉤子( onNodeCreate ):

?
1
2
3
4
5
6
7
8
9
onNodeCreate(name, attrs) {
   if (name === 'img' ) {
     attrs[ 'data-src' ] = attrs.src;
     // 預覽圖數組
     this .previewImgs.push(attrs.src);
     // 縮圖
     attrs.src = resizeImg(attrs.src, 640);
   }
}

對應的模板和事件處理邏輯以下:

?
1
2
3
<template name= "wepyhtml-img" >
   <image class= "wepyhtml-tag-img" mode= "widthFix" src= "{{ elem.attrs.src }}" data-src= "{{ elem.attrs['data-src'] || elem.attrs.src }}" @tap= "imgTap" ></image>
</template>
?
1
2
3
4
5
6
7
// 點擊小圖看大圖
imgTap(e) {
   wepy.previewImage({
     current: e.currentTarget.dataset.src,
     urls: this .previewImgs
   });
}

視頻

在小程序中,video組件的層級是較高的(且沒法下降)。若是頁面設計上存在着可能擋住視頻的元素,處理起來就須要一些技巧了:

  • 隱藏video組件,用image組件(視頻封面)佔位;
  • 點擊圖片時,讓視頻全屏播放;
  • 若是退出了全屏,則暫停播放。

相關代碼以下:

?
1
2
3
4
5
6
7
8
9
10
<template name= "wepyhtml-video" >
   <view class= "wepyhtml-tag-video" @tap= "videoTap" data-nodeid= "{{ elem.nodeId }}" >
     <!-- 視頻封面 -->
     <image class= "wepyhtml-tag-img wepyhtml-tag-video__poster" mode= "widthFix" src= "{{ elem.attrs.poster }}" ></image>
     <!-- 播放圖標 -->
     <image class= "wepyhtml-tag-img wepyhtml-tag-video__play" src= "./imgs/icon-play.png" ></image>
     <!-- 視頻組件 -->
     <video style= "display: none;" src= "{{ elem.attrs.src }}" id= "wepyhtml-video-{{ elem.nodeId }}" @fullscreenchange= "videoFullscreenChange" @play= "videoPlay" ></video>
   </view>
</template>
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
   // 點擊封面圖,播放視頻
   videoTap(e) {
     const nodeId = e.currentTarget.dataset.nodeid;
     const context = wepy.createVideoContext( 'wepyhtml-video-' + nodeId);
     context.play();
     // 在安卓微信下,若是視頻不可見,則調用play()也沒法播放
     // 須要再調用全屏方法
     if (wepy.getSystemInfoSync().platform === 'android' ) {
       context.requestFullScreen();
     }
   },
   // 視頻層級較高,爲防止遮擋其餘特殊定位元素,形成界面異常,
   // 強制全屏播放
   videoPlay(e) {
     wepy.createVideoContext(e.currentTarget.id).requestFullScreen();
   },
   // 退出全屏則暫停
   videoFullscreenChange(e) {
     if (!e.detail.fullScreen) {
       wepy.createVideoContext(e.currentTarget.id).pause();
     }
   }
}

 

 

微專業前端設計師之3個月從入門成爲前端工程師全套高清視頻與配套資料
Vue2.5開發去哪兒網App 從零基礎入門到實戰項目
前端JavaScript面試技巧-某課網價值149元實戰教程
前端跳槽面試必備技巧 - 某課網價值199元實戰教程

前端精品教程:百度網盤下載
2018年最新傳智播客黑馬WEB前端36期全套
尚學堂全套Python從基礎到WEB開發
Web前端攻城獅 - HTML5與CSS3實現動態網頁
SpringBoot2.0不容錯過的新特性 WebFlux響應式編程
Web前端攻城獅 - 前端小白入門系列課程

前端精品教程:百度網盤下載價值488全新全棧高級工程師實戰課程Vue+Node+MongoDB(完結)2018React 16+Redux+React Router 4 Node.Js全棧開發招聘App項目實戰視頻iOS MVVM+RAC 從框架到實戰全網首發mpvue課程小程序全棧開發Java從零到企業級電商項目實戰Java Spring 技術棧構建先後臺團購網站Java SSM開發大衆點評後端 Mybatis實戰商城項目牛人計劃-Java+Python項目實戰視頻教程騰訊工程師教你9小時搞定微信小程序開發最新短視頻網站實戰教程 node.js+ES+Koa2基礎到精通項目實戰課程2018最新人工智能全套視頻課程|內含機器學習

相關文章
相關標籤/搜索