Spring Boot does not require any specific code layout to work. However, there are some best practices that help.
When a class does not include a package declaration, it is considered to be in the
“default package”. The use of the “default package” is generally discouraged and
should be avoided. It can cause particular problems for Spring Boot applications that use
the @ComponentScan, @EntityScan, or @SpringBootApplication annotations, since every
class from every jar is read.
![]() | Tip |
|---|---|
We recommend that you follow Java’s recommended package naming conventions and use a
reversed domain name (for example, |
We generally recommend that you locate your main application class in a root package
above other classes. The @EnableAutoConfiguration annotation is often placed on your
main class, and it implicitly defines a base “search package” for certain items. For
example, if you are writing a JPA application, the package of the
@EnableAutoConfiguration annotated class is used to search for @Entity items.
Using a root package also lets the @ComponentScan annotation be used without needing to
specify a basePackage attribute. You can also use the @SpringBootApplication
annotation if your main class is in the root package.
The following listing shows a typical layout:
com
+- example
+- myapplication
+- Application.java
|
+- customer
| +- Customer.java
| +- CustomerController.java
| +- CustomerService.java
| +- CustomerRepository.java
|
+- order
+- Order.java
+- OrderController.java
+- OrderService.java
+- OrderRepository.javaThe Application.java file would declare the main method, along with the basic
@Configuration, as follows:
package com.example.myapplication; 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); } }