您的位置: 首页  >  IT文章  >  （四）Spring Boot官网文档学习

（四）Spring Boot官网文档学习

分类: IT文章 • 2024-06-14 08:20:31

文章目录

原文地址：https://docs.spring.io/spring-boot/docs/2.1.3.RELEASE/reference/htmlsingle/#using-boot-structuring-your-code

关于默认包的问题

在 java 中，如果我们把一个 java 类，不放到特定包里面，则默认放到 默认包 里面，在使用 Spring Boot 的时候，要避免这样做，因为这样做，会导致使用 @ComponentScan, @EntityScan, or @SpringBootApplication 注解出现一些问题；

加载启动类

Spring Boot 建议我们将，启动类，放在所有类之上，根包下面，因为启动类上面的 @SpringBootApplication 注解，有个隐式的扫描包的动作，它会扫描他所在包下面的所以包，这样就省去我们使用 @ComponentScan 注解进行手动扫描了；

官网建议我们包格式如下：

com
 +- example
     +- myapplication
         +- Application.java
         |
         +- customer
         |   +- Customer.java
         |   +- CustomerController.java
         |   +- CustomerService.java
         |   +- CustomerRepository.java
         |
         +- order
             +- Order.java
             +- OrderController.java
             +- OrderService.java
             +- OrderRepository.java

可以看到启动类 Application.java 在所有类的上面；

如果不想使用 @SpringBootApplication 可以使用 @EnableAutoConfiguration and @ComponentScan 两个注解替换，完成一样的效果；

@EnableAutoConfiguration
@ComponentScan(value = "hello")
// @SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

配置

  • 基于 java 类

    在 Spring Boot 里面，推荐使用基于 java 类的配置，而不去使用基于 xml 的配置，杜绝任何 xml 文件的产生；

    官网建议的做法是：创建一个单例的 java 类，使用 @Configuration 标识为配置类，该类里面进行各种配置，因为 Spring Boot 支持基于 java 的配置 ；

    但是不需要将所有的配置，都放在一个 java 里面，可以使用 @Import 注解导入其他配置类，或者使用 @ComponentScan 注解，扫描所有的类，这样也就自动的导入了配置类；

  • 导入 xml 文件

    如果项目必须使用到 xml 文件，官方依然建议先创建一个配置类，进行其他配置，然后使用注解 @ImportResource 导入 xml 文件的配置 ；

  • 自动配置（Auto-configuration）

    Spring Boot 会自动配置依赖，根据你在 pom 文件里面配置的依赖，你只需要将注解 @EnableAutoConfiguration或@SpringBootApplication 配置到任何一个配置类上，即可获得 Auto-configuration 的功能 ；

    自动配置是非侵入性的；比如你添加了数据源的依赖，则自动配置，会在你没有配置数据源实例的时候，进行自动配置，一旦你自己配置了，则自动配置将取消之前的配置；

    还可以禁止某些配置的自动配置，在配置上使用注解 @EnableAutoConfiguration

    import org.springframework.boot.autoconfigure.*;
import org.springframework.boot.autoconfigure.jdbc.*;
import org.springframework.context.annotation.*;

@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class MyConfiguration {
}

    如果要禁止的类不在类路径下面，则使用 excludeName 值为类的全限定名来替换掉 exclude ：

Bean管理和依赖注入

官方建议使用 @ComponentScan 扫描 beans，然后使用 @Autowired 进行属性的注入 ；

如果我们按照上面我说的 加载启动类 那样做。则我们可以直接使用不带参数的@ComponentScan 所有应用程序组件（@ Component，@ Service，@ Repository，@ Controller等），注册 Beans ;

就像下面这样，直接使用 @Service 创建一个 service 层 的 bean ，而不用带任何参数：

package com.example.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class DatabaseAccountService implements AccountService {

	private final RiskAssessor riskAssessor;

	@Autowired
	public DatabaseAccountService(RiskAssessor riskAssessor) {
		this.riskAssessor = riskAssessor;
	}

	// ...

}

如果 bean 只有一个构造器，则 @Autowired 可以被省略：

@Service
public class DatabaseAccountService implements AccountService {

	private final RiskAssessor riskAssessor;

	public DatabaseAccountService(RiskAssessor riskAssessor) {
		this.riskAssessor = riskAssessor;
	}

	// ...

}

@SpringBootApplication

一个 @SpringBootApplication 相当于下面三个注解：

  1. @EnableAutoConfiguration 根据依赖项自动配置项目
  2. @ComponentScan 可以扫描本身所在包及其子包
  3. @Configuration 配置类

Developer Tools

开发者工具；Spring Boot 还提供了一额外的工具包，提供一些开发时可能需要的功能，可以添加到 Maven 依赖里面：

<dependencies>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-devtools</artifactId>
		<optional>true</optional>
	</dependency>
</dependencies>

上述配置中的 optional 置为 true ，使得开发者工具，仅仅在开发环境中可以使用，也就是打成 jar 包的时候，将自动的被禁用；

关于 Developer Tools 的一些细节

  1. 缓存问题

    Sping Boot 支持一些库使用缓存功能；比如：模板引擎，会缓存已经编译过的模板，以避免重复解析模板文件；SpringMvc 提供静态资源的时候，可以设置 Http 缓存头 ；

    但是缓存功能，可能会导致新的页面无法里面被访问，因此，spring-boot-devtools 工具包，默认禁用缓存选项；

    缓存配置（包括下面的配置），通常在 application.properties 文件里面配置，spring-boot-devtools 不需要手动去设置这些属性，只会自适应application.properties 等配置文件的配置 ；

  2. 日志级别

    还可以打印出 Web 请求的详细信息，只需要将 spring.http.log-request-details 置为 true，否则默认是不打印详细信息的；

  3. 自动重启

    使用了工具包以后，将会监测类路径上的文件，一旦有文件发生改变，则自动重启项目，以及时得到修改反馈，在 IDEA 中，更改完资源以后，需要 build 一下，以更新类路径下文件，触发自动重启 ；

    当决定类路径上的条目是否应该在更改时触发重新启动时，DevTools会自动忽略名为spring-boot，spring-boot-devtools，spring-boot-autoconfigure，spring-boot-actuator和spring-boot-starter的项目。

  4. 排除资源

    一些资源改动，我们整个项目重启，比如只是改变了模板元素这些，我们更希望的是，仅仅重新加载我们改动的，其他的不要重新加载 ；

    默认情况下 /META-INF/maven，/META-INF/resources，/resources，/static，/public，或 /templates 下面的资源改动，不会引起重启，只会引起局部重新加载；

    如果要自定义这些排除项，这样默认的排除项就没了：

    spring.devtools.restart.exclude=static/**,public/**

    如果想保留默认的排除项，再继续添加新的排除项，使用：

    spring.devtools.restart.additional-exclude=static/**,public/**

  5. 其他触发重启路径

    使用注解 spring.devtools.restart.additional-paths 配置；

  6. 禁用重启

    如果想禁用重启，则配置 spring.devtools.restart.enabled 为 false ，但是这样做，还是会初始化重新启动的类加载器，只是不会监视文件更改；

    在某些情况下，需要完全禁用，让它得不到加载，因为某些库不能与重新加载的类加载器一起使用，这时候需要这样做：

    public static void main(String[] args) {
	System.setProperty("spring.devtools.restart.enabled", "false");
	SpringApplication.run(MyApp.class, args);
}

  7. 使用触发器文件

    仅针对特定文件的修改，才触发重启；使用 spring.devtools.restart.trigger-file 配置下特定文件的路径地址 ；

    实现了序列化接口对象的改动，不会触发重启 ；

相关推荐