程式碼結構

Spring Boot 並不要求任何特定的程式碼佈局才能工作。然而，有一些最佳實踐會有所幫助。

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

使用“default”包

當一個類不包含 package 宣告時，它被認為位於“default package”中。通常不鼓勵使用“default 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)
}