二、SpringBoot3配置文件
|
32
|
0
|
springboot

2024 字
|
20 分钟

二、SpringBoot3配置文件

1、统一配置管理概述

1、作用

1、就是统一配置。我们可以设置任何参数（端口号、项目根路径、数据库连接等）

2、怎么做？

1、要写一个配置文件

2、而且是固定命名的配置文件：

  • application.properties
  • 或application.yml

3、功能配置参照表

Common Application Properties (spring.io)

3、例子（以properties为例）

1、创建一个application.properties配置文件

2、代码实现

server.address="/"
server.port=8088

spring.cassandra.username=root
spring.cassandra.password=root

2、属性配置文件

1、就是用properties文件进行配置

2、可以使用一些Spring家族定义的固定key，我们自己写value

# 固定的key
# 启动端口号
server.port=80

3、也可以定义自定义的key和value

# 自定义
spring.jdbc.datasource.driverClassName=com.mysql.cj.jdbc.driver
spring.jdbc.datasource.url=jdbc:mysql:///springboot_01
spring.jdbc.datasource.username=root
spring.jdbc.datasource.password=root

4、属性设置好了。怎么读取？

  • 例子

  • package com.atguigu.properties;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class DataSourceProperties {

  @Value("${spring.jdbc.datasource.driverClassName}")
  private String driverClassName;

  @Value("${spring.jdbc.datasource.url}")
  private String url;

  @Value("${spring.jdbc.datasource.username}")
  private String username;

  @Value("${spring.jdbc.datasource.password}")
  private String password;

  // 生成get set 和 toString方法
  public String getDriverClassName() {
      return driverClassName;
  }

  public void setDriverClassName(String driverClassName) {
      this.driverClassName = driverClassName;
  }

  public String getUrl() {
      return url;
  }

  public void setUrl(String url) {
      this.url = url;
  }

  public String getUsername() {
      return username;
  }

  public void setUsername(String username) {
      this.username = username;
  }

  public String getPassword() {
      return password;
  }

  public void setPassword(String password) {
      this.password = password;
  }

  @Override
  public String toString() {
      return "DataSourceProperties{" +
              "driverClassName='" + driverClassName + '\'' +
              ", url='" + url + '\'' +
              ", username='" + username + '\'' +
              ", password='" + password + '\'' +
              '}';
  }
}

  • 测试

  • @Autowired
private DataSourceProperties dataSourceProperties ;

@RequestMapping(path = "/hello")
public String sayHello() {
System.out.println(dataSourceProperties);
return "Hello Spring Boot ! " ;
}

3、YAML配置文件使用

1、什么是YAML文件

1、YAML（YAML Ain’t Markup Language）是一种基于层次结构的数据序列化格式，旨在提供一种易读、人类友好的数据表示方式。

1、优势

1、优势

  • 层次结构：
    • YAML文件使用缩进和冒号来表示层次结构，使得数据之间的关系更加清晰和直观。
    • 这样可以更容易理解和维护复杂的配置，特别适用于深层次嵌套的配置情况。
  • 自我描述性：
    • YAML文件具有自我描述性，字段和值之间使用冒号分隔，并使用缩进表示层级关系。
    • 这使得配置文件更易于阅读和理解，并且可以减少冗余的标点符号和引号。
  • 注释支持：
    • YAML格式支持注释，可以在配置文件中添加说明性的注释，使配置更具可读性和可维护性。
    • 相比之下，.properties文件不支持注释，无法提供类似的解释和说明。
  • 多行文本：
    • YAML格式支持多行文本的表示，可以更方便地表示长文本或数据块。
    • 相比之下，.properties文件需要使用转义符或将长文本拆分为多行。
  • 类型支持：
    • YAML格式天然支持复杂的数据类型，如列表、映射等。
    • 这使得在配置文件中表示嵌套结构或数据集合更加容易，而不需要进行额外的解析或转换。
  • 更好的可读性：
    • 由于YAML格式的特点，它更容易被人类读懂和解释。
    • 它减少了配置文件中需要的特殊字符和语法，让配置更加清晰明了，从而减少了错误和歧义。

2、总结

  • AML格式相对于.properties文件具有更好的层次结构表示、自我描述性、注释支持、多行文本表示、复杂数据类型支持和更好的可读性。
  • 这些特点使YAML成为一种有力的配置文件格式，尤其适用于复杂的配置需求和人类可读的场景。然而，选择使用YAML还是.properties取决于实际需求和团队的偏好，简单的配置可以使用.properties，而复杂的配置可以选择YAML以获得更多的灵活性和可读性

2、语法

1、 数据结构用树形结构呈现，通过缩进来表示层级，

2、连续的项目（集合）通过减号 ” - ” 来表示

3、键值结构里面的key/value对用冒号 ” : ” 来分隔。

4、YAML配置文件的扩展名是yaml 或 yml

5、例子

# YAML配置文件示例
app_name: 我的应用程序
version: 1.0.0
author: 张三

database:
  host: localhost
  port: 5432
  username: admin
  password: password123

features:
  - 登录
  - 注册
  - 仪表盘

settings:
  analytics: true
  theme: dark

3、怎么配置？

1、举例

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.jdbc.Driver
      url: jdbc:mysql:///springboot_02
      username: root
      password: root

server:
  port: 80

4、如何读取？

1、读取和properties配置是一样的

2、例子

