TypeScript/Angular2調(diào)用原生JS的橋接文件的編寫

許多開發(fā)者在使用Angular2或者TypeScript開發(fā)的時(shí)候不可避免地要用到許多原生的JavaScript函數(shù)變量等冰木,但是如何使用TypeScript調(diào)用已經(jīng)封裝好的JavaScript是許多開發(fā)者心中的疑惑竭望。


如何使用TypeScript調(diào)用JavaScript呢?


流行的第三方JavaScript庫(kù)

使用Angular2開發(fā)的童鞋可能會(huì)注意到,Angular2需要引用進(jìn)來(lái)的許多的庫(kù)文件中總會(huì)有.d.ts后綴名的文件父阻,這個(gè)文件就是一個(gè)TypeScript調(diào)用JavaScript的橋接文件杜窄,TypeScript需要通過(guò)這個(gè)文件來(lái)識(shí)別JavaScript中的內(nèi)容。
對(duì)于許多流行的第三方JavaScript庫(kù)蚌本,GitHub上已經(jīng)有一個(gè)開源項(xiàng)目編譯好了他們的.d.ts橋接文件盔粹,直接下載下來(lái)便可以直接使用了隘梨。
項(xiàng)目地址是:https://github.com/DefinitelyTyped/DefinitelyTyped


快速生成橋接文件

但是有些JavaScript是我們開發(fā)人員自己編寫的,該如何調(diào)用呢舷嗡?TypeScript有一個(gè)快速生成.d.ts橋接文件的方法轴猎。

  1. 將你要生成橋接文件的.js文件修改后綴名為.ts。因?yàn)門ypeScript是JavaScript的超集进萄,所以JavaScript代碼完全可以在TypeScript的文件中執(zhí)行(就像C++的文件能夠跑C語(yǔ)言一樣)捻脖。

  2. 首先確保你的電腦上已經(jīng)安裝了TypeScript,打開“終端”(Windows下是命令行)中鼠,cd到你剛剛修改后綴名的文件所在的文件夾可婶,運(yùn)行命令:
    tsc --declaration 剛剛修改后綴名的文件名(包括后綴名)。
    例如:

    tsc --declaration myJavaScript.ts
    

之后便可以看到TypeScript自動(dòng)生成的.d.ts的橋接文件了援雇。
如果在生成過(guò)程中報(bào)錯(cuò)矛渴,建議將要生成的文件中的JavaScript代碼中實(shí)現(xiàn)部分全部刪掉,只保留接口即可惫搏,反正生成的.d.ts文件就是一個(gè)變量和函數(shù)等的橋接文件具温。


手動(dòng)編寫橋接文件

如果通過(guò)TypeScript自動(dòng)生成的.d.ts橋接文件不合適怎么辦?(很正常筐赔,我從來(lái)沒生成正常過(guò)桂躏,因?yàn)槲业腏avaScript代碼是封裝到一個(gè)單例里面的,TypeScript不認(rèn)識(shí)單例...)
這個(gè)時(shí)候就需要我們自己手動(dòng)來(lái)編寫.d.ts的橋接文件了川陆。
TypeScript官方也給出了如何編寫橋接文件:https://www.tslang.cn/docs/handbook/declaration-files/introduction.html

注:.d.ts文件放在TypeScript調(diào)用JavaScript中國(guó)年是橋接文件剂习,放在單純的TypeScript中便是TypeScript的聲明文件)

TypeScript官方給的文檔很不好理解(至少我看了半天的時(shí)間才搞明白)
下面我重點(diǎn)說(shuō)一下應(yīng)該如何編寫.d.ts橋接文件(只適用于TypeScript和JavaScript橋接)。

橋接文件中分為模塊较沪,接口鳞绕,類,函數(shù)尸曼,變量等们何。所有的最外層都需要關(guān)鍵字declare來(lái)聲明。

模塊 的橋接

模塊在TypeScript可以為JavaScript中的單例控轿,匿名函數(shù)冤竹,全局的對(duì)象,全局的庫(kù)等包含多個(gè)屬性多個(gè)接口方法的東西茬射,具體在何種情況應(yīng)該聲明為模塊還主要是看個(gè)人的喜好鹦蠕。模塊中可以聲明任何東西。
單純的模塊:

