本發(fā)明涉及項目框架領(lǐng)域,具體涉及一種前端項目框架生成方法。
背景技術(shù):
項目的初始框架搭建,需要定義好目錄結(jié)構(gòu),編寫程序啟動文件、配置文件,啟動調(diào)試等工作,而這些工作是每個項目初始都必須要做的。項目的數(shù)量越多,花費的時間就越長??焖匍_發(fā)是每個企業(yè)追求的目標,而快速創(chuàng)建項目是其中的一個關(guān)鍵環(huán)節(jié)。
前端技術(shù)發(fā)展很快,已不再僅僅局限于頁面展示,前端技術(shù)引入了更多其他領(lǐng)域的思想和方法論,從而產(chǎn)生各種框架和新技術(shù),把現(xiàn)有的一些前端新技術(shù)整合在一起,讓其為創(chuàng)建項目服務(wù),也是各個企業(yè)和開發(fā)團隊要考慮的問題。
現(xiàn)有技術(shù)基本上是通過復(fù)制老項目的項目框架進行開發(fā),速度慢,技術(shù)落后。其創(chuàng)建新項目時,首先復(fù)制粘貼老項目的目錄,然后在其基礎(chǔ)上修改項目中的文件,修改完成后進行新項目的調(diào)試,確認沒問題之后開始新項目的開發(fā)。這種方式的不足之處是:1)速度慢,要手動進行配置文件的修改,刪除不必要的文件等,修改完了還需要調(diào)試是否有問題。2)技術(shù)棧得不到更新,沿用老的項目框架導(dǎo)致只能繼續(xù)使用原有的技術(shù),一些可以提高開發(fā)效率的新技術(shù)得不到使用。
技術(shù)實現(xiàn)要素:
本發(fā)明所要解決的技術(shù)問題是提供一種前端項目框架生成方法,通過模板文件生成新項目所需的文件內(nèi)容,包括項目啟動文件,配置文件等,并且在程序中定義好項目的模塊和目錄結(jié)構(gòu),讓開發(fā)團隊無需再花時間重新定義整理。
為解決上述技術(shù)問題,本發(fā)明采用的技術(shù)方案是:
一種前端項目框架生成方法,包括以下步驟:
步驟1:定義項目模板文件,包括項目的啟動文件、初始頁面文件、樣式文件和配置文件,且所述模板文件的目錄結(jié)構(gòu)已按照模塊劃分好;
步驟2:定義交互式命令,包括提示用戶輸入項目名、提示用戶輸入項目描述、以及提示用戶選擇是否需要定制功能;
步驟3:找到存放模板文件的目錄,將其中的主程序目錄,包括文檔、源代碼、測試、配置和服務(wù)端復(fù)制到目標文件夾,根據(jù)用戶的輸入不同進行不同的處理邏輯,即若判斷到?jīng)]有選擇定制化功能,則只復(fù)制基礎(chǔ)的項目模板文件,包括文檔、源代碼和配置目錄,反之不僅會復(fù)制基本的項目模板文件,還會復(fù)制帶有定制化功能的模板文件到目標目錄;
步驟4:根據(jù)最終選擇生成新項目。
進一步的,定義交互式命令包括創(chuàng)建項目的命令,具體為:提示用戶輸入項目名稱;名稱輸入完畢后,繼續(xù)提示用戶輸入項目描述;描述輸入完畢后,提示用戶是否需要其他定制功能;若用戶選擇是,則生成帶有定制功能的項目,若用戶選擇否,則只生成基礎(chǔ)模塊的項目。
進一步的,定義交互式命令包括創(chuàng)建項目單一模塊的命令,具體為:提示用戶輸入模塊的名稱;名稱輸入完成后,繼續(xù)提示用戶該模塊是否需要其他定制功能;若選擇是,則生成帶有定制功能的模塊,若選擇否,則只生成帶有基礎(chǔ)功能的模塊。
與現(xiàn)有技術(shù)相比,本發(fā)明的有益效果是:通過模板文件生成新項目所需的文件內(nèi)容,包括項目啟動文件,配置文件等,并且在程序中定義好項目的模塊和目錄結(jié)構(gòu),讓開發(fā)團隊無需再花時間重新定義整理,快速搭建前端項目框架,提高效率,節(jié)省時間,配置靈活。
附圖說明
圖1是本發(fā)明一種前端項目框架生成方法之目錄結(jié)構(gòu)圖。
圖2是本發(fā)明一種前端項目框架生成方法之項目創(chuàng)建流程圖。
圖3是本發(fā)明一種前端項目框架生成方法之創(chuàng)建項目交互式命令流程圖。
圖4是本發(fā)明一種前端項目框架生成方法之創(chuàng)建模塊交互式命令流程圖。
具體實施方式
下面結(jié)合附圖和具體實施方式對本發(fā)明作進一步詳細的說明。本發(fā)明的前端表示網(wǎng)站的前臺部分,包括網(wǎng)站的表現(xiàn)層和結(jié)構(gòu)層,技術(shù)棧表示項目中使用到的各種技術(shù),工具和框架的統(tǒng)稱。
本發(fā)明一種前端項目框架生成方法,在創(chuàng)建項目的過程中,讓開發(fā)團隊自定義地選擇新項目要包含哪些模塊,一些不需要的項目模塊可以不在新項目中創(chuàng)建,從而達到定制化創(chuàng)建新項目的目的。整合了現(xiàn)有前端的前沿技術(shù),包括頁面渲染技術(shù),文件構(gòu)建技術(shù),頁面數(shù)據(jù)狀態(tài)管理技術(shù)等,這樣使得創(chuàng)建出來的新項目可以很方便的為開發(fā)團隊服務(wù),提高團隊的開發(fā)效率。而且整合的技術(shù)棧不是一成不變,而是通過技術(shù)發(fā)展隨時進行更新,這樣就不用擔(dān)心技術(shù)棧得不到更新的問題。
詳述如下:
1)項目模板文件
自動化創(chuàng)建項目的方法需要先定義一套項目模板文件,這些文件包括項目的啟動文件,初始頁面文件和樣式文件,配置文件等,并且這些模板文件的目錄結(jié)構(gòu)已按照模塊劃分好了,方便開發(fā)團隊快速熟悉項目框架。目錄結(jié)構(gòu)如圖1所示。在圖1中,src目錄是項目源代碼目錄,下面有components,containers,constants,utils等目錄,這些目錄是按模塊定義好的目錄結(jié)構(gòu),webpack目錄是存放配置文件的地方,另外還有其他一些項目文件。
2)項目創(chuàng)建程序
項目創(chuàng)建分2個部分,一個是項目整體框架的創(chuàng)建,一個是項目單個模塊的創(chuàng)建。項目創(chuàng)建流程如圖2所示,包括用戶執(zhí)行創(chuàng)建項目的命令、程序?qū)⒛0逦募?fù)制到新項目的目錄、提示用戶選擇是否需要定制化功能、根據(jù)用戶選擇生成新項目。
首先定義3個交互式命令,分別是提示用戶輸入項目名、提示用戶輸入項目描述以及提示用戶選擇是否需要定制功能。
然后是復(fù)制程序模板框架的功能,先找到存放模板文件的目錄,然后將其中的主程序目錄,包括文檔、源代碼、測試、配置和服務(wù)端復(fù)制到目標文件夾,其中根據(jù)用戶的輸入不同而有不同的處理邏輯。如果判斷到用戶沒有選擇了定制化功能,則程序只復(fù)制文檔、源代碼和配置目錄的項目模板文件(基本的項目模板文件),反之程序不僅會復(fù)制基本項目文件,還會復(fù)制帶有定制化功能的模板文件到目標目錄。
程序在執(zhí)行復(fù)制文件的過程中,不是單純的原封不動的拷貝文件,而是會在模板文件的基礎(chǔ)上,動態(tài)生成具體的項目文件,然后再將文件拷貝到目標目錄。比如,有一個項目模板文件叫package.json,里面的內(nèi)容為:"name":"<%=projectName%>",程序在執(zhí)行的過程中,會將該文件動態(tài)生成為:"name":"my app",然后再將該文件復(fù)制到目標目錄。
3)交互式命令
在用戶創(chuàng)建項目的過程中,會提示用戶做一些命名上的交互,包括輸入項目名稱,項目描述,選擇特定的功能等。
(1)創(chuàng)建項目的交互式命令流程如圖3所示:包括用戶執(zhí)行創(chuàng)建項目的命令、程序提示用戶輸入項目名稱、名稱輸入完畢后程序繼續(xù)提示用戶輸入項目描述、描述輸入完畢后程序提示用戶是否需要其他定制功能、如果用戶輸入“是”,則生成帶有其他定制功能的項目、如果用戶輸入“否”,則只生成基礎(chǔ)模塊的項目,最后創(chuàng)建項目成功。
(2)創(chuàng)建項目模塊的交互式流程如圖4所示:包括用戶執(zhí)行創(chuàng)建項目單一模塊的命令、程序提示用戶輸入模塊的名稱、名稱輸入完成后程序繼續(xù)提示用戶該模塊是否需要其他定制功能、如果用戶選擇是,則程序生成帶有定制功能的模塊、如果用戶選擇否,則程序只生成帶有基礎(chǔ)功能的模塊。