Java開發學習心得(三):專案結構
3 專案結構
經過前面一系列學習,差不多對Java的開發過程有了一定的瞭解,為了能保持一個良好的專案結構,考慮到接下來要進行開發,還需要學習一下Java的專案結構
下面以兩個專案結構為參照
圖1
圖2
第一個是我自己學習時的Demo,一邊學一邊建檔案,應該有些錯誤的地方,第二張是從網上看到的一個結構比較清晰的圖片
圖1的結構完整一點,就以圖1為主一點點講起
3.1 src
因為我用的是Maven,大方向上專案兩大資料夾分別是src和target,以及一個pom.xml配置檔案,src目錄裡是專案工程的原始碼檔案,配置檔案和資原始檔等,其下一級是main和test這兩個資料夾
3.1.1 main
main資料夾下是主要的工程原始檔,然後下面又是兩個資料夾:java和resources,其實上面也講了,而且顧名思義,java裡面是原始碼檔案,resources裡面是資原始檔
3.1.1.1 java
這之下的檔案結構可以參考上面的圖2了,大體上就是model-mapper-service-controller,其他還有公共類和表現層等,這裡在下面單獨分一個章節來說
3.1.1.2 resources
資原始檔夾預設就是這個樣子,application.properties是用來填寫各種配置的,比如資料庫連線的配置資訊、日誌元件的配置資訊等,有些人會改成yml字尾名,裡面的格式就不盡相同了,在前面也講過,這裡就不再贅述。
除此之外,各種元件的配置檔案也在這個資料夾下
還有一個主要的作用是存放靜態檔案資源,包括需要訪問的jsp、html、css、js、圖片等,還有程式碼模板
- 專案配置檔案:resources/application.yml
- 靜態資源目錄:resources/static/
——用於存放html、css、js、圖片等資源 - 檢視模板目錄:resources/templates/
——用於存放jsp、thymeleaf等模板檔案 - mybatis對映檔案:resources/mapper/(mybatis專案)
- mybatis配置檔案:resources/mapper/config/(mybatis專案)
3.1.2 test
如題所述,單元測試用的
3.2 target
target是有存放專案構建後的檔案和目錄,jar包、war包、編譯的class檔案等
target裡的所有內容都是maven構建的時候生成的
jar 包就是 java archive file java 的一種文件格式。jar檔案非常類似zip
WAR是Sun提出的一種Web應用程式格式,與JAR類似,也是許多檔案的一個壓縮包。這個包中的檔案按一定目錄結構來組織:
通常其根目錄下包含有Html和Jsp檔案或者包含這兩種檔案的目錄,另外還會有一個WEB-INF目錄,這個目錄很重要。通常在WEB-INF目錄下有一個web.xml檔案和一個classes目錄,web.xml是這個應用的配置檔案,而classes目錄下則包含編譯好的Servlet類和Jsp或Servlet所依賴的其它類(如JavaBean)。
通常這些所依賴的類也可以打包成JAR放到WEB-INF下的lib目錄下,當然也可以放到系統的CLASSPATH中,但那樣移植和管理起來不方便
target裡的所有內容都是maven構建的時候生成的
4 Java的工程檔案結構
傳統的三層不用再解釋了,在Java裡對應資料訪問層的是DAO,進行資料互動,對應業務邏輯層的是Service層,這裡寫邏輯程式碼,然後就是UI層
4.1 幾種物件的解釋
上面提到DAO,這裡簡單說說一些相關的簡寫,在一些原始碼裡看到了,初學時有點懵
- PO(persistant object): 持久物件,可以看成是與資料庫中的表相對映的java物件。最簡單的PO就是對應資料庫中某個表中的一條記錄,多個記錄可以用PO的集合。PO中應該不包含任何對資料庫的操作。實體
- VO(value object):值物件,通常用於業務層之間的資料傳遞,和PO一樣也是僅僅包含資料而已。但應是抽象出的業務物件,可以和表對應,也可以不,這根據業務的需要。可能就是Get/Set?
- DAO(Data Access Object):資料訪問物件,用於訪問資料庫,裡面包含對資料庫的各種操作,配合VO進行CRUD
- DTO(Data Transfer Object):資料傳輸物件,是一組需要跨程序或網路邊界傳輸的聚合資料的簡單容器。它不應該包含業務邏輯,並將其行為限制為諸如內部一致性檢查和基本驗證之類的活動。我一開始以為是業務實體,但是看說明不是一個東西,那個是BO。
DTO的用法:
比如我們一張表有100個欄位,那麼對應的PO就有100個屬性。但是我們介面上只要顯示10個欄位,客戶端用WEB service來獲取資料,沒有必要把整個PO物件傳遞到客戶端,這時我們就可以用只有這10個屬性的DTO來傳遞結果到客戶端,這樣也不會暴露服務端表結構.到達客戶端以後,如果用這個物件來對應介面顯示,那此時它的身份就轉為VO。DTO還有減少請求的次數、簡化傳輸物件、避免程式碼重複等作用。
- ORM(O/R Mapping,Object Relational Mapping):物件關係對映
4.2 實際的專案檔案應該如何設計
可以參考圖2
- bean也就是實體了,對應資料庫的欄位
- DAO,前面也說過了,不過裡面寫法可以細分很多種,使用Mybatis就是Mapper介面檔案或者是xml的寫法,如果還使用了JPA,還會有個repository類檔案
- Service,這塊好像寫法的爭議比較多,可以看看這篇文章有多少人在濫用 service+serviceImpl,又有多少人在誤用myBatis
我在很多地方都看到了一個ServiceImpl介面,一個service類的寫法,一直不理解為什麼要多次一舉,但還是照著做了,上面那篇文章裡說到這是一種過時的寫法,使用介面檔案是為了解決可能連線各種資料庫而有多個數據訪問層的問題,這樣只需要實現對應的結構就行了,而有了Mybatis之後這種問題就不存在了,所以不需要再寫impl介面檔案,使用 service+dao+mapper.xml 是一種更好的選擇 - Controller,這裡只討論MVC了,普通java web的寫法還不會,然後從controller應該就直接到資原始檔裡的HTML頁面了
- 上面是按順序自下而上的,除此之外一些公共層:工具類庫(utils)、配置類(config)、資料傳輸物件(dto)、檢視包裝物件(vo)
還可以看看這篇spring boot 專案開發常用目錄結構