declare module myModule { ... }

模塊的嵌套在抛,在一個(gè)模塊中聲明另一個(gè)模塊可以使用以下兩種方式:

declare module aModule, bModule { ... }

等于

declare module aModule {
    module bModule {
        ...
    }
    ...
}
類 的橋接

所有聲明在橋接文件中的類的名稱需要和JavaScript中對(duì)應(yīng)的類的名稱保持一致钟病。
單純的類的聲明:

declare class myClass { ... }

類的繼承:

declare class mySubClass extends myClass { ... }

如何調(diào)用:

let tempClass = new mySubClass();

模塊中的類:

declare module myModule {
    class myModuleClass { ... }
}
接口 的橋接

TypeScript單獨(dú)的提供了一個(gè)接口的聲明,接口類似于類,不過(guò)類是要new出來(lái)的肠阱,而接口是可以直接調(diào)用的票唆,類似于全局的函數(shù)。
單純的接口:

declare interface myInterface { ... }

模塊中的接口:

declare module myModule {
    class myModuleClass { ... }

    interface myModuleInterface { ... }
}
變量 的橋接

全局變量
全局變量需要聲明變量類型屹徘,變量的名稱需要和JavaScript中對(duì)應(yīng)的變量的名稱一致走趋。

declare var myVariable: string;

模塊中的變量:

declare module myModule {
    var myModuleVariable: string;

    class myModuleClass { ... }

    interface myModuleInterface { ... }
}

類中的變量屬性,變量屬性的名稱需要和JavaScript中對(duì)應(yīng)的類的變量屬性的名稱一致噪伊。

declare class myClass {
    name: string;
    id  : number;
}

接口中的變量:

declare interface myInterface {
     myInterfaceVariable: string;
}
函數(shù) 的橋接

單純的函數(shù)的聲明吆视,函數(shù)的名稱需要和JavaScript中對(duì)應(yīng)的函數(shù)的名稱一致,參數(shù)數(shù)量也應(yīng)該一致酥宴,參數(shù)名稱可以不一樣:

declare function myfunction(param: string): void;

模塊中的方法啦吧,方法的名稱需要和JavaScript中對(duì)應(yīng)的模塊的方法的名稱一致,參數(shù)數(shù)量也應(yīng)該一致拙寡,參數(shù)名稱可以不一樣:

declare module myModule {
    var myModuleVariable: string;

    class myModuleClass { ... }

    interface myModuleInterface { ... }

    function myModuleFunction(param: string): void;
}

接口中的方法:

declare interface myInterface {
     myInterfaceVariable: string;

     myInterfaceFunction(param: string): void;
}

