Java如何搭建腳手架(自動生成通用程式碼),建立自定義的archetype(專案模板)

發表於2021-09-04

  新建專案時,有些配置和包總是相同的,每次新增非常麻煩,並且都是重複性複製貼上的工作。此時,一個優秀的程式設計師,會想著如何不做重複性的工作,去提高工作效率。

  那什麼叫腳手架呢?當搭建一個專案時,一些基礎性的工作,如一些共同的元件、服務、配置、測試等在新建專案時就一起生成,形成一個模板。這個就叫做腳手架。

本篇部落格包含

  ①分析整個工程包含的結構

  ②如何建立腳手架;

  ③如何使用腳手架

一、專案包含的結構

  在我們的專案中,有一個檔案,叫read.me,就是用來說明專案的資訊,其中就描述了專案的相關資訊。

  1.專案包結構

    每個公司的專案名稱、包名稱,都有自己公司的標準。所以結構都不相同。並且每個專案的特點也不同。對於小專案或者以模組為專案的微服務,多采用controller,service,dao,entity的分包方式;而對於大的單體應用,更多采用的是以業務命名的包方式。這兩種各有優缺點。前者命名的方式,程式碼量相對較少,程式碼複用率高,缺點是相對較聚集,耦合度高,拆分不方便。後者業務能夠聚聚,方便查詢,更清晰,維護方便。本人更傾向於後者。

以本人的為例,如下圖所示:

  2.各個層的模板類

  包括controller、service、mapper等包中的模板類。每個類的命名、註解、返回的響應實體都統一。開發程式碼時以這些類作為模板,統一風格和標準。

  如下圖所示:

 

 

 

 

 

 

二、如何建立腳手架

  建立步驟:

  1.首先建立一個spring-boot的maven專案。

     假如需要搭建一個web專案,則需要引入SpringMvc作為基礎;假如搭建一個task或者rop專案,則需要引入對於的定時任務包等相關包。(參考上面的包結構)

  2.搭建基本的專案完成

     將專案執行起來,能夠訪問並進行單元測試,說明專案基本的沒有問題。將專案中的.class,.setting,.project的檔案刪除調。

  3.然後在專案pom中加入以下外掛配置。

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-archetype-plugin</artifactId>
                <version>3.0.1</version>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
            </plugin>

   注:對於已經存在的專案,也可以將專案做成腳手架,同樣先將.class,.setting,.project等不必要的檔案刪除,再加入外掛

  4.執行外掛

  在maven中,雙擊archetype:create-from-project執行archetype外掛,執行的結果在控制檯中顯示:BUILD SUCCESS 說明構建成功,同時可以看到檔案存放的路徑。如下圖:

 

  6.執行安裝命令

  在檔案的存放路徑下(archetype目錄中),開啟cmd視窗,執行命令:mvn clean install 。如下圖所示,直到看到 BUILD SUCCESS,說明執行成功了。

 

  7.執行結果

  成功之後,就可以在本地倉庫的根目錄中看到一個檔案:archetype-catalog.xml, 開啟該檔案,可以看到對應的archetypes結果,並且其中的groupId和artifactId能在倉庫中找到,如下圖:

 

   

 

  8.然後依然在該archetype目錄執行命令:mvn archetype:crawl

   當看到 BUILD SUCCESS時,說明成功了。

 

三、如何使用腳手架

  在IntelliJ IDEA中使用腳手架

  1.新增腳手架

  在idea中引入腳手架 點選選單File -> new -> Project... 如下圖所示,選擇maven,勾選Create from archetype,點選 Add Archetype按鈕,

填寫groupId和artifactId、version資訊(就是archetype-catalog.xml檔案中的資訊),點選OK,便新增完成。

 

  2.填寫專案名稱

  點選next,填寫專案名稱,然後確定,便生成了整個專案結構。  

  注:包下有檔案的才會生成,而空包不會生成。

  結果如下圖:

  

 

 

 

  若覺得博文不錯 請點選推薦,感謝你的支援。

 

.

相關文章