学习笔记之一《SpringBoot3-基础特性》

文章目录

• • • 一、SpringApplication
    • 二、Profiles
    • • 2.1 使用
      • 2.2 Profile 分组
      • 2.3 Profile 配置文件
    • 三、外部化配置
    • 四、单元测试-JUnit5
    • • 4.1 整合
      • 4.2 测试

一、SpringApplication

1.1 自定义 banner

• 类路径添加banner.txt 或设置 spring.banner.location 就可以定制 banner。
• 推荐网站：Spring Boot banner 在线生成工具，制作下载英文 banner.txt，修改替换 banner.txt 文字失效自定义，个性化启动banner-bootschool.net 。

1.2 自定义SpringApplication

import org.springframework.boot.Banner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication application = new SpringApplication(MyApplication.class);
        application.setBannerMode(Banner.Mode.OFF);
        application.run(args);
    }

}

1.3 FluentBuilder API

new SpringApplicationBuilder()
    .sources(Parent.class)
    .child(Application.class)
    .bannerMode(Banner.Mode.OFF)
    .run(args);

二、Profiles

2.1 使用

2.1.1 指定环境

• Spring Profiles 提供了一种隔离配置的方式，使其仅在特定环境生效；
• 任何@Component，@Configuration，或@ConfigurationProperties 可以使用 @Profile 标记，来指定何时被加载。【容器中的组件都可以被 @Profile 标记】

2.1.2 环境激活

1. 配置环境指定环境；配置文件

spring.profiles.active=production,hsqldb

1. 也可以使用命令行激活。–spring.profiles.active=dev,hsqldb

2. 还可以配置默认环境；不标注@Profile的组件永远都存在。

   a. 以前默认环境叫default。

   b. spring.profiles.default=test

3. 推荐使用激活方式激活指定环境。

2.1.3 环境包含

注意：

1. spring.profiles.active 和 spring.profiles.default 只能用到 无 profile 的文件中，如果在 application-dev.yaml 中编写就是无效的。

2. 也可以额外添加到生效文件，而不是激活替换。比如：

spring.profiles.include[0]=common
spring.profiles.include[1]=local

最佳实战：

• 生效的环境 = 激活的环境/默认环境 + 包含的环境
• 项目里面这么用
  • 基础的配置 mybatis 、log 、xxx ：写到包含环境中。
  • 需要动态切换变化的 db、 redis：写到激活的环境中。

2.2 Profile 分组

创建 prod 组，指定包含 db 和 mq 配置。

spring.profiles.group.prod[0]=db
spring.profiles.group.prod[1]=mq

使用–spring.profiles.active=prod ，就会激活prod，db，mq配置文件

2.3 Profile 配置文件

• application-{profile}.properties 可以作为指定环境的配置文件。
• 激活这个环境。配置就会生效。最终生效的所有配置是
  • application.properties ： 主配置文件，任意时候都能生效。
  • application-{profile}.properties：指定环境配置文件，激活指定环境生效

profile优先级 > application

三、外部化配置

3.1 配置优先级

Spring Boot 允许将配置外部化，以便可以在不同的环境中使用相同的应用程序代码。

我们可以使用各种外部配置资源，包括 Java Properties 文件、YAML 文件、环境变量 和 命令行参数。

@Value 可以获取值，也可以使用 @ConfigurationProperties 将所有属性绑定到 java object中

以下是 SpringBoot 属性源加载顺序。后面的会覆盖前面的值。由低到高，高优先级配置覆盖低优先级

1. 默认属性（通过SpringApplication.setDefaultProperties指定的）
2. @PropertySource 指定加载配置（需要卸载@Configuration类上才可以生效）
3. 配置文件（application.properties/yaml等）
4. RandomValuePropertySource 支持的 random.* 配置（如：@Value(“${random.int}”)
5. OS环境变量
6. Java系统属性(System.getProperties())
7. JNDI 属性（来自 java:comp/env)
8. ServletContext 初始化参数
9. ServletConfig 初始化参数
10. SPRING_APPLICATION_JSON属性（内置在环境变量或系统属性中的JSON）
11. 命令行参数
12. 测试属性。(@SpringBootTest进行测试时指定的属性)
13. 测试类@TestPropertySource注解
14. Devtools 设置的全局属性。（$HOME/.config/spring-boot）

配置文件优先级如下:(后面覆盖前面)

1. jar 包内的 application.properties/yml
2. jar 包内的 application-{profile}.properties/yml
3. jar 包外的 application.properties/yml
4. jar 包外的 application-{profile}.properties/yml

建议：用一种格式的配置文件。如果 .properties 和.yml 同时存在，则 .properties优先

所有参数均可由命令行传入，使用 --参数项=参数值，将会被添加到环境变量中，并优先于配置文件。

比如java -jar app.jar --name="Spring",可以使用@Value("${name}")获取

演示场景：

• 包内： application.properties server.port=8000
• 包内： application-dev.properties server.port=9000
• 包外： application.properties server.port=8001
• 包外： application-dev.properties server.port=9001

启动端口？：命令行 > 9001 > 8001 > 9000 > 8000

3.2 外部配置

