dart學(xué)習(xí)-自定義庫包的創(chuàng)建

參考
dart是通過打包來實(shí)現(xiàn)模塊或庫的分發(fā)和使用的乱豆,有兩種類型的包:應(yīng)用程序包(可能包含很多本地庫)、庫包征炼。

包的構(gòu)成

最簡單的包的構(gòu)成如圖
pubspec.yaml

管理和維護(hù)app/lib的依賴和資源

lib目錄

用于存放要打包到庫里的代碼间聊。lib下可以有任意的目錄結(jié)構(gòu)笤虫,一般功能實(shí)現(xiàn)相關(guān)的代碼放在lib/src目錄下淳玩。通常該目錄為私有目錄直撤,應(yīng)該避免被第三方包引入⊥勺牛可以通過在lib目錄下新增文件的方式間接引用到src下的內(nèi)容谋竖。

打包時(shí)如沒有特別指定library指令參數(shù),將基于lib/file.dart的路徑和名稱來生成庫的唯一標(biāo)識(shí)

包的組織

為了方便管理承匣,包的內(nèi)容應(yīng)該最小化(只包括所需的內(nèi)容)蓖乘,雖然dart有提供part指令用于分包,但并不推薦使用韧骗。

lib/<package-name>.dart

該文件將作為重要的文件對(duì)外提供API嘉抒,只需要import該文件即可使用所有該庫提供的功能。
當(dāng)然袍暴,庫也可以包含其他可被引入些侍,非源的內(nèi)容。

dart提供的*shelf*庫結(jié)構(gòu)圖

該庫的主要文件shelf.dart,負(fù)責(zé)導(dǎo)出lib/src下的文件

export 'src/cascade.dart';
export 'src/handler.dart';
export 'src/handlers/logger.dart';
export 'src/hijack_exception.dart';
export 'src/middleware.dart';
export 'src/pipeline.dart';
export 'src/request.dart';
export 'src/response.dart';
export 'src/server.dart';
export 'src/server_handler.dart';

shelf庫也包含一個(gè)小庫shelf_io容诬,以適用于處理依賴dart:io的HTTPRequest

包文件的導(dǎo)入

通過package:指令導(dǎo)入特定URI的文件

import 'package:utilities/utilities.dart';

庫包lib下的文件之間可以用相對(duì)路徑導(dǎo)入娩梨,否則必須通過package:指令導(dǎo)入。

如何導(dǎo)入lib/foo/a.dart

其他文件

建議測試相關(guān)放在test目錄下
命令行工具相關(guān)放在bin目錄下
如果有一些庫的使用例子览徒,可以放在example目錄下
任何輔助相關(guān)的工具或可執(zhí)行程序,可以放在tool目錄下

文檔的生成

通過dartdoc將代碼中文檔注釋的內(nèi)容生成API文檔

庫的發(fā)布

通過pub命令發(fā)布庫,推薦發(fā)布到Pub site

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末颂龙,一起剝皮案震驚了整個(gè)濱河市习蓬,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌措嵌,老刑警劉巖躲叼,帶你破解...
    沈念sama閱讀 219,589評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異企巢,居然都是意外死亡枫慷,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,615評(píng)論 3 396
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來或听,“玉大人探孝,你說我怎么就攤上這事∮桑” “怎么了顿颅?”我有些...
    開封第一講書人閱讀 165,933評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長足丢。 經(jīng)常有香客問我粱腻,道長,這世上最難降的妖魔是什么斩跌? 我笑而不...
    開封第一講書人閱讀 58,976評(píng)論 1 295
  • 正文 為了忘掉前任绍些,我火速辦了婚禮,結(jié)果婚禮上耀鸦,老公的妹妹穿的比我還像新娘柬批。我一直安慰自己,他們只是感情好揭糕,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,999評(píng)論 6 393
  • 文/花漫 我一把揭開白布萝快。 她就那樣靜靜地躺著,像睡著了一般著角。 火紅的嫁衣襯著肌膚如雪揪漩。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,775評(píng)論 1 307
  • 那天吏口,我揣著相機(jī)與錄音奄容,去河邊找鬼。 笑死产徊,一個(gè)胖子當(dāng)著我的面吹牛昂勒,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播舟铜,決...
    沈念sama閱讀 40,474評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼戈盈,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼!你這毒婦竟也來了谆刨?” 一聲冷哼從身側(cè)響起塘娶,我...
    開封第一講書人閱讀 39,359評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎痊夭,沒想到半個(gè)月后刁岸,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,854評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡她我,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,007評(píng)論 3 338
  • 正文 我和宋清朗相戀三年虹曙,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了迫横。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,146評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡酝碳,死狀恐怖矾踱,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情击敌,我是刑警寧澤介返,帶...
    沈念sama閱讀 35,826評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站沃斤,受9級(jí)特大地震影響圣蝎,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜衡瓶,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,484評(píng)論 3 331
  • 文/蒙蒙 一徘公、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧哮针,春花似錦关面、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,029評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至蛮放,卻和暖如春缩抡,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背包颁。 一陣腳步聲響...
    開封第一講書人閱讀 33,153評(píng)論 1 272
  • 我被黑心中介騙來泰國打工瞻想, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人娩嚼。 一個(gè)月前我還...
    沈念sama閱讀 48,420評(píng)論 3 373
  • 正文 我出身青樓蘑险,卻偏偏與公主長得像,于是被迫代替她去往敵國和親岳悟。 傳聞我的和親對(duì)象是個(gè)殘疾皇子佃迄,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,107評(píng)論 2 356

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