使用自定义类型映射

原文： https://docs.oracle.com/javase/tutorial/jdbc/basics/sqlcustommapping.html

注意：MySQL 目前不支持用户定义的类型。 MySQL 和 Java DB 目前不支持结构化类型或DISTINCT SQL 数据类型。没有 JDBC 教程示例可用于演示本节中描述的功能。

随着业务的蓬勃发展，The Coffee Break 的所有者定期添加新商店并对数据库进行更改。所有者已决定使用结构化类型ADDRESS的自定义映射。这使所有者能够对映射ADDRESS类型的 Java 类进行更改。 Java 类将为ADDRESS的每个属性提供一个字段。类的名称及其字段的名称可以是任何有效的 Java 标识符。

涵盖以下主题：

自定义映射所需的第一件事是创建一个实现接口SQLData的类。

结构化类型ADDRESS的 SQL 定义如下所示：

  1.   CREATE TYPE ADDRESS
  2.   (
  3.     NUM INTEGER,
  4.     STREET VARCHAR(40),
  5.     CITY VARCHAR(40),
  6.     STATE CHAR(2),
  7.     ZIP CHAR(5)
  8.   );

为ADDRESS类型的自定义映射实现SQLData接口的类可能如下所示：

  1. public class Address implements SQLData {
  2.     public int num;
  3.     public String street;
  4.     public String city;
  5.     public String state;
  6.     public String zip;
  7.     private String sql_type;
  9.     public String getSQLTypeName() {
  10.         return sql_type;
  11.     }
  13.     public void readSQL(SQLInput stream, String type)
  14.         throws SQLException {
  15.         sql_type = type;
  16.         num = stream.readInt();
  17.         street = stream.readString();
  18.         city = stream.readString();
  19.         state = stream.readString();
  20.         zip = stream.readString();
  21.     }
  23.     public void writeSQL(SQLOutput stream)
  24.         throws SQLException {
  25.         stream.writeInt(num);
  26.         stream.writeString(street);
  27.         stream.writeString(city);
  28.         stream.writeString(state);
  29.         stream.writeString(zip);
  30.     }
  31. }

在编写实现接口SQLData的类之后，设置自定义映射所需要做的唯一事情就是在类型映射中创建一个条目。例如，这意味着输入ADDRESS类型的完全限定 SQL 名称和类Address的Class对象。类型映射（java.util.Map接口的实例）在创建时与每个新连接相关联，因此您可以使用该连接。假设con是活动连接，以下代码片段将 UDT ADDRESS的条目添加到与con关联的类型映射。

  1. java.util.Map map = con.getTypeMap();
  2. map.put("SchemaName.ADDRESS", Class.forName("Address"));
  3. con.setTypeMap(map);

每当您调用getObject方法来检索ADDRESS类型的实例时，驱动程序将检查与该连接关联的类型映射，并看到它具有ADDRESS的条目。驱动程序将记录Address类的Class对象，创建它的实例，并在后台执行许多其他操作以将ADDRESS映射到Address。除了为映射生成类之外，您不必执行任何操作，然后在类型映射中创建条目以使驱动程序知道存在自定义映射。司机将完成剩下的工作。

存储具有自定义映射的结构化类型的情况类似。当您调用方法setObject时，驱动程序将检查要设置的值是否是实现接口SQLData的类的实例。如果是（意味着存在自定义映射），则驱动程序将使用自定义映射将值转换为 SQL 对应项，然后再将其返回到数据库。同样，驱动程序在幕后进行自定义映射;您需要做的就是为方法setObject提供一个具有自定义映射的参数。您将在本节后面看到此示例。

查看使用标准映射，Struct对象和自定义映射（Java 编程语言中的类）之间的区别。以下代码片段显示了到Struct对象的标准映射，该对象是驱动程序在连接的类型映射中没有条目时使用的映射。

  1. ResultSet rs = stmt.executeQuery(
  2.     "SELECT LOCATION " +
  3.     "WHERE STORE_NO = 100003");
  4. rs.next();
  5. Struct address = (Struct)rs.getObject("LOCATION");

变量address包含以下属性值：4344，"First_Street"，"Verona"，"CA"，"94545"。

以下代码片段显示了在连接的类型映射中存在结构化类型ADDRESS的条目时会发生什么。请记住，列LOCATION存储ADDRESS类型的值。

  1. ResultSet rs = stmt.executeQuery(
  2.     "SELECT LOCATION " +
  3.     "WHERE STORE_NO = 100003");
  4. rs.next();
  5. Address store_3 = (Address)rs.getObject("LOCATION");

变量store_3现在是类Address的一个实例，每个属性值是Address的一个字段的当前值。请注意，在将getObject方法分配给store_3之前，必须记住将getObject方法检索的对象转换为Address对象。另请注意，store_3必须是Address对象。

比较使用Struct对象来处理Address类的实例。假设商店移动到邻近城镇的更好位置，因此您必须更新数据库。使用自定义映射，重置store_3的字段，如下面的代码片段所示：

  1. ResultSet rs = stmt.executeQuery(
  2.     "SELECT LOCATION " +
  3.     "WHERE STORE_NO = 100003");
  4. rs.next();
  5. Address store_3 = (Address)rs.getObject("LOCATION");
  6. store_3.num = 1800;
  7. store_3.street = "Artsy_Alley";
  8. store_3.city = "Arden";
  9. store_3.state = "CA";
  10. store_3.zip = "94546";
  11. PreparedStatement pstmt = con.prepareStatement(
  12.     "UPDATE STORES " +
  13.     "SET LOCATION = ? " +
  14.     "WHERE STORE_NO = 100003");
  15. pstmt.setObject(1, store_3);
  16. pstmt.executeUpdate();

列LOCATION中的值是ADDRESS类型的实例。驱动程序检查连接的类型映射，并看到有一个条目链接ADDRESS和类Address，因此使用Address中指示的自定义映射。当代码以变量_store_3_作为第二个参数调用方法setObject时，驱动程序检查并看到_store_3_代表类Address的实例，它实现结构化类型ADDRESS的接口SQLData，并再次自动使用自定义映射。

没有ADDRESS的自定义映射，更新看起来会更像这样：

  1. PreparedStatement pstmt = con.prepareStatement(
  2.     "UPDATE STORES " +
  3.     "SET LOCATION.NUM = 1800, " +
  4.     "LOCATION.STREET = 'Artsy_Alley', " + 
  5.     "LOCATION.CITY = 'Arden', " +
  6.     "LOCATION.STATE = 'CA', " +
  7.     "LOCATION.ZIP = '94546' " +
  8.     "WHERE STORE_NO = 100003");
  9. pstmt.executeUpdate;

到目前为止，您仅使用与连接关联的类型映射进行自定义映射。通常，这是大多数程序员将使用的唯一类型映射。但是，也可以创建类型映射并将其传递给某些方法，以便驱动程序将使用该类型映射而不是与连接关联的映射。这允许两个不同的映射用于相同的用户定义类型（UDT）。实际上，只要每个映射都使用实现SQLData接口的类和类型映射中的条目设置，就可以为同一个 UDT 创建多个自定义映射。如果未将类型映射传递给可接受类型映射的方法，则驱动程序将默认使用与该连接关联的类型映射。

很少有情况要求使用除与连接关联的类型映射之外的类型映射。例如，如果在 JDBC 应用程序上工作的几个程序员将​​其组件组合在一起并使用相同的连接，则可能需要提供带有类型映射的方法。如果两个或多个程序员为同一个 SQL UDT 创建了自己的自定义映射，则每个程序员都需要提供他或她自己的类型映射，从而覆盖连接的类型映射。