com.tencent.bkrepo.common.service.util.ResponseBuilder.kt Maven / Gradle / Ivy

Go to download
/*
 * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
 *
 * Copyright (C) 2020 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.bkrepo.common.service.util

import com.tencent.bkrepo.common.api.message.CommonMessageCode
import com.tencent.bkrepo.common.api.pojo.Response
import org.springframework.beans.BeansException
import org.springframework.cloud.sleuth.Tracer

object ResponseBuilder {

    fun  build(code: Int, message: String?, data: T?) =
        Response(code, message, data, getTraceId())

    /**
     * 创建确定类型的[Response]，规避Jackson序列化时不包含类型信息问题
     */
    inline fun  buildTyped(
        data: T,
        message: String? = null,
        code: Int = CommonMessageCode.SUCCESS.getCode()
    ): Response = object : Response(code, message, data) {}

    fun success() = build(CommonMessageCode.SUCCESS.getCode(), null, null)

    fun  success(data: T) = build(CommonMessageCode.SUCCESS.getCode(), null, data)

    fun fail(code: Int, message: String?) = build(code, message, null)

    private fun getTraceId(): String? {
        return try {
            SpringContextUtils.getBean().currentSpan()?.context()?.traceId()
        } catch (_: BeansException) {
            null
        }
    }
}