com.feilong.net.http.builder.HttpRequestExecuterExceptionMessageBuilder Maven / Gradle / Ivy

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.0.8
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.builder;

import static com.feilong.core.Validator.isNullOrEmpty;
import static com.feilong.core.lang.StringUtil.EMPTY;
import static com.feilong.tools.slf4j.Slf4jUtil.format;

import java.net.SocketTimeoutException;
import java.util.Map;

import javax.net.ssl.SSLException;

import org.apache.http.client.HttpClient;

import com.feilong.core.lang.ClassUtil;
import com.feilong.core.lang.SystemUtil;
import com.feilong.core.util.MapUtil;
import com.feilong.json.JsonUtil;
import com.feilong.net.http.ConnectionConfig;
import com.feilong.net.http.HttpRequest;

/**
 * http 请求执行异常 message 构造器.
 *
 * @author feilong
 * @since 1.14.0
 */
public class HttpRequestExecuterExceptionMessageBuilder{

    /** Don't let anyone instantiate this class. */
    private HttpRequestExecuterExceptionMessageBuilder(){
        //AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
        //see 《Effective Java》 2nd
        throw new AssertionError("No " + getClass().getName() + " instances for you!");
    }

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

    /**
     * Builds the message.
     *
     * @param httpClient
     *            the http client
     * @param httpRequest
     *            the http request
     * @param useConnectionConfig
     *            the use connection config
     * @param e
     *            the e
     * @return the string
     * @since 1.11.4
     * @since 1.14.0 rename from buildMessage
     */
    static String build(HttpClient httpClient,HttpRequest httpRequest,ConnectionConfig useConnectionConfig,Exception e){
        String handlerMessage = buildHandlerMessage(e, useConnectionConfig);

        String result = commonMessage(httpRequest, useConnectionConfig);
        if (isNullOrEmpty(handlerMessage)){
            return result;
        }
        //---------------------------------------------------------------
        //带自定义头 handlerMessage
        return format("[{}],{}", handlerMessage, result);
    }

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

    /**
     * 构造不同异常,特殊友好提示.
     *
     * @param e
     *            the e
     * @param useConnectionConfig
     *            the use connection config
     * @return the string
     * @since 1.14.0
     */
    //XXX 留坑
    private static String buildHandlerMessage(Exception e,ConnectionConfig useConnectionConfig){
        if (ClassUtil.isInstance(e, SocketTimeoutException.class)){ //链接超时
            StringBuilder sb = new StringBuilder();
            sb.append("current ConnectTimeout:").append(useConnectionConfig.getConnectTimeout());
            sb.append(",ReadTimeout:").append(useConnectionConfig.getReadTimeout());
            return sb.toString();
        }

        //---------------------------------------------------------------
        //https://www.cnblogs.com/sunny08/p/8038440.html
        if (ClassUtil.isInstance(e, SSLException.class)){
            return EMPTY;
        }
        return EMPTY;
    }

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

    /**
     * Common message.
     *
     * @param httpRequest
     *            the http request
     * @param useConnectionConfig
     *            the use connection config
     * @return the string
     */
    private static String commonMessage(HttpRequest httpRequest,ConnectionConfig useConnectionConfig){
        Map httpPropertiesMap = buildHttpPropertiesMap();

        //---------------------------------------------------------------
        String pattern = "httpRequest:[{}],useConnectionConfig:[{}]";
        String commonResult = format(pattern, JsonUtil.format(httpRequest, true), JsonUtil.format(useConnectionConfig, true));
        if (isNullOrEmpty(httpPropertiesMap)){
            return commonResult;
        }

        //---------------------------------------------------------------
        //带 httpPropertiesMap的
        return format("{},http system properties:[{}]", commonResult, JsonUtil.format(httpPropertiesMap));
    }

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

    /**
     * 构造和 http 相关的属性.
     *
     * @return the string
     */
    private static Map buildHttpPropertiesMap(){
        Map propertiesMap = SystemUtil.getPropertiesMap();
        //"http.nonProxyHosts": "local|*.local|169.254/16|*.169.254/16",
        //"java.protocol.handler.pkgs": "com.sun.net.ssl.internal.www.protocol",
        //"javax.net.ssl.trustStore": SystemUtil.USER_HOME+ "/workspace/feilong/feilong-net/feilong-net-httpclient4/src/test/java/ami***uat.keystore",
        //"javax.net.ssl.trustStorePassword": "ami***t",
        //"socksNonProxyHosts": "local|*.local|169.254/16|*.169.254/16",
        return MapUtil.getSubMap(
                        propertiesMap,
                        "http.nonProxyHosts",
                        "java.protocol.handler.pkgs",
                        "javax.net.ssl.trustStore",
                        "javax.net.ssl.trustStorePassword",
                        "socksNonProxyHosts");
    }
}