com.mybatisflex.processor.builder.ContentBuilder Maven / Gradle / Ivy
/*
* Copyright (c) 2022-2025, Mybatis-Flex ([email protected]).
*
* 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.mybatisflex.processor.builder;
import com.mybatisflex.processor.entity.ColumnInfo;
import com.mybatisflex.processor.entity.TableInfo;
import com.mybatisflex.processor.util.StrUtil;
import java.util.Collection;
import java.util.List;
import java.util.StringJoiner;
/**
* 文件内容构建。
*
* @author 王帅
* @since 2023-06-23
*/
@SuppressWarnings({"squid:S107", "squid:S1192"})
public class ContentBuilder {
private ContentBuilder() {
}
/**
* 构建 Mapper 文件内容。
*/
public static String buildMapper(TableInfo tableInfo, String mappersPackage, String mapperClassName,
String baseMapperClass, boolean mapperAnnotationEnable) {
String entityClass = tableInfo.getEntityName();
StringBuilder content = new StringBuilder("package ");
content.append(mappersPackage).append(";\n\n");
content.append("import ").append(baseMapperClass).append(";\n");
content.append("import ").append(entityClass).append(";\n\n");
if (mapperAnnotationEnable) {
content.append("import org.apache.ibatis.annotations.Mapper;\n\n");
content.append("@Mapper\n");
}
String realEntityClassName = StrUtil.getClassName(entityClass);
String baseMapperClassName = StrUtil.getClassName(baseMapperClass);
content.append("public interface ").append(mapperClassName).append(" extends ").append(baseMapperClassName).append("<").append(realEntityClassName).append("> {\n}");
return content.toString();
}
/**
* 构建 TableDef 文件内容。
*/
public static String buildTableDef(TableInfo tableInfo, boolean allInTablesEnable,
String tableDefPackage, String tableDefClassName,
String tableDefPropertiesNameStyle, String tableDefInstanceSuffix,
Collection columnInfos, List defaultColumns) {
StringBuilder content = new StringBuilder("package ");
content.append(tableDefPackage).append(";\n\n");
content.append("import com.mybatisflex.core.query.QueryColumn;\n");
content.append("import com.mybatisflex.core.table.TableDef;\n\n");
content.append("// Auto generate by mybatis-flex, do not modify it.\n");
content.append("public class ").append(tableDefClassName).append(" extends TableDef {\n\n");
//TableDef 类的属性名称
String tableDefPropertyName = null;
if (!allInTablesEnable) {
String entityComment = tableInfo.getEntityComment();
if (!StrUtil.isBlank(entityComment)) {
content.append(" /**\n")
.append(" * ").append(entityComment.trim()).append("\n")
.append(" */\n");
}
tableDefPropertyName = StrUtil.buildFieldName(tableInfo.getEntitySimpleName().concat(tableDefInstanceSuffix != null ? tableDefInstanceSuffix.trim() : ""), tableDefPropertiesNameStyle);
content.append(" public static final ").append(tableDefClassName).append(' ').append(tableDefPropertyName)
.append(" = new ").append(tableDefClassName).append("();\n\n");
}
String finalTableDefPropertyName = tableDefPropertyName;
columnInfos.forEach(columnInfo -> {
String comment = columnInfo.getComment();
if (!StrUtil.isBlank(comment)) {
content.append(" /**\n")
.append(" * ").append(comment.trim()).append("\n")
.append(" */\n");
}
// QueryColumn 属性定义的名称
String columnPropertyName = StrUtil.buildFieldName(columnInfo.getProperty(), tableDefPropertiesNameStyle);
//当字段名称和表名一样时，自动为字段添加一个小尾巴 "_"，例如 account_
if (columnPropertyName.equals(finalTableDefPropertyName)) {
columnPropertyName = columnPropertyName + "_";
}
content.append(" public final QueryColumn ")
.append(columnPropertyName)
.append(" = new QueryColumn(this, \"")
.append(columnInfo.getColumn()).append("\"");
if (columnInfo.getAlias() != null && columnInfo.getAlias().length > 0) {
content.append(", \"").append(columnInfo.getAlias()[0]).append("\"");
}
content.append(");\n\n");
});
content.append(" /**\n")
.append(" * 所有字段。\n")
.append(" */\n");
content.append(" public final QueryColumn ").append(StrUtil.buildFieldName("allColumns", tableDefPropertiesNameStyle)).append(" = new QueryColumn(this, \"*\");\n");
StringJoiner defaultColumnJoiner = new StringJoiner(", ");
columnInfos.forEach(columnInfo -> {
if (defaultColumns.contains(columnInfo.getColumn())) {
String columnPropertyName = StrUtil.buildFieldName(columnInfo.getProperty(), tableDefPropertiesNameStyle);
if (columnPropertyName.equals(finalTableDefPropertyName)) {
columnPropertyName = columnPropertyName + "_";
}
defaultColumnJoiner.add(columnPropertyName);
}
});
content.append("\n /**\n")
.append(" * 默认字段，不包含逻辑删除或者 large 等字段。\n")
.append(" */\n");
content.append(" public final QueryColumn[] ").append(StrUtil.buildFieldName("defaultColumns", tableDefPropertiesNameStyle)).append(" = new QueryColumn[]{").append(defaultColumnJoiner).append("};\n\n");
String schema = !StrUtil.isBlank(tableInfo.getSchema())
? tableInfo.getSchema()
: "";
String tableName = !StrUtil.isBlank(tableInfo.getTableName())
? tableInfo.getTableName()
: StrUtil.firstCharToLowerCase(tableInfo.getEntitySimpleName());
content.append(" public ").append(tableDefClassName).append("() {\n")
.append(" super").append("(\"").append(schema).append("\", \"").append(tableName).append("\");\n")
.append(" }\n\n");
content.append(" private ").append(tableDefClassName).append("(String schema, String name, String alisa) {\n")
.append(" super(schema, name, alisa);\n")
.append(" }\n\n");
content.append(" public ").append(tableDefClassName).append(" as(String alias) {\n")
.append(" String key = getNameWithSchema() + \".\" + alias;\n")
.append(" return getCache(key, k -> new ").append(tableDefClassName).append("(\"").append(schema).append("\", \"").append(tableName).append("\", alias));\n")
.append(" }\n\n}\n");
return content.toString();
}
/**
* 构建 Tables 文件内容。
*/
public static String buildTables(StringBuilder importBuilder, StringBuilder fieldBuilder,
String tablesPackage, String tablesClassName) {
return "package " + tablesPackage + ";\n\n" +
importBuilder.toString() +
"\n// Auto generate by mybatis-flex, do not modify it.\n" +
"public class " + tablesClassName + " {\n\n" +
" private " + tablesClassName + "() {\n" +
" }\n\n" +
fieldBuilder.toString() +
"\n}\n";
}
/**
* 构建 Tables 文件常量属性。
*/
public static void buildTablesField(StringBuilder importBuilder, StringBuilder fieldBuilder, TableInfo tableInfo,
String tableDefClassSuffix, String tableDefPropertiesNameStyle, String tableDefInstanceSuffix, String tableDefPackage) {
String tableDefClassName = tableInfo.getEntitySimpleName().concat(tableDefClassSuffix);
importBuilder.append("import ").append(tableDefPackage).append('.').append(tableDefClassName).append(";\n");
String entityComment = tableInfo.getEntityComment();
if (!StrUtil.isBlank(entityComment)) {
fieldBuilder.append(" /**\n")
.append(" * ").append(entityComment).append("\n")
.append(" */\n");
}
fieldBuilder.append(" public static final ").append(tableDefClassName).append(' ')
.append(StrUtil.buildFieldName(tableInfo.getEntitySimpleName().concat(tableDefInstanceSuffix != null ? tableDefInstanceSuffix.trim() : ""), tableDefPropertiesNameStyle))
.append(" = new ").append(tableDefClassName).append("();\n");
}
}