程式碼結構化

Spring Boot 並不要求特定的程式碼佈局才能運作。然而，有些最佳實踐可以提供幫助。

如果您希望強制執行基於領域的結構，請查看 Spring Modulith。

使用「預設」套件

當一個類別不包含 package 宣告時，它會被視為在「預設套件」中。「預設套件」的使用通常不被鼓勵，應該避免。對於使用 @ComponentScan、@ConfigurationPropertiesScan、@EntityScan 或 @SpringBootApplication 註解的 Spring Boot 應用程式，這可能會導致特殊問題，因為會讀取每個 jar 中的每個類別。

我們建議您遵循 Java 建議的套件命名慣例，並使用反向網域名稱（例如，com.example.project）。

定位主應用程式類別

我們通常建議您將主應用程式類別放在高於其他類別的根套件中。@SpringBootApplication 註解 通常放在您的主類別上，並且它隱含地為某些項目定義了一個基礎「搜尋套件」。例如，如果您正在編寫 JPA 應用程式，則 @SpringBootApplication 註解類別的套件會用於搜尋 @Entity 項目。使用根套件也允許元件掃描僅應用於您的專案。

如果您不想使用 @SpringBootApplication，它導入的 @EnableAutoConfiguration 和 @ComponentScan 註解定義了該行為，因此您也可以改用這些註解。

以下列表顯示了一個典型的佈局

com
 +- example
     +- myapplication
         +- MyApplication.java
         |
         +- customer
         |   +- Customer.java
         |   +- CustomerController.java
         |   +- CustomerService.java
         |   +- CustomerRepository.java
         |
         +- order
             +- Order.java
             +- OrderController.java
             +- OrderService.java
             +- OrderRepository.java

MyApplication.java 檔案將宣告 main 方法，以及基本的 @SpringBootApplication，如下所示

  • Java

  • Kotlin

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

	public static void main(String[] args) {
		SpringApplication.run(MyApplication.class, args);
	}

}
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

@SpringBootApplication
class MyApplication

fun main(args: Array<String>) {
	runApplication<MyApplication>(*args)
}