微服务日志体系最佳实践

logging.path=./logs

<file>${logging.path}/${spring.application.name}/service-info.log</file>

[(tntInstId,0a02ba811656639422496100241949)][(com.ys.demo.LogDemo,serverDigest)][(10ms,01,TE0051101002,0,5)]

/**
* 错误上下文
*/
public class ErrorContext extends ToString {
    /**
     * 错误栈，用于存储错误信息
     */
    private List<CommonError> errorStack = new ArrayList<>();
    /**
     * 第三方错误信息
     */
    private String thirdPartyError;

    private static final String SPLIT = "|";

    /**
     * 匹配当前的错误信息，返回CommonError<br>
     * 当无错误信息时，返回null值
     *
     * @return CommonError对象
     */
    public CommonError fetchCurrentError() {
        if (this.errorStack != null && this.errorStack.size() > 0) {
            return this.errorStack.get(this.errorStack.size() - 1);
        }
        return null;
    }

    /**
     * 从上下文中获取错误码信息，返回ErrorCode对象 <br>
     * 当无错误信息时，返回null值
     *
     * @return ErrorCode对象
     */
    public String fetchCurrentErrorCode() {
        if (this.errorStack != null && this.errorStack.size() > 0) {
            return (this.errorStack.get(this.errorStack.size() - 1)).getErrorCode().toString();
        }

        return null;
    }

    /**
     * 获取最早发生的异常  <br>
     * 当无错误信息时，返回null值
     *
     * @return CommonError
     */
    public CommonError fetchRootError() {
        if (this.errorStack != null && this.errorStack.size() > 0) {
            return this.errorStack.get(0);
        }

        return null;
    }

    /**
     * 添加错误栈信息<br>
     * 添加信息时，从尾部添加，故位置越靠前，错误发生时间越早，或理解为最根本错误
     *
     * @param error 公共错误对象
     */
    public void addError(CommonError error) {
        if (this.errorStack == null) {
            this.errorStack = new ArrayList<>();
        }

        this.errorStack.add(error);
    }

    /**
     * 打印错误摘要信息
     *
     * @return 摘要信息
     */
    public String toDigest() {
        StringBuffer sb = new StringBuffer();
        for (int i = this.errorStack.size(); i > 0; i--) {
            if (i == this.errorStack.size()) {
                sb.append(digest(this.errorStack.get(i - 1)));
            } else {
                sb.append(SPLIT).append(digest(this.errorStack.get(i - 1)));
            }
        }
        return sb.toString();
    }

    /**
     * 通过重写ToString，组件完整的错误信息，会将错误栈里的错误都循环打印
     *
     * @return
     */
    @Override
    public String toString() {
        StringBuffer sb = new StringBuffer();
        for (int i = this.errorStack.size(); i > 0; i--) {
            if (i == this.errorStack.size()) {
                sb.append(this.errorStack.get(i - 1));
            } else {
                sb.append(SPLIT).append(this.errorStack.get(i - 1));
            }
        }
        return sb.toString();
    }

    /**
     * 转换为摘要信息<br>
     * 当错误信息为null时，返回占位符
     *
     * @param commonError 错误信息
     * @return 摘要信息
     */
    private String digest(CommonError commonError) {
        if (null == commonError) {
            return LogFormatConstants.HYPHEN;
        }

        return commonError.toDigest();
    }

    public List<CommonError> getErrorStack() {
        return this.errorStack;
    }

    public void setErrorStack(List<CommonError> errorStack) {
        this.errorStack = errorStack;
    }

    public String getThirdPartyError() {
        return this.thirdPartyError;
    }

    public void setThirdPartyError(String thirdPartyError) {
        this.thirdPartyError = thirdPartyError;
    }
}

/**
*错误信息
*
*/
public class CommonError extends ToString {
    /**
     * 错误码信息
     */
    private ErrorCode errorCode;

    /**
     * 错误描述信息
     */
    private String errorMsg;

    /**
     * 错误发生位置，一般写appName
     */
    private String location;

    public CommonError() {
    }

    public CommonError(ErrorCode code, String msg, String location) {
        this.errorCode = code;
        this.errorMsg = msg;
        this.location = location;
    }

    /**
     * 构建为摘要日志输出时使用
     *
     * @return 摘要日志
     */
    public String toDigest() {
        return this.errorCode + "@" + this.location;
    }

    @Override
    public String toString() {
        return this.errorCode + "@" + this.location + "::" + this.errorMsg;
    }

    public ErrorCode getErrorCode() {
        return this.errorCode;
    }

    public void setErrorCode(ErrorCode errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMsg() {
        return this.errorMsg;
    }

    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }

    public String getLocation() {
        return this.location;
    }

    public void setLocation(String location) {
        this.location = location;
    }
}

/*
* toString的通用实现
*/
public class ToString implements Serializable {
    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_STYLE);
    }
}