前端結構 の 里程碑(v3)

最近三個月我們一直在不斷調整前端結構,目的在于提升 前端開發的一致性和復用性,先后提出了 前端結構 の 調整建議(v1),前端結構 の 調整新建議(v2)。

最近兩周,基于 Jimmy 的實踐經驗,與目前團隊不斷的交流融合,在 6月24日,我們有了新共識,到達了一個新的里程碑。

原則
  • 可理解性是首要的,通過明確的約定以保持良好的一致性;
  • 創建和業務相關的 典型案例,便于團隊模仿、學習和理解;
  • 鼓勵嘗試,容忍犯錯,凝聚團隊共識,漸進改造現有代碼;
三個頂級目錄
  • imodules 模塊;
  • ipages 頁面;
  • iscripts 腳本;
目錄結構示例
├── imodules/
│  ├── base/
│  ├── embed/
│  ├── hour24/
│  ├── repair/
│  └── xbase/
├── ipages/
│  ├── home/
│  └── repair/
└── iscripts/
  ├── immy/
  ├── vendor/
  └── xlibs/
imodules(模塊)

模塊劃分目的在于將復雜問題進行分解,提升獨立性,降低耦合度,促進復用,并行開發,以提升開發效率。

imodules
├── base
│  └── _baseUModules
├── embed
│  ├── EmbedBottom
│  └── EmbedTop
├── hour24
│  └── Hour24Matte
├── repair
│  ├── RepairMatte
│  └── RepairScreenSelect
└── xbase
  └── _Matte
  • 模塊分類目錄約定
    1. 小寫字母開頭,駝峰風格,不使用中劃線和下劃線進行區隔,慎用數字;
    2. 僅為源碼分類使用,不在 dist 發布目錄上體現;
    3. 支持多級分類目錄;

  • 模塊實體目錄約定
    同時作為模塊 id(元素 id),大寫字母開頭,駝峰風格,不使用中劃線和下劃線進行區隔,慎用數字;
    特殊:下劃線開頭是允許的,表示內部基類;

  • 模塊 id 和 元素 id 約定的說明
    規則:大寫字母開頭,駝峰風格,不使用中劃線和下劃線進行區隔,慎用數字;
    考慮:中劃線使得正則復雜化;駝峰了就自然拒絕下劃線;除非數字有意義,否則慎用數字;

  • base 非常特殊,和 xbase | _parts | partial 分離;

  • 葉子節點示例
    imodules/repair/RepairModal/

imodules/repair/RepairModal/
├── main.css
├── main.html
├── main.js
└── screen.tpl
ipages(頁面)
ipages
├── home/
│  ├── I404/
│  └── Index/
└── repair/
  └── RepairIndex/
  • 頁面分類目錄約定;
    ipages/home/,ipages/repair/;
    命名約定同模塊分類目錄的命名約定;
  • 頁面實體目錄約定;
    BODY id,命名約定同模塊實體目錄的命名約定;
  • 葉子節點示例
    ipages/repair/RepairIndex/
ipages/repair/RepairIndex/
├── images/
│  └── supplier-avatar.png
├── main.css
├── main.js
└── repair@index.html
  • repair@index.html,表示發布后 repair/index.html,指定了發布路由;沒有 @ 則表示發布在根目錄下,有幾個 @,則有幾層目錄;有一定的靈活變換性;
iscripts(腳本)
iscripts/
├── immy/
│  ├── libs/
│  ├── baseWidgets.js
│  ├── data.js
│  ├── project.js
│  └── utils.js
├── vendor/
│  └── mustache.js
└── xlibs/
  ├── common-structure-expanded/
  ├── global-structure-expanded/
  └── tip.js
  • mustache.js 放到 vendor 下;
  • xlibs 是業務庫,其內容存在相當的不確定性和變動可能;跨業務模塊公用,跨站點公用。這里有一個轉變,就是放到這里的,默認都是全局公用的;
  • tip.js 放到 xlibs 下;
immy(基礎框架)
  • 基礎框架和應用模塊適度分離,以便進一步重構框架和模塊;
  • 新框架命名
    使用 immy,簡潔、易記憶,和 Jimmy 有深刻淵源;
  • immy 框架 可作為產品,以適度分離的方式迭代發展;
immy
├── libs/
│   ├── potato.js
│   └── require.js
├── baseWidgets.js
├── data.js
├── project.js
└── utils.js

immy 應當有繼續演進的機會,雖然 require.js 可以放到 vendor 下,但考慮到若沒有 require.js,這個框架就跑不起來。require.js 屬于 immy 這個框架的最小集合。

idom、ievent、imodule
  • 設置 自定義屬性 idom,將 dom 操作從 class 分離;
  • 設置 自定義屬性 ievent,明確區分 event 和 action;
  • 設置 自定義屬性 imodule,明確引用依賴的模塊 js;
  • 基于 els elements 去綁定;
模塊 の 類、函數、變量
  • 類名:大寫字母開頭,駝峰風格;
  • 變量:小寫字母開頭,駝峰風格;
  • 函數:小寫字母開頭,駝峰風格;
  • 私有:下劃線開頭表示內部使用;
HTML 元素 の id 和 class
  • 元素 id:命名約定同模塊實體目錄的命名約定;
  • css class:全小寫,中劃線分隔;

URL、目錄、文件 の 一般命名約定

  1. URL 設計要盡量簡單、直觀和有意義;
  2. 除了模塊實體目錄和頁面實體目錄作為 id 使用要加以特殊約定外,目錄文件名統一使用英文小寫(除 README.md 外),慎重使用數字后綴;如果要多個單詞區隔,請使用 中劃線“-”進行區隔
  3. CSS 類名也是中劃線區隔,全小寫;
  4. 網頁鏈接通常使用絕對路徑;
緣起

兩個不同的角色要共享后臺注冊登錄認證服務,但在頁面彈出層有所不同,如何合理復用?

imodules/user/

imodules/user/
├── CustomerLoginForm
├── _LoginForm
└── SupplierLoginForm
約定
后記
  • 我們的前兩版結構調整,應該說主要是文件夾的合理組織,工程耦合不是通過文件夾拆分組合(不論多么自洽和復雜)就能簡單解耦的;
  • 第三版結構調整,應該說在工程解耦上走出了堅實的一步;
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,825評論 6 546
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,814評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,980評論 0 384
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 64,064評論 1 319
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,779評論 6 414
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,109評論 1 330
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,099評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,287評論 0 291
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,799評論 1 338
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,515評論 3 361
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,750評論 1 375
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,221評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,933評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,327評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,667評論 1 296
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,492評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,703評論 2 380

推薦閱讀更多精彩內容

  • 1、引言 數據庫設計過程中表、字段等的命名規范也算是設計規范的一部分,不過設計規范更多的是為了確保數據庫設計的合理...
    SnowflakeCloud閱讀 41,070評論 0 48
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,836評論 18 139
  • 一、入口文件 入口文件內容:一般格式如下: 二、主配置文件 保存位置:你的應用/protected/config/...
    layjoy閱讀 1,211評論 4 14
  • 常用html、CSS、javascript前端命名規范無論是從技術角度還是開發視角,對于web前端開發規范文檔都有...
    krock01閱讀 268評論 0 1
  • 小時候我是孩子王,滿世界搗蛋,欺負女孩子能追著跑兩里地,掏張家的鳥窩,摘李家的棗,能想到的荒唐事我都干過,那時候沒...
    江楓閱讀 2,812評論 25 54