搭建Weex的Typescript開發(fā)環(huán)境

前言

本文重點介紹如何搭建一個Typescript+Vue的Weex開發(fā)環(huán)境,需要你有一定的Typescript惑惶、Vue、Webpack的開發(fā)經(jīng)驗短纵,如果你不清楚這些带污,可以先看看相關(guān)內(nèi)容:

初始化

示例項目結(jié)構(gòu)

- dist
- src
  - page
    - example
      - example.vue
      - index.ts
  - types
    - vue.d.ts
    - weex.d.ts
- package.json
- tsconfig.json
- webpack.config.js

安裝依賴

使用 yarn init 構(gòu)建好 package.json

然后安裝相關(guān)開發(fā)依賴,因Weex項目最終運行環(huán)境為構(gòu)建好的 bundle js 香到,故所有依賴項均放入devDependencies即可

yarn add webpack typescript vue vue-class-component weex-loader ts-loader -D

配置文件

tsconfig.json

{
    "compilerOptions": {
        "target": "es5",
        "lib": [
            "dom",
            "es5",
            "es2015"
        ],
        "module": "es2015",
        "moduleResolution": "node",
        "experimentalDecorators": true,
        "removeComments": true,
        "suppressImplicitAnyIndexErrors": true,
        "allowSyntheticDefaultImports": true,
        "strict": true,
        "allowJs": true
    },
    "include": [
        "./src/**/*"
    ]
}

webpack.config.js

ts-loader 必須指定 .ts 文件為入口才能工作

