使用 BizTalk Server 在 SQL Server 中执行具有 FOR XML 子句的存储过程

  • 项目

SQL SELECT 语句可以具有一个 FOR XML 子句，该子句以 XML 而不是行集的形式返回查询结果。 还可以具有具有具有 FOR XML 子句的 SELECT 语句的存储过程。 FOR XML (SQL Server) 包含详细信息。

可以使用基于 WCF 的 SQL 适配器执行此类存储过程。

重要

BizTalk Server提供的“本机”SQL 适配器要求存储过程将 FOR XML 子句作为 SELECT 语句的一部分。 可以将此类存储过程与基于 WCF 的 SQL 适配器配合使用，而无需对存储过程定义进行任何更改。

始终可以使用BizTalk Server早期版本随附的“本机”SQL 适配器生成的架构。 有关详细信息，请参阅 将 FOR XML 查询与 WCF-SQL 适配器配合使用。

如何使用 FOR XML 子句调用存储过程

使用 SQL Server Management Studio 中的 FOR XML 子句或使用 BizTalk Server 可用的 SQL 适配器调用存储过程时，输出采用 xml 消息的形式。 若要将这些过程用于基于 WCF 的 SQL 适配器，必须具有输出消息的架构。 基于 WCF 的 SQL 适配器在使用 FOR XML 子句执行存储过程后从 SQL Server 接收响应消息时需要此架构。 请注意，调用此存储过程的请求消息将由适配器本身生成。

除了具有响应消息的架构外，还必须执行某些任务，以使用基于 WCF 的 SQL 适配器使用 FOR XML 子句调用存储过程。

  1. 使用 FOR XML 子句为存储过程生成响应消息的架构。 如果已有“本机”SQL 适配器生成的响应架构可用于 BizTalk Server，则可以跳过此步骤。

  2. 创建 BizTalk 项目，并将生成的架构添加到项目。

  3. 使用基于 WCF 的 SQL 适配器使用 FOR XML 子句为存储过程生成架构。 这为适配器发送到 SQL Server调用存储过程的请求消息提供架构。

  4. 在 BizTalk 项目中创建消息以发送和接收来自SQL Server的消息。 请求消息必须符合适配器生成的请求消息的架构。 响应消息必须符合使用“本机”SQL 适配器或通过在 SQL Server Management Studio 中使用 FOR XML 子句执行存储过程获取的响应消息的架构。

  5. 创建业务流程以调用 SQL Server 数据库中的存储过程。

  6. 生成和部署 BizTalk 项目。

  7. 通过创建物理发送和接收端口来配置 BizTalk 应用程序。

  8. 启动 BizTalk 应用程序。

为存储过程的响应消息生成架构

注意

如果 SQL 适配器生成的响应架构可用于 BizTalk Server，则无需执行此步骤。

可以为存储过程生成响应消息的架构，前提是存储过程中的 SELECT 语句具有 xmlschema 子句 for xml 。 在本主题中，我们使用GET_EMP_DETAILS_FOR_XML存储过程来检索给定员工 ID 的员工详细信息。 若要通过执行存储过程来检索架构，SELECT 语句如下所示：

SELECT [Employee_ID] ,[Name] ,[DOJ] ,[Designation] ,[Job_Description] ,[Photo] ,cast([Rating] as varchar(100)) as Rating ,[Salary] ,[Last_Modified] ,[Status] ,[Address]
FROM [Adapt_Doc].[dbo].[Employee] for xml auto, xmlschema

执行此存储过程以获取响应消息的架构。 请注意，存储过程的响应包含架构以及执行存储过程的数据。 必须从响应复制架构并将其保存到文本板。 对于此示例，可以将此架构命名为 ResponseSchema.xsd。 现在必须在 Visual Studio 中创建 BizTalk 项目，并将此架构添加到项目中。

重要

