Refactor unknown column handling and improve safety checks

Author: nakamura-to

doma-core/src/main/java/org/seasar/doma/internal/jdbc/command/ColumnNameMapFormatter.java

@@ -16,10 +16,13 @@
 package org.seasar.doma.internal.jdbc.command;
 
 import java.util.Map;
+import java.util.Objects;
 import java.util.TreeMap;
 
-public class ColumnNameMapFormatter {
-  public static String format(Map<String, MappingSupport.PropType> columnNameMap) {
+class ColumnNameMapFormatter {
+  static String format(Map<String, MappingSupport.PropType> columnNameMap) {
+    Objects.requireNonNull(columnNameMap);
+
     StringBuilder buf = new StringBuilder();
     buf.append("------------------------------------------------------\n");
     buf.append("Lowercase Column Name -> Property Name (Entity Name)\n");

doma-core/src/main/java/org/seasar/doma/internal/jdbc/command/MappingSupport.java

@@ -98,7 +98,11 @@ public Map<Integer, MappingSupport.PropType> createIndexMap(
         if (ROWNUMBER_COLUMN_NAME.equals(lowerCaseColumnName)) {
           continue;
         }
-        unknownColumnHandler.handle(query, entityType, lowerCaseColumnName, columnNameMap);
+        unknownColumnHandler.handle(
+            query,
+            entityType,
+            lowerCaseColumnName,
+            () -> ColumnNameMapFormatter.format(columnNameMap));
       } else {
         unmappedPropertySet.remove(propertyType);
         indexMap.put(i, propertyType);
@@ -159,6 +163,13 @@ private void throwResultMappingException(Set<PropType> unmappedPropertySet) {
    */
   public record PropType(
       EntityType<?> entityType, EntityPropertyType<?, ?> propertyType, String propertyPath) {
+
+    public PropType {
+      Objects.requireNonNull(entityType);
+      Objects.requireNonNull(propertyType);
+      Objects.requireNonNull(propertyPath);
+    }
+
     public String name() {
       return propertyType.getName();
     }
@@ -180,6 +191,11 @@ public String columnName(BiFunction<NamingType, String, String> namingFunction)
    */
   public record Prop(PropType propType, Property<Object, ?> property, Object rawValue) {
 
+    public Prop {
+      Objects.requireNonNull(propType);
+      Objects.requireNonNull(property);
+    }
+
     public EntityType<?> entityType() {
       return propType.entityType();
     }

doma-core/src/main/java/org/seasar/doma/jdbc/UnknownColumnHandler.java

@@ -15,9 +15,7 @@
  */
 package org.seasar.doma.jdbc;
 
-import java.util.Map;
-import org.seasar.doma.internal.jdbc.command.ColumnNameMapFormatter;
-import org.seasar.doma.internal.jdbc.command.MappingSupport;
+import java.util.function.Supplier;
 import org.seasar.doma.jdbc.entity.EntityType;
 import org.seasar.doma.jdbc.entity.NamingType;
 import org.seasar.doma.jdbc.query.Query;
@@ -50,24 +48,25 @@ default void handle(Query query, EntityType<?> entityType, String unknownColumnN
   }
 
   /**
-   * Handles the unknown column with additional context provided by the column name map.
+   * Handles an unknown column during query execution. Provides additional information for the
+   * exception when the column is unrecognized by the entity.
    *
-   * @param query the query associated with the operation
-   * @param entityType the entity type description
-   * @param unknownColumnName the name of the unknown column
-   * @param columnNameMap the map containing column names and their corresponding property types
-   * @throws UnknownColumnAdditionalInfoException if handling the unknown column fails with
-   *     additional information
+   * @param query the query being executed
+   * @param entityType the entity type containing the metadata about the entity
+   * @param unknownColumnName the name of the column that is unknown
+   * @param informationSupplier the supplier that provides additional information about the unknown
+   *     column
+   * @throws UnknownColumnAdditionalInfoException if the unknown column cannot be handled
    */
   default void handle(
       Query query,
       EntityType<?> entityType,
       String unknownColumnName,
-      Map<String, MappingSupport.PropType> columnNameMap) {
+      Supplier<String> informationSupplier) {
     try {
       handle(query, entityType, unknownColumnName);
     } catch (UnknownColumnException original) {
-      String additionalInfo = ColumnNameMapFormatter.format(columnNameMap);
+      String additionalInfo = informationSupplier.get();
       UnknownColumnAdditionalInfoException ex =
           new UnknownColumnAdditionalInfoException(
               query.getConfig().getExceptionSqlLogType(), original, additionalInfo);

doma-core/src/main/java/org/seasar/doma/message/Message.java

@@ -280,7 +280,7 @@ public enum Message implements MessageResource {
   DOMA2238(
       """
       While the column "{0}" is in the result set, the corresponding property is not found in the entity class "{1}".
-      Check the following mapping table:
+      Check the following mapping information:
       {4}
       PATH=[{2}]
       SQL=[{3}]"""),

doma-core/src/test/java/org/seasar/doma/internal/jdbc/command/EntityProviderTest.java

@@ -25,7 +25,7 @@
 import java.math.BigDecimal;
 import java.sql.SQLException;
 import java.util.Collections;
-import java.util.Map;
+import java.util.function.Supplier;
 import org.junit.jupiter.api.Test;
 import org.seasar.doma.FetchType;
 import org.seasar.doma.internal.jdbc.mock.ColumnMetaData;
@@ -140,7 +140,7 @@ public void testCreateIndexMap_WithDuplicateColumnName() throws SQLException {
   }
 
   @Test
-  public void testCreateIndexMap_DuplicateColumnHandler() throws SQLException {
+  public void testCreateIndexMap_DuplicateColumnHandler() {
     MockResultSetMetaData metaData = new MockResultSetMetaData();
     metaData.columns.add(new ColumnMetaData("id"));
     metaData.columns.add(new ColumnMetaData("name"));
@@ -254,7 +254,7 @@ public void handle(
         Query query,
         EntityType<?> entityType,
         String unknownColumnName,
-        Map<String, MappingSupport.PropType> columnNameMap) {}
+        Supplier<String> informationSupplier) {}
   }
 
   protected static class EmptyUnknownColumnHandlerConfig extends MockConfig {