提供了编程的基础技术教程

zl程序教程

您现在的位置是：首页 >  后端

当前栏目

你有没有掉进去过这些Spring Boot中的“陷阱“（上）

SpringBoot 这些 有没有 陷阱 掉进去
2023-06-13 09:11:16 时间

一、Spring Boot配置文件中的“陷阱”

Spring Boot的配置文件是指导Spring Boot Application运行的重要文件，是一个全局的配置文件；相比较Spring Spring MVC MyBatis框架的配置文件更加简化，底层默认做了很多配置。Spring Boot的配置文件默认放在resources目录下，且文件名必须为application。

Spring Boot存在两种形式的配置文件分别是properties和yml形式，两种配置文件同时存在的情况下，properties格式的配置文件优先级更高，相比之下yml格式配置文件更加简洁明了紧凑且可读性高，Spring Boot支持并推荐使用yml格式配置文件。

工程搭建

新建一个Maven工程spring-boot-traps，在pom.xml文件中添加依赖以及maven插件，完整的pom.xml文件如下

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.citi</groupId>
    <artifactId>spring-boot-traps</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-traps</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- apache 的一些工具类 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.8.1</version>
        </dependency>
    </dependencies>

    <build>
        <!--指定打成JAR包的名字-->
        <finalName>${artifactId}</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

在com.citi.spring.traps包下新增主启动类TrapsApplication

@SpringBootApplication
public class TrapsApplication {

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

在test包的相同路径下增加主启动类的测试类TrapsApplicationTest

@SpringBootTest
public class TrapsApplicationTest {

    @Test
    public void context(){
        ApplicationContext context = new AnnotationConfigApplicationContext("com.citi.spring.traps");
        String[] beanDefinitionNames = context.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            System.out.println("容器中的对象:" + beanDefinitionName);
        }
    }
}

执行测试

Spring 容器可以正常运行

配置文件加载顺序的“陷阱”

使用配置文件给实体类赋值

在entity包下新增UserProperties

@Data
@Component
@ConfigurationProperties(prefix = "traps.user")
public class UserProperties {

    private String name;
    private Integer age;

}

@ConfigurationProperties注解可以指定配置文件中配置项的前缀

在application.yml中增加配置

traps:
  user:
    name: stark
    age: 41

增加UserProperties的测试类

public class UserPropertiesTest extends TrapsApplicationTest {

    @Autowired
    private UserProperties userProperties;

    @Test
    public void getProperty(){

        System.out.println(userProperties);
    }

}

执行测试

根据控制台打印日志，可以看出UserProperties被成功赋值

配置文件优先级

  • 工程目录下/config/application.yml，优先级最高
  • 工程目录下/application.yml，优先级第二
  • resources/config/application.yml，优先级第三
  • resources/application.yml，优先级第四

不同位置都放置了配置文件，高优先级的配置会覆盖低优先级的配置，多个配置文件是互补的，即取多个文件的并集

验证配置文件优先级

在resource目录下新建config文件夹，增加application.yml

traps:
  user:
    name: stark in resources/config/
    age: 41

执行测试

根据控制台打印出的日志，可以确定resources目录下的application.yml被config目录下的application.yml覆盖了

在工程下目录下新增application.yml

traps:
  user:
    name: stark in root/
    age: 41

执行测试

根据控制台日志打印，可以确定工程根目录下的配置文件覆盖了resource目录下的两个配置文件

在工程根目录下新建config目录，在config目录下新增application.yml

traps:
  user:
    name: stark in root/config/
    age: 41

执行测试

根据控制台日志打印，可以确定工程根目录下config文件下的配置文件的优先级是最高的

application.yml多环境配置

第一种方式可以使用spring.profile.active指定配置文件

resources目录下新建两个配置文件application-dev.yml、application-test.yml

traps:
  user:
    name: stark in dev
    age: 41
traps:
  user:
    name: stark in test
    age: 41

修改application.yml，使用spring.profile.active指定使用的配置文件

spring:
  profiles:
    # 指定使用的配置文件
    active: test

删除config目录，执行测试

根据控制台的日志可以确定，使用的配置文件为test环境的配置文件

第二种方式是使用占位符，即启动应用时指定使用哪个环境的配置 修改application.yml

spring:
  profiles:
    # 使用占位符
    active: ${spring.profiles.active}

使用maven命令打包，在终端中执行启动命令并指定配置文件

java -jar spring-boot-traps.jar --spring.profiles.active=test

终端启动日志如下

控制台日志显示使用的配置文件是test

定时任务执行的“陷阱”

Spring Boot中可以非常简单的实现定时任务，而且定时任务有自己独立的线程池，不会影响到业务主线程

Spring Boot中编写定时任务需要用到两个注解

  • @EnableScheduling标注在配置类上使@Scheduled注解生效
  • @Schedule注解标注在方法上，表示这是一个定时任务
    • fixedDelay：上次任务的结束和下次任务的开始之间的固定间隔多少秒
    • fixedRate：上次任务的开始和下次任务开始之间的频率，不管任务是否结束
    • initialDelay：与fixedDelay和fixedRate组合使用，指的是第一次任务等待指定的时间后才开始执行
    • cron：表达式配置任务执行时间

编写定时任务类

新建task目录，新增ScheduledTask类，定义定时任务

@Component
@Slf4j
public class ScheduledTask {

    @Scheduled(fixedRate = 1000)
    public void task01() throws InterruptedException {
        log.info("Scheduled task01 processing");
        while (true){
            Thread.sleep(2000);
            log.info("Scheduled Task process something");
        }
    }

    @Scheduled(fixedRate = 1000)
    public void task02() throws InterruptedException {
        log.info("Scheduled task01 processing");

    }
}

在主启动类上增加注解@EnableScheduling，表示启用定时任务

启动主程序类，观察控制台打印的日志

根据打印的日志可以发现，只有task01在运行，task02并没有运行，这是为什么？

点击主启动类上的@EnableScheduling注解，查看 ScheduledAnnotationBeanPostProcessor类的源码

其中setScheduler方法的作用就是设置定时任务线程池 ，而Spring Boot 默认使用单线程去执行定时任务，线程一直在task01的while中循环，没有多余的线程去执行task02

配置定时任务线程池

配置定时任务线程池的方式有两种，第一种是在application.yml中配置线程池

在application.yml中增加定时任务线程池配置

spring:
  profiles:
    # 指定使用的配置文件
    active: test

  task:
    scheduling:
      pool:
        size: 5

重新启动应用

根据控制台的打印可以看出，task01和task02都执行了

第二种方式是通过编写配置类ScheduleConfig实现自定义定时任务的线程池

新增config包，在config包下新增配置类ScheduleConfig

@Configuration
public class ScheduleConfig {

    @Bean
    public TaskScheduler taskScheduler(){
        ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
        taskScheduler.setPoolSize(5);
        return taskScheduler;
    }
}

注释掉application.yml中的线程池大小配置，重新启动应用

根据控制台日志显示，task01和task02都可以正常执行

相关文章