请确保在执行存储过程以生成架构后删除 xmlschema 子句。 如果未能执行此操作，则在最终通过 BizTalk 执行存储过程时，将在响应消息中再次生成架构。 因此，若要以 xml 格式获取响应消息， xmlschema 必须删除 子句。

将架构添加到 BizTalk 项目

  1. 在 Visual Studio 中创建 BizTalk 项目。

  2. 将为存储过程生成的响应架构添加到 BizTalk 项目。 右键单击解决方案资源管理器中的 BizTalk 项目，指向“添加”，然后单击“现有项”。 在“添加现有项”对话框中，导航到保存架构的位置，然后单击“ 添加”。

  3. 在 Visual Studio 中打开架构并进行以下更改。

    1. 将节点添加到架构，并将现有根节点移到此新添加的节点下。 为根节点命名。 对于本主题，请将根节点重命名为 根节点。

    2. 为存储过程生成的响应架构引用 sqltypes.xsd。 可以从 获取 sqltypes.xsd 架构 https://go.microsoft.com/fwlink/?linkid=31850。 将 sqltypes.xsd 架构添加到 BizTalk 项目。 有关此架构的详细信息，请转到：

    3. 在为存储过程生成的架构中，将 的值 import schemaLocation 更改为以下内容。

      import schemaLocation=”sqltypes.xsd”

      之所以这样做，是因为已将 sqltypes.xsd 架构添加到 BizTalk 项目。

    4. 为架构提供目标命名空间。 <单击“架构”>节点，并在“属性”窗格中指定“目标命名空间”属性中的命名空间。 对于本主题，将 命名空间指定为 http://ForXmlStoredProcs/namespace。

为请求消息生成架构以调用存储过程

若要为请求消息生成架构，可以使用 Visual Studio 中的 BizTalk 项目中的“使用适配器服务外接程序”。 对于本主题，请生成GET_EMP_DETAILS_FOR_XML存储过程的架构。 有关如何使用适配器服务外接程序生成架构的详细信息，请参阅使用 SQL 适配器在 Visual Studio 中检索SQL Server操作的元数据。

重要

必须仅从“使用适配器服务加载项”中的“ 过程” 节点选择过程来生成架构。

定义消息和消息类型

你之前生成的架构描述了业务流程中的消息所需的“类型”。 消息通常是一个变量，其类型由相应的架构定义。 现在必须为业务流程创建消息，并将其链接到在上一步中生成的架构。

  1. 将业务流程添加到 BizTalk 项目。 在解决方案资源管理器中，右键单击 BizTalk 项目名称，指向“添加”，然后单击“新建项”。 键入 BizTalk 业务流程的名称，然后单击“ 添加”。

  2. 打开 BizTalk 项目的“业务流程视图”窗口（如果尚未打开该窗口）。 为此，请单击“ 视图”，指向“ 其他窗口”，然后单击“ 业务流程视图”。

  3. 在“业务流程视图”中，右键单击“ 消息”，然后单击“ 新建消息”。

  4. 右键单击新创建的消息，然后选择“ 属性窗口”。

  5. 在Message_1的“属性”窗格中，执行以下操作：

    使用此选项 要执行此操作
    标识符 键入 Request
    消息类型 在下拉列表中，展开“ 架构”，然后选择“ ForXMLProcedure.Procedure_dbo”。GET_EMP_DETAILS_FOR_XML，其中 ForXMLProcedure 是 BizTalk 项目的名称。 Procedure_dbo是为调用GET_EMP_DETAILS_FOR_XML过程而生成的架构。

  6. 重复步骤 2 以创建新消息。 在新邮件的“ 属性 ”窗格中，执行以下操作：

    使用此选项 要执行此操作
    标识符 键入 Response
    消息类型 在下拉列表中，展开“ 架构”，然后选择“ ForXMLProcedure.ResponseSchema”，其中 ResponseSchema 是执行存储过程生成的响应架构的名称，如 为存储过程的响应消息生成架构中所述。

