com.tencent.devops.common.api.util.YamlUtil.kt Maven / Gradle / Ivy

Go to download
/*
 * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
 *
 * Copyright (C) 2019 THL A29 Limited, a Tencent company.  All rights reserved.
 *
 * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
 *
 * A copy of the MIT License is included in this file.
 *
 *
 * Terms of the MIT License:
 * ---------------------------------------------------
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
 * the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 * LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
 * NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.tencent.devops.common.api.util

import com.fasterxml.jackson.core.type.TypeReference
import com.fasterxml.jackson.databind.ObjectMapper
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator
import com.fasterxml.jackson.module.kotlin.registerKotlinModule
import org.yaml.snakeyaml.Yaml

/**
 *
 * Powered By Tencent
 */
object YamlUtil {
    private val objectMapper = ObjectMapper(
        YAMLFactory().disable(YAMLGenerator.Feature.SPLIT_LINES)
    ).registerKotlinModule()

    private const val RETRY_TIME = 3

    fun getObjectMapper() = objectMapper

    fun toYaml(bean: Any): String {
        if (ReflectUtil.isNativeType(bean) || bean is String) {
            return bean.toString()
        }
        return getObjectMapper().writeValueAsString(bean)!!
    }

    fun  to(yamlStr: String, valueTypeRef: TypeReference? = null): T {
        val obj = loadYamlRetryOnAccident(yamlStr)
        return getObjectMapper().readValue(obj, valueTypeRef ?: object : TypeReference() {})
    }

    fun loadYamlRetryOnAccident(yamlStr: String, retryTime: Int = RETRY_TIME, retryPeriodMills: Long = 50): String {
        try {
            val yml = if (RETRY_TIME != retryTime) {
                // 由于snakeYaml底层原因，部分正常yaml会解析失败，于是在此处尝试改变yaml内容进行重试
                "# auto fix ${"+".repeat(retryTime)}\n$yamlStr"
            } else yamlStr
            val yaml = Yaml()
            return toYaml(yaml.load(yml) as Any)
        } catch (re: Throwable) {
            if (retryTime - 1 < 0) {
                throw re
            }
            if (retryPeriodMills > 0) {
                Thread.sleep(retryPeriodMills)
            }
            return loadYamlRetryOnAccident(yamlStr, retryTime = retryTime - 1, retryPeriodMills = retryPeriodMills)
        }
    }
}