com.wl4g.component.common.web.rest.RespBase Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017 ~ 2025 the original author or authors. 
 *
 * 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.wl4g.component.common.web.rest;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.google.common.annotations.Beta;

import java.io.Serializable;
import java.lang.reflect.Field;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;

import com.wl4g.component.common.annotation.Stable;
import com.wl4g.component.common.collection.CollectionUtils2;
import com.wl4g.component.common.remoting.standard.HttpStatus;

import static com.wl4g.component.common.lang.Assert2.hasText;
import static com.wl4g.component.common.lang.Assert2.state;
import static com.wl4g.component.common.remoting.standard.HttpStatus.*;
import static com.wl4g.component.common.lang.Exceptions.getRootCausesString;
import static com.wl4g.component.common.serialize.JacksonUtils.convertBean;
import static com.wl4g.component.common.serialize.JacksonUtils.toJSONString;
import static com.wl4g.component.common.web.rest.RespBase.RetCode.newCode;
import static java.lang.String.format;
import static java.lang.System.getProperty;
import static java.lang.reflect.Modifier.isFinal;
import static java.lang.reflect.Modifier.isStatic;
import static java.util.Collections.emptyMap;
import static java.util.Collections.unmodifiableMap;
import static java.util.Locale.US;
import static java.util.Objects.isNull;
import static java.util.Objects.nonNull;
import static org.apache.commons.lang3.StringUtils.*;

/**
 * Generic restful response base model wrapper.
 * 
 * @author Wangl.sir <[email protected]>
 * @version v1.0
 * @date 2018年3月9日
 * @since
 */
@Stable
public class RespBase implements Serializable {
	private static final long serialVersionUID = 2647155468624590650L;

	private RetCode code = RetCode.OK;
	private String status = DEFAULT_STATUS; // [Extensible]
	private String requestId = DEFAULT_REQUESTID; // [Extensible]
	private String message = EMPTY;
	@SuppressWarnings("unchecked")
	private D data = (D) DEFAULT_DATA;

	public RespBase() {
		this(null);
	}

	public RespBase(RetCode retCode) {
		this(retCode, null);
	}

	public RespBase(D data, String status) {
		this(null, data);
	}

	public RespBase(RetCode retCode, D data) {
		this(retCode, null, data);
	}

	public RespBase(RetCode retCode, String message, D data) {
		this(retCode, null, message, data);
	}

	public RespBase(RetCode retCode, String status, String message, D data) {
		setCode(retCode);
		setStatus(status);
		setMessage(message);
		setData(data);
	}

	/**
	 * Gets response code value.
	 * 
	 * @return
	 */
	public int getCode() {
		return code.getErrcode();
	}

	/**
	 * Sets response code of {@link RetCode}.
	 * 
	 * @param retCode
	 */
	public void setCode(RetCode retCode) {
		if (nonNull(retCode)) {
			this.code = (RetCode) retCode;
		}
	}

	/**
	 * Sets response code of {@link RetCode}.
	 * 
	 * @param retCode
	 * @return
	 */
	@JsonIgnore
	public RespBase withCode(RetCode retCode) {
		setCode(retCode);
		return this;
	}

	/**
	 * Sets response code of int.
	 * 
	 * @param retCode
	 */
	public void setCode(int retCode) {
		this.code = newCode(retCode);
	}

	/**
	 * Sets response code of int.
	 * 
	 * @param retCode
	 * @return
	 */
	@JsonIgnore
	public RespBase withCode(int retCode) {
		setCode(retCode);
		return this;
	}

	/**
	 * Gets status
	 * 
	 * @return
	 */
	public String getStatus() {
		return status;
	}

	/**
	 * Sets status.
	 * 
	 * @param status
	 */
	public void setStatus(String status) {
		if (!isBlank(status)) {
			this.status = status;
		}
	}

	/**
	 * Sets status.
	 * 
	 * @param status
	 * @return
	 */
	@JsonIgnore
	public RespBase withStatus(String status) {
		setStatus(status);
		return this;
	}

	/**
	 * Gets current requestId.
	 * 
	 * @return
	 */
	public String getRequestId() {
		return requestId;
	}

	/**
	 * Sets current requestId.
	 * 
	 * @param requestId
	 */
	public void setRequestId(String requestId) {
		this.requestId = requestId;
	}

	/**
	 * Sets current requestId.
	 * 
	 * @param requestId
	 * @return
	 */
	@JsonIgnore
	public RespBase withRequestId(String requestId) {
		setRequestId(requestId);
		return this;
	}

	/**
	 * Gets error message text.
	 * 
	 * @return
	 */
	public String getMessage() {
		return isBlank(message) ? code.getErrmsg() : message;
	}

	/**
	 * Sets error message text.
	 */
	public void setMessage(String message) {
		this.message = ErrorPromptMessageBuilder.build(code, !isBlank(message) ? message : this.message);
	}

	/**
	 * Sets error message text.
	 * 
	 * @return
	 */
	@JsonIgnore
	public RespBase withMessage(String message) {
		setMessage(message);
		return this;
	}

	/**
	 * Gets response data node of {@link Object}.
	 * 
	 * @return
	 */
	public D getData() {
		return data;
	}

	// --- Expanded's. ---.

	/**
	 * Sets response bean to data.
	 * 
	 * @param data
	 */
	public void setData(D data) {
		if (isNull(data))
			return;
		if (checkDataAvailable()) // Data already payLoad ?
			throw new IllegalStateException(format(
					"Already data payload, In order to set it successful the data node must be the initial value or empty. - %s",
					getData()));

		this.data = data;
	}

	/**
	 * Sets response bean to data.
	 * 
	 * @param data
	 * @return
	 */
	@JsonIgnore
	public RespBase withData(D data) {
		setData(data);
		return this;
	}

	/**
	 * Sets error throwable, does not set response status code.
	 * 
	 * @param th
	 */
	@JsonIgnore
	public void setThrowable(Throwable th) {
		setMessage(getRootCausesString(th));
	}

	/**
	 * Sets error throwable, does not set response status code.
	 * 
	 * @param th
	 * @return
	 */
	@JsonIgnore
	public RespBase withThrowable(Throwable th) {
		setThrowable(th);
		return this;
	}

	/**
	 * Handle exceptions, at the same time, the restful API compatible error
	 * status code is automatically set. If there is no match, the default value
	 * of {@link RetCode.SYS_ERR} is used
	 * 
	 * @param th
	 */
	@JsonIgnore
	public void handleError(Throwable th) {
		withCode(getRestfulCode(th, RetCode.SYS_ERR)).withMessage(getRootCausesString(th));
	}

	/**
	 * As {@link RespBase#data} convert to {@link DataMap}.
	 * 
	 * @see {@link RespBase#getData()}
	 * @return
	 */
	@SuppressWarnings({ "unchecked" })
	@JsonIgnore
	public synchronized DataMap