package com.atguigu.properties;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class DataSourceProperties {

    @Value("${spring.jdbc.datasource.driverClassName}")
    private String driverClassName;

    @Value("${spring.jdbc.datasource.url}")
    private String url;

    @Value("${spring.jdbc.datasource.username}")
    private String username;

    @Value("${spring.jdbc.datasource.password}")
    private String password;

    // 生成get set 和 toString方法
    public String getDriverClassName() {
        return driverClassName;
    }

    public void setDriverClassName(String driverClassName) {
        this.driverClassName = driverClassName;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "DataSourceProperties{" +
                "driverClassName='" + driverClassName + '\'' +
                ", url='" + url + '\'' +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

4、批量配置文件注入

1、@ConfigurationProperties注解

1、@ConfigurationProperties注解是SpringBoot提供的重要注解, 他可以将一些配置属性批量注入到bean对象

1、怎么用

1、一般是在类上

2、@ConfigurationProperties( prefix = "xxxx") //xxxx是前缀

2、例子

1、单独的读取

    //这些是单独的读取
    @Value("${zwf.info.username}")
    private String username;
    @Value("${zwf.info.password}")
    private String password;

    @Value("${zwf.gfd.username}")
    private List<String > gfs;

2、这个是批量读取

package com.atguigu.pojo;

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;

/**
 *
 */

@Component
@Data
//添加注释，批量配置读取
@ConfigurationProperties(prefix = "zwf.user")
public class User {

//    这些是单独的读取
//    @Value("${zwf.info.username}")
    private String username;
//    @Value("${zwf.info.password}")
    private String password;

//    @Value("${zwf.gfd.username}")
    private List<String > gfs;
}

5、多环境配置和使用

1、需求

1、开发环境、测试环境、生产环境都不一样。我们要可以使用多环境配置来适应这些环境

2、内容

1、就是说我们可以配置多个.yaml的配置文件。来让项目加载不同的环境

3、常见方法

1、方法一：属性文件分离

1、将应用程序的配置参数分离到不同的属性文件中，每个环境对应一个属性文件。

例如，可以创建application-dev.properties、application-prod.properties和application-test.properties等文件。

在这些文件中，可以定义各自环境的配置参数，如数据库连接信息、端口号等。

然后，在application.properties中通过spring.profiles.active属性指定当前使用的环境。Spring Boot会根据该属性来加载对应环境的属性文件，覆盖默认的配置。

2、方法二：YAML配置文件

1、与属性文件类似，可以将配置参数分离到不同的YAML文件中，每个环境对应一个文件。

2、例如，可以创建application-dev.yml、application-prod.yml和application-test.yml等文件。

3、在这些文件中，可以使用YAML语法定义各自环境的配置参数。

4、同样，通过spring.profiles.active属性指定当前的环境，Spring Boot会加载相应的YAML文件。

3、方法三：命令行参数(动态)

1、可以通过命令行参数来指定当前的环境。

2、例如，可以使用--spring.profiles.active=dev来指定使用开发环境的配置。

4、总结

1、pring Boot会根据当前指定的环境来加载相应的配置文件或参数，从而实现多环境配置。

2、这样可以简化在不同环境之间的配置切换，并且确保应用程序在不同环境中具有正确的配置。

4、例子（基于方法二实践）

1、创建开发、测试、生产环境的配置文件

2、开发环境文件：application-dev.yml（开发）

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql:///dev
      username: root
      password: root

3、测试环境文件：application-test.yml（测试）

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql:///test
      username: root
      password: root

4、生产环境文件：application-prod.yml（生产）

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql:///prod
      username: root
      password: root

5、整体环境激活

spring:
  profiles:
    active: dev

5、注意

1、如果设置了spring.profiles.active，并且和application有重叠属性，以active设置优先。

2、如果设置了spring.profiles.active，和application无重叠属性，application设置依然生效！

6、启动类的配置

1、目的是为了快速方便搭建配置

2、注解@SpringBootApplication

3、实现

package com.atguigu;

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

@SpringBootApplication
public class Main {
    public static void main(String[] args) {
        SpringApplication.run(Main.class, args);
        // 启动项目
    }

}
暂无评论

发送评论 编辑评论 


				

			

						

				

					

						

							

								
							

							
						

					

				

				

					

						

							

								
							

							
						

					

				

				

					

						

							

								
							

							
							
													

					

				

			

			
			

				

					
				

			

				

											

							
							
						

																				
					
											
						

	

		
|´・ω・)ノ
ヾ(≧∇≦*)ゝ
(☆ω☆)
（╯‵□′）╯︵┴─┴
￣﹃￣
(/ω＼)
∠( ᐛ 」∠)＿
(๑•̀ㅁ•́ฅ)
→_→
୧(๑•̀⌄•́๑)૭
٩(ˊᗜˋ*)و
(ノ°ο°)ノ
(´இ皿இ｀)
⌇●﹏●⌇
(ฅ´ω`ฅ)
(╯°A°)╯︵○○○
φ(￣∇￣o)
ヾ(´･ ･｀｡)ノ"
( ง ᵒ̌皿ᵒ̌)ง⁼³₌₃
(ó﹏ò｡)
Σ(っ °Д °;)っ
( ,,´･ω･)ﾉ"(´っω･｀｡)
╮(╯▽╰)╭
o(*////▽////*)q
＞﹏＜
( ๑´•ω•) "(ㆆᴗㆆ)
😂
😀
😅
😊
🙂
🙃
😌
😍
😘
😜
😝
😏
😒
🙄
😳
😡
😔
😫
😱
😭
💩
👻
🙌
🖕
👍
👫
👬
👭
🌚
🌝
🙈
💊
😶
🙏
🍦
🍉
😣
Source: github.com/k4yt3x/flowerhd
	

	

		
颜文字
Emoji
小恐龙
花!
	


									

			

			
			
		

	






上一篇
下一篇