兰州网站怎么建设,wordpress连接数据修改,网站 对比,福州正规网站建设公司推荐spring boot的配置文件详解 文章目录 spring boot的配置文件详解常用配置spring boot的配置文件1. properties 文件2. YAML 文件3. 多环境配置4. 配置文件优先级5. 配置属性注入特殊说明 properties配置文件基本语法 例子peoperties文件的缺点 YML配置文件YML使用yml 配置不同数…spring boot的配置文件详解 文章目录 spring boot的配置文件详解常用配置spring boot的配置文件1. properties 文件2. YAML 文件3. 多环境配置4. 配置文件优先级5. 配置属性注入特殊说明 properties配置文件基本语法 例子peoperties文件的缺点 YML配置文件YML使用yml 配置不同数据类型及 null注意事项 配置对象配置集合配置mapYML 的优缺点优点缺点 常用配置
spring:datasource:url: jdbc:mysql://127.0.0.1:3306/mycnblog?characterEncodingutf8useSSLfalseusername: rootpassword: rootdriver-class-name: com.mysql.cj.jdbc.Drivermvc:favicon:enable: falseprofiles: #多平台配置active: dev
# 设置 Mybatis 的 xml 保存路径
mybatis:mapper-locations: classpath:mapper/*Mapper.xmlconfiguration: # 配置打印 MyBatis 执行的 SQLlog-impl: org.apache.ibatis.logging.stdout.StdOutImplmap-underscore-to-camel-case: true #自动驼峰转换
# 配置打印 MyBatis 执行的 SQL
logging:file:name: logs/springboot.loglogback:rollingpolicy:max-file-size: 1KBfile-name-pattern: ${LOG_FILE}.%d{yyyy-MM-dd}.%ilevel:com:example:demo: debugspring boot的配置文件
SpringBoot⽀持并定义了配置⽂件的格式, 也在另⼀个层⾯达到了规范其他框架集成到SpringBoot的
⽬的.
很多项⽬或者框架的配置信息也放在配置⽂件中, ⽐如: 项⽬的启动端⼝数据库的连接信息(包含⽤⼾名和密码的设置)第三⽅系统的调⽤密钥等信息⽤于发现和定位问题的普通⽇志和异常⽇志等. 在idea中我们修改 application.properties ⽂件即可。
Spring Boot 配置文件详解
在 Spring Boot 中配置文件是管理应用程序配置的重要组成部分。它可以用来配置应用程序的各种属性包括数据库连接、日志级别、端口号等。Spring Boot 支持多种类型的配置文件包括 properties 文件、YAML 文件等。本文将详细介绍 Spring Boot 配置文件的使用方法和常见配置项。
1. properties 文件
示例application.properties
# 设置应用程序端口号
server.port8080# 配置数据库连接
spring.datasource.urljdbc:mysql://localhost:3306/mydatabase
spring.datasource.usernameroot
spring.datasource.passwordroot# 配置日志级别
logging.level.org.springframeworkINFO2. YAML 文件
YAML和YML文件是一样的。
示例application.yaml
# 设置应用程序端口号
server:port: 8080# 配置数据库连接
spring:datasource:url: jdbc:mysql://localhost:3306/mydatabaseusername: rootpassword: root# 配置日志级别
logging:level:org:springframework: INFO3. 多环境配置
示例application-{profile}.properties 或 application-{profile}.yaml
# 开发环境配置
# application-dev.propertiesserver.port8080
spring.datasource.urljdbc:mysql://localhost:3306/dev_database
spring.datasource.usernameroot
spring.datasource.passwordroot# 生产环境配置
# application-prod.propertiesserver.port80
spring.datasource.urljdbc:mysql://localhost:3306/prod_database
spring.datasource.usernameadmin
spring.datasource.passwordadmin4. 配置文件优先级
Spring Boot 配置文件的优先级顺序如下
命令行参数使用命令行参数可以覆盖配置文件中的属性。内置默认值Spring Boot 内置了许多默认属性如果没有在配置文件中指定则会使用这些默认值。当前目录下的 config 文件夹Spring Boot 会在当前目录下的 config 文件夹中查找配置文件。当前目录Spring Boot 会在当前目录中查找配置文件。classpath 下的 /config 文件夹Spring Boot 会在类路径下的 /config 文件夹中查找配置文件。classpath 根目录Spring Boot 会在类路径的根目录下查找配置文件。
5. 配置属性注入
Spring Boot 支持在配置文件中定义属性并使用 Value 注解将属性值注入到 Java 类中。
示例
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;Component
public class MyComponent {Value(${myapp.message})private String message;public void displayMessage() {System.out.println(Message from properties file: message);}
}在配置文件中设置 myapp.messageHello, World!则 message 属性的值会被注入为 “Hello, World!”。
特殊说明
理论上讲 .properties 和 .yml 可以并存在于⼀个项⽬中当 .properties 和 .yml
并存时两个配置都会加载. 如果配置⽂件内容有冲突, 则以 .properties 为主, 也就是.properties 优先级更⾼.
虽然理论上来讲 .properties 可以和 .yml 共存但实际的业务当中我们通常会采取⼀种
统⼀的配置⽂件格式这样可以更好的维护 (降低故障率)
properties配置文件
配置文件官网可参考学习
基本语法
Properties 文件是一种常见的配置文件格式用于存储键值对形式的配置信息。它通常用于配置应用程序的参数、属性、设置等。下面是 Properties 文件的语法 键值对Properties 文件由多个键值对组成每个键值对由键和值组成中间用等号连接如keyvalue。 注释可以在 Properties 文件中添加注释以 # 或 ! 开头的行被视为注释不会被解析。 空行空行会被忽略不会被解析。 转义字符可以使用反斜杠 \ 进行转义表示特殊字符的转义如 \n 表示换行符。 Unicode 编码可以使用 Unicode 编码表示非 ASCII 字符。
下面是一个简单的 Properties 文件示例
# This is a sample properties file# Database configuration
db.urljdbc:mysql://localhost:3306/mydatabase
db.usernameadmin
db.password123456# Server configuration
server.port8080
server.hostlocalhost在这个示例中我们定义了数据库和服务器的配置信息每个键值对代表一个配置项键表示配置项的名称值表示配置项的值。注释以 # 开头表示注释内容。
例子
# 项目常用端口号
server.port8080
# 配置数据库连接信息
spring.datasource.urljdbc:mysql://127.0.0.1:3306/testdb?characterEncodingutf8useSSLfalse
spring.datasource.usernameroot
spring.datasource.passwordroot# 自定义一些配置
ben.key1ben666
ben.key2789package org.haobin.ioc.demo.Controller;import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;/*** author 刘浩彬* date 2024/2/25*/RestController
RequestMapping(/prop)
public class PropertiesController {Value(${ben.key1})private String key1;Value(${ben.key2})private Integer key2;RequestMapping(/readValue)public String readValue(){return 从Properties读取配置文件key1key1;}RequestMapping(/readValue2)public String readValue2(){return 从Properties读取配置文件key2key2;}
}peoperties文件的缺点
虽然 Properties 文件在很多情况下都是一种方便的配置方式但也存在一些缺点包括 扩展性差Properties 文件的结构简单只支持键值对形式的配置无法表示复杂的数据结构如列表、嵌套对象等因此在需要表示复杂配置信息时会显得不够灵活。 类型转换不方便Properties 文件中的值都是字符串形式无法直接表示其他类型的数据比如整数、浮点数、布尔值等。在读取配置时需要手动进行类型转换增加了开发的复杂度和出错的可能性。 不支持注释嵌套Properties 文件的注释只能位于行首无法在行内或值之后添加注释。这样的限制可能会导致注释和配置项的关系不够清晰不利于代码的维护和阅读。 不支持环境变量替换Properties 文件无法直接引用环境变量需要借助外部工具或框架来实现环境变量的替换增加了配置的复杂度。 不支持多语言Properties 文件中的配置项只能使用一种语言表示无法方便地支持多语言配置这在国际化的应用程序中可能会造成不便。
YML配置文件
yml 是树形结构的配置⽂件它的基础语法是key: value.
key 和 value 之间使⽤英⽂冒号加空格的⽅式组成空格不可省略YAMLYAML Ain’t Markup Language是一种人类友好的数据序列化格式常用于配置文件和数据交换。YAML 文件采用缩进和空格来表示层次结构具有清晰简洁、易读易写的特点。下面是 YAML 配置文件的主要语法 基本规则 YAML 文件以 .yml 或 .yaml 扩展名结尾。使用缩进表示层次结构缩进时只能使用空格不能使用制表符。使用 # 符号表示注释注释可以单独一行或在行尾。 键值对 使用冒号 : 将键和值分隔开。键值对可以写在同一行也可以换行写但冒号后必须跟一个空格。 列表 使用连字符 - 表示列表项。列表项可以是简单值也可以是对象或其他列表。 对象 对象使用缩进表示层次结构每个属性都是键值对形式。对象的属性可以是简单值也可以是嵌套的对象或列表。 引号 字符串值可以使用单引号 或双引号 包裹也可以省略引号。使用引号可以保留字符串的空白字符或特殊字符。 多行字符串 使用 | 符号表示多行字符串保留换行符和缩进。使用 符号表示多行字符串忽略换行符但保留缩进。 特殊值 true、false 和 null 分别表示布尔值 true、false 和空值。
下面是一个简单的 YAML 示例
# YAML 示例配置文件server:port: 8080hostname: localhostdatabase:url: jdbc:mysql://localhost:3306/mydbusername: rootpassword: passwordlogging:level:root: infocom.example: debugprofiles:- dev- test- prodserver:port: 9090spring:datasource:url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncodingutf8useSSLfalseusername: rootpassword: rootYML使用
yml 配置不同数据类型及 null
server:port: 9090spring:datasource:url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncodingutf8useSSLfalseusername: rootpassword: root# 自定义配置项
string.value: ben666
string:value2: ben22222222package org.haobin.ioc.demo.Controller;import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;RestController
RequestMapping(/yml)
public class ymlController {Value(${string.value})private String value;Value(${string.value2})private String key2;Value(${spring.datasource.url})private String url;RequestMapping(/readValue)public String readValue() {return 从yml读取配置文件value value;}RequestMapping(/readValue2)public String readValue2() {return 从yml读取配置文件key2 key2;}RequestMapping(/url)public String readUrl() {return 从yml读取配置文件url url;}
} # 字符串
string.value: Hello
# 布尔值true或false
boolean.value: true
boolean.value1: false
# 整数
int.value: 10
# 浮点数
float.value: 3.14159
# Null~代表null
null.value: ~
# 如果使用字符串接收字符串的值是 ~# 空字符串
#, 直接后⾯什么都不加就可以了, 但这种⽅式不直观, 更多的表⽰是使⽤引号括起来
empty.value:注意事项
value 值加单双引号
字符串默认不⽤加上单引号或者双引号如果加英⽂的单双引号可以表⽰特殊的含义。
尝试在 application.yml 中配置如下信息
string:str1: Hello \n Spring Boot.str2: Hello \n Spring Boot.str3: Hello \n Spring Boot.Value(${string.str1})private String str1;Value(${string.str2})private String str2;Value(${string.str3})private String str3;RequestMapping(/yml)public String readYml(){System.out.println(str1);System.out.println(str2);System.out.println(str3);return yml;}从上述结果可以看出
字符串默认不⽤加上单引号或者双引号。单引号会转义特殊字符使其失去特殊功能, 始终是⼀个普通的字符串.双引号不会转义字符串⾥⾯的特殊字符, 特殊字符会表⽰本⾝的含义. 此处的转义理解起来会有些拗⼝, \n 本意表⽰的是换⾏ 使⽤单引号会转义, 就是说, \n 不再表⽰换⾏了, ⽽是表⽰⼀个普通的字符串 使⽤双引号不会转义, 表⽰ \n 表⽰的是它本⾝的含义, 就是换⾏ 配置对象
Autowired
private Student student;RequestMapping(/stu)
public String readStu(){return student.toString();
}package org.haobin.ioc.demo.model;import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;Component
ConfigurationProperties(prefix student)
Data
public class Student {private Integer id;private Integer age;private String name;
}student:id: 1name: javaage: 18配置集合
配置⽂件也可以配置 list 集合如下所⽰
dbtypes:name:- mysql- sqlserver- db2注意点 dbtypes:name:- mysql- sqlserver- db2如果- mysql中的空格省略了不会报错。但是含义是变了的这几个元素就会被当做一个元素来处理 集合的读取和对象⼀样也是使⽤ ConfigurationProperties 来读取的具体实现如下
Component
Data
ConfigurationProperties(dbtypes)
public class Dbtypes {private ListString name;
}访问集合的实现如下
Autowired
private Dbtypes dbtypes;RequestMapping(/list)
public String readList(){return dbtypes.toString();
}配置map
道理和配置list一样
不做解释给示例代码如下
maptypes:map:k1: kk1k2: kk2k3: kk3Component
Data
ConfigurationProperties(maptypes)
public class Maptypes {private HashMapString, String map;
}Autowired
private Maptypes maptypes;RequestMapping(/map)
public String readMap(){return maptypes.toString();
}YML 的优缺点
优点 易读性高 YML 使用缩进和空格来表示层次结构与传统的大括号和逗号相比更接近自然语言更易于理解和阅读。YML 文件结构清晰简洁注重可读性适合人类阅读和编辑。 简洁清晰 YML 使用简洁的语法可以轻松地表示复杂的数据结构如列表、对象和多行字符串使配置文件更加简洁明了。 可扩展性 YML 具有灵活的语法和结构可以轻松地扩展和调整配置文件的内容适用于各种类型的应用场景和需求。 与多种编程语言兼容 YML 格式与多种编程语言兼容包括 Java、Python、JavaScript 等可以方便地在不同语言环境中使用和解析。
缺点 空格敏感 YML 的语法对空格敏感缩进和空格的使用必须严格遵循规范否则可能会导致解析错误或意外结果。 复杂性 随着配置文件的复杂度增加YML 文件的结构也可能变得复杂不易于管理和维护尤其是对于大型项目。 不适合所有场景 尽管 YML 在配置文件和数据交换方面表现良好但并不适合所有场景。对于某些特定需求或环境可能存在更合适的选择。 缺乏严格的规范 YML 并没有像 JSON 那样严格的规范不同的实现可能存在细微差异可能会导致不同解析器之间的兼容性问题。
