org.sagacity.sqltoy.config.model.EntityMeta Maven / Gradle / Ivy
/**
*
*/
package org.sagacity.sqltoy.config.model;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.sagacity.sqltoy.model.IgnoreCaseSet;
import org.sagacity.sqltoy.model.SecureType;
import org.sagacity.sqltoy.plugins.id.IdGenerator;
import org.sagacity.sqltoy.utils.ReservedWordsUtil;
import org.sagacity.sqltoy.utils.StringUtil;
/**
* @project sqltoy-orm
* @description sqltoy entity实体对象信息
* @author zhongxuchen
* @version v1.0,Date:2012-6-1
*/
@SuppressWarnings({ "rawtypes" })
public class EntityMeta implements Serializable {
/**
*
*/
private static final long serialVersionUID = -1723897636996281118L;
private Class entityClass;
/**
* 获取所有记录sql
*/
private String loadAllSql;
/**
* schema表空间
*/
private String schema;
/**
* 表名
*/
private String tableName;
/**
* 表的备注说明
*/
private String tableComment;
/**
* 主键的约束名称
*/
private String pkConstraint;
/**
* 主键列
*/
private String[] idArray;
/**
* 所有字段信息(主键字段放于末尾)
*/
private String[] fieldsArray;
/**
* 所有字段的类别
*/
private Integer[] fieldsTypeArray;
/**
* 所有字段的默认值(排除主键，提供对象save\saveAll 场景构建默认值)
*/
private String[] fieldsDefaultValue;
/**
* 字段是否可以为null
*/
private Boolean[] fieldsNullable;
/**
* 排除id的字段数组
*/
private String[] rejectIdFieldArray;
/**
* 字段名称对应字段信息的hashMap, 便于通过名称获取字段信息(长度、类型、默认值等等)
*/
private HashMap fieldsMeta = new LinkedHashMap();
/**
* 记录columName对应fieldName
*/
private HashMap columnFieldMap = new HashMap();
/**
* 字段对应的顺序
*/
private HashMap fieldIndexs = new HashMap();
/**
* 业务主键生成的标志符号
*/
private String bizIdSignature;
/**
* 业务主键生成时依赖的几个字段
*/
private String[] bizIdRelatedColumns = null;
/**
* 业务主键依赖的字段在整个表字段中的排列顺序(对象解析完后组织赋值)
*/
private Integer[] bizIdRelatedColIndex = null;
/**
* 业务ID的长度
*/
private Integer bizIdLength;
/**
* 流水部分长度
*/
private Integer bizIdSequenceSize = -1;
/**
* id产生策略
*/
private PKStrategy idStrategy;
/**
* 分库分表策略
*/
private ShardingConfig shardingConfig;
/**
* 对应数据库sequence
*/
private String sequence;
/**
* id产生的类实例,保证效率直接将实例放入单个实体信息中
*/
private IdGenerator idGenerator;
/**
* 业务主键生成策略(单例)
*/
private IdGenerator businessIdGenerator;
/**
* 业务id字段
*/
private String businessIdField;
/**
* 根据主键load查询的sql
*/
private String loadSql;
/**
* 主键名称参数条件语句(where id=:id)
*/
private String idNameWhereSql;
/**
* 主键?形式参数语句
*/
private String idArgWhereSql;
/**
* 主键被关联的子表信息
*/
private List cascadeModels = new ArrayList();
/**
* 外键字段{field,{tableName,field}}
*/
private Map foreignFields;
/**
* 级联对象
*/
private Class[] cascadeTypes;
private String idJavaType;
/**
* 是否存在业务id配置策略
*/
private boolean hasBizIdConfig = false;
/**
* 业务主键同时也是数据库主键
*/
private boolean bizIdEqPK = false;
/**
* 全部字段信息,默认值*最终存放colName1,colName2这种格式
*/
private String allColumnNames = "*";
/**
* 加密字段
*/
private List secureFields = new ArrayList();
/**
* 加解密字段
*/
private IgnoreCaseSet secureColumns;
/**
* 数据版本配置
*/
private DataVersionConfig dataVersion;
/**
* 租户字段名称
*/
private String tenantField;
/**
* 数据库表索引信息
*/
private IndexModel[] indexModels;
/**
* @return the loadAllSql
*/
public String getLoadAllSql() {
return loadAllSql;
}
/**
* @param loadAllSql the loadAllSql to set
*/
public void setLoadAllSql(String loadAllSql) {
this.loadAllSql = loadAllSql;
}
/**
* @return the tableName
*/
public String getTableName() {
return tableName;
}
/**
* @param tableName the tableName to set
*/
public void setTableName(String tableName) {
this.tableName = tableName;
}
public String getTableComment() {
return tableComment;
}
public void setTableComment(String tableComment) {
this.tableComment = tableComment;
}
/**
* @return the fieldsType
*/
public HashMap getFieldsMeta() {
return fieldsMeta;
}
public String getIdType() {
if (idArray == null) {
return "";
}
if (idJavaType == null) {
idJavaType = getColumnJavaType(idArray[0]);
}
return idJavaType;
}
public int getIdLength() {
if (idArray == null) {
return -1;
}
return this.getFieldMeta(idArray[0]).getLength();
}
/**
* @return the idStrategy
*/
public PKStrategy getIdStrategy() {
return idStrategy;
}
/**
* @param idStrategy the idStrategy to set
*/
public void setIdStrategy(PKStrategy idStrategy) {
this.idStrategy = idStrategy;
}
/**
* @return the idGenerator
*/
public IdGenerator getIdGenerator() {
return idGenerator;
}
/**
* @param idGenerator the idGenerator to set
*/
public void setIdGenerator(IdGenerator idGenerator) {
this.idGenerator = idGenerator;
}
public void addFieldMeta(FieldMeta fieldMeta) {
fieldsMeta.put(fieldMeta.getFieldName().toLowerCase(), fieldMeta);
// 数据库字段名称对应vo对象属性名称
String colName = fieldMeta.getColumnName().toLowerCase();
String fieldName = fieldMeta.getFieldName();
columnFieldMap.put(colName, fieldName);
// 属性名称中不包含"_"
if (!fieldName.contains("_")) {
columnFieldMap.put(colName.replace("_", ""), fieldName);
}
}
/**
* @return the idArray
*/
public String[] getIdArray() {
return idArray;
}
/**
* @param idArray the idArray to set
*/
public void setIdArray(String[] idArray) {
this.idArray = idArray;
}
/**
* @return the fieldArray
*/
public String[] getFieldsArray() {
return fieldsArray;
}
public String[] getFieldsNotPartitionKey() {
List fields = new ArrayList();
FieldMeta fieldMeta;
for (int i = 0; i < fieldsArray.length; i++) {
fieldMeta = fieldsMeta.get(fieldsArray[i].toLowerCase());
if (!fieldMeta.isPartitionKey()) {
fields.add(fieldsArray[i]);
}
}
String[] result = new String[fields.size()];
fields.toArray(result);
return result;
}
/**
* @param fieldsArray the fieldArray to set
*/
public void setFieldsArray(String[] fieldsArray) {
this.fieldsArray = fieldsArray;
for (int i = 0; i < fieldsArray.length; i++) {
fieldIndexs.put(fieldsArray[i].toLowerCase(), i);
}
if (this.bizIdRelatedColumns != null) {
this.bizIdRelatedColIndex = new Integer[bizIdRelatedColumns.length];
String colName;
for (int i = 0; i < bizIdRelatedColumns.length; i++) {
colName = bizIdRelatedColumns[i].toLowerCase();
if (fieldIndexs.containsKey(colName)) {
this.bizIdRelatedColIndex[i] = fieldIndexs.get(colName);
} else if (fieldIndexs.containsKey(colName.replace("_", ""))) {
this.bizIdRelatedColIndex[i] = fieldIndexs.get(colName.replace("_", ""));
} else {
// add 2024-08-11 增加业务主键关联字段设置错误场景下的提示,便于开发者提前发现问题
throw new IllegalArgumentException(entityClass.getName()
+ "业务主键@BusinessId()定义的关联字段:relatedColumns,其中:[" + bizIdRelatedColumns[i] + "]属性不存在,请检查!");
}
}
}
}
/**
* @param bizIdRelatedColumns the bizIdRelatedColumns to set
*/
public void setBizIdRelatedColumns(String[] bizIdRelatedColumns) {
this.bizIdRelatedColumns = bizIdRelatedColumns;
}
/**
* @return the bizIdRelatedColumn
*/
public String[] getBizIdRelatedColumns() {
return bizIdRelatedColumns;
}
public int getFieldIndex(String fieldName) {
return fieldIndexs.get(fieldName.toLowerCase());
}
/**
* @return the bizIdSignature
*/
public String getBizIdSignature() {
return bizIdSignature;
}
/**
* @return the bizIdRelatedColIndexs
*/
public Integer[] getBizIdRelatedColIndex() {
return bizIdRelatedColIndex;
}
public Integer getIdIndex() {
return (rejectIdFieldArray == null) ? 0 : rejectIdFieldArray.length;
}
/**
* @return the rejectIdFieldArray
*/
public String[] getRejectIdFieldArray() {
return rejectIdFieldArray;
}
/**
* @param rejectIdFieldArray the rejectIdFieldArray to set
*/
public void setRejectIdFieldArray(String[] rejectIdFieldArray) {
this.rejectIdFieldArray = rejectIdFieldArray;
}
public String getSequence() {
return (sequence == null) ? "" : sequence;
}
public void setSequence(String sequence) {
this.sequence = sequence;
}
public String getColumnName(String fieldName) {
FieldMeta fieldMeta = fieldsMeta.get(fieldName.toLowerCase());
if (fieldMeta == null) {
return null;
}
return fieldMeta.getColumnName();
}
/**
* @todo 针对字段采用数据库关键词命名的字段,增加相应的符合兼容
* @param fieldName
* @return
*/
public String getColumnOptName(String fieldName) {
FieldMeta fieldMeta = fieldsMeta.get(fieldName.toLowerCase());
if (fieldMeta == null) {
return null;
}
return fieldMeta.getColumnOptName();
}
public int getColumnJdbcType(String fieldName) {
FieldMeta fieldMeta = fieldsMeta.get(fieldName.toLowerCase());
if (fieldMeta == null) {
return -1;
}
return fieldMeta.getType();
}
public String getColumnJavaType(String fieldName) {
FieldMeta fieldMeta = fieldsMeta.get(fieldName.toLowerCase());
if (fieldMeta == null) {
return null;
}
return fieldMeta.getFieldType();
}
public String getSchemaTable(String shardingTable, Integer dbType) {
String table = tableName;
if (StringUtil.isNotBlank(shardingTable)) {
table = shardingTable;
}
table = ReservedWordsUtil.convertWord(table, dbType);
if (schema == null) {
return table;
}
// table已经包含了schema，则直接返回,避免重复拼接schema
if (table.startsWith(schema.concat("."))) {
return table;
}
return schema.concat(".").concat(table);
}
/**
* @return the oneToManys
*/
public List getCascadeModels() {
return cascadeModels;
}
/**
* @TODO 增加级联关系
* @param cascadeModel
*/
public boolean addCascade(TableCascadeModel cascadeModel) {
Iterator iter = cascadeModels.iterator();
TableCascadeModel iterModel;
boolean isRepeat = false;
// 删除已经存在的子表关联
while (iter.hasNext()) {
iterModel = iter.next();
// 存在一个对象中，不同属性对应一个子表，比如Student，主课、副课字段
// if (iterModel.getMappedType().equals(cascadeModel.getMappedType())) {
if (iterModel.getProperty().equals(cascadeModel.getProperty())) {
iter.remove();
isRepeat = true;
break;
}
}
this.cascadeModels.add(cascadeModel);
return isRepeat;
}
public String getLoadSql(String shardingTable) {
if (shardingTable == null || shardingTable.equals(tableName)) {
return loadSql;
}
// 针对sharding 分表情况使用重新组织表名
return "select ".concat(allColumnNames).concat(" from ").concat(getSchemaTable(shardingTable, null)).concat(" ")
.concat(this.idNameWhereSql);
}
/**
* @param loadSql the loadSql to set
*/
public void setLoadSql(String loadSql) {
this.loadSql = loadSql;
}
public FieldMeta getFieldMeta(String field) {
return fieldsMeta.get(field.toLowerCase());
}
/**
* @return the fieldsTypeArray
*/
public Integer[] getFieldsTypeArray() {
return fieldsTypeArray;
}
/**
* @param fieldsTypeArray the fieldsTypeArray to set
*/
public void setFieldsTypeArray(Integer[] fieldsTypeArray) {
this.fieldsTypeArray = fieldsTypeArray;
}
/**
* @return the fieldsDefaultValue
*/
public String[] getFieldsDefaultValue() {
return fieldsDefaultValue;
}
/**
* @param fieldsDefaultValue the fieldsDefaultValue to set
*/
public void setFieldsDefaultValue(String[] fieldsDefaultValue) {
this.fieldsDefaultValue = fieldsDefaultValue;
}
/**
* @param fieldsMeta the fieldsMeta to set
*/
public void setFieldsMeta(HashMap fieldsMeta) {
this.fieldsMeta = fieldsMeta;
}
/**
* @return the cascadeTypes
*/
public Class[] getCascadeTypes() {
return cascadeTypes;
}
/**
* @param cascadeTypes the cascadeTypes to set
*/
public void setCascadeTypes(Class[] cascadeTypes) {
this.cascadeTypes = cascadeTypes;
}
/**
* @return the fieldsNullable
*/
public Boolean[] getFieldsNullable() {
return fieldsNullable;
}
/**
* @param fieldsNullable the fieldsNullable to set
*/
public void setFieldsNullable(Boolean[] fieldsNullable) {
this.fieldsNullable = fieldsNullable;
}
/**
* @return the pkConstraint
*/
public String getPkConstraint() {
return pkConstraint;
}
/**
* @param pkConstraint the pkConstraint to set
*/
public void setPkConstraint(String pkConstraint) {
this.pkConstraint = pkConstraint;
}
/**
* @return the shardingModel
*/
public ShardingConfig getShardingConfig() {
return shardingConfig;
}
/**
* @param shardingConfig the shardingModel to set
*/
public void setShardingConfig(ShardingConfig shardingConfig) {
this.shardingConfig = shardingConfig;
}
/**
* @return the idNameWhereSql
*/
public String getIdNameWhereSql() {
return idNameWhereSql;
}
/**
* @param idNameWhereSql the idNameWhereSql to set
*/
public void setIdNameWhereSql(String idNameWhereSql) {
this.idNameWhereSql = idNameWhereSql;
}
/**
* @return the idArgWhereSql
*/
public String getIdArgWhereSql() {
return idArgWhereSql;
}
/**
* @param idArgWhereSql the idArgWhereSql to set
*/
public void setIdArgWhereSql(String idArgWhereSql) {
this.idArgWhereSql = idArgWhereSql;
}
/**
* @return the businessIdGenerator
*/
public IdGenerator getBusinessIdGenerator() {
return businessIdGenerator;
}
/**
* @param businessIdGenerator the businessIdGenerator to set
*/
public void setBusinessIdGenerator(IdGenerator businessIdGenerator) {
this.businessIdGenerator = businessIdGenerator;
}
/**
* @return the businessIdField
*/
public String getBusinessIdField() {
return businessIdField;
}
/**
* @param businessIdField the businessIdField to set
*/
public void setBusinessIdField(String businessIdField) {
this.businessIdField = businessIdField;
}
/**
* @return the bizIdLength
*/
public Integer getBizIdLength() {
// 默认26位nanotime主键策略
if (bizIdLength == null) {
return 26;
}
return bizIdLength;
}
/**
* @param bizIdLength the bizIdLength to set
*/
public void setBizIdLength(Integer bizIdLength) {
this.bizIdLength = bizIdLength;
}
/**
* @return the bizIdSequenceSize
*/
public Integer getBizIdSequenceSize() {
return bizIdSequenceSize;
}
/**
* @param bizIdSequenceSize the bizIdSequenceSize to set
*/
public void setBizIdSequenceSize(Integer bizIdSequenceSize) {
this.bizIdSequenceSize = bizIdSequenceSize;
}
/**
* @param bizIdSignature the bizIdSignature to set
*/
public void setBizIdSignature(String bizIdSignature) {
this.bizIdSignature = bizIdSignature;
}
/**
* @return the entityClass
*/
public Class getEntityClass() {
return entityClass;
}
/**
* @param entityClass the entityClass to set
*/
public void setEntityClass(Class entityClass) {
this.entityClass = entityClass;
}
/**
* @return the hasBizIdConfig
*/
public boolean isHasBizIdConfig() {
return hasBizIdConfig;
}
/**
* @param hasBizIdConfig the hasBizIdConfig to set
*/
public void setHasBizIdConfig(boolean hasBizIdConfig) {
this.hasBizIdConfig = hasBizIdConfig;
}
/**
* @return the bizIdEqPK
*/
public boolean isBizIdEqPK() {
return bizIdEqPK;
}
/**
* @param bizIdEqPK the bizIdEqPK to set
*/
public void setBizIdEqPK(boolean bizIdEqPK) {
this.bizIdEqPK = bizIdEqPK;
}
/**
* @return the allColumnNames
*/
public String getAllColumnNames() {
return allColumnNames;
}
/**
* @param allColumnNames the allColumnNames to set
*/
public void setAllColumnNames(String allColumnNames) {
this.allColumnNames = allColumnNames;
}
public HashMap getColumnFieldMap() {
return columnFieldMap;
}
/**
* @return the schema
*/
public String getSchema() {
return schema;
}
/**
* @param schema the schema to set
*/
public void setSchema(String schema) {
this.schema = schema;
}
public List getSecureFields() {
return secureFields;
}
public void addSecureField(FieldSecureConfig fieldSecureConfig) {
// 非加密的脱敏处理优先确保基于未加密的明文脱敏
if (!SecureType.ENCRYPT.equals(fieldSecureConfig.getSecureType())) {
this.secureFields.add(0, fieldSecureConfig);
} else {
this.secureFields.add(fieldSecureConfig);
}
}
public IgnoreCaseSet getSecureColumns() {
return secureColumns;
}
public void setSecureColumns(IgnoreCaseSet secureColumns) {
this.secureColumns = secureColumns;
}
public DataVersionConfig getDataVersion() {
return dataVersion;
}
public void setDataVersion(DataVersionConfig dataVersion) {
this.dataVersion = dataVersion;
}
public String getTenantField() {
return tenantField;
}
public void setTenantField(String tenantField) {
this.tenantField = tenantField;
}
public IndexModel[] getIndexModels() {
return indexModels;
}
public void setIndexModels(IndexModel[] indexModels) {
this.indexModels = indexModels;
}
public Map getForeignFields() {
return foreignFields;
}
public void setForeignFields(Map foreignFields) {
this.foreignFields = foreignFields;
}
/**
* 提取唯一索引信息,用于saveAllIgnoreExist
*
* @return
*/
public IndexModel getUniqueIndex() {
if (this.indexModels == null || this.indexModels.length == 0) {
return null;
}
int count = 0;
IndexModel result = null;
for (IndexModel indexModel : indexModels) {
if (indexModel.isUnique()) {
count++;
result = indexModel;
}
}
if (count == 1) {
return result;
}
return null;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy