Java如何搭建腳手架(自動生成通用代碼),創建自定義的archetype(項目模板)


  新建項目時,有些配置和包總是相同的,每次添加非常麻煩,並且都是重復性復制粘貼的工作。此時,一個優秀的程序員,會想着如何不做重復性的工作,去提高工作效率。

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

本篇博客包含

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

  ②如何創建腳手架;

  ③如何使用腳手架

一、項目包含的結構

  在我們的項目中,有一個文件,叫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,填寫項目名稱,然后確定,便生成了整個項目結構。  

  注:包下有文件的才會生成,而空包不會生成。

  結果如下圖:

  

 

 

 

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

 

.


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM