6.1.3. Gradle

要了解如何使用 Spring Boot 和 Gradle，请查看 Spring Boot 的 Gradle 插件文档：

• 参考 (HTML 和 PDF)

• API

6.1.4. Ant

搭建 Spring Boot 项目可以使用Apache的Ant + lvy。spring-boot-antlib模块也有助于Ant创建可执行的jar包。

要声明依赖关系，一个典型的ivy.xml文件如下所示：

<ivy-module version="2.0">
  <info organisation="org.springframework.boot" module="spring-boot-sample-ant" />
  <configurations>
  <conf name="compile" description="everything needed to compile this module" />
  <conf name="runtime" extends="compile" description="everything needed to run
this module" />
  </configurations>
  <dependencies>
  <dependency org="org.springframework.boot" name="spring-boot-starter"
  rev="${spring-boot.version}" conf="compile" />
  </dependencies>
</ivy-module>

一个典型的build.xml文件如下所示：

<project
  xmlns:ivy="antlib:org.apache.ivy.ant"
  xmlns:spring-boot="antlib:org.springframework.boot.ant"
  name="myapp" default="build">
  <property name="spring-boot.version" value="2.7.2" />
  <target name="resolve" description="--> retrieve dependencies with ivy">
  <ivy:retrieve pattern="lib/[conf]/[artifact]-[type]-[revision].[ext]" />
  </target>
  <target name="classpaths" depends="resolve">
  <path id="compile.classpath">
  <fileset dir="lib/compile" includes="*.jar" />
  </path>
  </target>
  <target name="init" depends="classpaths">
  <mkdir dir="build/classes" />
  </target>
  <target name="compile" depends="init" description="compile">
  <javac srcdir="src/main/java" destdir="build/classes"
classpathref="compile.classpath" />
  </target>
  <target name="build" depends="compile">
  <spring-boot:exejar destfile="build/myapp.jar" classes="build/classes">
  <spring-boot:lib>
  <fileset dir="lib/runtime" />
  </spring-boot:lib>
  </spring-boot:exejar>
  </target>
</project>

Tip

如果您不想使用spring-boot-antlib模块，请查看 How-to Guides 中的 Build an Executable Archive from Ant without Using spring-boot-antlib”

6.1.5. Starters

启动器是一套方便的依赖描述符，可以将其包含在应用程序中。您可以获得所有 Spring 和其相关技术的一站式服务，而不需要查找示例代码并且复制粘贴大量的依赖描述符。例如，如果您想要使用 Spring 和 JPA 来进行数据库访问，请在项目中包含 spring-boot-starter-data-jpa启动器

启动器包含许多快速启动和运行项目所需的依赖，并且具有一致的、受支持的托管依赖传递关系

在一个名称里的东西是什么？

所有的官方启动器都遵循一个类似的命名模板: spring-boot-starter-*，* 是一个独特的应用类型。这种命名结构旨在当需要找到启动器时提供帮助。大部分的 IDE 中集成的 Maven 允许按名称查找依赖，例如，安装了合适的 Eclipse 或者是 Spring Tools 插件后，在 POM 编辑器中按 ctrl + space 键入“ spring-boot-starter ”可以获得完整的依赖列表。

正如“Creating Your Own Starter”（创造自己的启动器）所言，第三方启动器不应该以spring-boot开头，因为这是为Spring Boot官方依赖所保留的。当然，一个第三方启动器常常会以项目的名称作为开头（所以一般不用担心）。比如，一个叫做thirdpartproject的第三方项目将会毫无疑问地以thirdpartproject-spring-boot-starter命名

Spring Boot 的org.springframework.boot分组提供下面的应用启动器：

表1.Spring Boot应用启动器

除了上面提到的应用启动器，下列启动器常常用于添加 生产就绪 特性：

表2.Spring Boot 生产启动器

最后，Spring Boot 还包含了以下启动器，如果您想排除或者更换指定技术面的话会用到：

表3.Spring Boot技术启动器

要了解如何交换技术面，请查看 swapping web server 和 logging system 文档

Tip

对于社区贡献的启动器列表，请查看在Github上的spring-boot-starters模块中的 README 文件

6.2. Structuring Your Code

