随着應用DinamicX(簡稱DX,下同)技術的場景和團隊愈加複雜與廣泛,持續保障DX核心競争力,支持團隊級别協同開發,助力複雜業務場景的訴求愈發強烈。之前的DX開發基于模闆平台,其核心為基于開源的Monaco編輯器(驅動VScode的開源代碼編輯器)定制開發的前端工程。雖然模闆平台在過去一定程度上滿足了業務開發需要,但其編輯體驗,調試體驗和性能保障等愈發難以滿足開發者要求。
面對上述這些問題,從DX業務研發的需求角度看,我們需要一站式的開發環境,提供從創建,開發,編譯,調試,到發布的全研發周期保障。
全研發周期保障技術方案選型與設計
基于上述考慮,我們需要的是一個IDE。不同于模闆平台這樣的Editor,IDE提供了完整的開發周期支持。目前業界主流的VSCode,不僅提供了豐富的API用于做擴展,也包含了極其豐富的插件市場,可通過開發VSCode插件的方式來提供DX IDE。
VSCode生态
模闆平台運行于Web環境,受限于浏覽器, IDE運行于本地環境,擴展豐富容易,環境可控兼容性好;
編輯器可用來做豐富的編輯期支持,其LSP API除部分API(調用棧,快速修複,展示所有引用,動态計算表達式,内聯值計算,類繼承關系,符号表)不支持外,提供了豐富的編輯補全文檔等功能;
相較于純粹的編輯器,IDE則提供了完整的開發周期支持,包括項目系統,代碼曆史上下文理解,調試,同其他功能的結合(如腳手架,編譯等),應用研發周期管理,平台相關的内容(如Swift, Kotlin, Faas)等。
雖然VSCode提供了諸多能力及擴展,包括但不限于文件樹及菜單,工程體系,編輯器與語言服務(智能感知),調試服務,更好的集成構建與開發生命周期管理,平台工具相關等,但在面向開發者的交互層面,仍存在諸多限制與不便。與此同時,發源于阿裡經濟體内部的IDE框架--OpenSumi框架 ( 阿裡&螞蟻自研 IDE 研發框架, 已開源 ),既可兼容 100% VS Code API,也擴展了諸多API,提供了豐富的UI自定義支持,大大簡化了自定義插件的交互開發,因而我們采用OpenSumi作為IDE最終的技術選型。
OpenSumi定制擴展如上,下圖簡要說明了OpenSumi對于自定義視圖的支持。
結合上述的開發目标和技術選型,我們有了如下的設計。
設計大圖分層設計
總體來看IDE分為以下幾個層次:
1 IDE容器(CLI)如上我們使用了基于OpenSumi框架的IDE基座,其不僅兼容了VSCode生态,還提供諸多API等擴展,形成了ide-framework。再通過針對經濟體場景下的定制,如登錄态,前端開發工作台等,打包構建了O2這一最終的交付産品。對于我們而言,就是通過開發兼容VSCode API的OpenSumi插件,通過在O2上安裝插件以達到最終的産品交付。
考慮到命令行調用、代碼複用的原因,我們設計了基于Node.js的CLI用于支持諸多基本功能,如創建模闆,編譯模闆,發布模闆等。這裡也有一個兩級分層。即提供通用的調試服務,靜态文件服務的utbd-devtools,以及基于utbd-devtools的各個不同CLI/IDE插件(通過DaemonInterface同utbd-devtools進行交互)。
2 底層能力
這裡主要抽象了一些同模闆開發沒有直接關系的一些公共服務,包括調試協議(通道)、數據的存儲與持久化、單例對象的管理池、Git服務、數據埋點服務等。
3 基礎服務(模闆開發)這裡主要是模闆開發所需要的一些基礎服務。
從編輯的角度而言,主要是自定義的DSL下的代碼智能感知,核心是要一方面去實時分析源代碼的語法樹結構,一方面要結合DSL本身的約束與規範來判斷各個樹節點(及屬性)是否合法等,再結合VSCode本身提供的語言服務器協議,實現最終的代碼智能感知。從DX的角度而言,我們需要考慮以下DSL的分析:
<ImageView
width="match_content"
height="14"
scaleType="fitXY"
imageUrl="@{data.picUrl}"
visibility="@{data.picUrl?'visible':'gone'}"
/>
此處的imageUrl和visibility屬性即通過表達式書寫,表達式不僅可用于XML,也可用于事件鍊文件。表達式語法是一個删減版的TypeScript語法,通過書寫antlr4語法文件(Lexer.g4和Parser.g4),使用antlr4ts工具即可自動生成對應的Lexer.ts,Parser.ts,ParserListener.ts和ParserVisitor.ts文件,從而用于後續AST分析。
分析獲得DSL的AST後,通過元數據(平台約束的控件、表達式、原子能力等)的約束,結合VSCode LSP下支持的代碼智能感知API,我們即可實現包括補全、懸浮文檔、診斷、跳轉定義、代碼格式化、折疊、高亮等在内的代碼開發支持。
4 Feature開發與研發模式組裝
我們按照研發模式包括一條工作流,工作流又可以分為多個階段(準備階段、創建階段、編輯階段、調試階段、測試階段、發布階段),每個階段又包括多個Feature(如創建階段包括創建工程與創建模闆)這樣的層次關系,通過開發Feature最終組裝成DevelopPattern。
5 研發模式擴展實踐中,不僅存在各類研發模式等的訴求,因為各種原因,還存在不少基于研發模式的自定義擴展,如消息業務域有基于DX模式的腳本擴展,菜鳥和CBU有基于DX模式的容器搭建擴展。為此,我們還設計了研發模式擴展插件,容許插件對上述的研發模式進行自定義擴展以滿足各自訴求。
IDE功能與使用本文隻介紹DX研發模式相關功能。
功能區圖示
創建階段創建階段包括DX工程與模闆。
創建工程
創建模闆
【新建模闆】
【克隆模闆】
編輯階段導入模闆
其中包括通過關鍵字搜索模闆,搜索結果可以直接打開(如本地存在),也可以選擇導入。
導入時,我們可以選擇針對單模闆的導入,也可以通過應用名 業務名的方式檢索到相關的所有模闆,一并導入。
模闆導入過程中,會挨個查詢各個模闆的所有版本号,已經對應的内容,将這些内容作為Git記錄,加以提交。對于正式版本号,會打上形如: release/templatename/templateversion這樣的tag。
模闆依賴管理目前IDE中并不支持編譯基礎組件,僅支持引用基礎組件。如需編輯基礎組件需在模闆平台上操作,然後本地更新元數據獲取最新版本号後更新依賴以生效。這是因為,我們希望未來Import可以由Template标簽來替代,Template相關的編輯,引用和編譯IDE中都是支持的。
因而,這裡隻包括基礎組件的依賴管理以及批量版本變更。
對于基礎組件的依賴管理,實際上是可視化地編輯cola.build中的dependencies字段。
批量版本變更則适用于一個基礎組件被一組模闆引用時,批量地更新這些引用模闆對于被引用的基礎組件的版本依賴描述(源代碼),通過選擇預發布,我們也可以在更新源代碼的同時,将引用模闆批量預發布。
類似基礎組件依賴的批量修改,IDE也支持了Slot引用的批量修改。
代碼幫助此處主要包括事件鍊格式化、表達式格式化、本地文件搜索、以及代碼樣例搜索。
其中本地文件搜索可通過簡單的規則精準搜索到文件如并點擊打開,如s/s/m可匹配到: sub_main/src/mock.json。
代碼樣例搜索可通過關鍵字搜索到當前Aone代碼庫(Gitlab)上有哪些引用,如@getEngineStorage結合event_chain.json可以了解到時間鍊中getEngineStorage的具體用法。
表達式支持此處的主要作用是實現表達式的一鍵格式化。
事件鍊可視化此處主要是通過可視化的方式将事件鍊描述的原子能力的調用與轉移表現出來,目前支持了多種轉移關系,包括顯式的轉移以及隐式(表達式)的轉移關系。
點擊節點或者邊也可以自動選中對應的代碼區域。
代碼智能感知這裡主要包括調試服務掃碼、預覽頁單模闆預覽和業務容器多模闆預覽。開發者通過掃碼連接調試服務,當有設備連接時,當前選中的模闆的變更将會編譯并将産物實時推送到手機并生效,當前沒有設備連接時,模闆變更會實時編譯,并将編譯産物以二維碼方式透出,可直接掃碼預覽。
其中預覽頁單模闆預覽同之前模闆平台。
業務容器多模闆的預覽核心是解決預覽頁預覽的一些問題,包括缺少對于自定義組建的良好支持,隻能預覽單模闆,數據Mock不真實等,使用這一特性,開發者可以在任意包含DX模闆的頁面中預覽IDE中的模闆文件,代碼變更并同步到設備成功後,刷新頁面重新渲染模闆即可生效。
這裡也包括通過Command Shift P喚起命令面闆,執行切換預覽模闆從而快速切換到指定模闆的功能(僅預覽頁預覽下有效)。
視圖審查視圖審查主要用于排查布局顯示上的問題,比如節點丢失,屬性值不對等。
假設已經掃碼連接了調試服務,下同,不贅述。
表達式回放
表達式回放主要用于排查複雜表達式執行的問題。
事件鍊回放
事件鍊回放主要用于排查事件鍊執行的問題。
設備管理
主要用于同iOS模拟器(Mac上)的深度融合,這樣開發者即使沒有一個iOS設備,或者設備商沒有可用于測試的包,也可以方便地安裝并使用IDE的各個功能。
發布階段模闆發布
發布的結果彈窗也會提示開發者這次發布産生了哪些版本号,産物cdn地址等。
模闆曆史版本查詢
這裡包括: 模闆url拷貝、模闆zip下載、模闆預覽、發布信息、源代碼查看、代碼Diff、内容回滾、Diff鍊接分享(CR使用)等。
批量内置
這裡将會完成雙端産物的内置,以及Android側所需要的presetTemplateInfos.json構建。
設置這裡主要是Gitlab Token的配置,以及基于GitDiff的模闆發布所以來的Diff基線配置。
IDE演進思考針對過去模闆平台的不足,我們實現了從編輯器到IDE的轉變,顯著提升了開發者的研發體驗。面向未來,我們有以下方面的演進思考:
擴大應用場景/團隊1 IDE直接收益目前,IDE已實現DX工程化和全研發生命周期支持,包含優秀的代碼編輯體驗,諸多問題排查手段,豐富的工具箱以解決研發痛點,後續我們将圍繞以下方面開展技術叠代。
1 既有設計的完善更多精彩资讯请关注tft每日頭條,我们将持续为您更新最新资讯!