Vue對象存在于Weex的運行環(huán)境鱼冀,無須加載 ,但為了保證代碼上下文的使用連貫(即代碼中依然使用 import Vue from 'vue )悠就,我們可以定義 externals 配置來讓 webpack 忽略 vue 包千绪,避免打包到 bundle js 中去

const path = require('path');
const webpack = require('webpack');

var distDir = path.join(__dirname, 'dist');
var pageDir = path.join(__dirname, 'src', 'page')

module.exports = {
    entry: {
        example: [path.join(pageDir, 'example', 'index.ts')]
    },
    output: {
        path: distDir,
        filename: '[name].js'
    },
    resolve: {
        extensions: ['.ts', '.js', '.vue']
    },
    module: {
        rules: [
            {
                test: /\.ts$/,
                loader: 'ts-loader',
                exclude: /node_modules/,
                options: {
                    appendTsSuffixTo: [/\.vue$/]
                }
            },
            {
                test: /\.vue$/,
                loader: 'weex-loader'
            }
        ]
    },
    externals: {
        vue: 'Vue'
    },
    plugins: [
        new webpack.BannerPlugin({
            banner: '// { "framework": "Vue" } \n',
            raw: true,
            exclude: 'Vue'
        })
    ]
}

src/types/vue.d.ts

讓TS代碼段可以導入 .vue 文件

declare module "*.vue" {
    import Vue from 'vue'
    export default Vue
}

src/types/weex.d.ts

聲明weex實例對象,可自行擴展其他模塊

declare namespace we {
    interface instance {
        /** 該變量包含了當前 Weex 頁面的所有環(huán)境信息 */
        config: any

        /** 獲取某個 native module 的所有方法 */
        requireModule(name: string): any
    }
}

declare var weex: we.instance

package.json

配置 dev 腳本 梗脾,在開發(fā)過程中監(jiān)測文件變化并編譯打包為 bundle js

"script": {
    "dev": "webpack --config ./webpack.config.js -w"
}

測試運行

示例代碼

src/page/example/example.vue

<template>
    <div><text>hello {{info}}</text></div>
</template>

<script lang="ts">
import Vue from "vue";
import Component from "vue-class-component";

@Component
export default class Example extends Vue {
  info = "weex";
}
</script>

src/page/example/index.ts

import Example from './example.vue'
new Example({ el: '#root' })

TS寫法與JS寫法的區(qū)別

.vue 文件中的TS代碼段荸型,導出的是Vue的“子類”,導出后就可以直接進行 new 實例化炸茧;而在JS代碼段中瑞妇,導出的則是一個 ComponentOptions<Vue> 接口(套用TS定義來說明)的JSON對象,導出后作為參數(shù)進行 new Vue(JSON) 進行實例化梭冠。關(guān)于這點可以比對上面的代碼辕狰,與官方示例代碼,即可看出區(qū)別

el 參數(shù)問題

官方文檔并沒有對 el 參數(shù)有特別的說明控漠,但經(jīng)個人踩坑發(fā)現(xiàn)該參數(shù)為必須值蔓倍,如果欠缺,運行時則頁面空白

目前已知當 entry.vue 文件為入口時,會自動生成偶翅;除此之外默勾,均須自已指定,基本上可以為任意字符串值倒堕,只要非空就可以了

編譯打包

執(zhí)行以下命令灾测,便會啟動 webpack 監(jiān)測 example/index.ts 為入口的文件變化,并編譯打包到 dist 目錄下

yarn dev

至此垦巴,拿到 dist/example.js 文件媳搪,就可以在 Weex框架下的APP里運行顯示了

進階

每個 bundle js 都是一個Weex實例頁面,可以參考示例項目結(jié)構(gòu)骤宣,在 webpack.config.js 里定義規(guī)則秦爆,遍歷 src/page ,每個目錄就是一個頁面憔披,動態(tài)生成 entry 入口配置

vue-class-component 提供的修飾器功能等限,在編譯打包時,不可避免的會生成部份代碼芬膝,最終在每個 bundle js 里都會重復出現(xiàn)望门。再加上項目可能還有一些公共lib定義,公共組件等锰霜〕镂螅基于這一點,可以考慮定制 JS Framework癣缅,將公用類庫及文件集成進去厨剪,進一步節(jié)省各個 bundle js 的體積

結(jié)尾

文中涉及的多項技術(shù)內(nèi)容,本人并未有深入的研究友存,只因Weex社區(qū)資源實在匱乏祷膳,在查找Typescript開發(fā)Weex相關(guān)資料時,很驚訝的幾乎完全沒有任何信息屡立。為了避免有類似需求的人走彎路直晨,所以將個人研究結(jié)果撰文分享出來,希望能給大家提供幫助侠驯。如若文中有描述錯誤之處抡秆,歡迎指出修正,感激不盡吟策。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末儒士,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子檩坚,更是在濱河造成了極大的恐慌着撩,老刑警劉巖诅福,帶你破解...
    沈念sama閱讀 211,194評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異拖叙,居然都是意外死亡氓润,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,058評論 2 385
  • 文/潘曉璐 我一進店門薯鳍,熙熙樓的掌柜王于貴愁眉苦臉地迎上來咖气,“玉大人,你說我怎么就攤上這事挖滤”老” “怎么了?”我有些...
    開封第一講書人閱讀 156,780評論 0 346
  • 文/不壞的土叔 我叫張陵斩松,是天一觀的道長伶唯。 經(jīng)常有香客問我,道長惧盹,這世上最難降的妖魔是什么乳幸? 我笑而不...
    開封第一講書人閱讀 56,388評論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮钧椰,結(jié)果婚禮上粹断,老公的妹妹穿的比我還像新娘。我一直安慰自己嫡霞,他們只是感情好姿染,可當我...
    茶點故事閱讀 65,430評論 5 384
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著秒际,像睡著了一般。 火紅的嫁衣襯著肌膚如雪狡汉。 梳的紋絲不亂的頭發(fā)上娄徊,一...
    開封第一講書人閱讀 49,764評論 1 290
  • 那天,我揣著相機與錄音盾戴,去河邊找鬼寄锐。 笑死,一個胖子當著我的面吹牛尖啡,可吹牛的內(nèi)容都是我干的橄仆。 我是一名探鬼主播,決...
    沈念sama閱讀 38,907評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼衅斩,長吁一口氣:“原來是場噩夢啊……” “哼盆顾!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起畏梆,我...
    開封第一講書人閱讀 37,679評論 0 266
  • 序言:老撾萬榮一對情侶失蹤您宪,失蹤者是張志新(化名)和其女友劉穎奈懒,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體宪巨,經(jīng)...
    沈念sama閱讀 44,122評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡磷杏,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,459評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了捏卓。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片极祸。...
    茶點故事閱讀 38,605評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖怠晴,靈堂內(nèi)的尸體忽然破棺而出遥金,到底是詐尸還是另有隱情,我是刑警寧澤龄寞,帶...
    沈念sama閱讀 34,270評論 4 329
  • 正文 年R本政府宣布汰规,位于F島的核電站,受9級特大地震影響物邑,放射性物質(zhì)發(fā)生泄漏溜哮。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,867評論 3 312
  • 文/蒙蒙 一色解、第九天 我趴在偏房一處隱蔽的房頂上張望茂嗓。 院中可真熱鬧,春花似錦科阎、人聲如沸述吸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,734評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽蝌矛。三九已至,卻和暖如春错英,著一層夾襖步出監(jiān)牢的瞬間入撒,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,961評論 1 265
  • 我被黑心中介騙來泰國打工椭岩, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留茅逮,地道東北人。 一個月前我還...
    沈念sama閱讀 46,297評論 2 360
  • 正文 我出身青樓判哥,卻偏偏與公主長得像献雅,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子塌计,可洞房花燭夜當晚...
    茶點故事閱讀 43,472評論 2 348

推薦閱讀更多精彩內(nèi)容

  • 2016年4月21日挺身,阿里巴巴在Qcon大會上宣布開源跨平臺移動開發(fā)工具Weex,Weex能夠完美兼顧性能與動態(tài)性...
    晴天咚咚閱讀 2,887評論 1 15
  • 引子 這篇文章是筆者近期關(guān)于Weex在iOS端的一些研究和實踐心得锌仅,和大家一起分享分享瞒渠,也算是對學習成果的總結(jié)良蒸。文...
    一縷殤流化隱半邊冰霜閱讀 12,044評論 53 165
  • 前言 2016年4月21日,阿里巴巴在Qcon大會上宣布跨平臺移動開發(fā)工具Weex開放內(nèi)測邀請伍玖。Weex能夠完美兼...
    一縷殤流化隱半邊冰霜閱讀 38,957評論 135 366
  • 長久以來嫩痰,我都有一個疑惑,為什么我從小腦子里就想的那么多窍箍,那么容易多愁善感串纺。是不是每個人都和我一樣喜歡想很多東西,...
    holajulie閱讀 197評論 0 0
  • 路遙椰棘,這個四十二歲便赍志而歿的優(yōu)秀作家纺棺。 論及路遙,語含不屑甚至輕蔑的邪狞,自然大有人在祷蝌。那些傲慢而淺薄的編輯,那...
    林六壬閱讀 819評論 4 13