设置业务流程

必须创建 BizTalk 业务流程才能使用 BizTalk Server 在 SQL Server 中执行存储过程。 在此业务流程中，会在定义的接收位置放置请求消息。 SQL 适配器使用此消息并将其传递给SQL Server。 来自SQL Server的响应将保存到另一个位置。 必须包含“发送和接收”形状，才能分别将消息发送到SQL Server和接收响应。 用于调用过程的示例业务流程如下所示：

用于调用存储过程的业务流程

添加消息形状

请确保为每个邮件形状指定以下属性。 “形状”列中列出的名称是刚才提到的业务流程中显示的消息形状的名称。

形状 形状类型 属性
ReceiveMessage 接收 - 将 Name 设置为 ReceiveMessage
- 将 “激活” 设置为 “True”
SendMessage 发送 - 将 “名称” 设置为 SendMessage
ReceiveResponse 接收 - 将 Name 设置为 ReceiveResponse
- 将 “激活” 设置为 “False”
SendResponse 发送 - 将 “名称” 设置为 SendResponse

添加端口

请确保为每个逻辑端口指定以下属性。 “端口”列中列出的名称是业务流程中显示的端口名称。

端口 属性
MessageIn - 将 标识符 设置为 MessageIn
- 将 Type 设置为 MessageInType
- 将 通信模式 设置为 单向
- 将 通信方向 设置为 接收
LOBPort - 将 标识符 设置为 LOBPort
- 将 Type 设置为 LOBPortType
- 将 通信模式 设置为 请求-响应
- 将 通信方向 设置为 “发送-接收”
ResponseOut - 将 标识符 设置为 ResponseOut
- 将 Type 设置为 ResponseOutType
- 将 通信模式 设置为 单向
- 将 “通信方向 ”设置为 “发送”

指定操作形状的消息，并将其连接到端口

下表指定了应设置的属性及其值，以便为操作形状指定消息并将消息链接到端口。 “形状”列中列出的名称是前面提到的业务流程中显示的消息形状的名称。

形状 属性
ReceiveMessage - 将 “消息 ”设置为 “请求”
- 将 操作 设置为 MessageIn.FOR_XML.Request
SendMessage - 将 “消息 ”设置为 “请求”
- 将 操作 设置为 LOBPort.FOR_XML.Request
ReceiveResponse - 将 消息 设置为 响应
- 将 操作 设置为 LOBPort.FOR_XML.Response
SendResponse - 将 消息 设置为 响应
- 将 操作 设置为 ResponseOut.FOR_XML.Request

指定这些属性后，将连接消息形状和端口，并且业务流程已完成。

现在必须生成 BizTalk 解决方案并将其部署到BizTalk Server。 有关详细信息，请参阅 生成和运行业务流程。

配置 BizTalk 应用程序

部署 BizTalk 项目后，前面创建的业务流程将列在 BizTalk Server 管理控制台的“业务流程”窗格中。 必须使用 BizTalk Server 管理控制台来配置应用程序。 有关演练，请参阅 演练：部署基本 BizTalk 应用程序。

