Rails Everyday: SJR 結(jié)合 Stimulus 構(gòu)建可維護(hù)的JavaScript代碼

這幾個月都在使用 DHH 今年新發(fā)布的 StimulusJS 框架來寫 Web 程序, 真的感覺很好, 感覺開發(fā)Web項目充滿了生產(chǎn)力, 而不像 AngularJS/React 前端框架, 看著技術(shù)吊炸天, 但是真正要寫項目的時候, 除了感覺到炫技和頭暈外, 反而把簡單的事情弄得越來越復(fù)雜.

如果說 CSS 是把樣式從 HTML 剝離的技術(shù), Stimulus 就是把 JS 從 HTML 剝離的技術(shù), 結(jié)合 Turbolinks 一起使用, 開發(fā)效率和用戶體驗都很棒.

Stimulus 的代碼一般長這樣:

<button
    data-controller="user"
    data-action="user.action">
Text
</button>

當(dāng)點擊按鈕的時候, Stimulus 會自動找到 user_controller.js 文件, 并調(diào)用 user_controller.js 中的 action 函數(shù).

Stimulus 利用元素的屬性, 在保證 JS 和 HTML 之間關(guān)聯(lián)性的同時最大程度的保持 HTML 文件的干凈, 并自動建立從 HTML 元素到 JS 函數(shù)的連接, 不用手動在 JS 文件中寫很多這種邏輯孤立的回調(diào)函數(shù) $("button").click(function(){${ ... }).

說 Stimulus 是生產(chǎn)力代表一點都不為過, 不過今天不詳細(xì)講解 Stimulus 的用法.
今天主要講怎么利用 Stimulus 優(yōu)雅的處理 AJAX 請求, 來構(gòu)建健壯可維護(hù)的 JavaScript 代碼.

Rails Demo

舉個簡單的例子, 如果我們要實現(xiàn)上圖中這種上傳頭像后自動更新頁面中兩處頭像元素的功能, 我們一般會按照下圖這種 Rails SJR (Server-generated JavaScript Responses) 流程來處理:

Rails SJR workflow
  1. 首先在瀏覽器端, 觸發(fā) submit 按鈕后, 提交表單數(shù)據(jù)到服務(wù)器
  2. 服務(wù)器接受到請求后, 在 ruby 控制器中處理數(shù)據(jù), 然后返回數(shù)據(jù)
  3. Rails 會根據(jù) ruby 控制器中 format.js 的名字找到對應(yīng)的 *.js.erb JS 模板文件, 并根據(jù)返回數(shù)據(jù)生成最終的 JS 文件
  4. JS 文件隨著 AJAX 的結(jié)果返回給瀏覽器中執(zhí)行并更改HTML頁面的DOM結(jié)構(gòu)
Rails SJR & Stimulus workflow

如果我們用 Stimulus 技術(shù)來處理, 看看會有哪些變化?

  1. 首先我們會在 form_with 表單中增加 data-controller 和 data-action 字段, 表示 AJAX 成功返回結(jié)果后, 調(diào)用 user_controller.js 的 update 函數(shù), submit 按鈕點擊后提交表單數(shù)據(jù)沒什么變化
  2. 服務(wù)器的 ruby 控制器在處理數(shù)據(jù)后, 返回的并不是 JS 文件, 而是返回 JSON 數(shù)據(jù)
  3. Stimulus 的JS文件在接到 AJAX 返回的 JSON 數(shù)據(jù)后在瀏覽器端修改 HTML頁面的DOM結(jié)構(gòu)

其實從大的流程運(yùn)行和最終改變 HTML DOM 結(jié)構(gòu)的效果上, 并沒有產(chǎn)生太多不同.
但是從技術(shù)團(tuán)隊的開發(fā)和可維護(hù)上, 有 Stimulus 技術(shù)的輔助, JavaScript 代碼的可維護(hù)性獲得了極大的提升.

我們首先來看看下面兩張圖:

SJR request
SJR & Stimulus request
  1. 第一張是 SJR 技術(shù)根據(jù)AJAX請求的響應(yīng)方式, SJR 技術(shù)的 ruby 控制器總是返回 format.js 的JS模板文件, 就會導(dǎo)致每個請求都會創(chuàng)建一個又小又碎的 JS 文件
  2. 第二張是 SJR 結(jié)合 Stimulus 技術(shù)后的響應(yīng)方式, SJR & Stimulus 技術(shù)的 ruby 控制器只是返回 JSON 數(shù)據(jù), 并不需要根據(jù)每個請求創(chuàng)建一個新的 JS 文件

在小項目的時候, 優(yōu)勢看不出來, 但是一旦業(yè)務(wù)變得越來越復(fù)雜的時候, 這些碎小的 JS 文件就非常難以維護(hù), 主要是因為這些 JS 文件往往都是極小的JS片段, 當(dāng)需要修改的時候, 往往要結(jié)合 HTML 和 ruby 的代碼一起看, 難以理解. 再加上這些 JS 文件運(yùn)行環(huán)境的復(fù)雜, 在運(yùn)行時也非常難以調(diào)試.

Stimulus 的好處就是, 把每個 AJAX:success 的 action 對應(yīng)到 controller.js 的一個函數(shù)中, 不同類型的 AJAX 請求可以分類到不同 Stimulus 控制器中分類管理, 因為每個 Stimulus 控制器一般都是根據(jù)某一個功能內(nèi)聚形成的, 在上下文理解和運(yùn)行時調(diào)試上都要比數(shù)量巨多的碎 JS 文件更容易維護(hù).

關(guān)于JS前端框架的一些看法.

現(xiàn)代的前端開發(fā)人員太浮躁了, 大多數(shù)前端從業(yè)同學(xué)都自從技術(shù)是否足夠復(fù)雜和精致上來評價一個技術(shù)框架的好壞, 而不從業(yè)務(wù)導(dǎo)向和技術(shù)的適用度來評價. 互聯(lián)網(wǎng)這種 "越復(fù)雜的技術(shù)才是最好技術(shù)" 的思想真是太膚淺了.

Web并不是一個 JSON API + JS Client render 的場景, 因為大多數(shù)Web應(yīng)用并不是游戲和高交互的程序, 大多數(shù) Web 產(chǎn)品依然是以內(nèi)容為主, 交互輔助的場景.
我相信開發(fā)過桌面程序的同學(xué)都知道, 如果Web服務(wù)器只是提供 API, 何不用本地圖形庫開發(fā)了? 本地圖形庫渲染的速度要遠(yuǎn)遠(yuǎn)快于瀏覽器, 而且客戶端渲染的技術(shù)真的非常難以控制, 一旦 API 之間不兼容或者版本迭代的時候, 非常非常的麻煩.

反觀 DHH 做的 Rails, Turbolinks 還是今天介紹的 Stimulus, 單從一個模塊的技術(shù)復(fù)雜度和精致程度并不能和 AngularJS/React 這些相比, 但是 DHH 真的很懂面向業(yè)務(wù)和開發(fā)生產(chǎn)力來開發(fā)新的技術(shù), Rails + Turbolinks + Stimulus 給我的感覺就像活塞隊一樣, 雖然每個技術(shù)都不是最頂尖的, 但是每個技術(shù)的比例和復(fù)雜度都剛剛好, 相互互補(bǔ)默契的結(jié)合可以掀翻看似全明星的湖人隊. 甚至可以說是在滿足功能的前提下盡最大程度減少邏輯的復(fù)雜度, 這樣構(gòu)建相同功能的代碼越簡單, 后期的維護(hù)性和可擴(kuò)展性都會越好.

最后我想說的是, 技術(shù)一定面向業(yè)務(wù)場景, 最合適的才是最好的, 技術(shù)應(yīng)該為人服務(wù), 使用起來應(yīng)該直覺化和簡單易懂, 完成開發(fā)后去像 DHH 那樣享受生活, 而不是沉浸在技術(shù)的復(fù)雜度中自我陶醉.

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市晌杰,隨后出現(xiàn)的幾起案子跷睦,更是在濱河造成了極大的恐慌铅搓,老刑警劉巖恨豁,帶你破解...
    沈念sama閱讀 221,406評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件宋彼,死亡現(xiàn)場離奇詭異录别,居然都是意外死亡椎工,警方通過查閱死者的電腦和手機(jī)古话,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,395評論 3 398
  • 文/潘曉璐 我一進(jìn)店門空民,熙熙樓的掌柜王于貴愁眉苦臉地迎上來设捐,“玉大人梗夸,你說我怎么就攤上這事层玲。” “怎么了?”我有些...
    開封第一講書人閱讀 167,815評論 0 360
  • 文/不壞的土叔 我叫張陵称簿,是天一觀的道長扣癣。 經(jīng)常有香客問我,道長憨降,這世上最難降的妖魔是什么父虑? 我笑而不...
    開封第一講書人閱讀 59,537評論 1 296
  • 正文 為了忘掉前任,我火速辦了婚禮授药,結(jié)果婚禮上士嚎,老公的妹妹穿的比我還像新娘。我一直安慰自己悔叽,他們只是感情好莱衩,可當(dāng)我...
    茶點故事閱讀 68,536評論 6 397
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著娇澎,像睡著了一般笨蚁。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上趟庄,一...
    開封第一講書人閱讀 52,184評論 1 308
  • 那天括细,我揣著相機(jī)與錄音,去河邊找鬼戚啥。 笑死奋单,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的猫十。 我是一名探鬼主播览濒,決...
    沈念sama閱讀 40,776評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼拖云!你這毒婦竟也來了贷笛?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,668評論 0 276
  • 序言:老撾萬榮一對情侶失蹤江兢,失蹤者是張志新(化名)和其女友劉穎昨忆,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體杉允,經(jīng)...
    沈念sama閱讀 46,212評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡邑贴,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,299評論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了叔磷。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片拢驾。...
    茶點故事閱讀 40,438評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖改基,靈堂內(nèi)的尸體忽然破棺而出繁疤,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 36,128評論 5 349
  • 正文 年R本政府宣布稠腊,位于F島的核電站躁染,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏架忌。R本人自食惡果不足惜吞彤,卻給世界環(huán)境...
    茶點故事閱讀 41,807評論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望叹放。 院中可真熱鬧饰恕,春花似錦、人聲如沸井仰。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,279評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽俱恶。三九已至雹嗦,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間速那,已是汗流浹背俐银。 一陣腳步聲響...
    開封第一講書人閱讀 33,395評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留端仰,地道東北人。 一個月前我還...
    沈念sama閱讀 48,827評論 3 376
  • 正文 我出身青樓田藐,卻偏偏與公主長得像荔烧,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子汽久,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,446評論 2 359

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