com.feilong.net.http.HttpLogHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
There is a newer version: 4.3.0
Show newest version
/*
 * Copyright (C) 2008 feilong
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.feilong.net.http;

import static com.feilong.core.Validator.isNotNullOrEmpty;
import static com.feilong.core.bean.ConvertUtil.toMap;
import static com.feilong.core.lang.StringUtil.formatPattern;

import com.feilong.core.lang.StringUtil;
import com.feilong.core.lang.SystemUtil;
import com.feilong.json.JavaToJsonConfig;
import com.feilong.json.JsonUtil;
import com.feilong.json.processor.StringOverLengthJsonValueProcessor;
import com.feilong.json.processor.ToStringJsonValueProcessor;
import com.feilong.lib.json.processors.JsonValueProcessor;

/**
 * 专注于辅助生成http日志.
 *
 * @author feilong
 * @since 4.0.1
 */
public class HttpLogHelper{

    /**
     * 自动追加request简单信息.
     *
     * @param httpRequest
     *            the http request
     * @param messagePattern
     *            the message pattern
     * @param params
     *            the params
     * @return the string
     * @since 4.0.8
     */
    public static String autoLog(HttpRequest httpRequest,String messagePattern,Object...params){
        return autoLog(httpRequest, (ConnectionConfig) null, messagePattern, params);
    }

    /**
     * 自动追加request简单信息.
     *
     * @param httpRequest
     *            the http request
     * @param connectionConfig
     *            the connection config
     * @param messagePattern
     *            the message pattern
     * @param params
     *            the params
     * @return the string
     * @since 4.0.8
     */
    public static String autoLog(HttpRequest httpRequest,ConnectionConfig connectionConfig,String messagePattern,Object...params){
        return autoLog(httpRequest, null, connectionConfig, messagePattern, params);
    }

    public static String autoLog(
                    HttpRequest httpRequest,
                    HttpResponse resultResponse,
                    ConnectionConfig connectionConfig,
                    String messagePattern,
                    Object...params){
        //"{}{},connectionConfigInfo:[{}],httpRequestInfo:[{}]",
        StringBuilder sb = new StringBuilder();

        //拼接 logTraceContext 日志
        String logTraceContext = httpRequest.getLogTraceContext();
        if (isNotNullOrEmpty(logTraceContext)){
            sb.append("logTraceContext:[" + logTraceContext + "]");
        }

        //拼接业务日志
        if (isNotNullOrEmpty(messagePattern)){
            sb.append(formatPattern(messagePattern, params));
        }

        //拼接httpRequest 日志
        sb.append(",httpRequestInfo:[" + createHttpRequestLog(httpRequest) + "]");

        //拼接connectionConfig 日志
        if (null != connectionConfig){
            sb.append(",connectionConfigInfo:[" + createConnectionConfigLog(connectionConfig) + "]");
        }

        //拼接resultResponse 日志
        if (null != resultResponse){
            String response = JsonUtil.toString(
                            resultResponse,
                            new JavaToJsonConfig(toMap("resultString", (JsonValueProcessor) new StringOverLengthJsonValueProcessor(1000))));
            sb.append(",HttpResponseInfo:[" + response + "]");
        }
        return sb.toString();
    }

    /**
     * 创建 http request log.
     * 
     * 
     * 场景: 某些公司json格式化在日志系统中会换行显示, 可阅读性特别差, 因此使用JsonUtil.toString 代替JsonUtil.format; 

     * 但是开发环境为了更快的发现以及排查问题需要使用JsonUtil.format;
     * 
     * 

     * 目前通过设置环境变量 feilong_httpRequest_format_enable 来区分, 如果值是true(忽略大小写) 那么会使用format,否则使用tostring
     * 
     *
     * @param httpRequest
     *            the http request
     * @return the string
     * @see 支持http 根据不同环境 日志是format 还是tostring 输出
     * @since 4.0.8 change to private
     */
    private static String createHttpRequestLog(HttpRequest httpRequest){
        JavaToJsonConfig javaToJsonConfig = new JavaToJsonConfig(true);
        javaToJsonConfig.setPropertyNameAndJsonValueProcessorMap(
                        toMap("requestByteArrayBody", ToStringJsonValueProcessor.DEFAULT_INSTANCE));

        //---------------------------------------------------------------
        //环境变量 see https://github.com/ifeilong/feilong/issues/602
        String formatEnable = SystemUtil.getEnv("feilong_httpRequest_format_enable");
        if (StringUtil.trimAndEqualsIgnoreCase("true", formatEnable)){
            return JsonUtil.format(httpRequest, javaToJsonConfig);
        }
        return JsonUtil.toString(httpRequest, javaToJsonConfig);
    }

    //---------------------------------------------------------------

    /**
     * 创建 connection config log.
     *
     * @param useConnectionConfig
     *            the use connection config
     * @return the string
     */
    private static String createConnectionConfigLog(ConnectionConfig useConnectionConfig){
        return JsonUtil.toString(useConnectionConfig, true);
    }
}