* db: validate enum must have @Property for json field List<Enum>

> to make it consistent with JSON serialization and ensure refactoring safety Signed-off-by: neo <1100909+neowu@users.noreply.github.com>
neowu · Feb 8, 2024 · 595f38a · 595f38a
1 parent 45f5a86
commit 595f38a
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@
 
 * executor: tweak shutdown handling, print all tasks not complete
 * jre: published neowu/jre:21.0.2
+* db: validate enum must have @Property for json field List<Enum>
+  > to make it consistent with JSON serialization and ensure refactoring safety
 
 ### 9.0.5 (1/10/2024 - 1/29/2024)
 

diff --git a/README.md b/README.md
@@ -9,9 +9,9 @@ core-ng is a webapp framework, it's designed to support our own projects.
 ```
 repositories {
     maven {
-        url 'https://neowu.github.io/maven-repo/'
+        url = uri("https://neowu.github.io/maven-repo/")
         content {
-            includeGroupByRegex 'core\\.framework.*'
+            includeGroupByRegex("core\\.framework.*")
         }
     }
     maven {

diff --git a/core-ng/src/main/java/core/framework/internal/db/DatabaseClassValidator.java b/core-ng/src/main/java/core/framework/internal/db/DatabaseClassValidator.java
@@ -116,10 +116,16 @@ private void validateJSONField(Field field) {
         if (GenericTypes.isList(fieldType)) {
             if (!GenericTypes.isGenericList(fieldType))
                 throw new Error("db json list field must be List<T> and T must be enum or value class, field=" + Fields.path(field));
+
             Class<?> valueClass = GenericTypes.listValueClass(fieldType);
-            if (!valueClass.isEnum() && !allowedValueClasses.contains(valueClass)) {
-                throw new Error("db json list field must be List<T> and T must be enum or value class, field=" + Fields.path(field));
+            if (valueClass.isEnum()) {
+                JSONClassValidator.validateEnum(valueClass);
+                return;
             }
+            // use db.allowedValues not json.allowedValues to keep json db field consistent with db entity
+            if (allowedValueClasses.contains(valueClass)) return;
+
+            throw new Error("db json list field must be List<T> and T must be enum or value class, field=" + Fields.path(field));
         } else {
             Class<?> fieldClass = GenericTypes.rawClass(fieldType);
             if (fieldClass.isEnum() || allowedValueClasses.contains(fieldClass))

diff --git a/core-ng/src/test/java/core/framework/internal/db/DatabaseClassValidatorTest.java b/core-ng/src/test/java/core/framework/internal/db/DatabaseClassValidatorTest.java
@@ -20,6 +20,7 @@ void validateEntityClass() {
         new DatabaseClassValidator(AssignedIdEntity.class, false).validate();
         new DatabaseClassValidator(AutoIncrementIdEntity.class, false).validate();
         new DatabaseClassValidator(CompositeKeyEntity.class, false).validate();
+        new DatabaseClassValidator(JSONEntity.class, false).validate();
     }
 
     @Test

diff --git a/core-ng/src/test/java/core/framework/internal/db/JSONEntity.java b/core-ng/src/test/java/core/framework/internal/db/JSONEntity.java
@@ -20,13 +20,21 @@ public class JSONEntity {
     public TestJSON jsonField;
 
     @Column(name = "enum_list", json = true)
-    public List<TestEnum> enumList;
+    public List<TestJSONEnum> enumList;
 
     @Column(name = "int_list", json = true)
     public List<Integer> intList;
 
+    public enum TestJSONEnum {
+        @Property(name = "DB_V1")
+        V1,
+        @Property(name = "DB_V2")
+        V2
+    }
+
     public static class TestJSON {
         @Property(name = "data")
         public String data;
+
     }
 }
diff --git a/core-ng/src/test/resources/db-test/row-mapper-json.java b/core-ng/src/test/resources/db-test/row-mapper-json.java
@@ -3,7 +3,7 @@ public Object map(core.framework.internal.db.ResultSetWrapper resultSet) {
         core.framework.internal.db.JSONEntity entity = new core.framework.internal.db.JSONEntity();
         entity.id = resultSet.getString("id");
         entity.jsonField = (core.framework.internal.db.JSONEntity.TestJSON) core.framework.internal.db.JSONHelper.fromJSON(resultSet.getString("json"), core.framework.internal.db.JSONEntity.TestJSON.class);
-        entity.enumList = (java.util.List) core.framework.internal.db.JSONHelper.fromJSON(resultSet.getString("enum_list"), core.framework.util.Types.list(core.framework.internal.db.TestEnum.class));
+        entity.enumList = (java.util.List) core.framework.internal.db.JSONHelper.fromJSON(resultSet.getString("enum_list"), core.framework.util.Types.list(core.framework.internal.db.JSONEntity.TestJSONEnum.class));
         entity.intList = (java.util.List) core.framework.internal.db.JSONHelper.fromJSON(resultSet.getString("int_list"), core.framework.util.Types.list(java.lang.Integer.class));
         return entity;
     }