!412 为生成的实体类增加serialVersionUID字段

Merge pull request !412 from hanjinfeng39/hjf

docs/zh/others/codegen.md

@@ -68,6 +68,8 @@ public class Codegen {
         //设置生成 entity 并启用 Lombok
         globalConfig.setEntityGenerateEnable(true);
         globalConfig.setEntityWithLombok(true);
+        //设置项目的JDK版本，项目的JDK为14及以上时建议设置该项，小于14则可以不设置
+        globalConfig.setJdkVersion(17);
 
         //设置生成 mapper
         globalConfig.setMapperGenerateEnable(true);
@@ -97,7 +99,8 @@ public class Codegen {
 
         //设置生成 entity 并启用 Lombok
         globalConfig.enableEntity()
-                .setWithLombok(true);
+                .setWithLombok(true)
+                .setJdkVersion(17);
 
         //设置生成 mapper
         globalConfig.enableMapper();
@@ -292,6 +295,7 @@ globalConfig.getTemplateConfig()
 | setSwaggerVersion(EntityConfig.SwaggerVersion) | Swagger 注解版本                     | SwaggerVersion.FOX |
 | setWithActiveRecord(boolean)                   | 是否生成 Active Record 模式的 Entity    | false              |
 | setDataSource(String)                          | 统一使用的数据源                         | null               |
+| setJdkVersion(int)                             | 设置项目的jdk版本                       | 0                  |
 
 ```java
 globalConfig.getEntityConfig()

mybatis-flex-codegen/src/main/java/com/mybatisflex/codegen/config/EntityConfig.java

@@ -77,6 +77,11 @@ public class EntityConfig implements Serializable {
      */
     private String dataSource;
 
+    /**
+     * 项目jdk版本
+     */
+    private int jdkVersion;
+
     /**
      * 获取类前缀。
      */
@@ -229,6 +234,21 @@ public class EntityConfig implements Serializable {
         return this;
     }
 
+    /**
+     * 获取项目jdk版本
+     */
+    public int getJdkVersion() {
+        return jdkVersion;
+    }
+
+    /**
+     * 设置项目jdk版本
+     */
+    public EntityConfig setJdkVersion(int jdkVersion) {
+        this.jdkVersion = jdkVersion;
+        return this;
+    }
+
     public enum SwaggerVersion {
 
         FOX("FOX"),

mybatis-flex-codegen/src/main/java/com/mybatisflex/codegen/config/GlobalConfig.java

@@ -942,6 +942,20 @@ public class GlobalConfig implements Serializable {
         getEntityConfig().setDataSource(dataSource);
     }
 
+    /**
+     * @see EntityConfig#getJdkVersion()
+     */
+    public int getEntityJdkVersion() {
+        return getEntityConfig().getJdkVersion();
+    }
+
+    /**
+     * @see EntityConfig#setJdkVersion(int)
+     */
+    public void setEntityJdkVersion(int jdkVersion) {
+        getEntityConfig().setJdkVersion(jdkVersion);
+    }
+
     public boolean isMapperGenerateEnable() {
         return mapperGenerateEnable;
     }

mybatis-flex-codegen/src/main/java/com/mybatisflex/codegen/generator/impl/TableDefGenerator.java

@@ -69,6 +69,7 @@ public class TableDefGenerator implements IGenerator {
         params.put("packageConfig", packageConfig);
         params.put("tableDefConfig", tableDefConfig);
         params.put("javadocConfig", globalConfig.getJavadocConfig());
+        params.put("entityConfig", globalConfig.getEntityConfig());
         params.putAll(globalConfig.getCustomConfig());
         globalConfig.getTemplateConfig().getTemplate().generate(params, templatePath, tableDefJavaFile);
 

mybatis-flex-codegen/src/main/resources/templates/enjoy/entity.tpl

@@ -2,6 +2,7 @@
 #set(withSwagger = entityConfig.isWithSwagger())
 #set(swaggerVersion = entityConfig.getSwaggerVersion())
 #set(withActiveRecord = entityConfig.isWithActiveRecord())
+#set(jdkVersion = entityConfig.getJdkVersion())
 #set(entityClassName = table.buildEntityClassName())
 package #(packageConfig.entityPackage);
 
@@ -30,6 +31,9 @@ import lombok.Data;
 import lombok.NoArgsConstructor;
 #end
 #end
+#if(jdkVersion >= 14)
+import java.io.Serial;
+#end
 
 /**
  * #(table.getComment()) 实体类。
@@ -58,6 +62,11 @@ import lombok.NoArgsConstructor;
 #(table.buildTableAnnotation())
 public class #(entityClassName)#if(withActiveRecord) extends Model<#(entityClassName)>#else#(table.buildExtends())#(table.buildImplements())#end  {
 
+    #if(jdkVersion >= 14)
+    @Serial
+    #end
+    private static final long serialVersionUID = 1L;
+
 #for(column : table.columns)
     #set(comment = javadocConfig.formatColumnComment(column.comment))
     #if(isNotBlank(comment))

mybatis-flex-codegen/src/main/resources/templates/enjoy/tableDef.tpl

@@ -1,10 +1,15 @@
 #set(tableDefClassName = table.buildTableDefClassName())
 #set(schema = table.schema == null ? "" : table.schema)
+#set(jdkVersion = entityConfig.getJdkVersion())
 package #(packageConfig.tableDefPackage);
 
 import com.mybatisflex.core.query.QueryColumn;
 import com.mybatisflex.core.table.TableDef;
 
+#if(jdkVersion >= 14)
+import java.io.Serial;
+#end
+
 /**
  * #(table.getComment()) 表定义层。
  *
@@ -13,6 +18,11 @@ import com.mybatisflex.core.table.TableDef;
  */
 public class #(tableDefClassName) extends TableDef {
 
+    #if(jdkVersion >= 14)
+    @Serial
+    #end
+    private static final long serialVersionUID = 1L;
+
     /**
      * #(table.getComment())
      */