springBoot項目常用目錄解讀

更新時間：2023年05月15日 15:10:03 作者：mx_wrc

這篇文章主要介紹了springBoot項目常用目錄解讀，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

springBoot項目常用目錄

springBoot項目的目錄結(jié)構(gòu)及名規(guī)范

介紹基于SpringBoot開發(fā)時的目錄結(jié)構(gòu)及命名規(guī)范，通過介紹能夠為你解決，在實際項目中如何規(guī)劃目錄結(jié)構(gòu)？如何命名目錄更規(guī)范？各個目錄分別代表什么含義？等三個問題。

目錄說明

servicex                 // 項目名
    |- admin-ui          // 管理服務(wù)前端代碼(一般將UI和SERVICE放到一個工程中，便于管理)
    |- servicex-auth     // 模塊1
    |- servicex-common   // 模塊2
    |- servicex-gateway  // 模塊3
    |- servicex-system   // 模塊4
        |- src
            |- main                  // 業(yè)務(wù)邏輯
                |- assembly          // 基于maven assembly插件的服務(wù)化打包方案
                    |- bin           // 模塊腳本(啟動、停止、重啟)
                    |- sbin          // 管理員角色使用的腳本(環(huán)境檢查、系統(tǒng)檢測等等)
                    |- assembly.xml  // 配置文件
                |- java              // 源碼
                    |- com
                        |- hadoopx
                            |- servicex
                                |- system
                                    |- annotation     // 注解
                                    |- aspect         // 面向切面編程
                                    |- config         // 配置文件POJO
                                    |- filter         // 過濾器
                                    |- constant       // 存放常量
                                    |- utils          // 工具
                                    |- exception      // 異常
                                    |- controller     // 控制層(將請求通過URL匹配，分配到不同的接收器/方法進(jìn)行處理，然后返回結(jié)果)
                                    |- service        // 服務(wù)層接口
                                        |- impl       // 服務(wù)層實現(xiàn)
                                    |- mapper/repository // 數(shù)據(jù)訪問層，與數(shù)據(jù)庫交互為service提供接口
                                    |- entity/domain     // 實體對象
                                        |- dto // 持久層需要的實體對象(用于服務(wù)層與持久層之間的數(shù)據(jù)傳輸對象)
                                        |- vo // 視圖層需要的實體對象(用于服務(wù)層與視圖層之間的數(shù)據(jù)傳輸對象)
                                    |- *Application.java  // 入口啟動類
                |- resources         // 資源
                    |- static        // 靜態(tài)資源(html、css、js、圖片等)
                    |- templates     // 視圖模板(jsp、thymeleaf等)
                    |- mapper        // 存放數(shù)據(jù)訪問層對應(yīng)的XML配置
                        |- *Mapper.xml
                        |- ...
                    |- application.yml        // 公共配置
                    |- application-dev.yml    // 開發(fā)環(huán)境配置
                    |- application-prod.yml   // 生產(chǎn)環(huán)境配置
                    |- banner.txt    
                    |- logback.xml            // 日志配置
            |- test                  // 測試源碼
               |- java               
                    |- com
                        |- hadoopx
                            |- servicex
                                |- system
                                    |- 根據(jù)具體情況按源碼目錄結(jié)構(gòu)存放編寫的測試用例
        |- target     // 編譯打包輸出目錄(自動生成，不需要創(chuàng)建)
        |- pom.xml    // 該模塊的POM文件
    |- sql            // 項目需要的SQL腳本
    |- doc            // 精簡版的開發(fā)、運維手冊
    |- .gitignore     // 哪些文件不用傳到版本管控工具中
    |- pom.xml        // 工程總POM文件
    |- README.md      // 注意事項
External Libraries    // 相關(guān)JAR包依賴

注意事項

(1). mapper/repository，數(shù)據(jù)訪問層，與數(shù)據(jù)庫交互為service提供接口(對某個表進(jìn)行增刪改查，一個’*Mapper.java’和一個’*Mapper.xml’對應(yīng)一張表(存在關(guān)聯(lián)查詢的情況)；Mybatis使用的是mapper，JPA使用的是repository)

(2). entity/domain，數(shù)據(jù)實體類(Mybatis使用的是entity，JPA使用的是domain)

(3). POJO，VO，DTO，DO，PO，BO的含義：

POJO：是一個簡單的、普通的JAVA對象，它包含業(yè)務(wù)邏輯處理或持久化邏輯等。但不是JavaBean、EntityBean等，不具有任何特殊角色，不繼承或不實現(xiàn)任何其它JAVA框架的類或接口。可以包含類似與JavaBean屬性和對屬性訪問的setter和getter方法的對象。
VO(View Object)：視圖對象，用于展示層顯示，代表展示層需要顯示的數(shù)據(jù)。它的作用是把某個指定頁面/組件需要的所有數(shù)據(jù)封裝起來。
DTO(Data Transfer Object)：數(shù)據(jù)傳輸對象，用于服務(wù)層與持久層之間的數(shù)據(jù)傳輸對象，代表服務(wù)層需要接收/返回的數(shù)據(jù)。
DO(Domain Object)：領(lǐng)域?qū)ο?，就是從現(xiàn)實世界中抽象出來的有形或無形的實體對象。
PO(Persistent Object)：持久化對象，它跟持久層(通常是關(guān)系型數(shù)據(jù)庫)的數(shù)據(jù)結(jié)構(gòu)形成一一對應(yīng)的映射關(guān)系，數(shù)據(jù)表中的每個字段(或若干個)就對應(yīng)PO的一個(或若干個)屬性。
BO(Business Object)：業(yè)務(wù)對象，用于把業(yè)務(wù)邏輯封裝為一個對象，這個對象可以包括一個或多個其它的對象。
POJO持久化之后 -> PO；POJO傳輸過程中 -> DTO；POJO用作表示層 -> VO