配置应用程序涉及：

  • 为应用程序选择主机。

  • 将业务流程中创建的端口映射到 BizTalk Server 管理控制台中的物理端口。 对于此业务流程，必须：

    • 在硬盘上定义一个位置和相应的文件端口，你将在其中放置请求消息。 BizTalk 业务流程将使用请求消息并将其发送到SQL Server数据库。

    • 在硬盘上定义一个位置和相应的文件端口，BizTalk 业务流程将删除包含来自 SQL Server 数据库的响应消息的响应消息。

    • 定义物理 WCF-Custom 或 WCF-SQL 发送端口以将消息发送到SQL Server数据库。 有关如何创建发送端口的说明，请参阅 手动配置到 SQL 适配器的物理端口绑定。

      还必须在发送端口中指定操作。 对于包含 FOR XML 子句的过程，必须采用以下格式设置操作。

      XmlProcedure/<schema_name>/<procedure_name>

      因此，对于要执行GET_EMP_DETAILS_FOR_XML过程的本主题，操作将为：

      XmlProcedure/dbo/GET_EMP_DETAILS_FOR_XML

      有关设置操作的详细信息，请参阅 为 SQL 适配器 配置 SOAP 操作 。

      在使用 FOR XML 子句执行存储过程时，还必须设置以下绑定属性。

      绑定属性名称 将其设置为
      XmlStoredProcedureRootNodeName 指定添加到为存储过程生成的响应架构的根节点的名称，如为存储过程 的响应消息生成架构中所述。 对于本主题，请将此项设置为 Root。
      XmlStoredProcedureRootNodeNamespace 为存储过程生成的响应架构指定目标命名空间，如为存储过程 的响应消息生成架构中所述。 对于本主题，请将此项设置为 http://ForXmlStoredProcs/namespace。

      有关为绑定属性指定值的详细信息，请参阅 配置 SQL 适配器的绑定属性。

      注意

      使用使用适配器服务 BizTalk 项目外接程序生成架构还会创建一个绑定文件，其中包含有关要为这些端口设置的端口和操作的信息。 可以从 BizTalk Server 管理控制台导入此绑定文件，为出站呼叫创建发送端口 () 或接收) 入站呼叫 (端口。 有关详细信息，请参阅 使用端口绑定文件配置物理端口绑定以使用 SQL 适配器。

启动应用程序

必须启动 BizTalk 应用程序，以便在 SQL Server 数据库中调用过程。 有关启动 BizTalk 应用程序的说明，请参阅 如何启动业务流程。

在此阶段，请确保：

  • 用于接收业务流程请求消息的 FILE 接收端口正在运行。

  • 用于从业务流程接收响应消息的 FILE 发送端口正在运行。

  • WCF-Custom 或 WCF-SQL 发送端口，用于将消息发送到正在运行SQL Server数据库。

  • 操作的 BizTalk 业务流程正在运行。

执行操作

运行应用程序后，必须将请求消息删除到 FILE 接收位置。 请求消息的架构必须符合使用使用适配器服务外接程序生成的过程的请求架构。 例如，调用GET_EMP_DETAILS_FOR XML 的请求消息为：

<GET_EMP_DETAILS_FOR_XML xmlns="http://schemas.microsoft.com/Sql/2008/05/Procedures/dbo">
  <emp_id>10765</emp_id>
</GET_EMP_DETAILS_FOR_XML>

有关使用 SQL 适配器在 SQL Server 数据库中调用过程的请求消息架构的详细信息，请参阅过程和函数的消息架构。

业务流程使用消息并将其发送到SQL Server数据库。 来自SQL Server数据库的响应保存在定义为业务流程的一部分的其他 FILE 位置。 例如，SQL Server 数据库中针对上述请求消息的响应为：

<?xml version="1.0" encoding="utf-8"?>
<Root xmlns="http://ForXmlStoredProcs/namespace">
  <Adapt_Doc.dbo.Employee Employee_ID="10765" Name="John" Designation="asdfaf" Salary="3434.00" Last_Modified="AAAAAAAANso=" Status="0" xmlns="" />
</Root>

请注意，响应接收的架构与执行存储过程生成的架构相同。 另请注意，根节点和命名空间与分别指定为 XmlStoredProcedureRootNodeName 和 XmlStoredProcedureRootNodeNamespace 绑定属性的值相同。

最佳实践

部署并配置 BizTalk 项目后，可以将配置设置导出到名为绑定文件的 XML 文件。 生成绑定文件后，可以从文件导入配置设置，这样就无需为同一业务流程创建诸如发送端口和接收端口之类的项。 有关绑定文件的详细信息，请参阅 重用适配器绑定。

另请参阅

使用 SQL 适配器开发 BizTalk 应用程序