Add the useMappedSuperclass option

nakamura-to · nakamura-to · commit 7f9516433d7c · 2020-05-30T10:58:26.000+09:00
diff --git a/README.md b/README.md
@@ -151,6 +151,7 @@ domaCodeGen {
 | useAccessor | whether to use accessors or not |  | `true` |
 | useListener | whether to use listeners or not |  | `true` |
 | useMetamodel | whether to use metamodels or not |  | `true` |
+| useMappedSuperclass | whether to use mapped superclasses or not |  | `true` |
 | originalStatesPropertyName | property to be annotated with `@OriginalStates` |  | |
 | entityPropertyClassNamesFile | file used to resolve entity property classes |  | |
 | prefix | prefix for entity classes |  | |
diff --git a/codegen/gradle.properties b/codegen/gradle.properties
@@ -1,2 +1,2 @@
 group=org.seasar.doma
-version=1.0.0
+version=1.1.0-SNAPSHOT
diff --git a/codegen/src/main/java/org/seasar/doma/gradle/codegen/GlobalFactory.java b/codegen/src/main/java/org/seasar/doma/gradle/codegen/GlobalFactory.java
@@ -10,6 +10,7 @@
 import org.seasar.doma.gradle.codegen.desc.EntityPropertyClassNameResolver;
 import org.seasar.doma.gradle.codegen.desc.EntityPropertyDescFactory;
 import org.seasar.doma.gradle.codegen.desc.GenerationType;
+import org.seasar.doma.gradle.codegen.desc.MappedSuperclassDescFactory;
 import org.seasar.doma.gradle.codegen.desc.NamingType;
 import org.seasar.doma.gradle.codegen.desc.SqlDescFactory;
 import org.seasar.doma.gradle.codegen.desc.SqlTestDescFactory;
@@ -77,7 +78,8 @@ public EntityDescFactory createEntityDescFactory(
       boolean showDbComment,
       boolean useAccessor,
       boolean useListener,
-      boolean useMetamodel) {
+      boolean useMetamodel,
+      boolean useMappedSuperclass) {
     return new EntityDescFactory(
         packageName,
         superclass,
@@ -90,14 +92,20 @@ public EntityDescFactory createEntityDescFactory(
         showDbComment,
         useAccessor,
         useListener,
-        useMetamodel);
+        useMetamodel,
+        useMappedSuperclass);
   }
 
   public EntityListenerDescFactory createEntityListenerDescFactory(
       String packageName, String superclassName) {
     return new EntityListenerDescFactory(packageName, superclassName);
   }
 
+  public MappedSuperclassDescFactory createMappedSuperclassDescFactory(
+      String packageName, String entitySuperclassName) {
+    return new MappedSuperclassDescFactory(packageName, entitySuperclassName);
+  }
+
   public DaoDescFactory createDaoDescFactory(
       String packageName, String suffix, String configClassName) {
     return new DaoDescFactory(packageName, suffix, configClassName);
diff --git a/codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/Constants.java b/codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/Constants.java
@@ -4,10 +4,14 @@ public class Constants {
 
   public static final String ENTITY_LISTENER_SUFFIX = "Listener";
 
+  public static final String MAPPED_SUPER_CLASS_PREFIX = "Abstract";
+
   public static final String ENTITY_TEMPLATE = "entity.ftl";
 
   public static final String ENTITY_LISTENER_TEMPLATE = "entityListener.ftl";
 
+  public static final String MAPPED_SUPERCLASS_TEMPLATE = "mappedSuperclass.ftl";
+
   public static final String DAO_TEMPLATE = "dao.ftl";
 
   public static final String SQL_TEST_CASE_TEMPLATE = "sqlTest.ftl";
diff --git a/codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/EntityDesc.java b/codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/EntityDesc.java
@@ -40,6 +40,8 @@ public class EntityDesc extends ClassDesc {
 
   protected boolean useMetamodel;
 
+  protected boolean useMappedSuperclass;
+
   protected boolean showDbComment;
 
   protected String templateName;
@@ -191,6 +193,14 @@ public void setUseMetamodel(boolean useMetamodel) {
     this.useMetamodel = useMetamodel;
   }
 
+  public boolean isUseMappedSuperclass() {
+    return useMappedSuperclass;
+  }
+
+  public void setUseMappedSuperclass(boolean useMappedSuperclass) {
+    this.useMappedSuperclass = useMappedSuperclass;
+  }
+
   public boolean isShowDbComment() {
     return showDbComment;
   }
diff --git a/codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/EntityDescFactory.java b/codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/EntityDescFactory.java
@@ -32,6 +32,8 @@ public class EntityDescFactory {
 
   protected final boolean useMetamodel;
 
+  protected final boolean useMappedSuperclass;
+
   protected final Class<?> superclass;
 
   protected final EntityPropertyDescMerger entityPropertyDescMerger;
@@ -50,7 +52,8 @@ public EntityDescFactory(
       boolean showDbComment,
       boolean useAccessor,
       boolean useListener,
-      boolean useMetamodel) {
+      boolean useMetamodel,
+      boolean useMappedSuperclass) {
     if (entityPropertyDescFactory == null) {
       throw new CodeGenNullPointerException("entityPropertyDescFactory");
     }
@@ -69,6 +72,7 @@ public EntityDescFactory(
     this.useAccessor = useAccessor;
     this.useListener = useListener;
     this.useMetamodel = useMetamodel;
+    this.useMappedSuperclass = useMappedSuperclass;
     this.entityPropertyDescMerger = new EntityPropertyDescMerger(superclass);
   }
 
@@ -93,10 +97,15 @@ public EntityDesc createEntityDesc(
     entityDesc.setTableName(tableMeta.getName());
     entityDesc.setQualifiedTableName(tableMeta.getQualifiedTableName());
     entityDesc.setPackageName(packageName);
-    entityDesc.setEntityPrefix(StringUtil.defaultString(entityPrefix, ""));
-    entityDesc.setEntitySuffix(StringUtil.defaultString(entitySuffix, ""));
+    String prefix = StringUtil.defaultString(entityPrefix, "");
+    entityDesc.setEntityPrefix(prefix);
+    String suffix = StringUtil.defaultString(entitySuffix, "");
+    entityDesc.setEntitySuffix(suffix);
     entityDesc.setSimpleName(simpleName);
-    if (superclass != null) {
+    if (useMappedSuperclass) {
+      entityDesc.setSuperclassSimpleName(
+          Constants.MAPPED_SUPER_CLASS_PREFIX + prefix + simpleName + suffix);
+    } else if (superclass != null) {
       entityDesc.setSuperclassSimpleName(superclass.getSimpleName());
     }
     entityDesc.setListenerClassSimpleName(
@@ -113,6 +122,7 @@ public EntityDesc createEntityDesc(
     entityDesc.setUseAccessor(useAccessor);
     entityDesc.setUseListener(useListener);
     entityDesc.setUseMetamodel(useMetamodel);
+    entityDesc.setUseMappedSuperclass(useMappedSuperclass);
     entityDesc.setTemplateName(Constants.ENTITY_TEMPLATE);
     handleShowTableName(entityDesc, tableMeta);
     handleEntityPropertyDesc(entityDesc, tableMeta);
@@ -158,7 +168,7 @@ protected void handleImportName(EntityDesc entityDesc, TableMeta tableMeta) {
         || entityDesc.getTableName() != null) {
       classDescSupport.addImportName(entityDesc, ClassConstants.Table);
     }
-    if (superclass != null) {
+    if (!useMappedSuperclass && superclass != null) {
       classDescSupport.addImportName(entityDesc, superclass.getName());
     }
     if (namingType != NamingType.NONE) {
diff --git a/codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/MappedSuperclassDesc.java b/codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/MappedSuperclassDesc.java
@@ -0,0 +1,54 @@
+package org.seasar.doma.gradle.codegen.desc;
+
+public class MappedSuperclassDesc extends ClassDesc {
+
+  protected String entityClassSimpleName;
+
+  protected String superclassSimpleName;
+
+  protected String mappedSuperclassSimpleName;
+
+  protected EntityDesc entityDesc;
+
+  protected String templateName;
+
+  public void setTemplateName(String templateName) {
+    this.templateName = templateName;
+  }
+
+  public String getTemplateName() {
+    return templateName;
+  }
+
+  public String getEntityClassSimpleName() {
+    return entityClassSimpleName;
+  }
+
+  public void setEntityClassSimpleName(String entityClassSimpleName) {
+    this.entityClassSimpleName = entityClassSimpleName;
+  }
+
+  public String getSuperclassSimpleName() {
+    return superclassSimpleName;
+  }
+
+  public void setSuperclassSimpleName(String superclassSimpleName) {
+    this.superclassSimpleName = superclassSimpleName;
+  }
+
+  public String getMappedSuperclassSimpleName() {
+    return mappedSuperclassSimpleName;
+  }
+
+  public void setMappedSuperclassSimpleName(String mappedSuperclassSimpleName) {
+    this.mappedSuperclassSimpleName = mappedSuperclassSimpleName;
+  }
+
+  public EntityDesc getEntityDesc() {
+    return entityDesc;
+  }
+
+  public void setEntityDesc(EntityDesc entityDesc) {
+    this.entityDesc = entityDesc;
+  }
+}
diff --git a/codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/MappedSuperclassDescFactory.java b/codegen/src/main/java/org/seasar/doma/gradle/codegen/desc/MappedSuperclassDescFactory.java
@@ -0,0 +1,44 @@
+package org.seasar.doma.gradle.codegen.desc;
+
+import org.seasar.doma.gradle.codegen.util.ClassUtil;
+import org.seasar.doma.gradle.codegen.util.StringUtil;
+
+public class MappedSuperclassDescFactory {
+
+  protected final String packageName;
+
+  protected final String entitySuperclassName;
+
+  protected final ClassDescSupport classDescSupport = new ClassDescSupport();
+
+  public MappedSuperclassDescFactory(String packageName, String entitySuperclassName) {
+    this.packageName = packageName;
+    this.entitySuperclassName = entitySuperclassName;
+  }
+
+  public MappedSuperclassDesc createMappedSuperclassDesc(EntityDesc entityDesc) {
+    MappedSuperclassDesc mappedSuperclassDesc = new MappedSuperclassDesc();
+    mappedSuperclassDesc.setEntityDesc(entityDesc);
+    mappedSuperclassDesc.setPackageName(entityDesc.getPackageName());
+    String entityPrefix = StringUtil.defaultString(entityDesc.getEntityPrefix(), "");
+    String entitySuffix = StringUtil.defaultString(entityDesc.getEntitySuffix(), "");
+    String entityName = entityPrefix + entityDesc.getSimpleName() + entitySuffix;
+    mappedSuperclassDesc.setSimpleName(Constants.MAPPED_SUPER_CLASS_PREFIX + entityName);
+    mappedSuperclassDesc.setEntityClassSimpleName(entityDesc.getSimpleName());
+    if (entitySuperclassName != null) {
+      String simpleName = ClassUtil.getSimpleName(entitySuperclassName);
+      mappedSuperclassDesc.setSuperclassSimpleName(simpleName);
+    }
+    mappedSuperclassDesc.setTemplateName(Constants.MAPPED_SUPERCLASS_TEMPLATE);
+    handleImportName(mappedSuperclassDesc, entityDesc);
+    return mappedSuperclassDesc;
+  }
+
+  protected void handleImportName(
+      MappedSuperclassDesc mappedSuperclassDesc, EntityDesc entityDesc) {
+    classDescSupport.addImportName(mappedSuperclassDesc, entityDesc.getQualifiedName());
+    if (entitySuperclassName != null) {
+      classDescSupport.addImportName(mappedSuperclassDesc, entitySuperclassName);
+    }
+  }
+}
diff --git a/codegen/src/main/java/org/seasar/doma/gradle/codegen/extension/EntityConfig.java b/codegen/src/main/java/org/seasar/doma/gradle/codegen/extension/EntityConfig.java
@@ -45,6 +45,8 @@ public class EntityConfig {
 
   protected Property<Boolean> useMetamodel;
 
+  protected Property<Boolean> useMappedSuperclass;
+
   protected Property<String> originalStatesPropertyName;
 
   protected RegularFileProperty entityPropertyClassNamesFile;
@@ -72,6 +74,7 @@ public EntityConfig(ObjectFactory objects) {
     useAccessor = objects.property(Boolean.class);
     useListener = objects.property(Boolean.class);
     useMetamodel = objects.property(Boolean.class);
+    useMappedSuperclass = objects.property(Boolean.class);
     originalStatesPropertyName = objects.property(String.class);
     entityPropertyClassNamesFile = objects.fileProperty();
     prefix = objects.property(String.class);
@@ -88,6 +91,7 @@ public EntityConfig(ObjectFactory objects) {
     useAccessor.set(true);
     useListener.set(true);
     useMetamodel.set(true);
+    useMappedSuperclass.set(true);
   }
 
   @Internal
@@ -243,6 +247,15 @@ public void setUseMetamodel(boolean useMetamodel) {
     this.useMetamodel.set(useMetamodel);
   }
 
+  @Internal
+  public Property<Boolean> getUseMappedSuperclass() {
+    return useMappedSuperclass;
+  }
+
+  public void setUseMappedSuperclass(boolean useMappedSuperclass) {
+    this.useMappedSuperclass.set(useMappedSuperclass);
+  }
+
   @Internal
   public Property<String> getOriginalStatesPropertyName() {
     return originalStatesPropertyName;
diff --git a/codegen/src/main/java/org/seasar/doma/gradle/codegen/task/CodeGenDtoTask.java b/codegen/src/main/java/org/seasar/doma/gradle/codegen/task/CodeGenDtoTask.java
@@ -207,7 +207,8 @@ private EntityDescFactory createEntityDescFactory(
             entityConfig.getShowDbComment().get(),
             entityConfig.getUseAccessor().get(),
             entityConfig.getUseListener().get(),
-            entityConfig.getUseMetamodel().get());
+            entityConfig.getUseMetamodel().get(),
+            entityConfig.getUseMappedSuperclass().get());
   }
 
   protected void generateDto(EntityDesc entityDesc) {
diff --git a/codegen/src/main/java/org/seasar/doma/gradle/codegen/task/CodeGenEntityDescTask.java b/codegen/src/main/java/org/seasar/doma/gradle/codegen/task/CodeGenEntityDescTask.java
@@ -173,6 +173,7 @@ private EntityDescFactory createEntityDescFactory(
             entityConfig.getShowDbComment().get(),
             entityConfig.getUseAccessor().get(),
             entityConfig.getUseListener().get(),
-            entityConfig.getUseMetamodel().get());
+            entityConfig.getUseMetamodel().get(),
+            entityConfig.getUseMappedSuperclass().get());
   }
 }
diff --git a/codegen/src/main/java/org/seasar/doma/gradle/codegen/task/CodeGenEntityTask.java b/codegen/src/main/java/org/seasar/doma/gradle/codegen/task/CodeGenEntityTask.java
@@ -13,6 +13,8 @@
 import org.seasar.doma.gradle.codegen.desc.EntityDesc;
 import org.seasar.doma.gradle.codegen.desc.EntityListenerDesc;
 import org.seasar.doma.gradle.codegen.desc.EntityListenerDescFactory;
+import org.seasar.doma.gradle.codegen.desc.MappedSuperclassDesc;
+import org.seasar.doma.gradle.codegen.desc.MappedSuperclassDescFactory;
 import org.seasar.doma.gradle.codegen.extension.EntityConfig;
 import org.seasar.doma.gradle.codegen.generator.GenerationContext;
 import org.seasar.doma.gradle.codegen.generator.Generator;
@@ -71,6 +73,7 @@ public void setEntityConfig(EntityConfig entityConfig) {
   @TaskAction
   public void generate() {
     EntityListenerDescFactory entityListenerDescFactory = createEntityListenerDescFactory();
+    MappedSuperclassDescFactory mappedSuperclassDescFactory = createMappedSuperclassDescFactory();
     for (EntityDesc entityDesc : entityDescList.get()) {
       generateEntity(entityDesc);
 
@@ -79,6 +82,12 @@ public void generate() {
             entityListenerDescFactory.createEntityListenerDesc(entityDesc);
         generateEntityListener(entityListenerDesc);
       }
+
+      if (entityDesc.isUseMappedSuperclass()) {
+        MappedSuperclassDesc mappedSuperclassDesc =
+            mappedSuperclassDescFactory.createMappedSuperclassDesc(entityDesc);
+        generateMappedSuperclass(mappedSuperclassDesc);
+      }
     }
   }
 
@@ -90,6 +99,13 @@ private EntityListenerDescFactory createEntityListenerDescFactory() {
             entityConfig.getListenerSuperclassName().getOrNull());
   }
 
+  private MappedSuperclassDescFactory createMappedSuperclassDescFactory() {
+    return globalFactory
+        .get()
+        .createMappedSuperclassDescFactory(
+            entityConfig.getPackageName().get(), entityConfig.getSuperclassName().getOrNull());
+  }
+
   private void generateEntity(EntityDesc entityDesc) {
     File javaFile =
         FileUtil.createJavaFile(sourceDir.get().getAsFile(), entityDesc.getQualifiedName());
@@ -115,4 +131,18 @@ private void generateEntityListener(EntityListenerDesc entityListenerDesc) {
             entityConfig.getOverwriteListener().get());
     generator.get().generate(context);
   }
+
+  private void generateMappedSuperclass(MappedSuperclassDesc mappedSuperclassDesc) {
+    File javaFile =
+        FileUtil.createJavaFile(
+            sourceDir.get().getAsFile(), mappedSuperclassDesc.getQualifiedName());
+    GenerationContext context =
+        new GenerationContext(
+            mappedSuperclassDesc,
+            javaFile,
+            mappedSuperclassDesc.getTemplateName(),
+            encoding.get(),
+            entityConfig.getOverwriteListener().get());
+    generator.get().generate(context);
+  }
 }
diff --git a/codegen/src/main/resources/org/seasar/doma/gradle/codegen/template/mappedSuperclass.ftl b/codegen/src/main/resources/org/seasar/doma/gradle/codegen/template/mappedSuperclass.ftl
@@ -0,0 +1,20 @@
+<#-- See also org.seasar.doma.gradle.codegen.desc.EntityListenerDesc -->
+<#import "/lib.ftl" as lib>
+<#if lib.copyright??>
+${lib.copyright}
+</#if>
+<#if packageName??>
+package ${packageName};
+</#if>
+
+<#list importNames as importName>
+import ${importName};
+</#list>
+
+/**
+<#if lib.author??>
+ * @author ${lib.author}
+</#if>
+ */
+public abstract class ${simpleName}<#if superclassSimpleName??> extends ${superclassSimpleName}</#if> {
+}
diff --git a/codegen/src/test/java/org/seasar/doma/gradle/codegen/GeneratorTest.java b/codegen/src/test/java/org/seasar/doma/gradle/codegen/GeneratorTest.java
diff --git a/codegen/src/test/resources/org/seasar/doma/gradle/codegen/GeneratorTest_ExtendingMappedSuperclass.txt b/codegen/src/test/resources/org/seasar/doma/gradle/codegen/GeneratorTest_ExtendingMappedSuperclass.txt
diff --git a/codegen/src/test/resources/org/seasar/doma/gradle/codegen/GeneratorTest_SimpleMappedSuperclass.txt b/codegen/src/test/resources/org/seasar/doma/gradle/codegen/GeneratorTest_SimpleMappedSuperclass.txt

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`group=org.seasar.doma`
`2`		`-version=1.0.0`
	`2`	`+version=1.1.0-SNAPSHOT`
Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,8 @@ private EntityDescFactory createEntityDescFactory(`
`207`	`207`	`entityConfig.getShowDbComment().get(),`
`208`	`208`	`entityConfig.getUseAccessor().get(),`
`209`	`209`	`entityConfig.getUseListener().get(),`
`210`		`- entityConfig.getUseMetamodel().get());`
	`210`	`+ entityConfig.getUseMetamodel().get(),`
	`211`	`+ entityConfig.getUseMappedSuperclass().get());`
`211`	`212`	`}`
`212`	`213`
`213`	`214`	`protected void generateDto(EntityDesc entityDesc) {`