yaml加配置文件后起不来_趟坑记: yaml多行配置之痛

最新推荐文章于 2024-04-18 02:48:38 发布
最新推荐文章于 2024-04-18 02:48:38 发布
阅读量286 收藏
点赞数
文章标签： yaml加配置文件后起不来
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_39856269/article/details/111645175
版权
本文记录了在yaml配置文件中遇到多行文本解密后无法正确解析的问题及解决方案。问题源于yaml解析时会将换行符替换为空格，导致配置失效。提出的两种方案分别是：1) 在加密前将换行符替换为'n'，解密后yaml会将其转义为换行；2) 每个换行后添加空行，yaml会将连续两个换行压缩为一个。总结指出，yaml的语法在动态修改时可能带来困扰，建议提供更灵活的字符串处理机制。
摘要由CSDN通过智能技术生成

问题

在项目中有一个yaml格式的配置文件，其中某项配置内容是多行文本，假设内容如下：

req:|
  -----BEGIN CERTIFICATE REQUEST-----
  MIICmzCCAYMCAQAwVjELMAkGA1UEBhM0R0IxDjAMBgNVBAcMBUNoaW5hMQ8wDQYD==
  +
  LmlvMIIBIjAnbgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0wDziKul3ncUvH0B
  5dextHcaIzix+Ez/6gWdGSnwXPA34cwvg9kX4isjRyPRCAyQbzlcDdGt9XSMVYz5
  K6d1rg2ICluUxxcuPZcPP0z8S33vjgBNcuzzhwF6EV0lCEZX4+XarklQtv7l+wh0
  -----END CERTIFICATE REQUEST-----

由于安全原因，需要将该配置项进行加密，但是在程序使用该配置时必须完成解密，假设加密后的内容为：

req: "[ssss]xxaxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

程序实现解密的流程如下：扫描配置文件中带有密文标记的字符串，然后解密后进行原地替换。

那么经过解密后配置文件的内容为：

req: ”-----BEGIN CERTIFICATE REQUEST-----
MIICmzCCAYMCAQAwVjELMAkGA1UEBhM0R0IxDjAMBgNVBAcMBUNoaW5hMQ8wDQYD==
+
LmlvMIIBIjAnbgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0wDziKul3ncUvH0B5de
xtHcaIzix+Ez/6gWdGSnwXPA34cwvg9kX4isjRyPRCAyQbzlcDdGt9XSMVYz5K6d1rg2
ICluUxxcuPZcPP0z8S33vjgBNcuzzhwF6EV0lCEZX4+XarklQtv7l+wh0
-----END CERTIFICATE REQUEST-----“

此时存在两个问题，一是配置文件本身的结构错误，换行符缺失了，二是该配置项是非法yaml格式，反解析失败。

现在的问题是在现有的解密流程下，如何实现解密后多行配置是合法且符合预期的配置内容。

问题分析

首先这个问题不是加解密本身的问题，因为加解密并不会去修改操作的数据，而且加解密是通用操作，也不应该为了某个具体场景而做特殊化的操作。
结合yaml的语法定义，为了保证最终得到符合预期的多行配置，则需要在加密的时候对原始内容做出适当的调整。为了保留最终配置项中换行符，就需要换行符在解密后处于转义状态，在yaml解析时再最终转换为实际的换行符。因为按照yaml的语法规则，在解析过程中会将换行符替换为空白符，这也是导致上述问题的原因。

此时需要充分利用yaml的双引号字符串的语义，将换行符替换为'n'

解决方案

将原需要加密的内容中的换行符替换为n, 这样会将多行内容变为单行内容，然后再进行加密处理。
解密后的单行内容为:

req: ”-----BEGIN CERTIFICATE REQUEST-----nMIICmzCCAYMCAQAwVjELMAkGA1UEBhM0R0IxDjAMBgNVBAcMBUNoaW5hMQ8wDQYD==n+nLmlvMIIBIjAnbgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0wDziKul3ncUvH0B5denxtHcaIzix+Ez/6gWdGSnwXPA34cwvg9kX4isjRyPRCAyQbzlcDdGt9XSMVYz5K6d1rg2nICluUxxcuPZcPP0z8S33vjgBNcuzzhwF6EV0lCEZX4+XarklQtv7l+wh0n-----END CERTIFICATE REQUEST-----“

