从存储过程返回的 STRUCT 中读取 ARRAY
Posted
技术标签:
【中文标题】从存储过程返回的 STRUCT 中读取 ARRAY【英文标题】：Read an ARRAY from a STRUCT returned by a stored procedure 【发布时间】：2017-03-17 09:24:52 【问题描述】：数据库中有三种Oracle自定义类型（简化）如下：
create or replace TYPE T_ENCLOSURE AS OBJECT(
ENCLOSURE_ID NUMBER(32,0),
ENCLOSURE_NAME VARCHAR2(255 BYTE),
ANIMALS T_ARRAY_ANIMALS,
MEMBER FUNCTION CHECK_IF_RED RETURN BOOLEAN
);
create or replace TYPE T_ARRAY_ANIMALS is TABLE OF T_ANIMAL;
create or replace TYPE T_ANIMAL AS OBJECT(
ANIMAL_ID NUMBER(32,0),
NUMBER_OF_HAIRS NUMBER(32,0)
);
还有一个构建对象树的函数
FUNCTION GET_ENCLOSURE ( f_enclosure_id zoo_schema.ENCLOSURE_TABLE.ENCLOSURE_ID%TYPE ) RETURN T_ENCLOSURE
AS
v_ENC T_ENCLOSURE;
v_idx pls_integer;
BEGIN
v_ENC := T_ENCLOSURE(
f_enclosure_id,
NULL,
T_ARRAY_ANIMALS(T_ANIMAL(NULL,NULL))
);
SELECT ENCLOSURE_NAME
INTO v_ENC.ENCLOSURE_NAME
FROM ENCLOSURE_TABLE WHERE ENCLOSURE_ID = f_ENCLOSURE_ID;
SELECT
CAST(MULTISET(
SELECT ANIMAL_ID, NUMBER_OF_HAIRS
FROM ANIMAL_TABLE
WHERE ENCLOSURE_ID = f_ENCLOSURE_ID
) AS T_ARRAY_ANIMALS
)
INTO v_ENC.ANIMALS
FROM dual;
RETURN v_ENC;
END;
现在我想调用 GET_ENCLOSURE 函数并在我的 Java 代码中使用它的结果 T_ENCLOSURE 对象。
// prepare the call
Connection connection = MyConnectionFactory.getConnection(SOME_CONNECTION_CONFIG);
CallableStatement stmt = connection.prepareCall("? = call zoo_schema.zoo_utils.GET_ENCLOSURE( ? )");
stmt.registerOutParameter(1, OracleTypes.STRUCT, "zoo_schema.T_ENCLOSURE");
stmt.setInt(2, 6); // fetch data for ENCLOSURE#6
// execute function
stmt.executeQuery();
// extract the result
Struct resultStruct = (Struct)stmt.getObject(1); // java.sql.Struct
我可以通过
访问ID和NAMEInteger id = ((BigInteger)resultStruct.getAttributes()[0]).intValue(); // works for me
String name = (String)resultStruct.getAttributes()[1]); // works for me
但是，我似乎无法获得动物列表
resultStruct.getAttributes()[2].getClass().getCanonicalName(); // oracle.sql.ARRAY
ARRAY arrayAnimals = (ARRAY)jdbcStruct.getAttributes()[2];
arrayAnimals.getArray(); // throws a java.sql.SQLException("Internal Error: Unable to resolve name")
我在这里经历了一些尝试和错误，包括
OracleConnection oracleConnection = connection.unwrap(OracleConnection.class);
STRUCT resultOracleStruct = (STRUCT) stmt.getObject(1); // oracle.sql.STRUCT
oracleConnection.createARRAY("zoo_schema.T_ARRAY_ANIMALS", resultOracleStruct.getAttributes()[2]) // throws an SQLException("Fail to convert to internal representation: oracle.sql.ARRAY@8de7cfc4")
但也没有运气。
如何将动物列表放入List<TAnimal>？
【问题讨论】：
我认为没有直接或标准的方法可以从 JDBC 中检索 TABLE OF 数组（一种 plsql 类型）。通常，您只能调用从 Java(JDBC) 返回 SQL 对象的过程，而不是 PlSQl 对象（即使它们包装在 OBJECT 类型中，您也无法检索它们）。我看到了 2 种可能的解决方案 1）将您的对象表转换为字符串（由逗号等分隔）并在客户端上手动解析 2）尝试使用一些特定于 Oracle 的未记录 API（例如 ***.com/questions/37767761/…） 一个非常特定于 Oracle 的解决方案会非常好。此项目中不会更改数据库。 能否提供 GET_ENCLOSURE 调试的代码？ 我更新了问题并添加了 GET_ENCLOSURE 的正文。 （希望我正确重构了实际代码以匹配问题......） 【参考方案1】：创建实现java.sql.SQLData 的对象。在这种情况下，创建TEnclosure 和TAnimal 类，它们都实现了SQLData。
仅供参考，在较新的 Oracle JDBC 版本中，oracle.sql.ARRAY 等类型已被弃用，取而代之的是 java.sql 类型。虽然我不确定如何仅使用 java.sql API 来编写数组（如下所述）。
当您实现readSQL() 时，您会按顺序读取字段。您会通过sqlInput.readArray() 获得java.sql.Array。所以TEnclosure.readSQL() 看起来像这样。
@Override
public void readSQL(SQLInput sqlInput, String s) throws SQLException
id = sqlInput.readBigDecimal();
name = sqlInput.readString();
Array animals = sqlInput.readArray();
// what to do here...
注意：readInt() 也存在，但 Oracle JDBC 似乎总是为NUMBER 提供BigDecimal
您会注意到一些 API，例如 java.sql.Array 具有采用类型映射 Map<String, Class<?>> 的方法，这是 Oracle 类型名称到实现 SQLData 的相应 Java 类的映射（ORAData 也可以工作？） .
如果您只调用Array.getArray()，您将获得Struct 对象，除非 JDBC 驱动程序通过Connection.setTypeMap(typeMap) 知道您的类型映射。但是，在连接上设置 typeMap 对我不起作用，所以我使用getArray(typeMap)
在某处创建您的 Map<String, Class<?>> typeMap 并为您的类型添加条目：
typeMap.put("T_ENCLOSURE", TEnclosure.class);
typeMap.put("T_ANIMAL", TAnimal.class);
在SQLData.readSQL() 实现中，调用sqlInput.readArray().getArray(typeMap)，它返回Object[]，其中Object 条目或TAnimal 类型。
当然，将代码转换为 List<TAnimal> 会很乏味，因此只需使用此实用程序函数并根据您的需要调整它，就空列表策略而言：
/**
* Constructs a list from the given SQL Array
* Note: this needs to be static because it's called from SQLData classes.
*
* @param <T> SQLData implementing class
* @param array Array containing objects of type T
* @param typeClass Class reference used to cast T type
* @return List<T> (empty if array=null)
* @throws SQLException
*/
public static <T> List<T> listFromArray(Array array, Class<T> typeClass) throws SQLException
if (array == null)
return Collections.emptyList();
// Java does not allow casting Object[] to T[]
final Object[] objectArray = (Object[]) array.getArray(getTypeMap());
List<T> list = new ArrayList<>(objectArray.length);
for (Object o : objectArray)
list.add(typeClass.cast(o));
return list;
编写数组
弄清楚如何编写数组令人沮丧，Oracle API 需要连接来创建数组，但在writeSQL(SQLOutput sqlOutput) 的上下文中没有明显的连接。幸运的是，this blog 有一个技巧/hack 来获取我在这里使用过的 OracleConnection。
当您使用createOracleArray() 创建数组时，您指定列表类型 (T_ARRAY_ANIMALS) 作为类型名称，而不是单数对象类型。
这是一个用于写入数组的通用函数。在您的情况下，listType 将是 "T_ARRAY_ANIMALS" 并且您将传入 List<TAnimal>
/**
* Write the list out as an Array
*
* @param sqlOutput SQLOutput to write array to
* @param listType array type name (table of type)
* @param list List of objects to write as an array
* @param <T> Class implementing SQLData that corresponds to the type listType is a list of.
* @throws SQLException
* @throws ClassCastException if SQLOutput is not an OracleSQLOutput
*/
public static <T> void writeArrayFromList(SQLOutput sqlOutput, String listType, @Nullable List<T> list) throws SQLException
final OracleSQLOutput out = (OracleSQLOutput) sqlOutput;
OracleConnection conn = (OracleConnection) out.getSTRUCT().getJavaSqlConnection();
conn.setTypeMap(getTypeMap()); // not needed?
if (list == null)
list = Collections.emptyList();
final Array array = conn.createOracleArray(listType, list.toArray());
out.writeArray(array);
注意事项：
在某一时刻，我认为setTypeMap 是必需的，但现在当我删除该行时，我的代码仍然有效，所以我不确定是否有必要。
我不确定你应该写 null 还是空数组，但我认为空数组更正确。
关于 Oracle 类型的提示
Oracle 将所有内容都大写，因此所有类型名称都应为大写。 如果类型不在您的默认架构中，您可能需要指定SCHEMA.TYPE_NAME。
如果您连接的用户不是所有者，请记住在类型上grant execute。
如果您对包执行了但没有执行类型，getArray() 在尝试查找类型元数据时会抛出异常。
春天
对于使用 Spring 的开发人员，您可能需要查看 Spring Data JDBC Extensions，它提供了 SqlArrayValue 和 SqlReturnArray，这对于为需要数组作为参数或返回一个数组。
7.2.1 Setting ARRAY values using SqlArrayValue for an IN parameter 章节解释了如何使用数组参数调用过程。
【讨论】：
【参考方案2】：只要 Oracle 特定的解决方案足够，关键就在于 DTO。他们都必须实现ORAData和ORADataFactory
public class TAnimal implements ORAData, ORADataFactory
Integer animal_id, number_of_hairs;
public TAnimal()
// [ Getter and Setter omitted here ]
@Override
public Datum toDatum(Connection connection) throws SQLException
OracleConnection oracleConnection = connection.unwrap(OracleConnection.class);
StructDescriptor structDescriptor = StructDescriptor.createDescriptor("zoo_schema.T_ANIMAL", oracleConnection);
Object[] attributes =
this.animal_id,
this.number_of_hairs
;
return new STRUCT(structDescriptor, oracleConnection, attributes);
@Override
public TAnimal create(Datum datum, int sqlTypeCode) throws SQLException
if (datum == null)
return null;
Datum[] attributes = ((STRUCT) datum).getOracleAttributes();
TAnimal result = new TAnimal();
result.animal_id = asInteger(attributes[0]); // see TEnclosure#asInteger(Datum)
result.number_of_hairs = asInteger(attributes[1]); // see TEnclosure#asInteger(Datum)
return result;
和
public class TEnclosure implements ORAData, ORADataFactory
Integer enclosureId;
String enclosureName;
List<Animal> animals;
public TEnclosure()
this.animals = new ArrayList<>();
// [ Getter and Setter omitted here ]
@Override
public Datum toDatum(Connection connection) throws SQLException
OracleConnection oracleConnection = connection.unwrap(OracleConnection.class);
StructDescriptor structDescriptor = StructDescriptor.createDescriptor("zoo_schema.T_ENCLOSURE", oracleConnection);
Object[] attributes =
this.enclosureId,
this.enclosureName,
null // TODO: solve this; however, retrieving data works without this
;
return new STRUCT(structDescriptor, oracleConnection, attributes);
@Override
public TEnclosure create(Datum datum, int sqlTypeCode) throws SQLException
if (datum == null)
return null;
Datum[] attributes = ((STRUCT) datum).getOracleAttributes();
TEnclosure result = new TEnclosure();
result.enclosureId = asInteger(attributes[0]);
result.enclosureName = asString(attributes[1]);
result.animals = asListOfAnimals(attributes[2]);
return result;
// Utility methods
Integer asInteger(Datum datum) throws SQLException
if (datum == null)
return null;
else
return ((NUMBER) datum).intValue(); // oracle.sql.NUMBER
String asString(Datum datum) throws SQLException
if (datum = null)
return null;
else
return ((CHAR) datum).getString(); // oracle.sql.CHAR
List<TAnimal> asListOfAnimals(Datum datum) throws SQLException
if (datum == null)
return null;
else
TAnimal factory = new TAnimal();
List<TAnimal> result = new ArrayList<>();
ARRAY array = (ARRAY) datum; // oracle.sql.ARRAY
Datum[] elements = array.getOracleArray();
for (int i = 0; i < elements.length; i++)
result.add(factory.create(elements[i], 0));
return result;
然后获取数据的工作方式如下：
TEnclosure factory = new TEnclosure();
Connection connection = null;
OracleConnection oracleConnection = null;
OracleCallableStatement oracleCallableStatement = null;
try
connection = MyConnectionFactory.getConnection(SOME_CONNECTION_CONFIG);
oracleConnection = connection.unwrap(OracleConnection.class);
oracleCallableStatement = (OracleCallableStatement) oracleConnection.prepareCall("? = call zoo_schema.zoo_utils.GET_ENCLOSURE( ? )");
oracleCallableStatement.registerOutParameter(1, OracleTypes.STRUCT, "zoo_schema.T_ENCLOSURE");
oracleCallableStatement.setInt(2, 6); // fetch data for ENCLOSURE#6
// Execute query
oracleCallableStatement.executeQuery();
// Check result
Object oraData = oracleCallableStatement.getORAData(1, factory);
LOGGER.info("oraData is a ", oraData.getClass().getName()); // acme.zoo.TEnclosure
finally
ResourceUtils.closeQuietly(oracleCallableStatement);
ResourceUtils.closeQuietly(oracleConnection);
ResourceUtils.closeQuietly(connection); // probably not necessary...
【讨论】：
嗨@DerMike我有类似的问题，但在我的情况下，我将传递类型，它是一个扩展其他类型的数组....看起来像下面创建或替换包PKG_WIRE AS PROCEDURE P_GET_WIRE（P2在 T1_ARRAY 默认为 NULL，【参考方案3】：我只是分享对我有用的逻辑。你可以试试这个来检索从 PL/SQL 到 Java 的 ARRAY 响应。
CallableStatement callstmt = jdbcConnection.prepareCall("call PROCEDURE_NAME(?, ?)");
callstmt.setArray(1, array);
callstmt.registerOutParameter(2,Types.ARRAY, <ARRAY_NAME_DECLARED_IN_PL/SQL>);
// Do all execute operations
Array arr = callstmt.getArray(1);
if (arr != null)
Object[] data = (Object[]) arr.getArray();
for (Object a : data)
OracleStruct empstruct = (OracleStruct) a;
Object[] objarr = empstruct.getAttributes();
<Your_Pojo_class> r = new <Your_Pojo_class>(objarr[0].toString(), objarr[1].toString());
System.out.println("Response-> : "+ r.toString());
【讨论】：
这有助于从过程中的集合中获取数据。但是数组 arr = callstmt.getArray(1); ，这里应该是2，而不是1？【参考方案4】：您可以像这样转换为java.sql.Array：
Object array = ( (Array) resultOracleStruct.getAttributes()[2]) ).getArray();
【讨论】：
以上是关于从存储过程返回的 STRUCT 中读取 ARRAY的主要内容，如果未能解决你的问题，请参考以下文章
jdbcTemplate 调用存储过程。 入参 array 返回 cursor