1. 程式人生 > 實用技巧 >Spring Boot 服務端開發專案目錄結構

Spring Boot 服務端開發專案目錄結構

後端伺服器的組成: pom.xml(Maven專案配置檔案) + java資料夾 + resource資料夾

  • 程式碼層(java),根目錄com.xxx:XxxApplication.java + 對應模組程式碼(domain + controller + service + mapper等)
  1. XxxApplication.java(專案主入口,main方法)
  2. controller: 控制層,請求介面
  3. service: 服務層,邏輯程式碼,資料服務的實現介面(serviceImpl)UserService.java 和 UserServiceImpl.java
  4. mapper: 資料層,或者dao, 比如UserMapper.java 、UserMapper.xml
  5. domain: 實體類,同 bean、entity、model

      bean:任何一個java類都可以成為一個bean,這個類裡包含物件的屬性、get、set方法及其他的業務邏輯。

      model:model是MVC中的概念,可以理解為View層展示資料的物件。

      entity:資料表對應到實體類的對映。

  • 資源層(resource):存放資原始檔,比如郵件html、mapper
  1. email郵件模板,比如registerSuccess.html
  2. properties配置檔案,比如mybatis.properties
  3. mapper檔案,比如UserMapper.xml(也可以寫到程式碼層的mapper資料夾中)
  4. template模板
  5. application.yml
  6. log4j2.xml日誌配置

// 根目錄結構
-src: 
  -main: 
    -java: - com.xxx
    -resource: -
  -test: 
-target:
-pom.xml
  • src/main/java: 程式碼檔案目錄
  • src/main/resource: 資原始檔目錄
  • pom.xm:Maven專案配置檔案

// java程式碼檔案目錄: 檔案目錄按如下進行規範命名
-java:
    -com.xxx:
        -entity
        -controller
        -service
        
-mapper -util -XxxApplication.java
  • entity:實體類,也可以命名為bean、entity、model,例如User.java
  • controller: 控制層,請求介面,例如UserController.java
  • service: 服務層,以及關聯的介面檔案,例如UserService.java(impl/UserServiceImpl.java)
  • mapper: 資料層,也可以命名為dao,例如UserMapper.java和UserMapper.xml
  • model: 請求使用到的實體類: xxxRequestTO.java、xxxReponseTO.java
  • config、constant、util等配置檔案
  • XxxApplication.java : 專案主入口,main方法

// resource資原始檔目錄
-resource: 
    -mapper
    -static
    -template
    -application.yml
  • application.yml: 配置檔案,也可命名為application.properties

// 資料庫配置 -- application.yml
spring:
    datosource:
        driver-class-name: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://localhost:3306/dataBaseName?userUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8
        username: youMysqlUsername
        password: yourMysqlPassword