Spring Boot不要求使用任何特殊的代码结构,不过,遵循以下的一些最佳实践还是挺有帮助的。
当类没有声明package
时,它被认为处于default package
下。通常不推荐使用default package
,因为对于使用@ComponentScan
,@EntityScan
或@SpringBootApplication
注解的Spring Boot应用来说,它会扫描每个jar中的类,这会造成一定的问题。
注 我们建议你遵循Java推荐的包命名规范,使用一个反转的域名(例如com.example.project
)。
通常建议将应用的main类放到其他类所在包的顶层(root package),并将@EnableAutoConfiguration
注解到你的main类上,这样就隐式地定义了一个基础的包搜索路径(search package),以搜索某些特定的注解实体(比如@Service,@Component等)
。例如,如果你正在编写一个JPA应用,Spring将搜索@EnableAutoConfiguration
注解的类所在包下的@Entity
实体。
采用root package方式,你就可以使用@ComponentScan
注解而不需要指定basePackage
属性,也可以使用@SpringBootApplication
注解,只要将main类放到root package中。
下面是一个典型的结构:
com
+- example
+- myproject
+- Application.java
|
+- domain
| +- Customer.java
| +- CustomerRepository.java
|
+- service
| +- CustomerService.java
|
+- web
+- CustomerController.java
Application.java
将声明main
方法,还有基本的@Configuration
。
package com.example.myproject;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}