SpringBoot 应用启动时会自动寻找application.properties和application.yaml位置，进行加载。顺序如下：（后面覆盖前面）

1. 类路径: 内部

2. 1. 类根路径
   2. 类下/config包

3. 当前路径（项目所在的位置）

4. 1. 当前路径
   2. 当前下/config子目录
   3. /config目录的直接子目录

最终效果：优先级由高到低，前面覆盖后面

• 命令行 > 包外config直接子目录 > 包外config目录 > 包外根目录 > 包内目录

• 同级比较：

• • profile配置 > 默认配置
  • properties配置 > yaml配置

规律：最外层的最优先。

• 命令行 > 所有
• 包外 > 包内
• config目录 > 根目录
• profile > application

配置不同就都生效（互补），配置相同高优先级覆盖低优先级

3.3 导入配置

使用spring.config.import 可以导入额外配置

spring.config.import=my.properties
my.property=value

无论以上写法的先后顺序，my.properties 的值总是优先于直接在文件编写的 my.property 。

3.4 属性占位符

配置文件中可以使用 ${name:default}形式取出之前配置过的值。

app.name=MyApp
app.descripation=${app.name} is a Spring Boot application written by ${username:Unknown}

四、单元测试-JUnit5

4.1 整合

SpringBoot 提供一系列测试工具集及注解方便我们进行测试。

spring-boot-test提供核心测试能力，spring-boot-test-autoconfigure 提供测试的一些自动配置。

我们只需要导入spring-boot-starter-test 即可整合测试

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

spring-boot-starter-test 默认提供了以下库供我们测试使用

• JUnit 5
• Spring Test
• AssertJ
• Hamcrest
• Mockito
• JSONassert
• JsonPath

4.2 测试

4.2.1 组件测试

直接@Autowired容器中的组件进行测试

4.2.2 注解

JUnit5的注解与JUnit4的注解有所变化

https://junit.org/junit5/docs/current/user-guide/#writing-tests-annotations

• **@Test 😗*表示方法是测试方法。但是与JUnit4的@Test不同，他的职责非常单一不能声明任何属性，拓展的测试将会由Jupiter提供额外测试
• **@ParameterizedTest 😗*表示方法是参数化测试，下方会有详细介绍
• **@RepeatedTest 😗*表示方法可重复执行，下方会有详细介绍
• **@DisplayName 😗*为测试类或者测试方法设置展示名称
• **@BeforeEach 😗*表示在每个单元测试之前执行
• **@AfterEach 😗*表示在每个单元测试之后执行
• **@BeforeAll 😗*表示在所有单元测试之前执行
• **@AfterAll 😗*表示在所有单元测试之后执行
• **@Tag 😗*表示单元测试类别，类似于JUnit4中的@Categories
• **@Disabled 😗*表示测试类或测试方法不执行，类似于JUnit4中的@Ignore
• **@Timeout 😗*表示测试方法运行如果超过了指定时间将会返回错误
• **@ExtendWith 😗*为测试类或测试方法提供扩展类引用

import static org.junit.jupiter.api.Assertions.fail;
import static org.junit.jupiter.api.Assumptions.assumeTrue;

import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

class StandardTests {

    @BeforeAll
    static void initAll() {
    }

    @BeforeEach
    void init() {
    }

    @DisplayName("hahahaha")
    @Test
    void succeedingTest() {
    }

    @Test
    void failingTest() {
        fail("a failing test");
    }

    @Test
    @Disabled("for demonstration purposes")
    void skippedTest() {
        // not executed
    }

    @Test
    void abortedTest() {
        assumeTrue("abc".contains("Z"));
        fail("test should have been aborted");
    }

    @AfterEach
    void tearDown() {
    }

    @AfterAll
    static void tearDownAll() {
    }

}

4.2.3 断言

4.2.4 嵌套测试

4.2.5 参数化测试

参数化测试是JUnit5很重要的一个新特性，它使得用不同的参数多次运行测试成为了可能，也为我们的单元测试带来许多便利。

利用@ValueSource等注解，指定入参，我们将可以使用不同的参数进行多次单元测试，而不需要每新增一个参数就新增一个单元测试，省去了很多冗余代码。

@ValueSource: 为参数化测试指定入参来源，支持八大基础类以及String类型,Class类型

@NullSource: 表示为参数化测试提供一个null的入参

@EnumSource: 表示为参数化测试提供一个枚举入参

@CsvFileSource：表示读取指定CSV文件内容作为参数化测试入参

@MethodSource：表示读取指定方法的返回值作为参数化测试入参(注意方法返回需要是一个流)

@ParameterizedTest
@ValueSource(strings = {"one", "two", "three"})
@DisplayName("参数化测试1")
public void parameterizedTest1(String string) {
    System.out.println(string);
    Assertions.assertTrue(StringUtils.isNotBlank(string));
}


@ParameterizedTest
@MethodSource("method")    //指定方法名
@DisplayName("方法来源参数")
public void testWithExplicitLocalMethodSource(String name) {
    System.out.println(name);
    Assertions.assertNotNull(name);
}

static Stream<String> method() {
    return Stream.of("apple", "banana");
}