回調(diào)函數(shù)的橋接注意:
因?yàn)門ypeScript中this的作用域同JavaScript中this的作用域不同授滓,TypeScript中默認(rèn)對(duì)函數(shù)聲明了this的作用域。
所以我們?cè)谡{(diào)用回調(diào)函數(shù)的時(shí)候必須使用=>來(lái)調(diào)用回調(diào)函數(shù):

callbackFunction((data) => {
    // 回調(diào)函數(shù)的內(nèi)容
})
橋接文件的舉例

這是我之前寫過(guò)的一個(gè)自己的單例模式的JavaScript文件的橋接文件肆糕,僅作參考

JavaScript代碼
tempJS.js:

function inherit(subClass, superClass) {
    function F() {};
    F.prototype = superClass.prototype;
    subClass.prototype = new F();
    subClass.prototype.constructor = subClass.constructor;
}

function User() {
    this.userID   = Number;
    this.userName = String;
    this.userICON = String;
    this.isFriend = Boolean;
}

function Member() {
    User.call(this);
    this.remarkName = String;
}
inherit(Member, User);

var TempModule = (function () {
    var instantiated;
    function init() {
        return { 
            userInfo:User;
            test: function (callback) { ... },
            login: function (loginName, password) { ... }
        };
    }
    return {
        shareTemp: function () {
            if (!instantiated) {
                instantiated = init();
            }
            return instantiated;
        }
    };
})();

對(duì)應(yīng)的橋接文件
tempJS.d.ts:

declare class User {
    userID   : number;
    userName : string;
    userICON : string;
    isFriend : boolean;
}

declare class Member extends User {
    remarkName : string;
}

declare module TempModule {
    interface shareTemp {
        userInfo: User;

        test(callback:Function): void;
        login(loginName: string, password: string): void;
    }
}

調(diào)用的文件:

let tempUser = new User();
tempUser.userID = 1;
tempUser.userName = "Shmily";
TempModule.shareTemp.userInfo = tempUser;
TempModule.shareTemp.test((data) => {
    // 回調(diào)函數(shù)內(nèi)容
});
TempModule.shareTemp.login(tempUser.userName, "1234");
如何調(diào)用呢般堆?

老式的方法是在需要用到的地方寫:

/// <reference path="你的.d.ts的文件路徑" />

但是這樣很麻煩。不過(guò)在Angular2項(xiàng)目中我們有了一個(gè)簡(jiǎn)單的方法诚啃,在項(xiàng)目中的tsconfig.json文件中這樣寫:

{  
    "compilerOptions": {
        "target": "es5",
        "module": "commonjs",
        "moduleResolution": "node",
        "sourceMap": true,
        "emitDecoratorMetadata": true,
        "experimentalDecorators": true,
        "lib": [ "es2015", "dom" ],
        "noImplicitAny": true,
        "suppressImplicitAnyIndexErrors": true,
        "types": ["./library/ArrowIM/ArrowIM.d.ts"]
}}

只需要在types中添加你想要引用的.d.ts文件淮摔,Angular2會(huì)在加載項(xiàng)目的時(shí)候自動(dòng)去加載,這樣就再也不用寫那么多的///了始赎。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末和橙,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子造垛,更是在濱河造成了極大的恐慌魔招,老刑警劉巖,帶你破解...
    沈念sama閱讀 207,248評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件五辽,死亡現(xiàn)場(chǎng)離奇詭異办斑,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)杆逗,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,681評(píng)論 2 381
  • 文/潘曉璐 我一進(jìn)店門乡翅,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人罪郊,你說(shuō)我怎么就攤上這事蠕蚜。” “怎么了排龄?”我有些...
    開封第一講書人閱讀 153,443評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵波势,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我橄维,道長(zhǎng)尺铣,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,475評(píng)論 1 279
  • 正文 為了忘掉前任争舞,我火速辦了婚禮凛忿,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘竞川。我一直安慰自己店溢,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,458評(píng)論 5 374
  • 文/花漫 我一把揭開白布委乌。 她就那樣靜靜地躺著床牧,像睡著了一般。 火紅的嫁衣襯著肌膚如雪遭贸。 梳的紋絲不亂的頭發(fā)上戈咳,一...
    開封第一講書人閱讀 49,185評(píng)論 1 284
  • 那天,我揣著相機(jī)與錄音壕吹,去河邊找鬼著蛙。 笑死,一個(gè)胖子當(dāng)著我的面吹牛耳贬,可吹牛的內(nèi)容都是我干的踏堡。 我是一名探鬼主播,決...
    沈念sama閱讀 38,451評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼咒劲,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼顷蟆!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起腐魂,我...
    開封第一講書人閱讀 37,112評(píng)論 0 261
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤慕的,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后挤渔,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體肮街,經(jīng)...
    沈念sama閱讀 43,609評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,083評(píng)論 2 325
  • 正文 我和宋清朗相戀三年判导,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了嫉父。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,163評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡眼刃,死狀恐怖绕辖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情擂红,我是刑警寧澤仪际,帶...
    沈念sama閱讀 33,803評(píng)論 4 323
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響树碱,放射性物質(zhì)發(fā)生泄漏肯适。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,357評(píng)論 3 307
  • 文/蒙蒙 一成榜、第九天 我趴在偏房一處隱蔽的房頂上張望框舔。 院中可真熱鬧,春花似錦赎婚、人聲如沸刘绣。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,357評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)纬凤。三九已至,卻和暖如春撩嚼,著一層夾襖步出監(jiān)牢的瞬間移斩,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,590評(píng)論 1 261
  • 我被黑心中介騙來(lái)泰國(guó)打工绢馍, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留向瓷,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,636評(píng)論 2 355
  • 正文 我出身青樓舰涌,卻偏偏與公主長(zhǎng)得像猖任,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子瓷耙,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,925評(píng)論 2 344

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