Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2017 ~ 2025 the original author or authors. James Wong
*
* 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.infra.common.bean;
import static java.util.Objects.isNull;
import static java.util.Objects.nonNull;
import static org.apache.commons.lang3.StringUtils.isBlank;
import java.io.Serializable;
import java.util.Date;
import java.util.List;
import javax.annotation.Nullable;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonView;
import com.wl4g.infra.common.bridge.RpcContextHolderBridges;
import com.wl4g.infra.common.id.SnowflakeIdGenerator;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.annotations.ApiModelProperty.AccessMode;
import io.swagger.annotations.ApiParam;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
import lombok.experimental.SuperBuilder;
/**
* DB based bean entity.
*
* @author <James [email protected], [email protected]>
* @version v1.0.0 2018-09-05
* @since
*/
@Getter
@Setter
@SuperBuilder
@ToString
@NoArgsConstructor
public abstract class BaseBean implements Serializable {
private static final long serialVersionUID = 8940373806493080114L;
/**
* When it is used as the request (input) parameter of the interface, if it
* is a modification operation, it needs to be displayed, but the response
* (output) parameter must not be displayed.
*/
@Schema(hidden = false, accessMode = io.swagger.v3.oas.annotations.media.Schema.AccessMode.READ_ONLY)
@ApiModelProperty(readOnly = true, accessMode = AccessMode.READ_ONLY)
@ApiParam(readOnly = true, hidden = true)
// Because feign remote call requires readability and writability, while
// swagger requires read-only, there is a conflict, so we should solve this
// problem on the swagger side.
// @JsonIgnoreProperties(allowGetters = true, allowSetters = true)
// see:https://github.com/FasterXML/jackson-databind/issues/3125
private @JsonProperty Long id;
/**
* The organization structure code, which can be used for data permissions
* as an organization tree, or in tenant isolation scenarios
*/
private @Nullable String orgCode;
/**
* The data record enable state.
*/
private @NotNull @Min(DISABLED) @Max(ENABLED) Integer enable;
/**
* The data record labels.
*/
private @Nullable List labels;
/**
* The data record description.
*/
private @Nullable String remark;
/**
* That is, when it is used as a request (input) parameter (e.g, add
* operation), it is hidden, and when it is used as a response (output)
* parameter, it is not hidden (such as query operation)
*/
@Schema(hidden = false, accessMode = io.swagger.v3.oas.annotations.media.Schema.AccessMode.READ_ONLY)
@ApiModelProperty(readOnly = true, accessMode = AccessMode.READ_ONLY)
@ApiParam(readOnly = true, hidden = true)
// Because feign remote call requires readability and writability, while
// swagger requires read-only, there is a conflict, so we should solve this
// problem on the swagger side.
// @JsonIgnoreProperties(allowGetters = true, allowSetters = false)
private Long createBy;
/**
* That is, when it is used as a request (input) parameter (e.g, add
* operation), it is hidden, and when it is used as a response (output)
* parameter, it is not hidden (such as query operation)
*/
@Schema(hidden = false, accessMode = io.swagger.v3.oas.annotations.media.Schema.AccessMode.READ_ONLY)
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
@ApiModelProperty(readOnly = true, accessMode = AccessMode.READ_ONLY)
@ApiParam(readOnly = true, hidden = true)
// Because feign remote call requires readability and writability, while
// swagger requires read-only, there is a conflict, so we should solve this
// problem on the swagger side.
// @JsonIgnoreProperties(allowGetters = true, allowSetters = false)
private Date createDate;
/**
* That is, when it is used as a request (input) parameter (e.g, add
* operation), it is hidden, and when it is used as a response (output)
* parameter, it is not hidden (such as query operation)
*/
@Schema(hidden = false, accessMode = io.swagger.v3.oas.annotations.media.Schema.AccessMode.READ_ONLY)
@ApiModelProperty(readOnly = true, accessMode = AccessMode.READ_ONLY)
@ApiParam(readOnly = true, hidden = true)
// Because feign remote call requires readability and writability, while
// swagger requires read-only, there is a conflict, so we should solve this
// problem on the swagger side.
// @JsonIgnoreProperties(allowGetters = true, allowSetters = false)
private Long updateBy;
/**
* That is, when it is used as a request (input) parameter (e.g, add
* operation), it is hidden, and when it is used as a response (output)
* parameter, it is not hidden (such as query operation)
*/
@Schema(hidden = false, accessMode = io.swagger.v3.oas.annotations.media.Schema.AccessMode.READ_ONLY)
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
@ApiModelProperty(readOnly = true, accessMode = AccessMode.READ_ONLY)
@ApiParam(readOnly = true, hidden = true)
// Because feign remote call requires readability and writability, while
// swagger requires read-only, there is a conflict, so we should solve this
// problem on the swagger side.
// @JsonIgnoreProperties(allowGetters = true, allowSetters = false)
private Date updateDate;
/**
* Whether it is the request (input) parameter or the response (output)
* parameter of the interface, it does not need to be displayed
*
* Note: In order to be compatible with the different usages of the
* annotations of swagger 2.x and 3.x, the safest way is to add all possible
* ways that will work.
*/
@Schema(hidden = true, accessMode = io.swagger.v3.oas.annotations.media.Schema.AccessMode.READ_WRITE)
@ApiModelProperty(readOnly = true, hidden = true)
@ApiParam(hidden = true, readOnly = true)
// Because feign remote call requires readability and writability, while
// swagger requires read-only, there is a conflict, so we should solve this
// problem on the swagger side.
// @JsonIgnore
// @JsonIgnoreProperties(allowGetters = false, allowSetters = false)
private Integer delFlag;
//
// --- Temporary fields. ---
//
/**
* Note: In order to be compatible with the different usages of the
* annotations of swagger 2.x and 3.x, the safest way is to add all possible
* ways that will work.
*/
@Schema(hidden = false, accessMode = io.swagger.v3.oas.annotations.media.Schema.AccessMode.READ_ONLY)
@ApiModelProperty(readOnly = true, accessMode = AccessMode.READ_ONLY)
@ApiParam(readOnly = true, hidden = true)
// Because feign remote call requires readability and writability, while
// swagger requires read-only, there is a conflict, so we should solve this
// problem on the swagger side.
// @JsonIgnoreProperties(allowGetters = true, allowSetters = false)
@JsonView(JsonForRestReadMarker.class)
private transient String humanCreateDate;
/**
* Note: In order to be compatible with the different usages of the
* annotations of swagger 2.x and 3.x, the safest way is to add all possible
* ways that will work.
*/
@Schema(hidden = false, accessMode = io.swagger.v3.oas.annotations.media.Schema.AccessMode.READ_ONLY)
@ApiModelProperty(readOnly = true, accessMode = AccessMode.READ_ONLY)
@ApiParam(readOnly = true, hidden = true)
// Because feign remote call requires readability and writability, while
// swagger requires read-only, there is a conflict, so we should solve this
// problem on the swagger side.
// @JsonIgnoreProperties(allowGetters = true, allowSetters = false)
@JsonView(JsonForRestReadMarker.class)
private transient String humanUpdateDate;
/**
* Execute method before inserting, need to call manually
*
* @return return current preparing insert generated id.
*/
public void preInsert() {
preInsert(null);
}
/**
* Execute method before inserting, need to call manually
*
* @param orgCode
* @return return current preparing insert generated id.
*/
public void preInsert(String orgCode) {
setId(SnowflakeIdGenerator.getDefault().nextId());
setOrgCode(isBlank(orgCode) ? getOrgCode() : orgCode);
setEnable(isNull(getEnable()) ? ENABLED : getEnable());
// @see:com.wl4g.infra.data.mybatis.mapper.PreparedBeanMapperInterceptor#preInsert
setCreateBy(UNKNOWN_USER_ID);
setCreateDate(isNull(getCreateDate()) ? new Date() : getCreateDate());
setDelFlag(isNull(getDelFlag()) ? DEL_FLAG_NORMAL : getDelFlag());
}
/**
* Execute method before update, need to call manually
*/
public void preUpdate() {
preUpdate(null);
}
/**
* Execute method before update, need to call manually
*
* @param orgCode
*/
public void preUpdate(String orgCode) {
setOrgCode(isBlank(orgCode) ? getOrgCode() : orgCode);
setEnable(isNull(getEnable()) ? ENABLED : getEnable());
// @see:com.wl4g.infra.data.mybatis.mapper.PreparedBeanMapperInterceptor#preUpdate
setUpdateBy(UNKNOWN_USER_ID);
setUpdateDate(new Date());
setDelFlag(isNull(getDelFlag()) ? DEL_FLAG_NORMAL : getDelFlag());
}
public BaseBean withId(Long id) {
setId(id);
return this;
}
public BaseBean withEnable(Integer enable) {
setEnable(enable);
return this;
}
public BaseBean withOrgCode(String orgCode) {
setOrgCode(orgCode);
return this;
}
public BaseBean withLabels(List labels) {
setLabels(labels);
return this;
}
public BaseBean withRemark(String remark) {
setRemark(remark);
return this;
}
public BaseBean withCreateBy(Long createBy) {
setCreateBy(createBy);
return this;
}
public BaseBean withCreateDate(Date createDate) {
setCreateDate(createDate);
return this;
}
public BaseBean withUpdateBy(Long updateBy) {
setUpdateBy(updateBy);
return this;
}
public BaseBean withUpdateDate(Date updateDate) {
setUpdateDate(updateDate);
return this;
}
public BaseBean withDelFlag(Integer delFlag) {
setDelFlag(delFlag);
return this;
}
public BaseBean deleted() {
setDelFlag(DEL_FLAG_DELETED);
return this;
}
public BaseBean undelete() {
setDelFlag(DEL_FLAG_NORMAL);
return this;
}
// --- Functions. ---
/**
* Internal utility for {@link BaseBean}
*/
public static final class Util {
private static transient final ThreadLocal localCurrentBean = new ThreadLocal<>();
public static void bind(BaseBean bean) {
localCurrentBean.set(bean);
}
public static void update() {
BaseBean lBean = localCurrentBean.get();
if (RpcContextHolderBridges.hasRpcContextHolderClass()) { // Distributed-mode?
Long rBeanId = (Long) RpcContextHolderBridges.invokeGet(true, CURRENT_BEANID_KEY, Long.class);
if (nonNull(rBeanId) && nonNull(lBean)) {
lBean.setId(rBeanId);
}
}
// Remove object reference from local.
localCurrentBean.remove();
// Remove from RPC origin context.
if (RpcContextHolderBridges.hasRpcContextHolderClass()) { // Distributed-mode?
// It's cleanup too:
// @see:com.wl4g.infra.integration.feign.core.context.interceptor.RpcContextProviderProxyInterceptor#postHandle
RpcContextHolderBridges.invokeRemoveAttachment(true, CURRENT_BEANID_KEY);
}
}
/**
* Distributed mode, current inserted bean.id RPC context key.
*/
public static transient final String CURRENT_BEANID_KEY = "currentInsertionBean";
}
public static interface JsonForRestReadMarker {
}
/**
* Generic Status: enabled
*/
public static transient final int ENABLED = 1;
/**
* Generic Status: disabled
*/
public static transient final int DISABLED = 0;
/**
* Generic Status: normal (not deleted)
*/
public static transient final int DEL_FLAG_NORMAL = 0;
/**
* Generic Status: deleted
*/
public static transient final int DEL_FLAG_DELETED = 1;
/**
* Unknown user ID.
*/
public static transient final long UNKNOWN_USER_ID = -1;
/*
* Default super administrator user name.
*/
public static transient final String DEFAULT_SUPER_USER = "unknown";
}
