JDBC API 支持自定义类型映射,将 SQL 用户定义类型(UDT)映射到 Java 类。本章介绍这种映射机制。

17.1 类型映射

类型映射由 java.util.Map 对象表示,用于关联 SQL UDT 名称与 Java 类。每个连接都维护自己的类型映射,应用程序可以通过 Connection.getTypeMap() 获取。

1
2
3
Map<String, Class<?>> typeMap = con.getTypeMap();
typeMap.put("SCHEMA.ADDRESS", Address.class);
con.setTypeMap(typeMap);
赞助商

17.2 类约定

参与自定义映射的 Java 类必须实现 java.sql.SQLData 接口。SQLData 接口定义了以下方法:

  • readSQL(SQLInput stream, String typeName):从 SQL 数据流读取数据
  • writeSQL(SQLOutput stream):将数据写入 SQL 数据流
  • getSQLTypeName():返回 SQL 类型名称

17.3 SQL 数据流

17.3.1 检索数据

使用 getObject 读取 UDT 时,JDBC 驱动程序会依次执行以下操作:

  1. 确定类型映射中是否定义了该 UDT 的自定义映射
  2. 如果有,创建相应 Java 类的实例
  3. 调用 readSQL 方法填充对象
1
Address addr = (Address) rs.getObject("address_column");

17.3.2 存储数据

使用 setObject 存储 Java 对象时,JDBC 驱动程序会执行以下操作:

  1. 检查对象是否实现 SQLData 接口
  2. 如果是,调用 writeSQL 方法序列化对象
1
pstmt.setObject(1, address);

17.4 示例

17.4.1 SQL 结构化类型

1
2
3
4
5
6
CREATE TYPE ADDRESS AS (
street VARCHAR(100),
city VARCHAR(50),
state VARCHAR(2),
zip VARCHAR(10)
);

17.4.2 SQLData 实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
public class Address implements SQLData {
private String street;
private String city;
private String state;
private String zip;
private String sqlType;

public String getSQLTypeName() {
return sqlType;
}

public void readSQL(SQLInput stream, String typeName) throws SQLException {
sqlType = typeName;
street = stream.readString();
city = stream.readString();
state = stream.readString();
zip = stream.readString();
}

public void writeSQL(SQLOutput stream) throws SQLException {
stream.writeString(street);
stream.writeString(city);
stream.writeString(state);
stream.writeString(zip);
}

// Getters and setters...
}

17.4.3 在 Java 类中反映 SQL 继承关系

如果 SQL 结构化类型之间存在继承关系,对应的 Java 类也应当反映这一层次结构。

17.4.4 SQL DISTINCT 类型映射示例

1
CREATE TYPE MONEY AS DECIMAL(10, 2);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
public class Money implements SQLData {
private BigDecimal amount;
private String sqlType;

public String getSQLTypeName() {
return sqlType;
}

public void readSQL(SQLInput stream, String typeName) throws SQLException {
sqlType = typeName;
amount = stream.readBigDecimal();
}

public void writeSQL(SQLOutput stream) throws SQLException {
stream.writeBigDecimal(amount);
}
}

17.5 变换组的作用

变换组是 SQL:2003 定义的一项功能,允许根据上下文使用不同方式表示 UDT。JDBC 驱动程序不一定支持这项功能。

17.6 方法的通用性

自定义类型映射方法也适用于:

  • Distinct 类型
  • 结构化类型
  • 数组元素

17.7 NULL 数据

SQL UDT 的值为 NULL 时,getObject 返回 Java 的 null。