此时经过yaml解析时会进行转义处理，将n替换为换行符，就得到了符合预期的配置内容。

第二方案

上述的方案是先将换行符替换为n, 将多行变单行。第二个方案是在每个换行符后边增加一个空行，同样是利用了yaml的语法，即将连续两个换行符压缩为一个换行符。

总结

yaml格式的语法更多的是为了人类而设计的，当遇到需要通过程序来进行动态的修改或者生成的时候，这种语法反而会成为绊脚石。很多语言都提供了原生字符串的支持，即在字符串中可以包含任意特殊字符，而不需要转义。或许yaml也该考虑提供类似的机制。

参考文档

YAML Multiline Strings​yaml-multiline.info The Official YAML Web Site​yaml.org

及时获取更多原创文章请关注公众号"DANG下时光"

02ac79580cc18e267928aabcfd135c4f.png

转载说明：

原创不易，转载不能修改或移除本文的任何信息，并需要在显眼处保留本文链接

weixin_39856269
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Yaml的多行字符串格式
林大虫子的专栏
05-07 3489
Yaml多行文本格式 Yaml支持多行的字符串格式，可以通过下面两种格式指定： Block Scalars Flow Scalars Block Scalars Block Scalars格式的字符串由两部分组成：Scalar header 和 字符串 下面就是一个Block scalar字符串的例子： example: > Several lines of text, with s...
SpringBoot入门(三) 之springboot的配置配置文件以及yaml的使用
12-22
`YAML`格式的配置文件特别适用于复杂的配置结构，通过缩进表示层次关系，使得配置文件更易读。同时，`@ConfigurationProperties`注解使得我们可以方便地将配置文件中的值映射到Java Bean，简化了代码中的配置处理。
YAML多行表示
罗小爬的技术宝书
07-02 1181
参考： https://stackoverflow.com/questions/3790454/how-do-i-break-a-string-in-yaml-over-multiple-lines Block scalar styles (>, |) These allow characters such as \ and " without escaping, and add a new line (\n) to the end of your string. Key: > this i
yaml格式的字符串多行
zyy247796143的博客
04-25 8654
原文：yaml格式的字符串多行 yaml 文件中多行字符串可以使用|保留换行符，或者使用>将换行符替换为空格。其中，这两个换行符有以下几种用法： |：文中自动换行，默认仅保留一行空行 |+：文中自动换行，保留字符串后面所有的空行 |-：文中自动换行，删除字符串后面所有的空行 >：文中不自动换行，默认仅保留一行空行 >+：文中不自动换行，保留字符串后面所有的空行 >-：文中不自动换行，删除字符串后面所有的空行 多行字符串可以使用引号括起来：" "会进行特殊字符转义，' '.
如何使用多配置yml
qq_38101304的博客
12-05 272
在项目中配置多套环境的配置方法。 因为现在一个项目有好多环境，开发环境，测试环境，准生产环境，生产环境，每个环境的参数不同，所以我们就可以把每个环境的参数配置到yml文件中，这样在想用哪个环境的时候只需要在主配置文件中将用的配置文件写上就行如application.yml 笔记：在Spring Boot中多环境配置文件名需要满足application-{profile}.yml的格式，其中{profile}对应你的环境标识，比如： application-dev.yml：开发环境 application-t
YAML 表示多行字符串
Little_fxc的博客
03-13 2086
http://yaml-multiline.info/
calico的yaml配置文件
最新发布
08-13
calico的yaml配置文件
vagrantfile_config：可通过YAML配置文件配置的通用Vagrantfile
02-06
Vagrantfile_config 是一个创新性的解决方案，它允许用户通过 YAML 配置文件来定制和管理他们的 Vagrant 环境。Vagrant 是一款强大的工具，主要用于创建和配置可移植的开发环境，而 YAML（YAML Ain't Markup ...
使用python检查yaml配置文件是否符合要求
01-20
我就废话不多说了，大家还是直接看代码吧！ # coding=utf-8 import logging import yaml import os ... #将配置config.yaml配置文件以字典方式读取 dts_method = config['service']['method'] dts
python中yaml配置文件模块的使用详解
01-20
不同的是，GNU对UNIX说不，YAML说不的对象是XML。 YAML不是XML。 为什么不是XML呢？因为： YAML的可读性好。 YAML和脚本语言的交互性好。 YAML使用实现语言的数据类型。 YAML有一个一致的信息模型。 YAML易于...
alacritty-config
04-05
我的alacritty配置
nvim-windows:Windows 10上NeovimAlacritty的配置文件
04-03
Windows 10的环境nVim 克隆nvim文件夹内的文件夹，然后运行PlugInstall 。 要在Windows上vim-plug ，请执行以下操作： md ~ \A ppData \L ocal \n vim \a utoload $uri = ' https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim ' (New-Object Net.WebClient).DownloadFile( $uri , $ExecutionContext .SessionState.Path.GetUnresolvedProviderPathFromPSPath( " ~\AppData\Local\nvim\autoload\plug.vim " ) )
YAML中多行字符串的配置方法
2401_84048671的博客
04-18 1141
这个需求下，我们希望配置和显示都按句子换行，就是这样：I am a coder.My blog is didispace.com.这样写：string: "I am a coder.\n\My blog is didispace.com."最终输出：I am a coder.My blog is didispace.com.通过在显示的时候换行，通过配置行末的让这个字符串换行继续写（这个必须有，如果没有第二行行首会多一个空格）。注意：这里必须使用双引号来定义字符串，不能用单引号。因为单引号是不支持换行的。在
程序中修改yml
qq_38337327的博客
04-23 529
@Override public void updateServerConfig(String wardNos) { DumperOptions OPTIONS = new DumperOptions(); OPTIONS.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); OPTIONS.setDefaultScala...
如何在 YAML 中将字符串拆分为多行？
kalman2019的博客
01-10 1198
在 YAML 中，我有一个很长的字符串。我想将其保留在编辑器的 80 列（左右）视图中，因此我想断开字符串。这个的语法是什么？换句话说，我有这个：我想要这个（或类似的东西）：我想使用上面的引号，所以我不需要转义字符串中的任何内容。
yaml解析
u011649691的博客
04-17 3609
1、使用spring自带的yaml解析工具： public class YamlUtils { private static final Logger logger = LogManager.getLogger(YamlUtils.class); public static Map<String, Object> yaml2Map(String yamlSour...
关于application配置文件报错的原因
CF_KaiFa_999Bug的博客
03-16 1683
报的mapping application.xml 映射文件报的错：原因是没有加上：提供给大家参考一下=_=
yaml yml 换行 多行 语法
热门推荐
某呆
12-09 2万+
参考yaml官网 yaml 文件中多行字符串可以使用 | 保留换行符，使用 > 将换行符替换为空格 多行字符串可以使用引号括起来：" " 会进行特殊字符转义，' ' 保留原始字符串。 | 示例 # vim test.yml --- - name: test hosts: 127.0.0.1 gather_facts: no tasks: - name: echo test # 换行符保留，输出三个 Line shell: | echo Line
python笔记74- yaml 使用特殊符号| 解决字符串带换行的问题
qq_27371025的博客
11-30 1696
在yaml文件中通过字符串写一行，如果字符串需要换行的，可以使用 yaml中的特殊符号|和>。
python yaml配置文件_python读取yaml配置文件
05-31
可以使用PyYAML库来读取yaml配置文件。以下是一个示例代码： ```python import yaml # 读取yaml配置文件 with open('config.yaml', 'r') as f: config = yaml.safe_load(f) # 打印配置项 print(config['database...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值