Spring Boot不需要使用任何指定的布局代码来工作，然而，也有些最佳实践是有所帮助的

6.2.1. Using the “default” Package

当一个类不包含package关键字的声明，它被认为在“默认包”下。这种“默认包”的使用通常是不被鼓励且应该摒弃的。，在Spring Boot使用@ComponentScan、@ConfigurationPropertiesScan、@EntityScan、或者是@SpringBootApplication注解的时候， 它会引起奇怪的 BUG，因为每个 jar 包里的类都是可读的

Tip

建议您这边遵循Java的推荐包命名规范并且使用反向域名（例如：com.example.project）

6.2.2. Locating the Main Application Class

我们通常推荐您在其他类上面的根路径包中查找您的主应用类。 @SpringBootApplication注解 常常用于放置在主类上，并且暗中为某些项目定义了一个基础的“搜索包”。例如，如果您编写一个JPA应用，@SpringBootApplication注释的包将用于定位@Entity注解项。此外，使用根路径包也允许组件扫描仅用于您的项目。

Tip

如果不想使用@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

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

Kotlin

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication
@SpringBootApplication
class MyApplication
fun main(args: Array<String>) {
  runApplication<MyApplication>(*args)
}

6.3. Configuration Classes

Spring Boot 钟爱基于Java的配置，虽然XML文件源也可以使用SpringApplication，我们通常建议您的主要来源应当是一个独立的@Configuration类。通常地，定义main方法的类是一个好的@Configuration的候选者

6.3.1. Importing Additional Configuration Classes

您不需要把所有的@Configuration放在一个独立的类中，@Import注解常常用于导入其他的配置类。此外，您还可以使用@ComponentScan注解，它会自动装配所有包含@Configuration注解的类将其作为Spring的组件

6.3.2. Importing XML Configuration

如果您必须要使用基于XML的配置，那么我们也建议您先从一个@Configuration类开始，接着使用@ImportResource注解加载XML配置文件

Tips

（虽然）网络上有许多使用XML配置的Spring Boot发布示例，（但是）如果可能的话，我们始终建议您使用基于Java的相同配置。比如查找Enable*开头注解是一个好的开端

6.4、 Auto-configuration

Spring Boot自动配置基于添加的 jar 包依赖试图自动地构建Spring应用程序。例如：如果 HSQLDB(Hyper SQL Database) 在类路径下，并且没有手动地配置任何数据库连接的 bean，那么 Spring Boot 自动配置一个内存中的数据库。

通过向其中一个@Configuration配置类中添加@EnableAutoConfiguration或者 @SpringBootApplication注解来选择加入自动配置。

Tips

您应该只添加一个@SpringBootApplication或者@EnableAutoConfiguration注解，通常建议只将其中一个添加到您的@Configuration配置类中

6.4.1. Gradually Replacing Auto-configuration

自动配置是非侵入式的，在任何时候，都可以自定义配置更换特定的自动配置。例如：如果您添加自定义的DataSource的bean，那么默认内置的数据库就会失效.

如果需要了解当前应用的自动配置及其原因，打开应用程序--debug开关，这样做可以启用核心日志器作日志调试并且会将情况输出到控制台。

6.4.2、Disabling Specific Auto-configuration Classes

如果发现应用程序中有不想使用的自动配置类，可以使用 @SpringBootAplication 注解的排除属性来禁用他们，如下所示：

Java

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class })
public class MyApplication {
}

Kotlin

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration
@SpringBootApplication(exclude = [DataSourceAutoConfiguration::class])
class MyApplication

如果该类不在类路径下，还可以使用注解的excludeName属性并且指定类的全限定名。如果您更喜欢使用@EnableAutoConfiguration而不是@SpringBootApplication注解，exclude和excludeName属性也能使用。顺便一提，使用spring.autoconfigure.exclude属性，还能排除自动配置类的列表

Tips

排除(不需要的自动配置类)不仅可以在注解上而且还能使用属性

Note

虽然自动配置类是公共的，但是这些API的公共部分只能用于禁用自动配置类。这些类的实际内容，就类似于嵌套配置类或者bean方法，只供内部使用，所以我们并不推荐直接使用这些内容