OPENJPA-2930 Implements UUID and GenerationType.UUID strategy (#124)

cristof · web-flow · commit 6f4cf5b11b5b · 2025-02-19T21:12:45.000+07:00
* [OPENJPA-2930] Implemented JPA 3.1 UUID support

* added basic support for UUID as string or uuid field, per db support
* added GenerationStrategy.UUID support using UUID-4 random

* [OPENJPA-2930] Implements UUID support

* Allows usage of UUID as a basic type
* Allows usage of UUID as identity type
* Allows GenerationType.AUTO and GenerationType.UUID usage on String and UUID fields
* Generates type 4 UUID for @GeneratedValue String and UUID fields
* Storage UUID fields as binary data on supporting pair db/jdbc driver
* Storage UUID fields as canonical string representation when database or jdbc driver does not support UUID binary usage.
* Updates manual

* [OPENJPA-2930] Fixing issues found on review
diff --git a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/kernel/JDBCStoreManager.java b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/kernel/JDBCStoreManager.java
@@ -82,6 +82,7 @@
 import org.apache.openjpa.util.OpenJPAId;
 import org.apache.openjpa.util.StoreException;
 import org.apache.openjpa.util.UserException;
+import org.apache.openjpa.util.UuidId;
 
 /**
  * StoreManager plugin that uses JDBC to store persistent data in a
diff --git a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/meta/MappingRepository.java b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/meta/MappingRepository.java
@@ -1360,6 +1360,7 @@ protected ValueHandler defaultHandler(ValueMapping val, boolean adapting) {
             case JavaTypes.LOCAL_DATETIME:
             case JavaTypes.OFFSET_TIME:
             case JavaTypes.OFFSET_DATETIME:
+            case JavaTypes.UUID_OBJ:
                 return ImmutableValueHandler.getInstance();
             case JavaTypes.STRING:
                 if (isClob(val, true))
diff --git a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/meta/strats/ImmutableValueHandler.java b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/meta/strats/ImmutableValueHandler.java
@@ -65,6 +65,8 @@ public Column[] map(ValueMapping vm, DBIdentifier name, ColumnIO io,
         col.setIdentifier(name);
         if (vm.getTypeCode() == JavaTypes.DATE)
             col.setJavaType(JavaSQLTypes.getDateTypeCode(vm.getType()));
+        else if (vm.getTypeCode() == JavaTypes.UUID_OBJ) 
+            updateUUIDColumn(vm, col);
         else
             col.setJavaType(vm.getTypeCode());
         return new Column[]{ col };
@@ -94,6 +96,7 @@ public boolean isVersionable(ValueMapping vm) {
             case JavaTypes.OFFSET_DATETIME:
             case JavaTypes.BIGINTEGER:
             case JavaTypes.LOCALE:
+            case JavaTypes.UUID_OBJ:
                 return true;
             default:
                 return false;
@@ -117,4 +120,15 @@ public Object toDataStoreValue(ValueMapping vm, Object val,
         // honor the user's null-value=default
         return JavaSQLTypes.getEmptyValue(vm.getTypeCode());
     }
+
+    private void updateUUIDColumn(ValueMapping vm, Column col) {
+        DBDictionary dict = vm.getMappingRepository().getDBDictionary();
+        if (dict.supportsUuidType) {
+            col.setJavaType(vm.getTypeCode());
+            col.setSize(-1);
+        } else {
+            col.setJavaType(JavaTypes.STRING);
+            col.setSize(36);
+        }
+    }
 }
diff --git a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/sql/DBDictionary.java b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/sql/DBDictionary.java
@@ -67,6 +67,7 @@
 import java.util.Map;
 import java.util.Set;
 import java.util.TreeMap;
+import java.util.UUID;
 
 import javax.sql.DataSource;
 
@@ -397,6 +398,7 @@ public enum DateMillisecondBehaviors { DROP, ROUND, RETAIN }
     public String varcharTypeName = "VARCHAR";
     public String xmlTypeName = "XML";
     public String xmlTypeEncoding = "UTF-8";
+    public String uuidTypeName = "UUID";
     public String getStringVal = "";
 
     // schema metadata
@@ -493,6 +495,8 @@ public enum DateMillisecondBehaviors { DROP, ROUND, RETAIN }
     protected String defaultSchemaName = null;
     private String conversionKey = null;
 
+    public boolean supportsUuidType = false;
+
     // Naming utility and naming rules
     private DBIdentifierUtil namingUtil = null;
     private Map<String, IdentifierRule> namingRules = new HashMap<>();
@@ -1628,6 +1632,9 @@ public void setTyped(PreparedStatement stmnt, int idx, Object val, Column col, i
                 } else
                     setTimestamp(stmnt, idx, (Timestamp) val, null, col);
                 break;
+            case JavaTypes.UUID_OBJ:
+                setObject(stmnt, idx, val, Types.OTHER, col);
+                break;
             default:
                 if (col != null && (col.getType() == Types.BLOB
                     || col.getType() == Types.VARBINARY))
@@ -1733,6 +1740,10 @@ else if (val instanceof OffsetDateTime) {
         else if (val instanceof Reader)
             setCharacterStream(stmnt, idx, (Reader) val,
                 (sized == null) ? 0 : sized.size, col);
+        else if (val instanceof UUID && supportsUuidType)
+            setObject(stmnt, idx, (UUID) val, Types.OTHER, col);
+        else if (val instanceof UUID && !supportsUuidType) 
+            setString(stmnt, idx, ((UUID) val).toString(), col);
         else
             throw new UserException(_loc.get("bad-param", val.getClass()));
     }
@@ -1956,6 +1967,14 @@ public String getTypeName(Column col) {
         if (col.isAutoAssigned() && autoAssignTypeName != null)
             return appendSize(col, autoAssignTypeName);
 
+        if (col.getJavaType() == JavaTypes.UUID_OBJ) {
+            if (supportsUuidType) 
+                return appendSize(col, uuidTypeName);
+            else {
+                return appendSize(col, getTypeName(Types.VARCHAR));
+            }
+        }
+
         return appendSize(col, getTypeName(col.getType()));
     }
 
diff --git a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/sql/H2Dictionary.java b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/sql/H2Dictionary.java
@@ -144,6 +144,7 @@ public class H2Dictionary extends DBDictionary {
             "UNKNOWN",
             "USER",
             "USING",
+            "UUID",
             "VALUE",
             "VALUES",
             "WHEN",
@@ -238,6 +239,7 @@ public H2Dictionary() {
             "IS", "JOIN", "LIKE", "LIMIT", "MINUS", "NATURAL", "NOT", "NULL", "OFFSET", "ON", "ORDER", "PRIMARY", "ROWNUM",
             "SELECT", "SYSDATE", "TRUE", "UNION", "UNIQUE", "WHERE", "WITH",
         }));
+        supportsUuidType = true;
     }
 
     @Override
diff --git a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/sql/HSQLDictionary.java b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/sql/HSQLDictionary.java
@@ -145,6 +145,9 @@ public void connectedConfiguration(Connection conn) throws SQLException {
             packageName = "org.hsqldb.Trace";
             fieldName = "VIOLATION_OF_UNIQUE_INDEX";
         }
+        if (dbMajorVersion > 2 || (dbMajorVersion == 2 && dbMinorVersion >= 4)) {
+            supportsUuidType = true;
+        }
         try {
             Class<?> cls = Class.forName(packageName);
             Field fld = cls.getField(fieldName);
diff --git a/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/sql/PostgresDictionary.java b/openjpa-jdbc/src/main/java/org/apache/openjpa/jdbc/sql/PostgresDictionary.java
@@ -216,6 +216,8 @@ public PostgresDictionary() {
 
         // PostgreSQL requires to escape search strings
         requiresSearchStringEscapeForLike = true;
+        supportsUuidType = true;
+        uuidTypeName = "UUID";
     }
 
 
@@ -305,7 +307,7 @@ public long getLong(ResultSet rs, int column)
     public void setNull(PreparedStatement stmnt, int idx, int colType,
         Column col)
         throws SQLException {
-        if (col != null && col.isXML()) {
+        if (col != null && (col.isXML() || col.getJavaType() == JavaTypes.UUID_OBJ)) {
             stmnt.setNull(idx, Types.OTHER);
             return;
         }
diff --git a/openjpa-kernel/src/main/java/org/apache/openjpa/enhance/PCEnhancer.java b/openjpa-kernel/src/main/java/org/apache/openjpa/enhance/PCEnhancer.java
@@ -4927,6 +4927,7 @@ private void readExternal(ClassNode classNode, InsnList instructions, String fie
                 case JavaTypes.MAP:
                 case JavaTypes.OBJECT:
                 case JavaTypes.CALENDAR:
+                case JavaTypes.UUID_OBJ:
                     // if (sm != null)
                     //   sm.proxyDetachedDeserialized (<index>);
                     instructions.add(new VarInsnNode(Opcodes.ALOAD, 0)); // this
diff --git a/openjpa-kernel/src/main/java/org/apache/openjpa/kernel/StateManagerImpl.java b/openjpa-kernel/src/main/java/org/apache/openjpa/kernel/StateManagerImpl.java
@@ -36,6 +36,7 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.TimeZone;
+import java.util.UUID;
 import java.util.concurrent.locks.ReentrantLock;
 
 import org.apache.openjpa.conf.OpenJPAConfiguration;
@@ -2905,6 +2906,13 @@ private void storeField(int field, Object val, FieldManager fm) {
             case JavaTypes.STRING:
                 fm.storeStringField(field, (String) val);
                 break;
+            case JavaTypes.UUID_OBJ:
+                if (val instanceof String) {
+                    fm.storeObjectField(field, (UUID) UUID.fromString((String) val));
+                } else if (val instanceof UUID) {
+                    fm.storeObjectField(field, (UUID) val);
+                }
+                break;
             default:
                 fm.storeObjectField(field, val);
         }
diff --git a/openjpa-kernel/src/main/java/org/apache/openjpa/meta/ClassMetaData.java b/openjpa-kernel/src/main/java/org/apache/openjpa/meta/ClassMetaData.java
@@ -71,6 +71,7 @@
 import org.apache.openjpa.util.ShortId;
 import org.apache.openjpa.util.StringId;
 import org.apache.openjpa.util.UnsupportedException;
+import org.apache.openjpa.util.UuidId;
 
 
 /**
@@ -559,6 +560,9 @@ public Class<?> getObjectIdType() {
             case JavaTypes.BOOLEAN_OBJ:
                 _objectId = BooleanId.class;
                 break;
+            case JavaTypes.UUID_OBJ:
+                _objectId = UuidId.class;
+                break;
         }
         return _objectId;
     }
diff --git a/openjpa-kernel/src/main/java/org/apache/openjpa/meta/JavaTypes.java b/openjpa-kernel/src/main/java/org/apache/openjpa/meta/JavaTypes.java
@@ -40,6 +40,7 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.Properties;
+import java.util.UUID;
 
 import org.apache.openjpa.enhance.PersistenceCapable;
 import org.apache.openjpa.lib.meta.CFMetaDataParser;
@@ -96,6 +97,7 @@ public class JavaTypes {
     public static final int OFFSET_TIME = 36;
     public static final int OFFSET_DATETIME = 37;
 
+    public static final int UUID_OBJ = 38;
 
 
     private static final Localizer _loc = Localizer.forPackage(JavaTypes.class);
@@ -131,6 +133,8 @@ public class JavaTypes {
         _typeCodes.put(LocalDateTime.class, LOCAL_DATETIME);
         _typeCodes.put(OffsetTime.class, OFFSET_TIME);
         _typeCodes.put(OffsetDateTime.class, OFFSET_DATETIME);
+
+        _typeCodes.put(UUID.class, UUID_OBJ);
     }
 
     /**
@@ -417,6 +421,11 @@ public static Object convert(Object val, int typeCode) {
                 if (val instanceof String)
                     return Short.valueOf(val.toString());
                 return val;
+            case UUID_OBJ:
+                if (val instanceof String) {
+                    return UUID.fromString((String) val);
+                }
+                return (UUID) val;
             case STRING:
                 return val.toString();
             default:
diff --git a/openjpa-kernel/src/main/java/org/apache/openjpa/meta/ValueStrategies.java b/openjpa-kernel/src/main/java/org/apache/openjpa/meta/ValueStrategies.java
@@ -77,6 +77,13 @@ public class ValueStrategies {
      */
     public static final int UUID_TYPE4_HEX = 8;
 
+    /**
+     * JPA 3.1 native UUID strategy
+     */
+    public static final int UUID_JPA = 9;
+
+    public static final int UUID_TYPE4_CANON = 10;
+
     private static final Localizer _loc = Localizer.forPackage
         (ValueStrategies.class);
 
@@ -93,6 +100,8 @@ public class ValueStrategies {
         _map.put("uuid-hex", UUID_HEX);
         _map.put("uuid-type4-string", UUID_TYPE4_STRING);
         _map.put("uuid-type4-hex", UUID_TYPE4_HEX);
+        _map.put("uuid-jpa", UUID_JPA);
+        _map.put("uuid-type4-canon", UUID_TYPE4_CANON);
     }
 
     /**
diff --git a/openjpa-kernel/src/main/java/org/apache/openjpa/util/ApplicationIds.java b/openjpa-kernel/src/main/java/org/apache/openjpa/util/ApplicationIds.java
@@ -25,6 +25,7 @@
 import java.security.AccessController;
 import java.security.PrivilegedActionException;
 import java.util.Date;
+import java.util.UUID;
 
 import org.apache.openjpa.enhance.FieldManager;
 import org.apache.openjpa.enhance.PCRegistry;
@@ -208,6 +209,12 @@ public static Object fromPKValues(Object[] pks, ClassMetaData meta) {
                         throw new ClassCastException("!(x instanceof Boolean)");
                     return new BooleanId(meta.getDescribedType(),
                         val == null ? false : (Boolean)val);
+                case JavaTypes.UUID_OBJ:
+                    if (convert && (val instanceof String))
+                        return new UuidId(meta.getDescribedType(), UUID.fromString((String) val));
+                    else if (val instanceof UUID)
+                        return new UuidId(meta.getDescribedType(), (UUID) val);
+                    throw new ClassCastException(String.format("Could not convert [%s] to UUID", val.getClass().getCanonicalName()));
                 default:
                     throw new InternalException();
             }
diff --git a/openjpa-kernel/src/main/java/org/apache/openjpa/util/ImplHelper.java b/openjpa-kernel/src/main/java/org/apache/openjpa/util/ImplHelper.java
@@ -23,6 +23,7 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Map;
+import java.util.UUID;
 
 import org.apache.openjpa.conf.OpenJPAConfiguration;
 import org.apache.openjpa.enhance.ManagedInstanceProvider;
@@ -169,6 +170,10 @@ private static Object generateValue(StoreContext ctx,
                 return UUIDGenerator.nextString(UUIDGenerator.TYPE4);
             case ValueStrategies.UUID_TYPE4_HEX:
                 return UUIDGenerator.nextHex(UUIDGenerator.TYPE4);
+            case ValueStrategies.UUID_TYPE4_CANON:
+                return UUID.randomUUID().toString();
+            case ValueStrategies.UUID_JPA:
+                return UUID.randomUUID();
             default:
                 return null;
         }
diff --git a/openjpa-kernel/src/main/java/org/apache/openjpa/util/UuidId.java b/openjpa-kernel/src/main/java/org/apache/openjpa/util/UuidId.java
@@ -0,0 +1,77 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.openjpa.util;
+
+import java.util.UUID;
+
+/**
+ * Identity type appropriate for UUID primary key fields and shared
+ * id classes.
+ *
+ * @author Abe White
+ * @author Paulo Cristovão Filho
+ * @author Max Solodovnik
+ */
+public final class UuidId
+    extends OpenJPAId {
+
+    
+    private static final long serialVersionUID = 1L;
+    private UUID _key;
+
+    public UuidId(Class<?> cls, UUID key) {
+        super(cls);
+        _key = key;
+    }
+
+    public UuidId(Class<?> cls, UUID key, boolean subs) {
+        super(cls, subs);
+        _key = key;
+    }
+
+    public UUID getId() {
+        return _key;
+    }
+
+    /**
+     * Allow utilities in this package to mutate id.
+     */
+    void setId(UUID id) {
+        _key = id;
+    }
+
+    @Override
+    public Object getIdObject() {
+        return _key;
+    }
+
+    @Override
+    protected int idHash() {
+        return (_key == null) ? 0 : _key.hashCode();
+    }
+
+    @Override
+    protected boolean idEquals(OpenJPAId o) {
+        if (!(o instanceof UuidId)) {
+            return false;
+        }
+        Object key = ((UuidId) o)._key;
+        return (_key == null) ? key == null : _key.equals(key);
+    }
+}
diff --git a/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/generationtype/TestUuidGeneratedEntity.java b/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/generationtype/TestUuidGeneratedEntity.java
diff --git a/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/generationtype/UuidGeneratedEntity.java b/openjpa-persistence-jdbc/src/test/java/org/apache/openjpa/persistence/generationtype/UuidGeneratedEntity.java
diff --git a/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/AnnotationPersistenceMetaDataParser.java b/openjpa-persistence/src/main/java/org/apache/openjpa/persistence/AnnotationPersistenceMetaDataParser.java
diff --git a/openjpa-project/src/doc/manual/jpa_overview_meta.xml b/openjpa-project/src/doc/manual/jpa_overview_meta.xml
diff --git a/openjpa-project/src/doc/manual/jpa_overview_pc.xml b/openjpa-project/src/doc/manual/jpa_overview_pc.xml
diff --git a/openjpa-project/src/doc/manual/supported_databases.xml b/openjpa-project/src/doc/manual/supported_databases.xml

Original file line number	Diff line number	Diff line change
`@@ -216,6 +216,8 @@ public PostgresDictionary() {`
`216`	`216`
`217`	`217`	`// PostgreSQL requires to escape search strings`
`218`	`218`	`requiresSearchStringEscapeForLike = true;`
	`219`	`+ supportsUuidType = true;`
	`220`	`+ uuidTypeName = "UUID";`
`219`	`221`	`}`
`220`	`222`
`221`	`223`
`@@ -305,7 +307,7 @@ public long getLong(ResultSet rs, int column)`
`305`	`307`	`public void setNull(PreparedStatement stmnt, int idx, int colType,`
`306`	`308`	`Column col)`
`307`	`309`	`throws SQLException {`
`308`		`- if (col != null && col.isXML()) {`
	`310`	`+ if (col != null && (col.isXML() \|\| col.getJavaType() == JavaTypes.UUID_OBJ)) {`
`309`	`311`	`stmnt.setNull(idx, Types.OTHER);`
`310`	`312`	`return;`
`311`	`313`	`}`