程式碼結構

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)
}