Apache CXF 开发指南

Red Hat Fuse 7.8

使用 Apache CXF Web 服务开发应用程序

Red Hat Fuse Documentation Team

法律通告

摘要

使用 Apache CXF 开发 Web 服务指南.

部分 I. 编写 WSDL 合同

这部分论述了如何使用 WSDL 定义 Web 服务接口。

第 1 章 WSDL 合同简介

摘要

WSDL 文档使用 Web 服务描述语言和许多可能的扩展来定义服务。文档具有逻辑部分和导引部分。合同摘要部分定义了实施中立数据类型和消息的服务。文档的对比部分定义了实施服务的端点如何与外界交互。

设计服务的建议方法是在编写任何代码前在 WSDL 和 XML Schema 中定义您的服务。在手动编辑 WSDL 文档时，您必须确保文档有效，并且正确。要执行此操作，您必须对 WSDL 有一定的了解。您可以在 W3C 网站 www.w3.org 中找到标准。

1.1. WSDL 文档的结构

概述

WSDL 文档在其最简单的元素中是根 定义 元素中包含的元素集合。这些元素描述了服务以及如何实施该服务的端点。

WSDL 文档有两个不同的部分：

在实施中立条款中定义服务的逻辑部分
一个 concrete 部分，用于定义如何在网络中公开实施该服务的端点

逻辑部分

WSDL 文档的逻辑部分包含 类型、消息 和 portType 元素。它描述了服务的接口以及服务交换的消息。在 类型 元素中，XML Schema 用于定义组成消息的数据的结构。许多 消息 元素用于定义服务所使用的消息的结构。portType 元素包含一个或多个 操作 元素，用于定义由服务公开的操作发送的消息。

concrete 部分

WSDL 文档中的 concrete 部分包含 绑定 和服务 元素。它描述了实现服务的端点如何连接到外部世界。绑定 元素描述了 消息 元素所描述的数据单元如何映射到 concrete，在线数据格式，如 SOAP。服务 元素包含一个或多个 端口 元素，它们定义实施服务的端点。

1.2. WSDL 元素

WSDL 文档由以下元素组成：

定义 - WSDL 文档的根元素。此元素的属性指定 WSDL 文档的名称、文档的目标命名空间以及 WSDL 文档中引用的命名空间的简短定义。
类型 - 组成由服务使用消息的构建块的数据单元的 XML Schema 定义。有关定义数据类型的详情，请参考第 2 章 定义逻辑数据单位。
Message - 在调用服务操作期间交换的消息的描述。这些元素定义了组成您的服务的操作的参数。有关定义信息的详情，请参考第 3 章 定义服务使用的逻辑消息。
portType - 描述服务的逻辑接口 的操作 元素集合。有关定义端口类型的详情，请参考第 4 章 定义逻辑接口。
operation - 服务执行的操作描述。操作通过调用操作时在两个端点之间传递的消息来定义。有关定义操作的详情，请参考 “操作”一节。
binding - 端点的 concrete 数据格式规格。binding 元素定义抽象消息如何映射到端点使用的 concrete 数据格式。这个元素是指定参数顺序和返回值等具体位置。
服务 - 相关端口 元素 的集合。这些元素是用于组织端点定义的存储库。
端口 - 由绑定和物理地址定义的端点。这些元素将所有抽象定义集合在一起，结合传输详情的定义，并定义服务所公开的物理端点。

1.3. 设计一个合同

要为服务设计 WSDL 合同，您必须执行以下步骤：

定义服务使用的数据类型。
定义服务所使用的消息。
定义您的服务的接口。
定义各个接口使用的消息之间的绑定，以及线上数据的 concrete 表示。
定义每个服务的传输详细信息。

第 2 章定义逻辑数据单位

摘要

在 WSDL 合同中描述服务时，使用 XML Schema 将服务定义为逻辑单元。

2.1. 逻辑数据单元简介

在定义服务时，您必须考虑首先考虑将数据用作公开操作的参数。与使用固定数据结构的编程语言编写的应用程序不同，服务必须在逻辑单元中定义其数据，这些单元可由任意数量的应用程序使用。这涉及两个步骤：

将数据拆分为逻辑单元，它们可映射到服务物理实施使用的数据类型
将逻辑单元合并到端点之间传递的消息中以执行操作

本章讨论第一步。第 3 章 定义服务使用的逻辑消息 讨论第二步。

2.2. 将数据映射到逻辑数据单元

概述

用于实施服务的接口定义了代表操作参数的数据，作为 XML 文档。如果您要为已经实施的服务定义接口，您必须将实施操作的数据类型转换为可编译到消息的 XML 元素中。如果您从头开始，您必须确定构建您的消息的构建块，以便在实施角度有意义。

用于定义服务单元的可用类型

根据 WSDL 规范，您可以使用任意类型系统在 WSDL 合同中定义数据类型。但是，W3C 规范指出 XML Schema 是 WSDL 文档的首选规范类型系统。因此，XML Schema 是 Apache CXF 中的内部类型系统。

XML Schema 作为类型系统

XML Schema 用于定义 XML 文档的结构。这可以通过定义组成文档的元素来完成。这些元素可以使用原生 XML Schema 类型，如 xsd:int，也可以使用用户定义的类型。用户定义的类型使用 XML 元素的组合构建，或者通过限制现有类型来定义。通过组合类型定义和元素定义，您可以创建包含复杂数据的指示 XML 文档。

在 WSDL XML Schema 中使用时，定义包含用于与服务交互数据的 XML 文档的结构。在定义服务使用的数据单元时，您可以将它们定义为指定消息部分结构的类型。您还可以将数据单元定义为组成消息部分的元素。

创建数据单元的注意事项

您可能只考虑创建在实施服务时直接映射到您部门类型的逻辑数据单元。虽然这种方法有效，并且密切遵循构建 RPC 风格应用程序的模型，但并非构建面向服务的架构的理想选择。

Web 服务互操作性组织的 WS-I 基本配置集提供了多个定义数据单元的准则，可通过 http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html#WSDLTYPES 访问。另外，W3C 还提供了以下使用 XML Schema 来代表 WSDL 文档中的数据类型的准则：

使用元素，而不是属性。
不要使用特定于协议的类型作为基本类型。

2.3. 在合同中添加数据单元

概述

根据您选择创建 WSDL 合同的方式，创建新的数据定义需要不同的知识。Apache CXF GUI 工具为使用 XML Schema 描述数据类型提供了多个帮助。其他 XML 编辑器可提供不同级别的帮助。无论您选择哪种编辑器，都最好了解所生成合同应看的内容。

流程

定义 WSDL 合同中使用的数据涉及以下步骤：

确定合同描述的接口中使用的所有数据单元。
在您的合同中创建 类型 元素。
创建一个 架构 元素，如例 2.1 “WSDL 合同的 schema 条目” 所示，作为 type 元素的子项。
targetNamespace 属性指定定义新数据类型的命名空间。最佳实践是定义提供目标命名空间访问权限的命名空间。剩余的条目不应更改。
例 2.1. WSDL 合同的 schema 条目
```
<schema targetNamespace="http://schemas.iona.com/bank.idl"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:xsd1="http://schemas.iona.com/bank.idl"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
```
对于作为元素集合的每个复杂类型，使用 complexType 元素定义数据类型。请参阅第 2.5.1 节 “定义数据结构”。
对于每个数组，使用 complexType 元素定义数据类型。请参阅第 2.5.2 节 “定义数组”。
对于从简单类型派生的每一复杂类型，使用 simpleType 元素定义数据类型。请参阅第 2.5.4 节 “根据限制定义类型”。
对于每个枚举类型，请使用 simpleType 元素定义数据类型。请参阅第 2.5.5 节 “定义枚举类型”。
对于每个元素，使用 元素 来定义它。请参阅第 2.6 节 “定义元素”。

2.4. XML Schema 简单的类型

概述

如果消息部分是简单类型，则不需要为其创建类型定义。但是，合同中定义的接口所使用的复杂类型是使用简单类型来定义的。

输入简单类型

XML Schema 简单的类型主要放在您的合同类型部分中使用的元素中。它们也用于限制元素和扩展 元素 的基本 属性。

始终使用 xsd 前缀输入简单的类型。例如，要指定元素类型是 int，您需要在其 type 属性中输入 xsd:int，如例 2.2 “使用简单类型定义元素” 所示。

例 2.2. 使用简单类型定义元素

<element name="simpleInt" type="xsd:int" />

支持的 XSD 简单类型

Apache CXF 支持以下 XML Schema 简单类型：

xsd:string
xsd:normalizedString
xsd:int
xsd:unsignedInt
xsd:long
xsd:unsignedLong
xsd:short
xsd:unsignedShort
xsd:float
xsd:double
xsd:boolean
xsd:byte
xsd:unsignedByte
xsd:integer
xsd:positiveInteger
xsd:negativeInteger
xsd:nonPositiveInteger
xsd:nonNegativeInteger
xsd:decimal
xsd:dateTime
xsd:time
xsd:date
xsd:QName
xsd:base64Binary
xsd:hexBinary
xsd:ID
xsd:token
xsd:language
xsd:Name
xsd:NCName
xsd:NMTOKEN
xsd:anySimpleType
xsd:anyURI
xsd:gYear
xsd:gMonth
xsd:gDay
xsd:gYearMonth
xsd:gMonthDay

2.5. 定义复杂数据类型

摘要

XML Schema 提供了一种灵活、强大的机制，用于从其简单数据类型构建复杂数据结构。您可以通过创建一系列元素和属性来创建数据结构。您还可以扩展定义的类型，以创建更复杂的类型。

除了构建复杂数据结构外，您还可以描述专用类型，如枚举类型、具有特定值的数据类型或需要遵循特定模式的数据类型，通过扩展或限制原语类型。

2.5.1. 定义数据结构

概述

在 XML Schema 中，是数据字段集合的数据集使用 复杂的Type 元素进行定义。指定复杂类型需要三段信息：

定义的类型的名称在 complexType 元素的 name 属性中指定。
complexType 的第一个子元素描述结构字段在线上时的行为。请参阅 “复杂类型 varieties”一节。
定义的结构的每个字段都在 复杂Type 元素中的元素中定义。请参阅 “定义结构的部分”一节。

例如：例 2.3 “简单结构” 中显示的结构在 XML Schema 中定义为带有两个元素的复杂类型。

例 2.3. 简单结构

struct personalInfo
{
  string name;
  int age;
};

例 2.4 “复杂类型” 显示例 2.3 “简单结构” 中显示的结构的一个可能 XML Schema 映射，例 2.4 “复杂类型” 中定义的结构会生成包括两个元素： name 和 age 的消息。

例 2.4. 复杂类型

<complexType name="personalInfo">
  <sequence>
    <element name="name" type="xsd:string" />
    <element name="age" type="xsd:int" />
  </sequence>
</complexType>

复杂类型 varieties

XML Schema 有三种方法：描述复杂类型的字段在以 XML 文档表示并传递线时如何组织。complexType 元素的第一个子元素决定了使用哪一种复杂类型。表 2.1 “复杂的类型描述符元素” 显示用来定义复杂类型行为的元素。

表 2.1. 复杂的类型描述符元素
element	复杂的类型行为
`sequence`	所有复杂的类型字段都可以存在，它们必须按照类型定义中指定的顺序。
`all`	所有复杂的类型字段都可以存在，但可以按照任何顺序排列。
`choice`	结构中只有一个元素可以放在消息中。

如果结构是使用 选择 元素定义的，如例 2.5 “简单复杂的选择类型” 所示，它会生成具有 name 元素或 age 元素的消息。

例 2.5. 简单复杂的选择类型

<complexType name="personalInfo">
  <choice>
    <element name="name" type="xsd:string"/>
    <element name="age" type="xsd:int"/>
  </choice>
</complexType>

定义结构的部分

您可以使用 元素 定义组成结构的数据字段。每个 complexType 元素都应该包含至少一个 元素。complexType 元素 中的每个元素都表示定义的数据结构中的一个字段。

要完全描述数据结构中的字段，元素 元素有两个必要属性：

name 属性指定 data 字段的名称，它必须在定义的复杂类型内唯一。
type 属性指定字段中存储的数据类型。类型可以是 XML Schema 的简单类型之一，也可以是合同中定义的任何指定复杂类型。

除了名称和类型外，元素 还有两个常用的可选属性： minOcurrs 和 maxOccurs。这些属性根据字段在结构中发生的次数绑定。默认情况下，每个字段仅在复杂类型中仅发生一次。通过使用这些属性，您可以更改字段必须或可在结构中出现的次数。例如，您可以定义一个字段( 之前Jobs )，它必须至少发生三次，且不超过七次，如例 2.6 “使用出现约束的简单复杂类型” 所示。

例 2.6. 使用出现约束的简单复杂类型

<complexType name="personalInfo">
  <all>
    <element name="name" type="xsd:string"/>
    <element name="age" type="xsd:int"/>
    <element name="previousJobs" type="xsd:string:
             minOccurs="3" maxOccurs="7"/>
  </all>
</complexType>

您还可以通过将 minOccurs 设置为零（如例 2.7 “带有 minOccurs 设置为 0 的简单复杂类型” 所示），使用 minOccurs 使 age 字段是可选的。在这种情况下，年龄 可以被省略，数据仍将有效。

例 2.7. 带有 minOccurs 设置为 0 的简单复杂类型

<complexType name="personalInfo">
  <choice>
    <element name="name" type="xsd:string"/>
    <element name="age" type="xsd:int" minOccurs="0"/>
  </choice>
</complexType>

定义属性

在 XML 文档中，属性包含在元素的标签中。例如，在下面的代码中的 complexType 元素中，name 是一个属性。要为复杂类型指定属性，您可以在 complexType 元素定义中定义 属性 元素。属性 元素只能在 所有、sequence 或 choice 元素后面出现。为每个复杂类型的属性指定一个 属性 元素。任何 属性 元素都必须是 complexType 元素的直接子项。

例 2.8. 带有属性的复杂类型

<complexType name="personalInfo">
  <all>
    <element name="name" type="xsd:string"/>
    <element name="previousJobs" type="xsd:string"
             minOccurs="3" maxOccurs="7"/>
  </all>
  <attribute name="age" type="xsd:int" use="required" />
</complexType>

在前面的代码中，属性 元素指定 personalInfo 复杂类型具有 age 属性。属性 元素具有这些属性：

Name - 指定 标识属性的字符串的必需属性。
type - 指定字段中存储的数据类型。类型可以是 XML Schema 简单类型之一。
使用 - 指定一个可选属性，用于指定是否需要复杂的类型来具有此属性。有效值 是必需的 或 可选。默认值是属性是可选的。

在 属性 元素中，您可以指定可选 默认 属性，这可让您为属性指定默认值。

2.5.2. 定义数组

概述

Apache CXF 支持两种方法来定义合同中的数组。第一种类型使用单个元素定义复杂类型，其 maxOccurs 属性的值大于一。第二种方法是使用 SOAP 阵列。SOAP 阵列提供添加的功能，例如可轻松定义多维数组和传输稀疏填充阵列。

复杂的类型数组

复杂的类型数组是一系列复杂类型的特殊情况。您只需通过单个元素定义复杂类型，并为 maxOccurs 属性指定一个值。例如：要定义一组二十个浮动点号，您可以使用类似例 2.9 “复杂类型数组” 中显示的复杂类型。

例 2.9. 复杂类型数组

<complexType name="personalInfo">
  <element name="averages" type="xsd:float" maxOccurs="20"/>
</complexType>

您还可以为 minOccurs 属性指定一个值。

SOAP 阵列

SOAP 阵列通过利用 wsdl:arrayType 元素从 SOAP-ENC:Array 基础类型分离来定义。其语法显示在例 2.10 “使用 wsdl:arrayType 进行 SOAP 数组派生的语法” 中。确保 定义 元素声明 xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"。

例 2.10. 使用 wsdl:arrayType 进行 SOAP 数组派生的语法

<complexType name="TypeName">
  <complexContent>
    <restriction base="SOAP-ENC:Array">
      <attribute ref="SOAP-ENC:arrayType"
                 wsdl:arrayType="ElementType<ArrayBounds>"/>
    </restriction>
  </complexContent>
</complexType>

使用这个语法，TypeName 指定新定义的数组类型的名称。ElementType 指定阵列中的元素类型。ArrayBounds 指定阵列中的维度数。要指定单一维度数组，请使用 []; 指定双维数组，使用 [][] 或 [,]。

例如，SOAP Array、SOAPStrings （如例 2.11 “SOAP 阵列的定义” 所示）定义了一维字符串数组。wsdl:arrayType 属性指定数组元素的类型、xsd:string 和 dissions 的数量，带有 [] 意味着一个维度。

例 2.11. SOAP 阵列的定义

<complexType name="SOAPStrings">
  <complexContent>
    <restriction base="SOAP-ENC:Array">
      <attribute ref="SOAP-ENC:arrayType"
                 wsdl:arrayType="xsd:string[]"/>
    </restriction>
  </complexContent>
</complexType>

您还可以使用一个简单的元素描述 SOAP Array，如 SOAP 1.1 规格中所述。其语法显示在例 2.12 “使用元素来派生 SOAP 阵列的语法” 中。

例 2.12. 使用元素来派生 SOAP 阵列的语法

<complexType name="TypeName">
  <complexContent>
    <restriction base="SOAP-ENC:Array">
      <sequence>
        <element name="ElementName" type="ElementType"
                 maxOccurs="unbounded"/>
      </sequence>
    </restriction>
  </complexContent>
</complexType>

使用这种语法时，元素的 maxOccurs 属性必须始终设置为 未绑定。

2.5.3. 按扩展定义类型

与大多数主要编码语言一样，XML Schema 允许您创建数据类型，从其他数据类型继承其部分元素。这称为扩展来定义类型。例如，您可以创建一个名为 alienInfo 的新类型，通过添加名为 planet 的新元素来扩展例 2.4 “复杂类型” 中定义的 personalInfo 结构。

由扩展定义的类型有四个部分：

类型的名称由 complexType 元素的 name 属性定义。
complexContent 元素指定新类型将拥有多个元素。
注意
如果您只向复杂类型添加新属性，您可以使用 simpleContent 元素。
新类型派生的类型（称为基本类型）是在 extension 元素的 base 属性中指定。
新的类型的元素和属性在 extension 元素中定义，它们与常规复杂类型相同。

例如，alienInfo 定义为例 2.13 “按扩展定义的类型” 所示。

例 2.13. 按扩展定义的类型

<complexType name="alienInfo">
  <complexContent>
    <extension base="xsd1:personalInfo">
      <sequence>
        <element name="planet" type="xsd:string"/>
      </sequence>
    </extension>
  </complexContent>
</complexType>

2.5.4. 根据限制定义类型

概述

XML Schema 允许您通过限制 XML Schema 简单类型可能的值来创建新类型。例如，您可以定义一个简单的类型 SSN，字符串为正好 9 个字符。通过限制使用 simpleType 元素来定义简单类型的新类型。

按限制划分的定义需要三个因素：

新类型的名称由 simpleType 元素的 name 属性指定。
新类型派生自的简单类型（称为 基本类型 ）是在 limit 元素中指定。请参阅 “指定基本类型”一节。
名为 facets 的规则，定义基本类型的限制被定义为 限制 元素的子项。请参阅 “定义限制”一节。

指定基本类型

基础类型是被限制在定义新类型中的类型。它使用 限制 元素来指定。limit 元素是 simpleType 元素的唯一子项，它有一个属性 base，用于指定基本类型。基础类型可以是任何 XML Schema 简单的类型。

例如，若要通过限制 xsd:int 的值来定义一个新类型，您可以使用类似例 2.14 “使用 int 作为基本类型” 所示的定义。

例 2.14. 使用 int 作为基本类型

<simpleType name="restrictedInt">
  <restriction base="xsd:int">
    ...
  </restriction>
</simpleType>

定义限制

定义对基本类型的限制的规则被称为 facets。facets 是带有一个属性( 值 )的元素，用于定义 facet 的强制实施方式。可用因素及其 有效值 设置取决于基本类型。例如，xsd:string 支持六个问题，包括：

length
minLength
maxLength
pattern
whitespace
enumeration

每个 facet 元素都是 限制 元素的子项。

示例

例 2.15 “SSN 简单的类型描述” 显示 SSN 的简单类型示例，它代表一个社交安全编号。生成的类型是 xxx-xx-xxxx 的格式字符串。<SSN>032-43-9876<SSN> 是此类型的元素的有效值，但 <SSN>032439876</SSN> 不是。

例 2.15. SSN 简单的类型描述

<simpleType name="SSN">
  <restriction base="xsd:string">
    <pattern value="\d{3}-\d{2}-\d{4}"/>
  </restriction>
</simpleType>

2.5.5. 定义枚举类型

概述

XML Schema 中枚举的类型是一个根据限制定义的特殊情形。它们通过使用枚举的 枚举来说明，它受所有 XML Schema 原语类型的支持。与大多数现代编程语言中枚举类型一样，此类型的变量只能具有一个指定的值。

在 XML Schema 中定义枚举

例 2.16 “枚举的语法” 中显示了用于定义枚举的语法。

例 2.16. 枚举的语法

<simpleType name="EnumName">
  <restriction base="EnumType">
    <enumeration value="Case1Value"/>
    <enumeration value="Case2Value"/>
    ...
    <enumeration value="CaseNValue"/>
  </restriction>
</simpleType>

EnumName 指定枚举类型的名称。EnumType 指定问题单值的类型。CaseNValue，其中 N 是任意数字一或大于值，指定枚举每个具体案例的值。枚举的类型可以具有任意数量的 case 值，但它源自一个简单类型，因此一次只有其中一个问题单值才有效。

示例

例如，如果一个含有 < widgetSize >big</widgetSize>big</widgetSize>，则由 enumeration widgetSize> 定义元素的 XML 文档在例 2.17 “widgetSize enumeration” 中包含 <widgetSize> 时才有效。

例 2.17. widgetSize enumeration

<simpleType name="widgetSize">
  <restriction base="xsd:string">
    <enumeration value="big"/>
    <enumeration value="large"/>
    <enumeration value="mungo"/>
  </restriction>
</simpleType>

2.6. 定义元素

XML Schema 中的元素代表从架构生成的 XML 文档中的元素实例。最基本的 元素由单一元素组成。与定义复杂类型的成员的 element 元素一样，它们有三个属性：

name - 一个必需属性，用于指定在 XML 文档中出现的元素名称。
type - 指定元素的类型。类型可以是任何 XML Schema 原语类型，也可以是合同中定义的任何指定复杂类型。如果类型包含 in-line 定义，则可以省略此属性。
nillable - 指定一个元素是否可以完全省略。如果将 nillable 设为 true，则这个元素可以从使用 schema 生成的任何文档中省略。

元素也可以 具有在线 类型定义。使用 complexType 元素或 simpleType 元素来指定在线类型。指定数据类型是否比较复杂或简单后，您可以使用每种数据类型可用的工具定义任何类型的数据。不建议使用 in-line 类型的定义，因为无法重复使用。

第 3 章定义服务使用的逻辑消息

摘要

服务由消息在调用其操作时进行交换定义。在 WSDL 合同中，这些消息通过使用 消息 元素来定义。这些消息由一个或多个使用 部分 元素定义的部分组成。

概述

服务的操作是通过指定调用操作时交换的逻辑消息来定义。这些逻辑消息定义通过网络作为 XML 文档传递的数据。它们包含属于方法调用一部分的所有参数。使用合同中的 message 元素定义逻辑消息。每个逻辑消息由一个或多个部分组成，它们在 部分 元素中定义。

虽然您的消息可以列出各个参数作为单独的部分，但推荐的做法是只使用单个部分来封装操作所需的数据。

消息和参数列表

服务公开的每个操作只能有一个输入消息和一个输出信息。输入消息定义服务在调用操作时接收的所有信息。输出消息定义在操作完成时返回的所有数据。容错消息定义在发生错误时服务返回的数据。

此外，每个操作都可以具有任意数量的故障消息。故障消息定义服务遇到错误时返回的数据。这些消息通常仅有一个部分提供足够的信息供消费者理解该错误。

用于与旧系统集成的消息设计

如果您要将现有应用程序定义为服务，您必须确保实施该操作方法使用的每个参数都会在消息中表示。您还必须确保返回的值包含在操作的输出消息中。

定义消息的一种方法是 RPC 样式。使用 RPC 风格时，您可以在方法的参数列表中为每个参数定义一个部分。每条消息部分都基于合同元素中定义的 类型。您的输入消息包含方法中每个输入参数的一个部分。您的输出消息包含每个输出参数的一个部分，以及用于表示返回值的部分（如果需要）。如果参数同时是输入和输出参数，它将被列为输入消息和输出消息的一部分。

当服务启用使用 Tibco 或 CORBA 等传输的系统时，RPC 风格消息定义很有用。这些系统围绕流程和方法设计。因此，它们最容易使用类似参数列表的消息来建模。RPC 风格还在服务与应用程序间进行清晰映射。

SOAP 服务的消息设计

尽管 RPC 风格对于对现有系统建模非常有用，但该服务的社区很强大地选择被嵌套的文档样式。在嵌套文档样式中，每个消息都有单个部分。消息的部分引用在合同 类型 的元素中定义的 wrapper 元素。wrapper 元素具有以下特征：

它是包含一系列元素的复杂类型。更多信息请参阅第 2.5 节 “定义复杂数据类型”。
如果它是输入消息的打包程序：
- 它有一个元素，用于各个方法的输入参数。
- 其名称与与之关联的操作的名称相同。
如果它是一个输出消息的打包程序：
- 它为每个方法的输出参数和一个元素，每个方法的 inout 参数都有一个元素。
- 其第一个元素表示方法的 return 参数。
- 其名称是通过在与打包程序关联的操作名称中添加 Response 来生成的。

消息命名

合同中的每个消息都必须在其命名空间内具有唯一的名称。建议您使用以下命名规则：

消息仅应由单个操作使用。
将 Request 附加到操作名称即可形成输入消息名称。
通过将 Response 附加到操作名称来形成输出信息名称。
容错消息名称应该代表故障的原因。

Message parts

Message 部分是逻辑消息的正式数据单元。每一部分使用 part 元素进行定义，由 name 属性和 type 属性识别，或者指定其数据类型的元素属性。数据类型属性列在表 3.1 “部分数据类型属性” 中。

表 3.1. 部分数据类型属性
属性	描述
`element`="elem_name"	部分的数据类型由名为 elem_name 的元素定义。
`type=`"type_name"	部分的数据类型由名为 type_name 的类型定义。

消息可以重复使用部分名称。例如，如果方法有一个参数 foo，它通过引用传递，或者是 in/out，它可以是请求消息和响应消息的一部分，如例 3.1 “重复使用部分” 所示。

例 3.1. 重复使用部分

<message name="fooRequest">
  <part name="foo" type="xsd:int"/>
<message>
<message name="fooReply">
  <part name="foo" type="xsd:int"/>
<message>

示例

例如，假设您有一个存储个人信息的服务器，并提供了一种根据员工的 ID 号返回员工数据的方法。查找数据的方法签名与例 3.2 “personalInfo 查找方法” 类似。

例 3.2. personalInfo 查找方法

personalInfo lookup(long empId)

这个方法签名可以映射到例 3.3 “RPC WSDL 消息定义” 中显示的 RPC 风格的 WSDL 片段。

例 3.3. RPC WSDL 消息定义

<message name="personalLookupRequest">
  <part name="empId" type="xsd:int"/>
<message/>
<message name="personalLookupResponse>
  <part name="return" element="xsd1:personalInfo"/>
<message/>

它还可映射到例 3.4 “嵌套的文档 WSDL 消息定义” 中显示的嵌套式文档风格的 WSDL 片段。

例 3.4. 嵌套的文档 WSDL 消息定义

<wsdl:types>
  <xsd:schema ... >
  ...
  <element name="personalLookup">
    <complexType>
      <sequence>
        <element name="empID" type="xsd:int" />
      </sequence>
    </complexType>
  </element>
  <element name="personalLookupResponse">
    <complexType>
      <sequence>
        <element name="return" type="personalInfo" />
      </sequence>
    </complexType>
  </element>
  </schema>
</types>
<wsdl:message name="personalLookupRequest">
  <wsdl:part name="empId" element="xsd1:personalLookup"/>
<message/>
<wsdl:message name="personalLookupResponse">
  <wsdl:part name="return" element="xsd1:personalLookupResponse"/>
<message/>

第 4 章定义逻辑接口

摘要

逻辑服务接口使用 portType 元素来定义。

概述

逻辑服务接口使用 WSDL portType 元素来定义。portType 元素是抽象操作定义的集合。每一操作由用于完成操作所代表的事务的输入、输出和错误消息定义。当生成代码来实施 portType 元素定义的服务接口时，每个操作都会转换为一个方法，其中包含由输入、输出和合同中指定的参数定义的参数。

Process

要在 WSDL 合同中定义逻辑接口，您必须执行以下操作：

创建一个 portType 元素以包含接口定义，并为它指定唯一名称。请参阅 “端口类型”一节。
为接口中定义的每个操作创建一个操作元素。请参阅 “操作”一节。
对于每个操作，指定用于表示操作参数列表、返回类型和例外的消息。请参阅 “操作消息”一节。

端口类型

WSDL portType 元素是逻辑接口定义中的根元素。虽然许多 Web 服务实现将 portType 元素直接映射到生成实现对象，但逻辑接口定义并不指定由实施的服务提供的确切功能。例如，名为 ticketSystem 的逻辑接口可导致销售问题单或问题清除票据实现。

portType 元素是 WSDL 文档的单元，它映射到一个绑定，用于定义由端点公开定义的服务使用的物理数据。

WSDL 文档中的每个 portType 元素都必须具有唯一的名称，该名称使用 name 属性指定，由一组操作组成，它们在 操作 元素中描述。WSDL 文档可以描述任意数量的端口类型。

操作

使用 WSDL 操作元素定义的逻辑 操作，定义两个端点之间的交互。例如，对检查帐户平衡的请求和跨小部件的顺序可以定义为操作。

portType 元素中定义的每个操作都必须使用 name 属性指定的唯一名称。定义操作需要 name 属性。

操作消息

逻辑操作由一组元素组成，它们代表端点之间传递的逻辑消息来执行操作。可以描述操作的元素列在表 4.1 “操作消息元素” 中。

表 4.1. 操作消息元素
element	描述
`输入`	指定在发出请求时客户端端点发送到服务提供商的消息。此消息的部分对应于操作的输入参数。
`output`	指定服务供应商发送到客户端端点的消息以响应请求。此消息的部分对应于任何可由服务提供商更改的操作参数，如引用传递的值。这包括操作返回值。
`fault`	指定用于在端点之间传递错误条件的消息。

要至少有一个 输入 或一个 输出 元素，需要一个操作。操作可以同时具有 输入和输出 元素，但它只能有一个。不需要操作来有任何错误元素，但可以根据需要具有任意数量的 故障 元素。

元素在表 4.2 “输入和输出元素的属性” 中列出的有两个属性。

表 4.2. 输入和输出元素的属性
属性	描述
`name`	标识消息，以便在将操作映射到 concrete 数据格式时对其进行引用。名称必须在封闭的端口类型内唯一。
`message`	指定描述正在发送或接收数据的抽象消息。`message` 属性的值必须与 WSDL 文档中定义的其中一个抽象消息的 `name` 属性对应。

不需要为所有 输入和输出 元素指定 name 属性；WSDL 提供了一个基于嵌套操作名称的默认命名方案。如果操作中只有一个元素，则元素名称默认为操作的名称。如果使用 输入和输出 元素，则元素名称默认为操作的名称，并且分别附加了 Request 或 Response。

返回值

因为 operation 元素是在操作过程中传递的数据抽象定义，所以 WSDL 不提供为操作指定的返回值。如果方法返回了一个值，它将映射到 output 元素，作为该消息的最后一个部分。

示例

例如，您可能有一个与例 4.1 “personalInfo lookup interface” 中显示的接口类似的接口。

例 4.1. personalInfo lookup interface

interface personalInfoLookup
{
  personalInfo lookup(in int empID)
  raises(idNotFound);
}

这个接口可以映射到例 4.2 “personalInfo 查找端口类型” 中的端口类型。

例 4.2. personalInfo 查找端口类型

<message name="personalLookupRequest">
  <part name="empId" element="xsd1:personalLookup"/>
<message/>
<message name="personalLookupResponse">
  <part name="return" element="xsd1:personalLookupResponse"/>
<message/>
<message name="idNotFoundException">
  <part name="exception" element="xsd1:idNotFound"/>
<message/>
<portType name="personalInfoLookup">
  <operation name="lookup">
    <input name="empID" message="tns:personalLookupRequest"/>
    <output name="return" message="tns:personalLookupResponse"/>
    <fault name="exception" message="tns:idNotFoundException"/>
  </operation>
</portType>

部分 II. Web 服务绑定

这部分论述了如何将 Apache CXF 绑定添加到 WSDL 文档。

第 5 章了解 WSDL 中的绑定

摘要

绑定将用于定义服务的逻辑消息映射到端点可以传输和接收的有效载荷格式。

概述

绑定为服务使用的逻辑消息提供网桥，用于隔离端点在物理世界中使用的数据格式。它们描述了逻辑消息如何映射到端点线上所用载荷格式。它在绑定中指定了参数顺序、concrete 数据类型和返回值。例如，消息的部分可以在绑定中重新排序，以反映 RPC 调用所需的顺序。根据绑定类型，您还可以识别消息部分（若有）代表方法的返回类型。

端口类型和绑定

端口类型和绑定直接相关。端口类型是两个逻辑服务之间一组交互的抽象定义。绑定是实施逻辑服务将如何在物理世界实例化的用于实施逻辑服务的消息的结盟定义。然后，每个绑定都与一组网络详细信息关联，以完成一个端点的定义，该端点公开了端口类型定义的逻辑服务。

为确保端点仅定义了单个服务，WSDL 要求绑定只能表示单个端口类型。例如，如果您有一个具有两个端口类型的合同，则无法写入将这两个映射为共用数据格式的单个绑定。您需要两个绑定。

但是，WSDL 允许将端口类型映射到多个绑定。例如，如果您的合同具有单一端口类型，您可以将其映射到两个或者多个绑定。每个绑定都可以改变消息的部分映射方式，也可以为消息指定完全不同的有效负载格式。

WSDL 元素

使用 WSDL 绑定元素在合同中定义绑定。绑定元素由 名称 等属性组成，用于指定提供 PortType 引用的绑定和 类型 的唯一名称。此属性的值用于将绑定与端点关联，如第 4 章 定义逻辑接口 中所述。

实际映射在 绑定 元素的子项中定义。这些元素根据您决定使用的有效负载格式类型而有所不同。以下章节中讨论不同的有效载荷格式以及用于指定其映射的元素。

添加到合同

Apache CXF 提供命令行工具，可以生成预定义服务接口的绑定。

这些工具将为您的合同添加正确的元素。但是，建议您了解不同类型的绑定如何工作。

您还可以使用任何文本编辑器向合同添加绑定。手动编辑合同时，您需要确保合同有效。

支持的绑定

Apache CXF 支持以下绑定：

SOAP 1.1
SOAP 1.2
CORBA
Pure XML

第 6 章使用 SOAP 1.1 消息

摘要

Apache CXF 提供了一个工具来生成 SOAP 1.1 绑定，该绑定不使用任何 SOAP 标头。但是，您可以使用任何文本或 XML 编辑器将 SOAP 标头添加到绑定中。

6.1. 添加 SOAP 1.1 绑定

使用 wsdl2soap

要使用 wsdl2soap 命令生成 SOAP 1.1 绑定：ws dl2soap-iport-type-name-bbinding-name-doutput-directory-ooutput-file-nsoap-body-namespace-style (document/rpc)-use (literal/encoded)-v-verbose-quietwsdlurl

注意

要使用 wsdl2soap，您需要下载 Apache CXF 分发。

该命令有以下选项：

选项	解释
`-i` port-type-name	指定生成绑定的 `portType` 元素。
wsdlurl	包含 `portType` 元素定义的 WSDL 文件的路径和名称。

该工具具有以下可选参数：

选项	解释
`-b` binding-name	指定生成的 SOAP 绑定的名称。
`-d` output-directory	指定要放置所生成的 WSDL 文件的目录。
`-o` output-file	指定生成的 WSDL 文件的名称。
`-n` soap-body-namespace	当样式为 RPC 时，指定 SOAP 正文命名空间。
`-style` (document/rpc)	指定 SOAP 绑定中使用的编码风格（文档或 RPC）。默认为 document。
`-use` (literal/encoded)	指定 SOAP 绑定中使用的绑定使用（编码或文字）。默认值为字面值。
`-v`	显示工具的版本号。
`-verbose`	在代码生成过程中显示注释。
`-quiet`	在代码生成过程中阻止注释。

需要 -iport-type-name 和 wsdlurl 参数。如果指定了 -style rpc 参数，则还需要 -nsoap-body-namspace 参数。所有其他参数都是可选的，可以按任何顺序列出。

重要

wsdl2soap 不支持生成 文档/编码的 SOAP 绑定。

示例

如果您的系统有一个处理订单的接口，并提供单一操作来处理在 WSDL 片段中定义的订单，类似于例 6.1 “排序系统接口” 中显示的订单。

例 6.1. 排序系统接口

<?xml version="1.0" encoding="UTF-8"?>
<definitions name="widgetOrderForm.wsdl"
    targetNamespace="http://widgetVendor.com/widgetOrderForm"
    xmlns="http://schemas.xmlsoap.org/wsdl/"
    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
    xmlns:tns="http://widgetVendor.com/widgetOrderForm"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsd1="http://widgetVendor.com/types/widgetTypes"
    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">

<message name="widgetOrder">
  <part name="numOrdered" type="xsd:int"/>
</message>
<message name="widgetOrderBill">
  <part name="price" type="xsd:float"/>
</message>
<message name="badSize">
  <part name="numInventory" type="xsd:int"/>
</message>

<portType name="orderWidgets">
  <operation name="placeWidgetOrder">
    <input message="tns:widgetOrder" name="order"/>
    <output message="tns:widgetOrderBill" name="bill"/>
    <fault message="tns:badSize" name="sizeFault"/>
  </operation>
</portType>
...
</definitions>

为 orderWidget 生成的 SOAP 绑定显示在例 6.2 “orderWidgets的 SOAP 1.1 绑定” 中。

例 6.2. orderWidgets的 SOAP 1.1 绑定

<binding name="orderWidgetsBinding" type="tns:orderWidgets">
  <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="placeWidgetOrder">
      <soap:operation soapAction="" style="document"/>
      <input name="order">
        <soap:body use="literal"/>
      </input>
      <output name="bill">
        <soap:body use="literal"/>
      </output>
      <fault name="sizeFault">
        <soap:body use="literal"/>
      </fault>
  </operation>
</binding>

此绑定指定消息使用 document/literal 消息样式发送。

6.2. 将 SOAP 标头添加到 SOAP 1.1 Binding 中

概述

SOAP 标头通过将 soap:header 元素添加到默认 SOAP 1.1 绑定来定义。soap:header 元素是 输入、输出 和绑定 错误 元素的可选子项。SOAP 标头成为父消息的一部分。通过指定消息和消息部分来定义 SOAP 标头。每个 SOAP 标头只能包含一个消息部分，但您可以根据需要插入所需数量的 SOAP 标头。

语法

定义 SOAP 标头的语法显示在例 6.3 “SOAP 标头语法” 中。soap:header 的 message 属性是要插入到标头中的部分的合格名称。part 属性是插入到 SOAP 标头中的消息部分的名称。由于 SOAP 标头始终是文档样式，因此必须使用元素来定义插入到 SOAP 标头中的 WSDL 消息部分。消息 和 部分 属性一起描述要插入到 SOAP 标头的数据。

例 6.3. SOAP 标头语法

<binding name="headwig">
  <soap:binding style="document"
                transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="weave">
      <soap:operation soapAction="" style="document"/>
      <input name="grain">
        <soap:body ... />
        <soap:header message="QName" part="partName"/>
      </input>
...
</binding>

以及强制 消息和 部分 属性，soap :header 也支持 命名空间、使用，以及 编码Style 属性。这些属性与 soap:header 的作用相同 。

在正文和标头间分割消息

插入到 SOAP 标头中的消息部分可以是来自合同的任何有效的消息部分。它甚至可以从父消息中用作 SOAP 正文的部分。由于不太可能在同一消息中发送信息两次，SOAP 绑定提供了指定插入到 SOAP 正文中的消息部分的方法。

soap:body 元素具有一个可选属性 部分，它用以空格分隔的部分名称列表。定义部分后，只有列出的消息部分才会插入到 SOAP 正文中。然后，您可以将剩余的部分插入到 SOAP 标头中。

注意

当使用父消息的部分定义 SOAP 标头时，Apache CXF 会自动填写 SOAP 标头。

示例

例 6.4 “带有 SOAP 标头的 SOAP 1.1 绑定” 显示例 6.1 “排序系统接口” 中显示的 orderWidgets 服务的修改版本。此版本已被修改，每个顺序都有一个 xsd:base64binary 值，放置在请求和响应的 SOAP 标头中。SOAP 标头定义为 widgetKey 消息中的 keyVal 部分。在本例中，您负责将 SOAP 标头添加到应用程序逻辑中，因为它不是输入或输出消息的一部分。

例 6.4. 带有 SOAP 标头的 SOAP 1.1 绑定

<?xml version="1.0" encoding="UTF-8"?>
<definitions name="widgetOrderForm.wsdl"
    targetNamespace="http://widgetVendor.com/widgetOrderForm"
    xmlns="http://schemas.xmlsoap.org/wsdl/"
    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
    xmlns:tns="http://widgetVendor.com/widgetOrderForm"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsd1="http://widgetVendor.com/types/widgetTypes"
    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">

<types>
  <schema targetNamespace="http://widgetVendor.com/types/widgetTypes"
           xmlns="http://www.w3.org/2001/XMLSchema"
           xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
    <element name="keyElem" type="xsd:base64Binary"/>
  </schema>
</types>

<message name="widgetOrder">
  <part name="numOrdered" type="xsd:int"/>
</message>
<message name="widgetOrderBill">
  <part name="price" type="xsd:float"/>
</message>
<message name="badSize">
  <part name="numInventory" type="xsd:int"/>
</message>
<message name="widgetKey">
  <part name="keyVal" element="xsd1:keyElem"/>
</message>

<portType name="orderWidgets">
  <operation name="placeWidgetOrder">
    <input message="tns:widgetOrder" name="order"/>
    <output message="tns:widgetOrderBill" name="bill"/>
    <fault message="tns:badSize" name="sizeFault"/>
  </operation>
</portType>

<binding name="orderWidgetsBinding" type="tns:orderWidgets">
  <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="placeWidgetOrder">
      <soap:operation soapAction="" style="document"/>
      <input name="order">
        <soap:body use="literal"/>
        <soap:header message="tns:widgetKey" part="keyVal"/>
      </input>
      <output name="bill">
        <soap:body use="literal"/>
        <soap:header message="tns:widgetKey" part="keyVal"/>
      </output>
      <fault name="sizeFault">
        <soap:body use="literal"/>
      </fault>
  </operation>
</binding>
...
</definitions>

您还可以修改例 6.4 “带有 SOAP 标头的 SOAP 1.1 绑定”，以便标头值是输入和输出信息的一部分。

第 7 章使用 SOAP 1.2 消息

摘要

Apache CXF 提供生成 SOAP 1.2 绑定的工具，该绑定不使用任何 SOAP 标头。您可以使用任何文本或 XML 编辑器将 SOAP 标头添加到绑定中。

7.1. 在 WSDL 文档中添加 SOAP 1.2 绑定

使用 wsdl2soap

注意

要使用 wsdl2soap，您需要下载 Apache CXF 分发。

要使用 wsdl2soap 命令生成 SOAP 1.2 绑定：ws dl2soap-iport-type-name-bbinding-name-soap12-doutput-directory-ooutput-file-nsoap-body-namespace-style (document/rpc)-use (literal/encoded)-name -b binding-quietwdl-quiet wdlurl 工具具有以下参数：

选项	解释
`-i` port-type-name	指定生成绑定的 `portType` 元素。
`-soap12`	指定生成的绑定使用 SOAP 1.2。
wsdlurl	包含 `portType` 元素定义的 WSDL 文件的路径和名称。

该工具具有以下可选参数：

选项	解释
`-b` binding-name	指定生成的 SOAP 绑定的名称。
`-soap12`	指定生成的绑定将使用 SOAP 1.2。
`-d` output-directory	指定要放置所生成的 WSDL 文件的目录。
`-o` output-file	指定生成的 WSDL 文件的名称。
`-n` soap-body-namespace	当样式为 RPC 时，指定 SOAP 正文命名空间。
`-style` (document/rpc)	指定 SOAP 绑定中使用的编码风格（文档或 RPC）。默认为 document。
`-use` (literal/encoded)	指定 SOAP 绑定中使用的绑定使用（编码或文字）。默认值为字面值。
`-v`	显示工具的版本号。
`-verbose`	在代码生成过程中显示注释。
`-quiet`	在代码生成过程中阻止注释。

需要 -i port-type-name 和 wsdlurl 参数。如果指定了 -style rpc 参数，则需要 -n soap-body-namspace 参数。所有其他参数都是可选的，可以按任何顺序列出。

重要

wsdl2soap 不支持生成 文档/编码的 SOAP 1.2 绑定。

示例

如果您的系统有一个处理订单的接口，并提供单一操作来处理在 WSDL 片段中定义的订单，类似于例 7.1 “排序系统接口” 中显示的订单。

例 7.1. 排序系统接口

<?xml version="1.0" encoding="UTF-8"?>
<definitions name="widgetOrderForm.wsdl"
    targetNamespace="http://widgetVendor.com/widgetOrderForm"
    xmlns="http://schemas.xmlsoap.org/wsdl/"
    xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
    xmlns:tns="http://widgetVendor.com/widgetOrderForm"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsd1="http://widgetVendor.com/types/widgetTypes"
    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">

<message name="widgetOrder">
  <part name="numOrdered" type="xsd:int"/>
</message>
<message name="widgetOrderBill">
  <part name="price" type="xsd:float"/>
</message>
<message name="badSize">
  <part name="numInventory" type="xsd:int"/>
</message>

<portType name="orderWidgets">
  <operation name="placeWidgetOrder">
    <input message="tns:widgetOrder" name="order"/>
    <output message="tns:widgetOrderBill" name="bill"/>
    <fault message="tns:badSize" name="sizeFault"/>
  </operation>
</portType>
...
</definitions>

为 orderWidget 生成的 SOAP 绑定显示在例 7.2 “orderWidgets 的 SOAP 1.2 绑定” 中。

例 7.2. orderWidgets 的 SOAP 1.2 绑定

<binding name="orderWidgetsBinding" type="tns:orderWidgets">
  <soap12:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="placeWidgetOrder">
      <soap12:operation soapAction="" style="document"/>
      <input name="order">
        <soap12:body use="literal"/>
      </input>
      <output name="bill">
        <wsoap12:body use="literal"/>
      </output>
      <fault name="sizeFault">
        <soap12:body use="literal"/>
      </fault>
  </operation>
</binding>

此绑定指定消息使用 document/literal 消息样式发送。

7.2. 在 SOAP 1.2 消息中添加标头

概述

SOAP 消息标头通过在 SOAP 1.2 消息中添加 soap12:header 元素来定义。soap12:header 元素是 输入、输出 和绑定 错误 元素的可选子项。SOAP 标头成为父消息的一部分。通过指定消息和消息部分来定义 SOAP 标头。每个 SOAP 标头只能包含一个消息部分，但您可以根据需要插入多个标头。

语法

定义 SOAP 标头的语法显示在例 7.3 “SOAP 标头语法” 中。

例 7.3. SOAP 标头语法

<binding name="headwig">
  <soap12:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="weave">
      <soap12:operation soapAction="" style="documment"/>
      <input name="grain">
        <soap12:body ... />
        <soap12:header message="QName" part="partName"
                       use="literal|encoded"
                        encodingStyle="encodingURI"
                        namespace="namespaceURI" />
      </input>
...
</binding>

soap12:header 元素的属性在表 7.1 “soap12:header Attributes” 中描述。

表 7.1. soap12:header Attributes
属性	描述
`message`	必需的属性，指定从中插入部分要放入标题中的相应消息的合格名称。
`part`	指定插入到 SOAP 标头中的消息部分的名称必需属性。
`use`	指定消息部分是否使用编码规则进行编码。如果设为 `编码`，则使用 `encodingStyle` 属性的值指定的编码规则对消息部分进行编码。如果设置为 `字面`，则消息部分由引用的模式类型定义。
`encodingStyle`	指定用于构建消息的编码规则。
`namespace`	定义 `使用="encoded"`，为标头元素 serialized 定义命名空间。

在正文和标头间分割消息

插入到 SOAP 标头中的消息部分可以是来自合同的任何有效的消息部分。它甚至可以从父消息中用作 SOAP 正文的部分。由于不太可能在同一消息中发送信息两次，SOAP 1.2 绑定提供了指定插入到 SOAP 正文中的消息部分的方法。

soap12:body 元素具有一个可选属性 部分，它用以空格分隔的部分名称列表。定义部分后，只有列出的消息部分才会插入到 SOAP 1.2 消息的正文中。然后，您可以将剩余的部分插入到消息的标头中。

注意

当使用父消息的部分定义 SOAP 标头时，Apache CXF 会自动填写 SOAP 标头。

示例

例 7.4 “带有 SOAP 标头的 SOAP 1.2 绑定” 显示例 7.1 “排序系统接口” 中显示的 orderWidgets 服务的修改版本。此版本会被修改，以便每个顺序在请求标题和响应的标头中都有一个 xsd:base64binary 值。标头定义为 widgetKey 消息中的 keyVal 部分。在本例中，您要负责添加应用程序逻辑以创建标头，因为它不是输入或输出消息的一部分。

例 7.4. 带有 SOAP 标头的 SOAP 1.2 绑定

<?xml version="1.0" encoding="UTF-8"?>
<definitions name="widgetOrderForm.wsdl"
    targetNamespace="http://widgetVendor.com/widgetOrderForm"
    xmlns="http://schemas.xmlsoap.org/wsdl/"
    xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
    xmlns:tns="http://widgetVendor.com/widgetOrderForm"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsd1="http://widgetVendor.com/types/widgetTypes"
    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">

<types>
  <schema targetNamespace="http://widgetVendor.com/types/widgetTypes"
           xmlns="http://www.w3.org/2001/XMLSchema"
           xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
    <element name="keyElem" type="xsd:base64Binary"/>
  </schema>
</types>

<message name="widgetOrder">
  <part name="numOrdered" type="xsd:int"/>
</message>
<message name="widgetOrderBill">
  <part name="price" type="xsd:float"/>
</message>
<message name="badSize">
  <part name="numInventory" type="xsd:int"/>
</message>
<message name="widgetKey">
  <part name="keyVal" element="xsd1:keyElem"/>
</message>

<portType name="orderWidgets">
  <operation name="placeWidgetOrder">
    <input message="tns:widgetOrder" name="order"/>
    <output message="tns:widgetOrderBill" name="bill"/>
    <fault message="tns:badSize" name="sizeFault"/>
  </operation>
</portType>

<binding name="orderWidgetsBinding" type="tns:orderWidgets">
  <soap12:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="placeWidgetOrder">
      <soap12:operation soapAction="" style="document"/>
      <input name="order">
        <soap12:body use="literal"/>
        <soap12:header message="tns:widgetKey" part="keyVal"/>
      </input>
      <output name="bill">
        <soap12:body use="literal"/>
        <soap12:header message="tns:widgetKey" part="keyVal"/>
      </output>
      <fault name="sizeFault">
        <soap12:body use="literal"/>
      </fault>
  </operation>
</binding>
...
</definitions>

您可以修改例 7.4 “带有 SOAP 标头的 SOAP 1.2 绑定”，以便标头值是输入和输出信息的一部分，如例 7.5 “带有 SOAP 标头的 orderWidget 的 SOAP 1.2 绑定” 所示。在本例中，keyVal 是输入和输出消息的一部分。在 soap12:body 元素中，parts 属性指定 键Val 不应插入到正文中。但是，它将插入到标头中。

例 7.5. 带有 SOAP 标头的 orderWidget 的 SOAP 1.2 绑定

<?xml version="1.0" encoding="UTF-8"?>
<definitions name="widgetOrderForm.wsdl"
    targetNamespace="http://widgetVendor.com/widgetOrderForm"
    xmlns="http://schemas.xmlsoap.org/wsdl/"
    xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
    xmlns:tns="http://widgetVendor.com/widgetOrderForm"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsd1="http://widgetVendor.com/types/widgetTypes"
    xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">

<types>
  <schema targetNamespace="http://widgetVendor.com/types/widgetTypes"
           xmlns="http://www.w3.org/2001/XMLSchema"
           xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
    <element name="keyElem" type="xsd:base64Binary"/>
  </schema>
</types>

<message name="widgetOrder">
  <part name="numOrdered" type="xsd:int"/>
  <part name="keyVal" element="xsd1:keyElem"/>
</message>
<message name="widgetOrderBill">
  <part name="price" type="xsd:float"/>
  <part name="keyVal" element="xsd1:keyElem"/>
</message>
<message name="badSize">
  <part name="numInventory" type="xsd:int"/>
</message>

<portType name="orderWidgets">
  <operation name="placeWidgetOrder">
    <input message="tns:widgetOrder" name="order"/>
    <output message="tns:widgetOrderBill" name="bill"/>
    <fault message="tns:badSize" name="sizeFault"/>
  </operation>
</portType>

<binding name="orderWidgetsBinding" type="tns:orderWidgets">
  <soap12:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="placeWidgetOrder">
      <soap12:operation soapAction="" style="document"/>
      <input name="order">
        <soap12:body use="literal" parts="numOrdered"/>
        <soap12:header message="tns:widgetOrder" part="keyVal"/>
      </input>
      <output name="bill">
        <soap12:body use="literal" parts="bill"/>
        <soap12:header message="tns:widgetOrderBill" part="keyVal"/>
      </output>
      <fault name="sizeFault">
        <soap12:body use="literal"/>
      </fault>
  </operation>
</binding>
...
</definitions>

第 8 章使用带有附件的 SOAP 发送 Binary 数据

摘要

SOAP 附加提供了一种将二进制数据作为 SOAP 消息的一部分发送的机制。使用带有附件的 SOAP 要求您将 SOAP 消息定义为 MIME 多部分消息。

概述

SOAP 消息通常不会执行二进制数据。但是，W3C SOAP 1.1 规范允许使用 MIME 多部件/相关消息在 SOAP 消息中发送二进制数据。使用 SOAP 与附加功能调用这一技术。SOAP 附加功能在 W3C 的 SOAP 消息中定义，该消息带有附件注释。

命名空间

用于定义 MIME 多部件/相关消息的 WSDL 扩展在命名空间 http://schemas.xmlsoap.org/wsdl/mime/ 中定义。

在下面的讨论中，假设此命名空间带有 mime 前缀。要设置的 WSDL 定义 元素中的条目显示在例 8.1 “MIME 命名空间规格在合同中” 中。

例 8.1. MIME 命名空间规格在合同中

xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"

更改消息绑定

在默认的 SOAP 绑定中，输入、输出和错误 元素的第一个子元素是描述代表数据的 SOAP 消息正文的 soap:body 元素。当使用带有附件的 SOAP 时，soap:body 元素替换为 mime:multipartRelated 元素。

注意

WSDL 不支持将 mime:multipartRelated 用于 错误消息。

mime:multipartRelated 元素告诉 Apache CXF，消息正文是一个可能包含二进制数据的多部件信息。元素的内容定义消息及其内容。MIME：multipartRelated 元素包含一个或多个 mime:part 元素，用于描述消息的各个部分。

第一个 mime:part 元素必须包含通常在默认的 SOAP 绑定中的 soap:body 元素。剩余的 mime:part 元素定义在消息中发送的附件。

描述 MIME 多部分信息

MIME 多部件使用 mime:multipartRelated 元素 来描述。要完全描述 MIME 多部件，您必须执行以下操作：

在您要发送为 MIME 多部件的输入或输出消息内，添加 mime:mulipartRelated 元素作为所属消息的第一个子元素。
将 mime:part 子元素添加到 mime:multipartRelated 元素，并将其 name 属性设置为唯一字符串。
添加 soap:body 元素作为 mime:part 元素的子元素，并相应地设置其属性。
注意
如果合同具有默认的 SOAP 绑定，您可以将 soap:body 元素从默认绑定复制到 MIME 多部分消息。
将另一个 mime:part 子元素添加到 mime:multipartReleated 元素，并将其 name 属性设置为唯一字符串。

将 mime:content 子元素添加到 mime:part 元素，以描述消息此部分的内容。

要完全描述 MIME 消息部分部分 mime:content 元素有以下属性：

表 8.1. MIME:content 属性
属性	描述 +
`part`	指定来自父消息定义中的 WSDL 消息 `部分` 的名称，该名称用作 MIME 多部件在线上放置的 MIME 多部件的内容。 +
`type`	此消息部分中数据的 MIME 类型。MIME 类型定义为类型，子类型使用语法类型`/`子类型。 + 有很多预定义的 MIME 类型，如 `image/jpeg` 和 `text/plain`。MIME 类型由互联网编号授权机构(IANA)维护，并在多用途 Internet 邮件扩展(MIME)中详细介绍：Internet Message Bodies 和多用途 Internet 邮件扩展(MIME)第 2 部分的内容。 +

对于每个额外的 MIME 部分，重复步骤 [i303819] 和 [i303821]。

示例

例 8.2 “使用带有附件的 SOAP 的合同” 显示 WSDL 片段，它定义了以 JPEG 格式存储 X-rays 的服务。镜像数据 xRay 存储在 xsd:base64 二进制代码 中，并打包成 MIME 多部件的第二个部分 imageData。输入消息的两部分 patientName 和 patientNumber 在 MIME 多部件镜像的第一部分中作为 SOAP 正文的一部分发送。

例 8.2. 使用带有附件的 SOAP 的合同

<?xml version="1.0" encoding="UTF-8"?>
<definitions name="XrayStorage"
    targetNamespace="http://mediStor.org/x-rays"
    xmlns="http://schemas.xmlsoap.org/wsdl/"
    xmlns:tns="http://mediStor.org/x-rays"
    xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <message name="storRequest">
    <part name="patientName" type="xsd:string"/>
    <part name="patientNumber" type="xsd:int"/>
    <part name="xRay" type="xsd:base64Binary"/>
  </message>
  <message name="storResponse">
    <part name="success" type="xsd:boolean"/>
  </message>

  <portType name="xRayStorage">
    <operation name="store">
      <input message="tns:storRequest" name="storRequest"/>
      <output message="tns:storResponse" name="storResponse"/>
    </operation>
  </portType>

  <binding name="xRayStorageBinding" type="tns:xRayStorage">
    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
      <operation name="store">
      <soap:operation soapAction="" style="document"/>
      <input name="storRequest">
        <mime:multipartRelated>
          <mime:part name="bodyPart">
            <soap:body use="literal"/>
          </mime:part>
          <mime:part name="imageData">
            <mime:content part="xRay" type="image/jpeg"/>
          </mime:part>
        </mime:multipartRelated>
      </input>
      <output name="storResponse">
        <soap:body use="literal"/>
      </output>
    </operation>
  </binding>

  <service name="xRayStorageService">
    <port binding="tns:xRayStorageBinding" name="xRayStoragePort">
      <soap:address location="http://localhost:9000"/>
    </port>
  </service>
</definitions>

第 9 章使用 SOAP MTOM 发送二进制数据

摘要

SOAP 消息传输优化机制(MTOM)将 SOAP 替换为附件作为 XML 消息的一部分发送二进制数据的机制。将 MTOM 与 Apache CXF 一起使用需要将正确的模式类型添加到服务合同中，并启用 MTOM 优化。

9.1. MTOM 概述

SOAP 消息传输优化机制(MTOM)指定以 SOAP 消息的一部分发送二进制数据的优化方法。与连接不同的 SOAP 不同，MTOM 需要使用 XML 二进制优化包(XOP)软件包来传输二进制数据。使用 MTOM 发送二进制数据不需要您完全定义 MIME 多部件/续订消息作为 SOAP 绑定的一部分。但是，它要求您进行以下操作：

注解您要作为附件发送的数据。
您可以注解 WSDL 或实现数据的 Java 类。
启用运行时的 MTOM 支持。
这可以通过编程方式或通过配置来完成。
为 作为附件 传递的数据开发数据处理程序。
注意
开发 数据处理程序已超出本书的讨论范畴。

9.2. 将数据类型注解为使用 MTOM

概述

在 WSDL 中，在定义传入二进制数据的数据类型时，如镜像文件或声文件，您可以定义要类型为 xsd:base64 inary 数据的元素。默认情况下，类型为 xsd:base64Binary 的任何元素都会生成 byte[]，这些元素可以使用 MTOM 进行序列化。但是，代码生成器的默认行为不会充分利用序列化。

要充分利用 MTOM，您必须在服务的 WSDL 文档或实施二进制数据结构的 JAXB 类中添加注解。在 WSDL 文档中添加注解会强制代码生成器为二进制数据生成流数据处理程序。注解 JAXB 类涉及指定正确的内容类型，并可能涉及更改包含二进制数据的字段类型规格。

WSDL 首先

例 9.1 “MTOM 的消息” 显示 Web 服务的 WSDL 文档，它使用一条信息，其中包含一个字符串字段、一个整数字段和二进制字段。二进制字段旨在保存大型镜像文件，因此不适合将其作为普通 SOAP 消息的一部分发送。

例 9.1. MTOM 的消息

<?xml version="1.0" encoding="UTF-8"?>
<definitions name="XrayStorage"
    targetNamespace="http://mediStor.org/x-rays"
    xmlns="http://schemas.xmlsoap.org/wsdl/"
    xmlns:tns="http://mediStor.org/x-rays"
    xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
    xmlns:xsd1="http://mediStor.org/types/"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <types>
    <schema targetNamespace="http://mediStor.org/types/"
            xmlns="http://www.w3.org/2001/XMLSchema">
      <complexType name="xRayType">
        <sequence>
          <element name="patientName" type="xsd:string" />
          <element name="patientNumber" type="xsd:int" />
          <element name="imageData" type="xsd:base64Binary" />
        </sequence>
      </complexType>
      <element name="xRay" type="xsd1:xRayType" />
    </schema>
  </types>

  <message name="storRequest">
    <part name="record" element="xsd1:xRay"/>
  </message>
  <message name="storResponse">
    <part name="success" type="xsd:boolean"/>
  </message>

  <portType name="xRayStorage">
    <operation name="store">
      <input message="tns:storRequest" name="storRequest"/>
      <output message="tns:storResponse" name="storResponse"/>
    </operation>
  </portType>

  <binding name="xRayStorageSOAPBinding" type="tns:xRayStorage">
    <soap12:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="store">
      <soap12:operation soapAction="" style="document"/>
      <input name="storRequest">
        <soap12:body use="literal"/>
      </input>
      <output name="storResponse">
        <soap12:body use="literal"/>
      </output>
    </operation>
  </binding>
  ...
</definitions>

如果要使用 MTOM 将消息的二进制部分作为优化的附件发送，您必须将 xmime:expectedContentTypes 属性添加到包含二进制数据的元素中。此属性在 http://www.w3.org/2005/05/xmlmime 命名空间中定义，并指定该元素应该包含的 MIME 类型。您可以指定以逗号分隔的 MIME 类型列表。此属性的设置改变了代码生成器为数据创建 JAXB 类的方式。对于大多数 MIME 类型，代码生成器会创建一个数据处理程序。某些 MIME 类型（如镜像的那些类型）定义了映射。

注意

MIME 类型由互联网编号授权机构(IANA)维护，并在多用途互联网邮件扩展(MIME)中详细介绍：Internet Message Bo dies 和多用途 Internet 邮件扩展(MIME)第 2 部分的内容。

对于大多数使用，您可以指定 application/octet-stream。

例 9.2 “MTOM 的二进制数据” 显示如何使用 MTOM 从例 9.1 “MTOM 的消息” 修改 xRayType。

例 9.2. MTOM 的二进制数据

...
  <types>
    <schema targetNamespace="http://mediStor.org/types/"
            xmlns="http://www.w3.org/2001/XMLSchema"
            xmlns:xmime="http://www.w3.org/2005/05/xmlmime">
      <complexType name="xRayType">
        <sequence>
          <element name="patientName" type="xsd:string" />
          <element name="patientNumber" type="xsd:int" />
          <element name="imageData" type="xsd:base64Binary"
                   xmime:expectedContentTypes="application/octet-stream"/>
        </sequence>
      </complexType>
      <element name="xRay" type="xsd1:xRayType" />
    </schema>
  </types>
...

为 xRayType 生成的 JAXB 类不再包含 字节[]。相反，代码生成器会看到 xmime:expectedContentTypes 属性，并为 imageData 字段生成 DataHandler。

注意

您不需要更改 绑定 元素以使用 MTOM。当数据发送时，运行时会进行适当的更改。

Java 首先

如果您进行 Java 首次开发，您可以通过以下操作使 JAXB 类 MTOM 就绪：

确保包含二进制数据的字段为数据处理程序。
将 @XmlMimeType （） 注释添加到包含您要流为 MTOM 附加数据的字段。

例 9.3 “MTOM 的 JAXB 类” 显示使用 MTOM 注解的 JAXB 类。

例 9.3. MTOM 的 JAXB 类

@XmlType
public class XRayType {
    protected String patientName;
    protected int patientNumber;
    @XmlMimeType("application/octet-stream")
    protected DataHandler imageData;
  ...
}

9.3. 启用 MTOM

默认情况下，Apache CXF 运行时不启用 MTOM 支持。它将所有二进制数据作为常规 SOAP 消息的一部分或者作为未优化的附件发送。您可以以编程方式激活 MTOM 支持，也可以使用配置。

9.3.1. 使用 JAX-WS API

概述

服务提供商和消费者都必须启用 MTOM 优化功能。JAX-WS API 为每种端点提供不同的机制。

服务供应商

如果使用 JAX-WS API 发布您的服务提供商，则启用运行时的 MTOM 支持，如下所示：

访问已发布服务的 Endpoint 对象。
访问 Endpoint 对象的最简单方法是当您发布端点时。更多信息请参阅第 31 章 发布服务。
使用其 getBinding （） 方法从 Endpoint 获取 SOAP 绑定，如例 9.4 “从 Endpoint 获取 SOAP Binding” 所示。
例 9.4. 从 Endpoint 获取 SOAP Binding
```
// Endpoint ep is declared previously
SOAPBinding binding = (SOAPBinding)ep.getBinding();
```
您必须将返回的绑定对象转换为 SOAPBinding 对象来访问 MTOM 属性。
使用绑定的 setMTOMEnabled （） 方法将绑定的 MTOM enabled 属性设为 true，如例 9.5 “设置服务提供商的 MTOM Enabled Property” 所示。
例 9.5. 设置服务提供商的 MTOM Enabled Property
```
binding.setMTOMEnabled(true);
```

消费者

要 MTOM 启用 JAX-WS 使用者，您必须执行以下操作：

将消费者的代理投到 BindingProvider 对象。
有关获取消费者代理的详情，请参考第 25 章 在没有 WSDL 合同的情况下开发消费者 或第 28 章 从 WSDL 合同开发消费者。
使用其 getBinding （） 方法从 BindingProvider 获取 SOAP 绑定，如例 9.6 “从 BindingProvider获取 SOAP 绑定” 所示。
例 9.6. 从 BindingProvider获取 SOAP 绑定
```
// BindingProvider bp declared previously
SOAPBinding binding = (SOAPBinding)bp.getBinding();
```
使用绑定的 setMEnabled （）方法将 bindings MTOM enabled 属性设为 true，如例 9.7 “设置 Consumer 的 MTOM Enabled Property” 所示。
例 9.7. 设置 Consumer 的 MTOM Enabled Property
```
binding.setMTOMEnabled(true);
```

9.3.2. 使用配置

概述

如果使用 XML （如部署到容器时）发布您的服务，您可以在端点配置文件中的 MTOM 支持启用端点的 MTOM 支持。有关配置端点的更多信息，请参阅第 IV 部分 “配置 Web 服务端点”。

流程

MTOM 属性在您的端点的 jaxws:endpoint 元素内设置。启用 MTOM 执行以下操作：

向端点的 jaxws:property 子元素中添加 jaxws: property 子元素。
向 jaxws:property 元素中 添加条目 子元素。
将 条目 元素的 key 属性设置为 mtom-enabled。
将 entry 元素的 value 属性设置为 true。

示例

例 9.8 “配置启用 MTOM” 显示已启用 MTOM 的端点。

例 9.8. 配置启用 MTOM

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:jaxws="http://cxf.apache.org/jaxws"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
                           http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
                           http://cxf.apache.org/jaxws http://cxf.apache.org/schema/jaxws.xsd">

  <jaxws:endpoint id="xRayStorage"
                  implementor="demo.spring.xRayStorImpl"
                  address="http://localhost/xRayStorage">
    <jaxws:properties>
      <entry key="mtom-enabled" value="true"/>
    </jaxws:properties>
  </jaxws:endpoint>
</beans>

第 10 章使用 XML 文档

摘要

纯 XML 有效负载格式提供了 SOAP 绑定的替代方法，允许服务使用直接 XML 文档交换数据，而不会导致 SOAP 信封开销。

XML 绑定命名空间

用于描述 XML 格式的绑定的扩展在命名空间 http://cxf.apache.org/bindings/xformat 中定义。Apache CXF 工具使用前缀 xformat 来代表 XML 绑定扩展。在您的合同中添加以下行：

xmlns:xformat="http://cxf.apache.org/bindings/xformat"

手动编辑

将接口映射到纯 XML 有效负载格式，请执行以下操作：

添加命名空间声明以包含定义 XML 绑定的扩展。请参阅 “XML 绑定命名空间”一节。
在您的合同中添加标准 WSDL 绑定 元素来容纳 XML 绑定，为绑定 指定唯一名称，并指定代表所绑定的接口的 WSDL portType 元素的名称。
向绑定元素中添加 xformat: binding 子元素，以标识消息作为纯 XML 文档处理，但没有 SOAP envelopes。
另外，还可将 xformat:binding 元素的 rootNode 属性设置为有效的 QName。有关 rootNode 属性的效果的更多信息，请参阅 “线上的 XML 消息”一节。
对于每个在绑定接口中定义的操作，添加一个标准的 WSDL 操作 元素，以存放操作消息的绑定信息。
对于添加到绑定的每个操作，添加 输入、输出和错误 子元素，以表示操作所使用的消息。
这些元素对应于逻辑操作的接口定义中定义的消息。
（可选）将具有有效 rootNode 属性的 xformat:body 元素添加到添加的 输入、输出 和故障元素中，以覆盖绑定级别的 rootNode 设置值。

注意

如果您的任何消息都没有部分，例如返回 void 的操作的输出消息，您必须为消息设置 rootNode 属性，以确保在线上写入的消息有效，但空 XML 文档。

线上的 XML 消息

当您指定接口的消息作为 XML 文档传递时，如果没有 SOAP envelope，则必须小心谨慎，以确保您的消息表单在有线上写时，确保消息形成有效的 XML 文档。您还需要确保接收 XML 文档的非 Apache CXF 参与者了解 Apache CXF 生成的消息。

解决这两个问题的简单方法是，在 global xformat:binding 元素上使用可选的 rootNode 属性，或者用于单个消息的 xformat:body 元素。rootNode 属性为元素指定 QName，充当由 Apache CXF 生成的 XML 文档的根节点。如果没有设置 rootNode 属性时，Apache CXF 使用消息部分的 root 元素，在使用 doc 风格消息时将消息部分名称用作 root 元素，或使用消息部分名称作为 root 元素。

例如，如果 rootNode 属性没有设置例 10.1 “有效的 XML 绑定消息” 中定义的信息，则会生成带有 root 元素 lineNumber 的 XML 文档。

例 10.1. 有效的 XML 绑定消息

<type ... >
  ...
  <element name="operatorID" type="xsd:int"/>
  ...
</types>
<message name="operator">
  <part name="lineNumber" element="ns1:operatorID"/>
</message>

对于只有一个部分的消息，即使未设置 rootNode 属性，Apache CXF 也会生成有效的 XML 文档。但是，例 10.2 “无效的 XML 绑定消息” 中的信息将生成无效的 XML 文档。

例 10.2. 无效的 XML 绑定消息

<types>
  ...
  <element name="pairName" type="xsd:string"/>
  <element name="entryNum" type="xsd:int"/>
  ...
</types>

<message name="matildas">
  <part name="dancing" element="ns1:pairName"/>
  <part name="number" element="ns1:entryNum"/>
</message>

如果没有在 XML 绑定中指定的 rootNode 属性，Apache CXF 会为例 10.3 “无效的 XML 文档” 中定义的消息生成类似如下的 XML 文档。例 10.2 “无效的 XML 绑定消息”生成的 XML 文档无效，因为它有两个根元素： pairName 和 entryNum。

例 10.3. 无效的 XML 文档

<pairName>
  Fred&Linda
</pairName>
<entryNum>
  123
</entryNum>

如果您设置了 rootNode 属性，如例 10.4 “带有 rootNode 设置的 XML 绑定” Apache CXF 所示，将在指定的根元素中嵌套元素。在本例中，rootNode 属性是针对整个绑定定义的，并指定根元素的名称为 entrants。

例 10.4. 带有 rootNode 设置的 XML 绑定

<portType name="danceParty">
  <operation name="register">
    <input message="tns:matildas" name="contestant"/>
  </operation>
</portType>

<binding name="matildaXMLBinding" type="tns:dancingMatildas">
  <xmlformat:binding rootNode="entrants"/>
  <operation name="register">
    <input name="contestant"/>
    <output name="entered"/>
</binding>

从输入信息生成的 XML 文档类似于例 10.5 “使用 rootNode 属性生成的 XML 文档”。请注意，XML 文档现在只有一个根元素。

例 10.5. 使用 rootNode 属性生成的 XML 文档

<entrants>
  <pairName>
    Fred&Linda
  <entryNum>
    123
  </entryNum>
</entrants>

覆盖绑定的 rootNode 属性设置

您还可以为每个单个消息设置 rootNode 属性，或者使用消息绑定中的 xformat:body 元素覆盖特定消息的全局设置。例如：如果您希望例 10.4 “带有 rootNode 设置的 XML 绑定” 中定义的输出消息具有与输入消息不同的根元素，您可以覆盖绑定的根元素，如例 10.6 “Using xformat:body” 所示。

例 10.6. Using xformat:body

<binding name="matildaXMLBinding" type="tns:dancingMatildas">
  <xmlformat:binding rootNode="entrants"/>
  <operation name="register">
    <input name="contestant"/>
    <output name="entered">
      <xformat:body rootNode="entryStatus" />
    </output>
  </operation>
</binding>

部分 III. Web 服务传输

这部分论述了如何在 WSDL 文档中添加 Apache CXF 传输。

第 11 章了解 WSDL 中的如何定义端点

摘要

端点表示实例化服务。它们通过将绑定和用于公开端点的网络详情组合来定义。

概述

端点可以被视为服务的物理清单。它组合了一个绑定，用于指定由服务使用的逻辑数据的物理表示，以及一组网络详情，用于定义用于使服务可被其他端点联系的物理连接详情。

注意

CXF 提供程序是 CXF 消费者的服务器，对应于客户端。如果您使用 CXF (camel-cxf)组件作为路由中的起始端点，则端点同时是 Camel consumer 和 CXF 供应商。如果您使用 Camel CXF 组件，作为路由中的端点，则端点都是 Camel producer 和 CXF consumer。

端点和服务

与绑定只能映射单个接口一样，端点只能映射到单个服务。不过，服务可以通过任意数量的端点进行描述。例如，您可以定义一个由四个不同端点的清单销售服务。但是，您无法使用一个端点来记录一个 ticket 销售服务和一个小部件销售服务。

WSDL 元素

端点利用 WSDL 服务 元素和 WSDL 端口 元素的组合在合同中定义。service 元素是相关端口元素 的集合。端口 元素定义实际的端点。

WSDL 服务 元素具有一个属性，名为，用于指定唯一名称。service 元素用作相关端口元素集合的父 元素。WSDL 没有有关 端口 元素的规范。您可以以任何方式关联 端口 元素。

WSDL 端口 元素具有一个 绑定 属性，用于指定端点使用的绑定，它引用 wsdl:binding 元素。它还包括 name 属性，这是在所有端口之间提供唯一名称的强制属性。port 元素是元素的父元素，用于指定端点使用的实际传输详细信息。以下部分讨论用于指定传输详情的元素。

在合同中添加端点

Apache CXF 提供命令行工具，可以生成用于预定义服务接口和绑定组合的端点。

这些工具将为您的合同添加正确的元素。但是，建议您了解定义端点工作时使用的不同传输方式。

您也可以使用任何文本编辑器向合同中添加端点。当您手动编辑合同时，您需要确保合同有效。

支持的传输

端点定义是使用为 Apache CXF 支持的每个传输的扩展而定义的扩展。这包括以下传输：

HTTP
CORBA
Java 消息传递服务

第 12 章使用 HTTP

摘要

HTTP 是 Web 的底层传输。它为在端点之间进行通信提供了一个标准化、强大且灵活的平台。因为这些因素是假定为大多数 WS-* 规格的传输，是 RESTful 架构不可或缺的。

12.1. 添加基本 HTTP 端点

其它 HTTP 运行时

Apache CXF 支持以下替代 HTTP 运行时实现：

Undertow，在第 12.4 节 “配置 Undertow 运行时” 中进行了详细介绍。
Netty，在第 12.5 节 “配置 Netty 运行时” 中进行了详细介绍。

Netty HTTP URL

通常，HTTP 端点使用，每当类路径中包含 HTTP 运行时(Undertow 或 Netty)中。如果类路径上同时包含 Undertow 运行时和 Netty 运行时，则需要在希望使用 Netty 运行时明确指定，因为默认情况下将使用 Undertow 运行时。

如果类路径上有多个 HTTP 运行时可用，您可以通过指定端点 URL 来指定 Undertow 运行时，使其具有以下格式：

netty://http://RestOfURL

有效负载类型

根据您使用的有效负载格式指定 HTTP 端点地址，可通过三种方式指定。

SOAP 1.1 使用标准化 soap:address 元素。
SOAP 1.2 使用 soap12:address 元素。
所有其他有效负载格式使用 http:address 元素。

注意

从 Camel 2.16.0 版本，Apache Camel CXF Payload 支持流缓存箱。

SOAP 1.1

当您通过 HTTP 发送 SOAP 1.1 消息时，您必须使用 SOAP 1.1 地址 元素来指定端点的地址。它具有一个属性，即 location，它将端点的地址指定为 URL。SOAP 1.1 地址 元素在命名空间 http://schemas.xmlsoap.org/wsdl/soap/ 中定义。

例 12.1 “SOAP 1.1 端口元素” 显示用于通过 HTTP 发送 SOAP 1.1 消息 的端口 元素。

例 12.1. SOAP 1.1 端口元素

<definitions ...
             xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" ...>
  ...
  <service name="SOAP11Service">
    <port binding="SOAP11Binding" name="SOAP11Port">
      <soap:address location="http://artie.com/index.xml">
    </port>
  </service>
  ...
<definitions>

SOAP 1.2

当您通过 HTTP 发送 SOAP 1.2 消息时，您必须使用 SOAP 1.2 地址 元素来指定端点的地址。它具有一个属性，即 location，它将端点的地址指定为 URL。SOAP 1.2 地址 元素在命名空间 http://schemas.xmlsoap.org/wsdl/soap12/ 中定义。

例 12.2 “SOAP 1.2 端口元素” 显示用于通过 HTTP 发送 SOAP 1.2 消息 的端口 元素。

例 12.2. SOAP 1.2 端口元素

<definitions ...
             xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" ... >
  <service name="SOAP12Service">
    <port binding="SOAP12Binding" name="SOAP12Port">
      <soap12:address location="http://artie.com/index.xml">
    </port>
  </service>
  ...
</definitions>

其他消息类型

当消息映射到 SOAP 以外的任何有效负载格式时，您必须使用 HTTP 地址 元素来指定端点的地址。它具有一个属性，即 location，它将端点的地址指定为 URL。HTTP 地址 元素在命名空间 http://schemas.xmlsoap.org/wsdl/http/ 中定义。

例 12.3 “HTTP 端口元素” 显示用于发送 XML 消息 的端口 元素。

例 12.3. HTTP 端口元素

<definitions ...
             xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" ... >
  <service name="HTTPService">
    <port binding="HTTPBinding" name="HTTPPort">
      <http:address location="http://artie.com/index.xml">
    </port>
  </service>
  ...
</definitions>

12.2. 配置一个消费者

12.2.1. HTTP Consumer Endpoints 的机制

HTTP 消费者端点可以指定很多 HTTP 连接属性，包括端点是否自动接受重定向响应，端点是否可以使用块，端点是否会请求持久的，端点如何与代理交互。除了 HTTP 连接属性外，HTTP 使用者端点还可指定保护方法。

消费者端点可以使用以下两种机制进行配置：

配置
WSDL

12.2.2. 使用配置

命名空间

用于配置 HTTP 消费者端点的元素在命名空间 http://cxf.apache.org/transports/http/configuration 中定义。通常会使用前缀 http-conf 来引用。要使用 HTTP 配置元素，您必须将例 12.4 “HTTP Consumer 配置命名空间” 中显示的行添加到端点配置文件的 Bean 元素中。另外，您必须将配置元素的命名空间添加到 xsi:schemaLocation 属性中。

例 12.4. HTTP Consumer 配置命名空间

<beans ...
       xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"
       ...
       xsi:schemaLocation="...
                           http://cxf.apache.org/transports/http/configuration
                              http://cxf.apache.org/schemas/configuration/http-conf.xsd
                          ...">

Undertow 运行时或 Netty 运行时

您可以使用 http-conf 命名空间中的元素来配置 Undertow 运行时或 Netty 运行时。

conduit 元素

您可以使用 http-conf:conduit 元素及其子项来配置 HTTP consumer 端点。http-conf:conduit 元素使用单个属性名称，用于指定与端点对应的 WSDL 端口 元素。name 属性的值采用 portQName'.http-conduit' 的形式。例 12.5 “http-conf:conduit Element” 显示 http-conf:conduit 元素，用于为 WSDL 片段 < port binding="widgetSOAPBinding" name="widgetSOAPPort& gt; 指定的端点添加配置。

例 12.5. http-conf:conduit Element

...
  <http-conf:conduit name="{http://widgets/widgetvendor.net}widgetSOAPPort.http-conduit">
    ...
  </http-conf:conduit>
...

http-conf:conduit 元素含有指定配置信息的子元素。它们在表 12.1 “用于配置 HTTP Consumer Endpoint 的元素” 中进行了说明。

表 12.1. 用于配置 HTTP Consumer Endpoint 的元素
element	描述
`http-conf:client`	指定 HTTP 连接属性，如超时、保留请求、内容类型等。请参阅 “client 元素”一节。
`http-conf:authorization`	指定用于配置端点预先使用的基本身份验证方法的参数。首选的方法是提供 `http-conf:basicAuthSupplier` 对象。
`http-conf:proxyAuthorization`	指定用于为传出 HTTP 代理服务器配置基本身份验证的参数。
`http-conf:tlsClientParameters`	指定用于配置 SSL/TLS 的参数。
`http-conf:basicAuthSupplier`	指定提供端点使用的基本身份验证信息的对象 bean 引用或类名称，可抢占或响应 401 HTTP 质询。
`http-conf:trustDecider`	指定对象的 bean 引用或类名称，用于检查 HTTP (S) `URLConnection` 对象，以便在传输任何信息前建立与 HTTPS 服务提供商的连接的信任。

client 元素

http-conf:client 元素用于配置消费者端点 HTTP 连接的非安全属性。其属性（如表 12.2 “HTTP Consumer Configuration Attributes” 所述）指定连接的属性。

表 12.2. HTTP Consumer Configuration Attributes
属性	描述
`ConnectionTimeout`	指定消费者在连接超时前尝试建立连接的时间长度（以毫秒为单位）。默认值为 `30000`。 `0` 指定使用者将继续无限期地发送请求。
`ReceiveTimeout`	指定消费者在超时前等待响应的时间长度（以毫秒为单位）。默认值为 `30000`。 `0` 指定使用者将无限期等待。
`AutoRedirect`	指定消费者是否会自动遵循服务器发出的重定向。默认值为 `false`。
`MaxRetransmits`	指定消费者要重新传输请求以满足重定向的次数上限。默认值为 `-1`，指定允许无限重新传输。
`AllowChunking`	指定消费者是否使用块发送请求。默认值为 `true`，指定消费者在发送请求时将使用块。如果以下条件之一为 true，则无法使用块： `http-conf:basicAuthSupplier` 配置为立即提供凭证。 `AutoRedirect` 设置为 `true`。在这两种情况下，`AllowChunking` 的值都被忽略，块会被禁止。
`accept`	指定消费者准备处理哪些媒体类型。该值用作 HTTP `Accept` 属性的值。属性的值使用多用途互联网邮件扩展(MIME)类型来指定。
`AcceptLanguage`	指定接收响应时使用者喜欢的语言（例如，美国英语）。该值用作 HTTP `AcceptLanguage` 属性的值。语言标签由标准(ISO)国际组织规定，通常通过组合语言代码（由 ISO-639 标准决定）和国家/地区代码（由 ISO-3166 标准决定）由 ISO-3166 标准决定，由连字符分开。例如，De-US 代表美国英语。
`AcceptEncoding`	指定消费者已准备好处理的内容编码。内容编码标签由互联网编号授权机构(IANA)规定。该值用作 HTTP `AcceptEncoding` 属性的值。
`ContentType`	指定消息正文中发送数据的介质类型。介质类型使用多用途的互联网邮件扩展(MIME)类型来指定。该值用作 HTTP `ContentType` 属性的值。默认为 `text/xml`。对于 Web 服务，这应设置为 `text/xml`。如果客户端正在向 CGI 脚本发送 HTML 表单数据，则应该将其设置为 `application/x-www-form-urlencoded`。如果 HTTP POST 请求绑定到固定有效负载格式（与 SOAP 不同），则内容类型通常设置为 `application/octet-stream`。
`主机`	指定请求被调用的资源的互联网主机和端口号。该值用作 HTTP `Host` 属性的值。通常不需要此属性。只有某些 DNS 场景或应用程序设计才需要它。例如，它指示了集群客户端首选的主机（即，用于虚拟服务器映射到相同的互联网协议(IP)地址）。
`连接`	指定在每个请求/响应对话框后，是否保持打开或关闭特定连接。有两个有效值： `keep-Alive` - 指定消费者希望连接在初始请求/响应序列后保持打开状态。如果服务器符合它，则连接将保持打开状态，直到使用者关闭为止。 `关闭`（默认）- 指定在每个请求/响应序列后关闭到服务器的连接。
`CacheControl`	指定有关通过链中涉及缓存的缓存遵守行为的指令，这些指令由来自消费者到服务提供商的请求组成。请参阅第 12.2.4 节 “消费者缓存控制指令”。
`cookie`	指定与所有请求一起发送的静态 Cookie。
`BrowserType`	指定请求源自的浏览器的信息。在 World Wide Web consortium (W3C)的 HTTP 规格中，这也被称为 user-agent。某些服务器根据发送请求的客户端进行优化。
`推荐程序`	指定定向到消费者在特定服务上发出请求的资源的 URL。该值用作 HTTP 推荐 `属性的值`。当请求是浏览器用户点击超链接而不是输入 URL 时，会使用此 HTTP 属性。这可允许服务器根据之前的任务流优化处理，并为日志、优化缓存、跟踪过时或错误类型链路等目的生成后端链接列表。但是，它通常在 Web 服务应用程序中使用。如果 `AutoRedirect` 属性设置为 `true`，并且请求被重定向，则 refer `er` 属性中指定的任何值都会被覆盖。HTTP Referer 属性的值设置为重定向使用者原始请求的服务的 URL。
`DecoupledEndpoint`	指定在一个单独的 provider→consumer 连接中接收响应的分离端点的 URL。有关使用分离端点的更多信息，请参阅第 12.6 节 “在拒绝模式中使用 HTTP 传输”。您必须配置使用者端点和服务供应商端点，以使用 WS-Addressing 分离端点才能工作。
`ProxyServer`	指定路由请求的代理服务器的 URL。
`ProxyServerPort`	指定路由请求的代理服务器的端口号。
`ProxyServerType`	指定用于路由请求的代理服务器的类型。有效值为： `HTTP`（默认） `SOCKS`

示例

例 12.6 “HTTP Consumer Endpoint 配置” 显示要保持与请求间打开的 HTTP 消费者端点的配置，该端点只会在每次调用一次重新传输请求，且无法使用块流。

例 12.6. HTTP Consumer Endpoint 配置

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"
       xsi:schemaLocation="http://cxf.apache.org/transports/http/configuration
                             http://cxf.apache.org/schemas/configuration/http-conf.xsd
                           http://www.springframework.org/schema/beans
                             http://www.springframework.org/schema/beans/spring-beans.xsd">

  <http-conf:conduit name="{http://apache.org/hello_world_soap_http}SoapPort.http-conduit">
    <http-conf:client Connection="Keep-Alive"
                      MaxRetransmits="1"
                      AllowChunking="false" />
  </http-conf:conduit>
</beans>

12.2.3. 使用 WSDL

命名空间

用于配置 HTTP 消费者端点的 WSDL 扩展元素在命名空间 http://cxf.apache.org/transports/http/configuration 中定义。通常会使用前缀 http-conf 来引用。要使用 HTTP 配置元素，您必须将例 12.7 “HTTP Consumer WSDL 元素的命名空间” 中显示的行添加到端点 WSDL 文档中的 定义 元素中。

例 12.7. HTTP Consumer WSDL 元素的命名空间

<definitions ...
       xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"

Undertow 运行时或 Netty 运行时

您可以使用 http-conf 命名空间中的元素来配置 Undertow 运行时或 Netty 运行时。

client 元素

http-conf:client 元素用于指定 WSDL 文档中的 HTTP 消费者的连接属性。http-conf:client 元素是 WSDL 端口 元素的子级。它具有与配置文件中使用的 client 元素相同的属性。属性在表 12.2 “HTTP Consumer Configuration Attributes” 中描述。

示例

例 12.8 “WSDL 配置 HTTP Consumer 端点” 显示 WSDL 片段，用于配置 HTTP 消费者端点来指定它与缓存交互。

例 12.8. WSDL 配置 HTTP Consumer 端点

<service ... >
  <port ... >
    <soap:address ... />
    <http-conf:client CacheControl="no-cache" />
  </port>
</service>

12.2.4. 消费者缓存控制指令

表 12.3 “http-conf:client Cache Control Directives” 列出 HTTP 使用者支持的缓存控制指令。

表 12.3. http-conf:client Cache Control Directives
指令	行为
no-cache	缓存无法使用特定的响应来满足后续请求，而不必先评估服务器响应。如果使用此值指定特定的响应标头字段，则限制仅适用于响应中的这些标头字段。如果没有指定响应标头字段，这个限制将应用到整个响应。
no-store	缓存不得存储响应的任何部分或调用它的请求的任何部分。
max-age	消费者可以接受其年龄不超过指定时间（以秒为单位）的响应。
max-stale	用户可以接受超过其过期时间的回复。如果一个值被分配到 max-stale，它代表响应的过期时间之外的秒数，使用者仍然可以接受该响应。如果没有分配值，使用者可以接受任何年龄的过时响应。
min-fresh	消费者希望获得至少指定秒数代表的回复。
no-transform	缓存不得在提供程序和消费者之间修改内容的介质类型或位置。
only-if-cached	缓存应仅返回当前存储在缓存中的响应，且不需要重新加载或撤销响应。
cache-extension	指定其他缓存指令的额外扩展。扩展可以是信息或行为。在标准指令上下文中指定了扩展指令，以便不了解扩展指令的应用程序可以遵循标准指令强制的行为。

12.3. 配置服务提供商

12.3.1. HTTP 服务提供商的机制

HTTP 服务提供商端点可以指定很多 HTTP 连接属性，包括它是否遵守实时请求、它与缓存交互的方式，以及它如何与消费者通信的错误。

服务供应商端点可以使用以下两种机制进行配置：

配置
WSDL

12.3.2. 使用配置

命名空间

用于配置 HTTP 提供程序端点的元素在命名空间 http://cxf.apache.org/transports/http/configuration 中定义。通常会使用前缀 http-conf 来引用。要使用 HTTP 配置元素，您必须将例 12.9 “HTTP Provider 配置命名空间” 中显示的行添加到端点配置文件的 Bean 元素中。另外，您必须将配置元素的命名空间添加到 xsi:schemaLocation 属性中。

例 12.9. HTTP Provider 配置命名空间

<beans ...
       xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"
       ...
       xsi:schemaLocation="...
                           http://cxf.apache.org/transports/http/configuration
                              http://cxf.apache.org/schemas/configuration/http-conf.xsd
                          ...">

Undertow 运行时或 Netty 运行时

您可以使用 http-conf 命名空间中的元素来配置 Undertow 运行时或 Netty 运行时。

destination 元素

您可以使用 http-conf:destination 元素及其子项来配置 HTTP 服务提供商端点。http-conf:destination 元素使用单个属性 name，用于指定与端点对应的 WSDL 端口 元素。name 属性的值格式为 portQName'.http-destination'。例 12.10 “http-conf:destination Element” 显示 http-conf:destination 元素，用于在端点中添加由 WSDL 片段 < port binding="widgetSOAPBinding" name="widgetSOAPPort > 指定的端点配置。

例 12.10. http-conf:destination Element

...
  <http-conf:destination name="{http://widgets/widgetvendor.net}widgetSOAPPort.http-destination">
    ...
  </http-conf:destination>
...

http-conf:destination 元素具有多个指定配置信息的子元素。它们在表 12.4 “用于配置 HTTP 服务提供商端点的元素” 中进行了说明。

表 12.4. 用于配置 HTTP 服务提供商端点的元素
element	描述
`http-conf:server`	指定 HTTP 连接属性。请参阅 “server 元素”一节。
`http-conf:contextMatchStrategy`	指定配置上下文匹配策略以处理 HTTP 请求的参数。
`http-conf:fixedParameterOrder`	指定此目的地处理的 HTTP 请求的参数顺序是否已解决。

server 元素

http-conf:server 元素用于配置服务提供商端点的 HTTP 连接的属性。其属性（如表 12.5 “HTTP 服务提供商配置属性” 所述）指定连接的属性。

表 12.5. HTTP 服务提供商配置属性
属性	描述
`ReceiveTimeout`	设定在连接超时前尝试接收请求的时间长度（以毫秒为单位）。默认值为 `30000`。 `0` 指定供应商不会超时。
`SuppressClientSendErrors`	指定在收到请求时遇到错误时是否会出现异常。默认值为 `false` ；在遇到错误时抛出异常。
`SuppressClientReceiveErrors`	指定在向消费者发送响应时遇到错误时要抛出异常。默认值为 `false` ；在遇到错误时抛出异常。
`HonorKeepAlive`	指定在发送响应后，服务提供商是否遵循要保持打开的连接的请求。默认值为 `false`; keep-alive 请求将被忽略。
`RedirectURL`	如果客户端请求中指定的 URL 不再适合于请求资源，则指定客户端请求的 URL 应该重定向到该 URL。在这种情况下，如果服务器响应的第一行中没有自动设置状态代码，则状态代码被设置为 302，状态描述设置为 Object Moved。该值用作 HTTP RedirectURL 属性的值。
`CacheControl`	指定有关通过链中涉及缓存的缓存遵守行为的指令，将来自服务提供商的响应组成到消费者。请参阅第 12.3.4 节 “服务提供商缓存控制指令”。
`ContentLocation`	设置响应中发送的资源的 URL。
`ContentType`	指定响应中发送的信息的介质类型。介质类型使用多用途的互联网邮件扩展(MIME)类型来指定。该值用作 HTTP ContentType 位置的值。
`ContentEncoding`	指定任何已应用于服务提供商发送的信息的额外内容编码。内容编码标签由互联网编号授权机构(IANA)规定。可能的内容编码值包括 zip、gzip、压缩、deflate 和 identity。这个值被用作 HTTP ContentEncoding 属性的值。内容编码的主要用途是允许使用一些编码机制（如 zip 或 gzip）来压缩文档。Apache CXF 对内容编码没有验证。用户负责确保在应用程序级别支持指定的内容编码。
`ServerType`	指定发送响应的服务器类型。值采用 `program-name/版本` ；例如，`Apache/1.2.5`。

示例

例 12.11 “HTTP 服务提供商端点配置” 显示 HTTP 服务供应商端点的配置，该端点遵循可持续的请求，并阻止所有通信错误。

例 12.11. HTTP 服务提供商端点配置

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"
       xsi:schemaLocation="http://cxf.apache.org/transports/http/configuration
                             http://cxf.apache.org/schemas/configuration/http-conf.xsd
                           http://www.springframework.org/schema/beans
                             http://www.springframework.org/schema/beans/spring-beans.xsd">

  <http-conf:destination name="{http://apache.org/hello_world_soap_http}SoapPort.http-destination">
    <http-conf:server SuppressClientSendErrors="true"
                      SuppressClientReceiveErrors="true"
                      HonorKeepAlive="true" />
  </http-conf:destination>
</beans>

12.3.3. 使用 WSDL

命名空间

用于配置 HTTP 提供程序端点的 WSDL 扩展元素在命名空间 http://cxf.apache.org/transports/http/configuration 中定义。通常会使用前缀 http-conf 来引用。要使用 HTTP 配置元素，您必须将例 12.12 “HTTP Provider WSDL 元素的命名空间” 中显示的行添加到端点 WSDL 文档中的 定义 元素中。

例 12.12. HTTP Provider WSDL 元素的命名空间

<definitions ...
       xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"

Undertow 运行时或 Netty 运行时

您可以使用 http-conf 命名空间中的元素来配置 Undertow 运行时或 Netty 运行时。

server 元素

http-conf:server 元素用于指定 WSDL 文档中的 HTTP 服务提供商的连接属性。http-conf:server 元素是 WSDL 端口 元素的子级。它具有与配置文件中使用的 server 元素相同的属性。属性在表 12.5 “HTTP 服务提供商配置属性” 中描述。

示例

例 12.13 “WSDL 配置 HTTP 服务提供商端点” 显示 WSDL 片段，用于配置 HTTP 服务提供商端点，指定它不与缓存交互。

例 12.13. WSDL 配置 HTTP 服务提供商端点

<service ... >
  <port ... >
    <soap:address ... />
    <http-conf:server CacheControl="no-cache" />
  </port>
</service>

12.3.4. 服务提供商缓存控制指令

表 12.6 “http-conf:server Cache Control Directives” 列出 HTTP 服务提供商支持的缓存控制指令。

表 12.6. http-conf:server Cache Control Directives
指令	行为
no-cache	缓存无法使用特定的响应来满足后续请求，而不必先评估服务器响应。如果使用此值指定特定的响应标头字段，则限制仅适用于响应中的这些标头字段。如果没有指定响应标头字段，这个限制将应用到整个响应。
public	任何缓存都可以存储响应。
private	公共(共享)缓存无法存储响应，因为响应适用于单个用户。如果使用此值指定特定的响应标头字段，则限制仅适用于响应中的这些标头字段。如果没有指定响应标头字段，这个限制将应用到整个响应。
no-store	缓存不得存储响应的任何部分或调用它的请求的任何部分。
no-transform	缓存不得在服务器和客户端之间响应中修改内容的介质类型或位置。
must-revalidate	缓存必须重新验证与响应相关的过期条目，然后才能在随后的响应中使用该条目。
proxy-revalidate	与 must-revalidate 相同的操作，除了只能在共享缓存上强制执行，并由私有非共享缓存忽略。当使用这个指令时，必须使用公共 cache 指令。
max-age	客户端可以接受其年龄不会超过指定秒数的响应。
s-max-age	与 max-age 相同的操作，只是只能在共享缓存中强制使用，并由私有非共享缓存忽略。s-max-age 指定的年龄会覆盖 max-age 指定的年龄。当使用这个指令时，还必须使用 proxy-revalidate 指令。
cache-extension	指定其他缓存指令的额外扩展。扩展可以是信息或行为。在标准指令上下文中指定了扩展指令，以便不了解扩展指令的应用程序可以遵循标准指令强制的行为。

12.4. 配置 Undertow 运行时

概述

HTTP 服务供应商和 HTTP 使用者使用 Undertow 运行时，利用分离的端点。可以配置运行时的线程池，您也可以通过 Undertow 运行时为 HTTP 服务提供商设置许多安全设置。

Maven 依赖项

如果您将 Apache Maven 用作构建系统，您可以通过在项目的 pom.xml 文件中包括以下依赖项，将 Undertow 运行时添加到您的项目中：

<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-transports-http-undertow</artifactId>
    <version>${cxf-version}</version>
</dependency>

命名空间

用于配置 Undertow 运行时的元素在命名空间 http://cxf.apache.org/transports/http-undertow/configuration 中定义。若要使用 Undertow 配置元素，您必须将例 12.14 “Undertow 运行时配置命名空间” 中显示的行添加到端点配置文件的 Bean 元素中。在本例中，为命名空间分配 httpu 前缀。另外，您必须将配置元素的命名空间添加到 xsi:schemaLocation 属性中。

例 12.14. Undertow 运行时配置命名空间

<beans ...
       xmlns:httpu="http://cxf.apache.org/transports/http-undertow/configuration"
       ...
       xsi:schemaLocation="...
                           http://cxf.apache.org/transports/http-undertow/configuration
                              http://cxf.apache.org/schemas/configuration/http-undertow.xsd
                          ...">

engine-factory 元素

httpu:engine-factory 元素是用于配置应用使用的 Undertow 运行时的根元素。它具有单个必需属性 总线，其值是管理所配置的 Undertow 实例的 总线 名称。

注意

该值通常是 cxf，这是默认 总线实例的名称。

http:engine-factory 元素有三个子项，其中包含用于配置由 Undertow 运行时工厂实例化的 HTTP 端口的信息。子项包括在表 12.7 “配置 Undertow 运行时工厂元素” 中。

表 12.7. 配置 Undertow 运行时工厂元素
element	描述
`httpu:engine`	指定特定 Undertow 运行时实例的配置。请参阅 “engine 元素”一节。
`httpu:identifiedTLSServerParameters`	指定用于保护 HTTP 服务提供商的可重用属性集。它有一个属性 `id`，它指定属性可以引用的唯一标识符。
`httpu:identifiedThreadingParameters`	指定用于控制 Undertow 实例的线程池的一组可重复使用的属性。它有一个属性 `id`，它指定属性可以引用的唯一标识符。请参阅 “配置线程池”一节。

engine 元素

httpu:engine 元素用于配置 Undertow 运行时的特定实例。它有一个属性 port，用于指定由 Undertow 实例管理的端口数量。

注意

您可以为 port 属性指定 0 值。httpu:engine 元素中指定的任何线程属性（其 port 属性设置为 0）都用作未明确配置的 Undertow 侦听器的配置。

每个 httpu:engine 元素都可以具有两个子项：一个用于配置安全属性，另一个用于配置 Undertow 实例的线程池。对于每种配置，您可以直接提供配置信息，也可以提供对父 httpu:engine-factory 元素中定义的一组配置属性的引用。

表 12.8 “配置 Undertow 运行时实例的元素” 描述用于提供配置属性的子元素。

表 12.8. 配置 Undertow 运行时实例的元素
element	描述
`httpu:tlsServerParameters`	指定一组属性，以配置用于特定 Undertow 实例的安全性。
`httpu:tlsServerParametersRef`	指的是由 `identifiedTLSServerParameters` 元素定义的一组安全属性。`id` 属性提供引用的 `TLSServerParameters` 元素的 id。
`httpu:threadingParameters`	指定特定 Undertow 实例使用的线程池的大小。请参阅 “配置线程池”一节。
`httpu:threadingParametersRef`	是指由 `确定的ThreadingParameters` 元素定义的一组属性。`id` 属性提供所 `识别的ThreadingParameters` 元素的 id。

配置线程池

您可以通过以下任一方式配置 Undertow 实例的线程池的大小：

使用 engine-factory 元素中的 identifiedThreadingParameters 元素指定线程池的大小。然后，您可以使用 threadingParametersRef 元素来引用这个元素。
使用 threadingParameters 元素直接指定线程池的大小。

threadingParameters 有两个属性来指定线程池的大小。属性在表 12.9 “配置 Undertow 线程池的属性” 中描述。

注意

httpu:identifiedThreadingParameters 元素具有单个子 线程Parameters 元素。

表 12.9. 配置 Undertow 线程池的属性
属性	描述
`workerIOThreads`	指定 worker 要创建的 I/O 线程数量。如果没有指定，则会选择 dafult 值。默认值为每个 CPU 内核的一个 I/O 线程。
`minThreads`	指定 Undertow 实例可用于处理请求的线程数量最少。
`maxThreads`	指定 Undertow 实例可用于处理请求的线程数上限。

示例

例 12.15 “配置 Undertow 实例” 显示配置片段，用于在端口号 9001 上配置 Undertow 实例。

例 12.15. 配置 Undertow 实例

<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:sec="http://cxf.apache.org/configuration/security"
  xmlns:http="http://cxf.apache.org/transports/http/configuration"
  xmlns:httpu="http://cxf.apache.org/transports/http-undertow/configuration"
  xmlns:jaxws="http://java.sun.com/xml/ns/jaxws"
  xsi:schemaLocation="http://cxf.apache.org/configuration/security
  		      http://cxf.apache.org/schemas/configuration/security.xsd
            http://cxf.apache.org/transports/http/configuration
            http://cxf.apache.org/schemas/configuration/http-conf.xsd
            http://cxf.apache.org/transports/http-undertow/configuration
            http://cxf.apache.org/schemas/configuration/http-undertow.xsd
            http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
  ...

  <httpu:engine-factory bus="cxf">
    <httpu:identifiedTLSServerParameters id="secure">
      <sec:keyManagers keyPassword="password">
        <sec:keyStore type="JKS" password="password"
                      file="certs/cherry.jks"/>
      </sec:keyManagers>
    </httpu:identifiedTLSServerParameters>

    <httpu:engine port="9001">
      <httpu:tlsServerParametersRef id="secure" />
      <httpu:threadingParameters minThreads="5"
                                 maxThreads="15" />
    </httpu:engine>
  </httpu:engine-factory>
 </beans>

12.5. 配置 Netty 运行时

概述

HTTP 服务供应商和 HTTP 用户使用 Netty 运行时，使用分离的端点。可以配置运行时的线程池，您还可以通过 Netty 运行时为 HTTP 服务提供商设置一些安全设置。

Maven 依赖项

如果您使用 Apache Maven 作为构建系统，您可以在项目的 pom.xml 文件中添加以下依赖项，将 Netty 运行时（用于定义 Web 服务端点）的服务器端实施添加到项目中：

<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-transports-http-netty-server</artifactId>
    <version>${cxf-version}</version>
</dependency>

您可以通过在项目的 pom.xml 文件中包括以下依赖项，将 Netty 运行时（用于定义 Web 服务客户端）的客户端实现添加到项目中：

<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-transports-http-netty-client</artifactId>
    <version>${cxf-version}</version>
</dependency>

命名空间

用于配置 Netty 运行时的元素在命名空间 http://cxf.apache.org/transports/http-netty-server/configuration 中定义。通常会使用前缀 httpn 来引用。要使用 Netty 配置元素，您必须将例 12.16 “Netty Runtime Configuration 命名空间” 中显示的行添加到端点配置文件的 Bean 元素中。另外，您必须将配置元素的命名空间添加到 xsi:schemaLocation 属性中。

例 12.16. Netty Runtime Configuration 命名空间

<beans ...
       xmlns:httpn="http://cxf.apache.org/transports/http-netty-server/configuration"
       ...
       xsi:schemaLocation="...
               http://cxf.apache.org/transports/http-netty-server/configuration
            http://cxf.apache.org/schemas/configuration/http-netty-server.xsd
               ...">

engine-factory 元素

httpn:engine-factory 元素是用于配置供应用使用的 Netty 运行时的根元素。它具有单个必需属性 总线，其值是管理所配置的 Netty 实例的 总线 的名称。

注意

该值通常是 cxf，这是默认 总线实例的名称。

httpn:engine-factory 元素有三个子项，其中包含用于配置由 Netty 运行时工厂实例化的 HTTP 端口的信息。子项包括在表 12.10 “配置 Netty Runtime Factory 的元素” 中。

表 12.10. 配置 Netty Runtime Factory 的元素
element	描述
`httpn:engine`	指定特定 Netty 运行时实例的配置。请参阅 “engine 元素”一节。
`httpn:identifiedTLSServerParameters`	指定用于保护 HTTP 服务提供商的可重用属性集。它有一个属性 `id`，它指定属性可以引用的唯一标识符。
`httpn:identifiedThreadingParameters`	指定控制 Netty 实例的线程池的可重用属性集合。它有一个属性 `id`，它指定属性可以引用的唯一标识符。请参阅 “配置线程池”一节。

engine 元素

httpn:engine 元素用于配置 Netty 运行时的特定实例。表 12.11 “配置 Netty Runtime 实例的属性” 显示 httpn:engine 元素支持的属性。

表 12.11. 配置 Netty Runtime 实例的属性
属性	描述
`port`	指定 Netty HTTP 服务器实例使用的端口。您可以为 port 属性指定 `0` 值。engine 元素中指定的任何线程属性及其 port `属性设置为` 0，作为未明确配置的 Netty 监听器的配置。
`主机`	指定 Netty HTTP 服务器实例使用的侦听地址。该值可以是主机名或 IP 地址。如果没有指定，Netty HTTP 服务器将侦听所有本地地址。
`readIdleTime`	指定 Netty 连接的最大读时时间。每当对底层流有任何读取操作时，会重置计时器。
`writeIdleTime`	指定 Netty 连接的最大写入空闲时间。每当对底层流有任何写入操作时，会重置计时器。
`maxChunkContentSize`	指定 Netty 连接的最大聚合内容大小。默认值为 10MB。

httpn:engine 元素具有一个用于配置安全属性的子元素，以及用于配置 Netty 实例的线程池的一个子元素。对于每种配置，您可以直接提供配置信息，也可以提供对父 httpn:engine-factory 元素中定义的一组配置属性的引用。

httpn:engine 支持的子元素显示在表 12.12 “配置 Netty Runtime 实例元素” 中。

表 12.12. 配置 Netty Runtime 实例元素
element	描述
`httpn:tlsServerParameters`	指定一组属性，用于配置用于特定 Netty 实例的安全性。
`httpn:tlsServerParametersRef`	指的是由 `identifiedTLSServerParameters` 元素定义的一组安全属性。`id` 属性提供引用的 `TLSServerParameters` 元素的 id。
`httpn:threadingParameters`	指定特定 Netty 实例使用的线程池的大小。请参阅 “配置线程池”一节。
`httpn:threadingParametersRef`	是指由 `确定的ThreadingParameters` 元素定义的一组属性。`id` 属性提供所 `识别的ThreadingParameters` 元素的 id。
`httpn:sessionSupport`	当 `true` 时，启用对 HTTP 会话的支持。默认为 `false`。
`httpn:reuseAddress`	指定设置 `ReuseAddress` TCP socket 选项的布尔值。默认为 `false`。

配置线程池

您可以通过以下任一方式配置 Netty 实例的线程池的大小：

使用 engine-factory 元素中的 identifiedThreadingParameters 元素指定线程池的大小。然后，您可以使用 threadingParametersRef 元素来引用这个元素。
使用 threadingParameters 元素直接指定线程池的大小。

threadingParameters 元素有一个属性来指定线程池的大小，如表 12.13 “配置 Netty Thread Pool 的属性” 所述。

注意

httpn:identifiedThreadingParameters 元素具有单个子 线程Parameters 元素。

表 12.13. 配置 Netty Thread Pool 的属性
属性	描述
`threadPoolSize`	指定 Netty 实例用于处理请求的线程数量。

示例

例 12.17 “配置 Netty 实例” 显示配置片段，用于配置各种 Netty 端口。

例 12.17. 配置 Netty 实例

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:beans="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:h="http://cxf.apache.org/transports/http/configuration"
       xmlns:httpn="http://cxf.apache.org/transports/http-netty-server/configuration"
       xmlns:sec="http://cxf.apache.org/configuration/security"
       xsi:schemaLocation="
        http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans.xsd
        http://cxf.apache.org/configuration/security
            http://cxf.apache.org/schemas/configuration/security.xsd
        http://cxf.apache.org/transports/http/configuration
            http://cxf.apache.org/schemas/configuration/http-conf.xsd
        http://cxf.apache.org/transports/http-netty-server/configuration
            http://cxf.apache.org/schemas/configuration/http-netty-server.xsd"
>
    ...
    <httpn:engine-factory bus="cxf">
       <httpn:identifiedTLSServerParameters id="sample1">
         <httpn:tlsServerParameters jsseProvider="SUN" secureSocketProtocol="TLS">
            <sec:clientAuthentication want="false" required="false"/>
         </httpn:tlsServerParameters>
       </httpn:identifiedTLSServerParameters>

       <httpn:identifiedThreadingParameters id="sampleThreading1">
          <httpn:threadingParameters threadPoolSize="120"/>
       </httpn:identifiedThreadingParameters>

       <httpn:engine port="9000" readIdleTime="30000" writeIdleTime="90000">
          <httpn:threadingParametersRef id="sampleThreading1"/>
       </httpn:engine>

       <httpn:engine port="0">
          <httpn:threadingParameters threadPoolSize="400"/>
       </httpn:engine>

       <httpn:engine port="9001" readIdleTime="40000" maxChunkContentSize="10000">
         <httpn:threadingParameters threadPoolSize="99" />
         <httpn:sessionSupport>true</httpn:sessionSupport>
       </httpn:engine>

       <httpn:engine port="9002">
         <httpn:tlsServerParameters>
           <sec:clientAuthentication want="true" required="true"/>
         </httpn:tlsServerParameters>
       </httpn:engine>

       <httpn:engine port="9003">
          <httpn:tlsServerParametersRef id="sample1"/>
       </httpn:engine>

    </httpn:engine-factory>
</beans>

12.6. 在拒绝模式中使用 HTTP 传输

概述

在普通的 HTTP 请求/响应情况下，将使用相同的 HTTP 连接发送请求和响应。服务提供商处理请求，并通过包含相应 HTTP 状态代码和响应内容的响应。如果请求成功，HTTP 状态代码被设置为 200。

在一些实例中，比如使用 WS-RM，或者当请求执行时会延长时间执行时，最好分离请求和响应消息。在这种情况下，服务提供商通过收到请求的 HTTP 连接后端将消费者发送 202 Accepted 响应到消费者。然后，它会使用新的分离的服务器→client HTTP 连接处理请求，并将响应发回到消费者。使用者运行时收到传入请求，并将其与适当的请求相关联，然后再返回到应用代码。

配置分离的交互

以分离模式使用 HTTP 传输需要进行以下操作：

将使用者配置为使用 WS-Addressing。
请参阅 “配置端点以使用 WS-Addressing”一节。
将使用者配置为使用分离的端点。
请参阅 “配置使用者”一节。
配置消费者与交互的任何服务提供商，以使用 WS-Addressing。
请参阅 “配置端点以使用 WS-Addressing”一节。

配置端点以使用 WS-Addressing

指定消费者以及使用 WS-Addressing 的任何服务提供商。

您可以通过以下两种方式之一指定端点使用 WS-Addressing：

将 wswa:UsingAddressing 元素添加到端点的 WSDL 端口 元素中，如例 12.18 “使用 WSDL 激活 WS-Address” 所示。

例 12.18. 使用 WSDL 激活 WS-Address

...
<service name="WidgetSOAPService">
  <port name="WidgetSOAPPort" binding="tns:WidgetSOAPBinding">
    <soap:address="http://widgetvendor.net/widgetSeller" />
    <wswa:UsingAddressing xmlns:wswa="http://www.w3.org/2005/02/addressing/wsdl"/>
  </port>
</service>
...

将 WS-Addressing 策略添加到端点的 WSDL 端口 元素中，如例 12.19 “使用策略激活 WS-Addressing” 所示。

例 12.19. 使用策略激活 WS-Addressing

...
<service name="WidgetSOAPService">
  <port name="WidgetSOAPPort" binding="tns:WidgetSOAPBinding">
    <soap:address="http://widgetvendor.net/widgetSeller" />
    <wsp:Policy xmlns:wsp="http://www.w3.org/2006/07/ws-policy"> <wsam:Addressing xmlns:wsam="http://www.w3.org/2007/02/addressing/metadata"> <wsp:Policy/> </wsam:Addressing> </wsp:Policy>
  </port>
</service>
...

注意

WS-Addressing 策略取代 wswa:UsingAddressing WSDL 元素。

配置使用者

使用 http-conf:conduit 元素的 DecoupledEndpoint 属性将消费者端点配置为使用分离的端点。

例 12.20 “将消费者配置为使用 Decoupled HTTP 端点” 显示设置例 12.18 “使用 WSDL 激活 WS-Address” 中定义的端点的配置，以使用分离的端点。现在，消费者在 http://widgetvendor.net/widgetSellerInbox 接收所有响应。

例 12.20. 将消费者配置为使用 Decoupled HTTP 端点

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:http="http://cxf.apache.org/transports/http/configuration"
       xsi:schemaLocation="http://cxf.apache.org/transports/http/configuration
                             http://cxf.apache.org/schemas/configuration/http-conf.xsd
                           http://www.springframework.org/schema/beans
                             http://www.springframework.org/schema/beans/spring-beans.xsd">

  <http:conduit name="{http://widgetvendor.net/services}WidgetSOAPPort.http-conduit">
    <http:client DecoupledEndpoint="http://widgetvendor.net:9999/decoupled_endpoint" />
  </http:conduit>
</beans>

如何处理消息

在分离模式中使用 HTTP 传输会增加处理 HTTP 消息的复杂层。虽然在应用中的实施级别代码增加了复杂性是透明的，但了解调试原因的原因可能很重要。

图 12.1 “中用于已拒绝的 HTTP 传输的消息流” 显示在分离模式中使用 HTTP 时的消息流。

图 12.1. 中用于已拒绝的 HTTP 传输的消息流

请求会启动以下过程：

使用者实施调用操作，并且生成请求消息。
WS-Addressing 层将 WS-A 标头添加到消息。
当在消费者配置中指定分离端点时，分离的端点的地址将放入 WS-A ReplyTo 标头中。
消息发送到服务提供程序。
服务提供商接收消息。
来自消费者的请求消息被分配到供应商的 WS-A 层。
因为 WS-A ReplyTo 标头没有设置为 anonymous，因此该提供程序将 HTTP 状态代码发回为 202，确认已收到该请求。
HTTP 层使用原始连接的 back-channel 将 202 Accepted 消息发回到使用者。
使用者接收了用于发送原始消息的 HTTP 连接的 202 Accepted reply。
当消费者收到 202 Accepted 回复时，HTTP 连接会关闭。
该请求将传递到处理请求的服务提供商的实施。
当响应就绪时，它将被分配给 WS-A 层。
WS-A 层将 WS-Addressing 标头添加到响应消息。
HTTP 传输将响应发送到消费者的分离端点。
消费者的分离端点从服务提供商接收响应。
响应被分配到消费者的 WS-A 层，使用 WS-AlatesTo 标头将其与正确的请求关联。
相关响应返回给客户端实施，调用调用将被取消阻塞。

第 13 章使用 SOAP Over JMS

摘要

Apache CXF 实施 W3C 标准 SOAP/JMS 传输。这个标准旨在为 SOAP/HTTP 服务提供更强大的替代方法。使用这个传输的 Apache CXF 应用程序应该能够与实施 SOAP/JMS 标准的应用程序交互。传输在端点的 WSDL 中直接配置。

注意：在 CXF 3.0 中删除了对 JMS 1.0.2 API 的支持。如果您使用红帽JBoss Fuse 6.2 或更高版本（包括 CXF 3.0），您的 JMS 提供程序必须支持 JMS 1.1 API。

13.1. 基本配置

概述

JMS 协议的 SOAP 由全球 Wide Web Consortium (W3C)定义为为大部分服务使用的自定义ary SOAP/HTTP 协议提供更可靠的传输层的方法。Apache CXF 实现与规范完全兼容，并且应与还合规的任何框架兼容。

此传输使用 JNDI 来查找 JMS 目的地。调用操作时，该请求将打包为 SOAP 消息，并在 JMS 消息的正文中发送到指定的目的地。

使用 SOAP/JMS 传输：

指定传输类型是 SOAP/JMS。
使用 JMS URI 指定目标目的地。
另外，还可配置 JNDI 连接。
（可选）添加额外的 JMS 配置。

指定 JMS 传输类型

您会将 SOAP 绑定配置为在指定 WSDL 绑定时使用 JMS 传输。您可以将 soap:binding 元素的 transport 属性设置为 http://www.w3.org/2010/soapjms/。例 13.1 “使用 JMS 绑定规格的 SOAP” 显示使用 SOAP/JMS 的 WSDL 绑定。

例 13.1. 使用 JMS 绑定规格的 SOAP

<wsdl:binding ... >
  <soap:binding style="document"
                transport="http://www.w3.org/2010/soapjms/" />
  ...
</wsdl:binding>

指定目标目的地

在为端点指定 WSDL 端口时，可以指定 JMS 目标目的地的地址。SOAP/JMS 端点的地址规格使用与 SOAP/HTTP 端点相同的 soap:address 元素和属性。区别在于地址规格。JMS 端点使用 JMS URI，如 JMS 1.0 的 URI Scheme 中定义的。例 13.2 “JMS URI 语法” 显示 JMS URI 的语法。

例 13.2. JMS URI 语法

jms:variant:destination?options

表 13.1 “JMS URI 变体” 描述 JMS URI 的可用变体。

表 13.1. JMS URI 变体
变体	描述
jndi	指定目的地名称是 JNDI 队列名称。使用这种变体时，您必须提供用于访问 JNDI 供应商的配置。
jndi-topic	指定目的地名称是 JNDI 主题名称。使用这种变体时，您必须提供用于访问 JNDI 供应商的配置。
队列	指定目的地是使用 JMS 解析的队列名称。提供的字符串传递到 `Session.createQueue （）`，以创建目的地表示。
topic	指定目的地是使用 JMS 解析的主题名称。提供的字符串传递到 `Session.createTopic （）`，以创建目的地表示。

JMS URI 的选项 部分用于配置传输，并在第 13.2 节 “JMS URI” 中进行讨论。

例 13.3 “SOAP/JMS 端点地址” 显示用于使用 JNDI 检查目标目的地的 SOAP/JMS 端点的 WSDL 端口条目。

例 13.3. SOAP/JMS 端点地址

<wsdl:port ... >
  ...
  <soap:address location="jms:jndi:dynamicQueues/test.cxf.jmstransport.queue" />
</wsdl:port>

配置 JNDI 和 JMS 传输

SOAP/JMS 提供了多种方法来配置 JNDI 连接和 JMS 传输：

第 13.2 节 “JMS URI”
第 13.3 节 “WSDL 扩展”

13.2. JMS URI

概述

使用 SOAP/JMS 时，使用 JMS URI 指定端点的目标目的地。JMS URI 也可用于配置 JMS 连接，方法是在 URI 中附加一个或多个选项。这些选项在 IETF 标准中详述，Java Message Service 1.0 的 URI Scheme 进行了详细介绍。它们可用于配置 JNDI 系统、回复目的地、要使用的交付模式，以及其他 JMS 属性。

语法

如例 13.4 “JMS URI 选项的语法” 所示，您可以通过使用问号(?)将它们与目标地址分开，在 JMS URI 的末尾附加一个或多个选项。多个选项由符号( 和 )分开。例 13.4 “JMS URI 选项的语法” 显示在 JMS URI 中使用多个选项的语法。

例 13.4. JMS URI 选项的语法

jms:variant:jmsAddress?option1=value1&option2=value2&_optionN_=valueN

JMS 属性

表 13.2 “JMS 属性设置为 URI 选项” 显示影响 JMS 传输层的 URI 选项。

表 13.2. JMS 属性设置为 URI 选项
属性	默认	描述
`conduitIdSelectorPrefix`		[可选] 是一个字符串值，前缀为 conduit 创建的所有关联 ID。选择器可以使用它来监听回复。
`deliveryMode`	`PERSISTENT`	指定是否使用 JMS `PERSISTENT` 或 `NON_PERSISTENT` 消息语义。对于 `PERSISTENT` delivery 模式，JMS 代理在确认信息前将消息存储在持久存储中，而 `NON_PERSISTENT` 消息仅保存在内存中。
`durableSubscriptionClientID`		[可选] 指定连接的客户端标识符。此属性用于将连接与提供程序代表客户端维护的状态相关联。这可让带有同一身份的后续订阅者恢复其前面订阅的状态。
`durableSubscriptionName`		[可选] 指定订阅的名称。
`messageType`	`byte`	指定 CXF 使用的 JMS 消息类型。有效值为： byte text binary
`password`		[可选] 指定创建连接的密码。不建议将此属性附加到 URI。
`priority`	`4`	指定 JMS 消息优先级，范围从 0 （最低）到 9 （最高）。
`receiveTimout`	`60000`	指定时间，以毫秒为单位，在使用请求/重新交换时，客户端会等待回复。
`reconnectOnException`	`true`	[弃用在 CXF 3.0] 中，指定在出现异常时传输是否应重新连接。从 3.0 开始，传输会在异常发生时始终重新连接。
`replyToName`		[可选] 指定队列消息的回复目的地。回复目的地会出现在 `JMSReplyTo` 标头中。对于具有请求语义的应用程序，建议设置此属性，因为 JMS 提供程序将在没有指定临时回复队列时分配临时回复队列。此属性的值根据 JMS URI 中指定的变体进行解释： `JNDI` 变体 - 由 JNDI 解析的目的地队列的名称 `队列` 变体 - 使用 JMS 解析的目的地队列的名称
`sessionTransacted`	`false`	指定事务类型。有效值为： `true`-resource 本地事务 `false`-JTA 事务
`timeToLive`	`0`	指定 JMS 提供程序丢弃消息的时间（以毫秒为单位）。`0` 代表一个无限生命周期。
`topicReplyToName`		[可选] 指定主题消息的回复目的地。此属性的值根据 JMS URI 中指定的变体进行解释： `JNDI-topic`- 由 JNDI 解析的目标主题的名称 `topic`- 由 JMS 解析的目标主题的名称
`useConduitIdSelector`	`true`	指定 conduit 的 UUID 将用作所有关联 ID 的前缀。由于所有 conduit 都分配有唯一 UUID，请将此属性设置为 `true` 可启用多个端点来共享 JMS 队列或主题。
`username`		[可选] 指定用于创建连接的用户名。

JNDI 属性

表 13.3 “JNDI 属性 settable 作为 URI 选项” 显示可用于配置此端点 JNDI 的 URI 选项。

表 13.3. JNDI 属性 settable 作为 URI 选项
属性	描述
`jndiConnectionFactoryName`	指定 JMS 连接工厂的 JNDI 名称。
`jndiInitialContextFactory`	指定 JNDI 提供程序的完全限定 Java 类名称（必须是 `javax.jms.InitialContextFactory` 类型）。等同于设置 `java.naming.factory.initial` Java 系统属性。
`jndiTransactionManagerName`	指定在 Spring、Blueprint 或 JNDI 中搜索的 JTA 事务管理器的名称。如果找到事务管理器，将启用 JTA 事务。请参阅 `sessionTransacted` JMS 属性。
`jndiURL`	指定初始化 JNDI 供应商的 URL。等同于设置 `java.naming.provider.url` Java 系统属性。

其他 JNDI 属性

属性 java.naming.factory.initial 和 java.naming.provider.url 是标准属性，这是初始化任何 JNDI 提供程序所必需的。但有些时候，JNDI 供应商除标准供应商外还可能支持自定义属性。在这种情况下，您可以通过设置 jndi-PropertyName 格式的 URI 选项来设置任意 JNDI 属性。

例如，如果您使用 SUN 的 LDAP 实施 JNDI，您可以设置 JNDI 属性 java.naming.factory.control，在 JMS URI 中，如例 13.5 “在 JMS URI 中设置 JNDI 属性” 所示。

例 13.5. 在 JMS URI 中设置 JNDI 属性

jms:queue:FOO.BAR?jndi-java.naming.factory.control=com.sun.jndi.ldap.ResponseControlFactory

示例

如果尚未配置 JMS 提供程序，则可以使用选项在 URI 中提供必需的 JNDI 配置详情（请参阅表 13.3 “JNDI 属性 settable 作为 URI 选项”）。例如，若要将端点配置为使用 Apache ActiveMQ JMS 提供程序并连接到名为 test.cxf.jmstransport.queue 的队列，请使用例 13.6 “配置 JNDI 连接的 JMS URI” 中显示的 URI。

例 13.6. 配置 JNDI 连接的 JMS URI

jms:jndi:dynamicQueues/test.cxf.jmstransport.queue
?jndiInitialContextFactory=org.apache.activemq.jndi.ActiveMQInitialContextFactory
&jndiConnectionFactoryName=ConnectionFactory
&jndiURL=tcp://localhost:61616

发布服务

JAX-WS 标准 发布（） 方法无法用于发布 SOAP/JMS 服务。反之，您必须使用 Apache CXF 的 JaxWsServerFactoryBean 类，如例 13.7 “发布 SOAP/JMS 服务” 所示。

例 13.7. 发布 SOAP/JMS 服务

String address = "jms:jndi:dynamicQueues/test.cxf.jmstransport.queue3"
    + "?jndiInitialContextFactory"
    + "=org.apache.activemq.jndi.ActiveMQInitialContextFactory"
    + "&jndiConnectionFactoryName=ConnectionFactory"
    + "&jndiURL=tcp://localhost:61500";
Hello implementor = new HelloImpl();
JaxWsServerFactoryBean svrFactory = new JaxWsServerFactoryBean();
svrFactory.setServiceClass(Hello.class);
svrFactory.setAddress(address);
svrFactory.setTransportId(JMSSpecConstants.SOAP_JMS_SPECIFICIATION_TRANSPORTID);
svrFactory.setServiceBean(implementor);
svrFactory.create();

例 13.7 “发布 SOAP/JMS 服务” 中的代码执行以下操作：

创建代表端点地址的 JMS URI。

将 JaxWsServerFactoryBean 实例化以发布服务。

使用服务的 JMS URI 设置 factory bean 的 address 字段。

指定工厂创建的服务将使用 SOAP/JMS 传输。

消耗服务

标准 JAX-WS API 无法用于使用 SOAP/JMS 服务。反之，您必须使用 Apache CXF 的 JaxWsProxyFactoryBean 类，如例 13.8 “使用 SOAP/JMS 服务” 所示。

例 13.8. 使用 SOAP/JMS 服务

// Java
public void invoke() throws Exception {
    String address = "jms:jndi:dynamicQueues/test.cxf.jmstransport.queue3"
        + "?jndiInitialContextFactory"
        + "=org.apache.activemq.jndi.ActiveMQInitialContextFactory"
        + "&jndiConnectionFactoryName=ConnectionFactory&jndiURL=tcp://localhost:61500";
    JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
    factory.setAddress(address);
    factory.setTransportId(JMSSpecConstants.SOAP_JMS_SPECIFICIATION_TRANSPORTID);
    factory.setServiceClass(Hello.class);
    Hello client = (Hello)factory.create();
    String reply = client.sayHi(" HI");
    System.out.println(reply);
}

例 13.8 “使用 SOAP/JMS 服务” 中的代码执行以下操作：

创建代表端点地址的 JMS URI。

将 JaxWsProxyFactoryBean 实例化以创建代理。

使用服务的 JMS URI 设置 factory bean 的 address 字段。

指定工厂创建的代理将使用 SOAP/JMS 传输。

13.3. WSDL 扩展

概述

您可以在合同中插入 WSDL 扩展元素（在绑定范围、服务范围或端口范围）来指定 JMS 传输的基本配置。WSDL 扩展允许您指定引导 JNDI InitialContext 的属性，然后可以用来查找 JMS 目的地。您还可以设置一些影响 JMS 传输层行为的属性。

SOAP/JMS 命名空间

SOAP/JMS WSDL 扩展在 http://www.w3.org/2010/soapjms/ 命名空间中定义。要在 WSDL 合同中使用它们，请在 wsdl:definitions 元素中添加以下设置：

<wsdl:definitions ...
    xmlns:soapjms="http://www.w3.org/2010/soapjms/"
  ... >

WSDL 扩展元素

表 13.4 “SOAP/JMS WSDL 扩展元素” 显示可用于配置 JMS 传输的所有 WSDL 扩展元素。

表 13.4. SOAP/JMS WSDL 扩展元素
element	默认	描述
`soapjms:jndiInitialContextFactory`		指定 JNDI 提供程序的完全限定 Java 类名称。等同于设置 `java.naming.factory.initial` Java 系统属性。
`soapjms:jndiURL`		指定初始化 JNDI 供应商的 URL。等同于设置 `java.naming.provider.url` Java 系统属性。
`soapjms:jndiContextParameter`		指定用于创建 JNDI `InitialContext` 的额外属性。使用 `name` 和 `value` 属性来指定属性。
`soapjms:jndiConnectionFactoryName`		指定 JMS 连接工厂的 JNDI 名称。
`soapjms:deliveryMode`	`PERSISTENT`	指定是否使用 JMS `PERSISTENT` 或 `NON_PERSISTENT` 消息语义。对于 `PERSISTENT` delivery 模式，JMS 代理在确认信息前将消息存储在持久存储中，而 `NON_PERSISTENT` 消息仅保存在内存中。
`soapjms:replyToName`		[可选] 指定队列消息的回复目的地。回复目的地会出现在 `JMSReplyTo` 标头中。对于具有请求语义的应用程序，建议设置此属性，因为 JMS 提供程序将在没有指定临时回复队列时分配临时回复队列。此属性的值根据 JMS URI 中指定的变体进行解释： `JNDI` 变体 - 由 JNDI 解析的目的地队列的名称 `队列` 变体 - 使用 JMS 解析的目的地队列的名称
`soapjms:priority`	`4`	指定 JMS 消息优先级，范围从 0 （最低）到 9 （最高）。
`soapjms:timeToLive`	`0`	JMS 提供程序丢弃消息的时间（以毫秒为单位）。`0` 代表一个无限生命周期。

配置范围

WSDL 合同中的 WSDL 元素会影响对合同中定义的端点更改的范围。SOAP/JMS WSDL 元素可以放在 wsdl:binding 元素、wsdl:service 元素或 wsdl:port 元素的子项。SOAP/JMS 元素的父项决定配置要放入哪些范围。

绑定范围: 您可以通过在 wsdl: binding 元素中放置扩展元素，在绑定范围内 配置 JMS 传输。此范围内的元素定义使用该绑定的所有端点的默认配置。绑定范围内的所有设置都可以在服务范围或端口范围中覆盖。
服务范围: 您可以通过将扩展元素放入 wsdl: service 元素，在服务范围内 配置 JMS 传输。此范围内的元素定义此服务中的所有端点的默认配置。服务范围内的任何设置都可以在端口范围内覆盖。
端口范围: 您可以通过将扩展元素放入 wsdl: port 元素，在端口范围内 配置 JMS 传输。端口范围中的元素定义此端口的配置。它们覆盖服务范围或绑定范围中定义的相同扩展元素的默认值。

示例

例 13.9 “带有 SOAP/JMS 配置的 WSDL 合同” 显示 SOAP/JMS 服务的 WSDL 合同。它会在绑定范围内配置 JNDI 层、服务范围内的消息传送详细信息，以及端口范围内的回复目的地。

例 13.9. 带有 SOAP/JMS 配置的 WSDL 合同

<wsdl:definitions ...
    xmlns:soapjms="http://www.w3.org/2010/soapjms/"
  ... >
  ...
  <wsdl:binding name="JMSGreeterPortBinding" type="tns:JMSGreeterPortType">
    ...
    <soapjms:jndiInitialContextFactory>
      org.apache.activemq.jndi.ActiveMQInitialContextFactory
    </soapjms:jndiInitialContextFactory>
    <soapjms:jndiURL>tcp://localhost:61616</soapjms:jndiURL>
    <soapjms:jndiConnectionFactoryName>
      ConnectionFactory
    </soapjms:jndiConnectionFactoryName>
    ...
  </wsdl:binding>
  ...
  <wsdl:service name="JMSGreeterService">
    ...
    <soapjms:deliveryMode>NON_PERSISTENT</soapjms:deliveryMode>
    <soapjms:timeToLive>60000</soapjms:timeToLive>
    ...
    <wsdl:port binding="tns:JMSGreeterPortBinding" name="GreeterPort">
      <soap:address location="jms:jndi:dynamicQueues/test.cxf.jmstransport.queue" />
      <soapjms:replyToName>
        dynamicQueues/greeterReply.queue
      </soapjms:replyToName>
      ...
    </wsdl:port>
    ...
  </wsdl:service>
  ...
</wsdl:definitions>

例 13.9 “带有 SOAP/JMS 配置的 WSDL 合同” 中的 WSDL 执行以下操作：

为 SOAP/JMS 扩展声明命名空间。

在绑定范围内配置 JNDI 连接。

将 JMS 交付方式设置为非持久性，并将每条消息设置为 live （一分钟）。

指定目标目的地。

配置 JMS 传输，以便回复消息在greeter Reply.queue 队列 上发送。

第 14 章使用通用 JMS

摘要

Apache CXF 提供 JMS 传输的通用实施。通用 JMS 传输不仅限于使用 SOAP 消息，并允许连接到使用 JMS 的任何应用程序。

注意：在 CXF 3.0 中删除了对 JMS 1.0.2 API 的支持。如果您使用红帽JBoss Fuse 6.2 或更高版本（包括 CXF 3.0），您的 JMS 提供程序必须支持 JMS 1.1 API。

14.1. 配置 JMS 的方法

Apache CXF 通用 JMS 传输可以连接到任何 JMS 提供程序，并与通过 TextMessage 或 ByteMessage 交换 JMS 消息的应用程序一起工作。

启用和配置 JMS 传输方法有两种：

第 14.2 节 “使用 JMS 配置 bean”
第 14.5 节 “使用 WSDL 配置 JMS”

14.2. 使用 JMS 配置 bean

概述

为简化 JMS 配置并使其强大，Apache CXF 使用单一 JMS 配置 Bean 配置 JMS 端点。bean 通过 org.apache.cxf.transport.jms.JMSConfiguration 类来实施。它可用于直接配置端点，或者配置 JMS conduits 和目的地。

配置命名空间

JMS 配置 bean 使用 Spring p-namespace 尽可能简单。要使用这个命名空间，您需要在配置的根元素中声明它，如例 14.1 “声明 Spring p-namespace” 所示。

例 14.1. 声明 Spring p-namespace

<beans ...
  xmlns:p="http://www.springframework.org/schema/p"
  ... >
  ...
</beans>

指定配置

您可以通过定义 bean 类 org.apache.cxf.transport.jms.JMSConfiguration 来指定 JMS 配置。Bean 的属性提供传输的配置设置。

重要

在 CXF 3.0 中，JMS 传输不再依赖于 Spring JMS，因此删除了一些 Spring JMS 相关的选项。

表 14.1 “常规 JMS 配置属性” 列出提供商和消费者常用的属性。

表 14.1. 常规 JMS 配置属性
属性	默认	描述
`connectionFactory`		[required] 指定定义 JMS ConnectionFactory 的 bean 的引用。
`wrapInSingleConnectionFactory`	`true` [pre v3.0]	在 CXF 3.0 中删除 pre CXF 3.0 指定是否将 ConnectionFactory 替换为 Spring `SingleConnectionFactory`。在使用不含池连接的 ConnectionFactory 时启用此属性，因为它将提高 JMS 传输的性能。因此，因为 JMS 传输为每个消息创建一个新连接，并且 `SingleConnectionFactory` 需要缓存连接，因此可以重复使用它。
`reconnectOnException`	`false`	在 CXF 3.0 CXF 中已弃用，总是在异常时重新连接。 pre CXF 3.0 指定在出现异常时是否创建新连接。使用 Spring `SingleConnectionFactory` 嵌套 ConnectionFactory 时： `true` TOKEN-TOKENon a exception, 创建新连接在使用 PooledConnectionFactory 时不要启用这个选项，因为这个选项只返回池的连接，但不会重新连接。例外情况为 `false` 的 TOKEN- lpron，不要尝试重新连接
`targetDestination`		指定目的地的 JNDI 名称或特定于提供程序的名称。
`replyDestination`		指定发送回复的 JMS 目的地的 JMS 名称。此属性允许使用用户定义的目的地进行回复。详情请查看第 14.6 节 “使用 Named Reply Destination”。
`destinationResolver`	DynamicDestinationResolver	指定 Spring `DestinationResolver` 的引用。通过此属性，您可以定义目标名称如何解析为 JMS 目的地。有效值为： `使用 JMS 提供程序的功能，DestinationResolver` solv-resolve 目的地名称。使用 JNDI 进行 `JndiDestinationResolver` WWN-resolve 目的地名称。
`transactionManager`		指定 Spring 事务管理器的引用。这使得该服务能够参与 JTA 事务。
`taskExecutor`	`SimpleAsyncTaskExecutor`	在 CXF 3.0 中删除 pre CXF 3.0 指定对 Spring TaskExecutor 的引用。这用于监听器来确定如何处理传入的信息。
`useJms11`	`false`	在 CXF 3.0 中删除，CXF 3.0 仅支持 JMS 1.1 功能。 pre CXF 3.0 指定是否使用 JMS 1.1 功能。有效值为： `true` TOKEN-JMSJMS 1.1 功能 `false` — JMS 1.0.2 features
`messageIdEnabled`	`true`	在 CXF 3.0 中删除 pre CXF 3.0 指定 JMS 传输是否希望 JMS 代理来提供消息 ID。有效值为： `true` containerruntime-keyringbroker 需要提供消息 ID `false` WWN-broker 需要提供消息 ID 在本例中，端点将调用消息 producer 的 `setDisableMessageID （）` 方法，值为 `true`。然后，为代理提供一个提示，它不需要生成消息 ID，或将其添加到端点的消息中。代理可以接受 hint 或忽略它。
`messageTimestampEnabled`	`true`	在 CXF 3.0 中删除 pre CXF 3.0 指定 JMS 传输是否希望 JMS 代理提供消息时间戳。有效值为： `true` WWN-keyringbroker 需要提供消息时间戳 `false` 的 WWN-BUFFERbroker 不需要提供消息时间戳在本例中，端点将调用消息 producer 的 `setDisableMessageTimestamp （）` 方法，值为 `true`。然后，为代理提供一个提示，它不需要生成时间戳或将其添加到端点的消息中。代理可以接受 hint 或忽略它。
`cacheLevel`	`-1 (` 禁用功能)	在 CXF 3.0 中删除 pre CXF 3.0 指定 JMS 侦听器容器可以应用的缓存级别。有效值为： `0` — CACHE_NONE `1` — CACHE_CONNECTION `2` — CACHE_SESSION `3` — CACHE_CONSUMER `4` — CACHE_AUTO 详情请参阅 Class DefaultMessageListenerContainer
`pubSubNoLocal`	`false`	指定在使用主题时是否接收您自己的消息。 `true` TOKEN- lprdo 没有接收您自己的信息 `false` WWN-receive 您自己的消息
`receiveTimeout`	`60000`	指定响应消息的时间（毫秒）。
`explicitQosEnabled`	`false`	指定是否明确为每条消息(`true`)或默认值(`false`)设置 QoS 设置（如 priority、persistent 和 time to live）。
`deliveryMode`	`2`	指定消息是否持久。有效值为： `1 (` NON_PERSISTENT)-messages 只保留内存 `2` (PERSISTENT)-messages 会保留给磁盘
`priority`	`4`	指定消息优先级。JMS 优先级值范围从 `0 (` 最低)到 `9` （最高）。详情请参阅您的 JMS 供应商的文档。
`timeToLive`	`0` (indefinitely)	在丢弃了消息之前，以毫秒为单位指定时间。
`sessionTransacted`	`false`	指定是否使用 JMS 事务。
`concurrentConsumers`	`1`	在 CXF 3.0 中删除 pre CXF 3.0 指定监听器的最小并发用户数量。
`maxConcurrentConsumers`	`1`	在 CXF 3.0 中删除 pre CXF 3.0 指定监听器的最大并发用户数量。
`messageSelector`		指定用于过滤传入消息的选择器的字符串值。这个属性可让多个连接共享一个队列。如需有关用于指定消息选择器的语法的更多信息，请参阅 JMS 1.1 规范。
`subscriptionDurable`	`false`	指定服务器是否使用 durable 订阅。
`durableSubscriptionName`		指定用于注册持久订阅的名称（字符串）。
`messageType`	`text`	指定消息数据将如何打包为 JMS 消息。有效值为： `text` WWN-WWNspec 表示该数据将打包为 `文本消息` `byte` horizon-encryptspec 表示数据将打包为一个字节数组(`byte[]`) `二进制` WWN-WWNspec 表示该数据将打包为一个 `ByteMessage`
`pubSubDomain`	`false`	指定目标目的地是主题还是一个队列。有效值为： `true` ALLOW-topictopic `false` — queue
`jmsProviderTibcoEms`	`false`	指定 JMS 提供程序是否为 Tibco EMS。当设置为 `true` 时，安全性上下文中的主体会填充来自 `JMS_TIBCO_SENDER` 标头。
`useMessageIDAsCorrelationID`	`false`	在 CXF 3.0 中删除指定 JMS 是否将使用消息 ID 来关联消息。当设置为 `true` 时，客户端会设置生成的关联 ID。
`maxSuspendedContinuations`	`-1 (` 禁用功能)	CXF 3.0 指定 JMS 目标可能具有的最大暂停数。当当前数量超过指定的最大值时，JMSListenerContainer 将停止。
`reconnectPercentOfMax`	`70`	CXF 3.0 指定在超过 `maxSuspendedContinuations` 时重启 JMSListenerContainer 停止的时间。当其当前暂停的延续数低于的值时 `(maxSuspendedContinuations * reconnectPercentOfMax/100)，则监听器容器将重启`。

如例 14.2 “JMS 配置 bean” 所示，bean 的属性被指定为 bean 元素的属性。它们都在 Spring p 命名空间中声明。

例 14.2. JMS 配置 bean

<bean id="jmsConfig"
      class="org.apache.cxf.transport.jms.JMSConfiguration"
      p:connectionFactory="jmsConnectionFactory"
      p:targetDestination="dynamicQueues/greeter.request.queue"
      p:pubSubDomain="false" />

将配置应用到端点

JMSConfiguration bean 可以使用 Apache CXF 功能机制直接应用于服务器和客户端端点。要做到这一点：

将端点的 address 属性设置为 jms://。
将 jaxws:feature 元素添加到端点的配置。
向功能添加 bean 类型的 org.apache.cxf.transport.jms.JMSConfigFeature。
将 bean 元素的 p:jmsConfig-ref 属性设置为 JMSConfiguration bean 的 ID。

例 14.3 “将 JMS 配置添加到 JAX-WS 客户端” 显示使用来自例 14.2 “JMS 配置 bean” 的 JMS 配置的 JAX-WS 客户端。

例 14.3. 将 JMS 配置添加到 JAX-WS 客户端

<jaxws:client id="CustomerService"
              xmlns:customer="http://customerservice.example.com/"
              serviceName="customer:CustomerServiceService"
              endpointName="customer:CustomerServiceEndpoint"
              address="jms://"
              serviceClass="com.example.customerservice.CustomerService">
  <jaxws:features>
    <bean xmlns="http://www.springframework.org/schema/beans"
          class="org.apache.cxf.transport.jms.JMSConfigFeature"
          p:jmsConfig-ref="jmsConfig"/>
  </jaxws:features>
</jaxws:client>

将配置应用到传输

JMSConfiguration bean 可以使用 jms:jmsConfig-ref 元素应用到 JMS conduits 和 JMS 目的地。jms:jmsConfig-ref 元素的值是 JMSConfiguration bean 的 ID。

例 14.4 “在 JMS conduit 中添加 JMS 配置” 显示使用例 14.2 “JMS 配置 bean” 中的 JMS 配置的 JMS conduit。

例 14.4. 在 JMS conduit 中添加 JMS 配置

<jms:conduit name="{http://cxf.apache.org/jms_conf_test}HelloWorldQueueBinMsgPort.jms-conduit">
  ...
  <jms:jmsConfig-ref>jmsConf</jms:jmsConfig-ref>
</jms:conduit>

14.3. 优化客户端 - 通过防火墙 JMS 性能

概述

两种主要设置会影响客户端的 JMS 性能：池和同步接收。

池

在客户端一端，CXF 会为每条消息创建一个新的 JMS 会话和 JMS producer。因此，因为 session 和 producer 对象都不安全。创建制作者特别要花费大量时间，因为它需要与服务器通信。

池连接工厂通过缓存连接、会话和制作者来提高性能。

对于 ActiveMQ，配置池是简单的；例如：

import org.apache.activemq.ActiveMQConnectionFactory;
import org.apache.activemq.pool.PooledConnectionFactory;

ConnectionFactory cf = new ActiveMQConnectionFactory("tcp://localhost:61616");
PooledConnectionFactory pcf = new PooledConnectionFactory();

//Set expiry timeout because the default (0) prevents reconnection on failure
pcf.setExpiryTimeout(5000);
pcf.setConnectionFactory(cf);

JMSConfiguration jmsConfig = new JMSConfiguration();

jmsConfig.setConnectionFactory(pdf);

有关共用的更多信息，请参阅 Red Hat JBoss Fuse 事务指南中的"Appendix A Optimizing Performance of JMS Single- and Multiple-Resource Transactions"。

避免同步接收

对于请求/重新交换，JMS 传输会发送请求，然后等待回复。在可能的情况下，使用 JMS MessageListener 以异步方式实施请求/回复。

但是，当 CXF 需要共享端点之间的队列时，CXF 必须使用 synchronous Consumer.receive （） 方法。此场景需要 MessageListener 来使用消息选择器来过滤消息。邮件选择器必须提前已知，因此 MessageListener 只只打开一次。

应该避免避免出现消息选择器的两种情况：

当将 JMSMessageID 用作 JMSCorrelationID时
如果 JMS 属性使用ConduitIdSelector 和 conduitSelectorPrefix，则客户端不会设置 JMSCorrelationId。这会导致服务器使用 JMSMessageId 请求的消息作为 JMSCorrelationId。由于 JMSMessageID 无法事先知道，客户端必须使用同步的 Consumer.receive （） 方法。
请注意，您必须将 Consumer.receive （） 方法用于 IBM JMS 端点（默认）。
用户在请求消息中设置 JMStype，然后设置自定义 JMSCorrelationID。
同样，因为无法事先知道自定义 JMSCorrelationID，客户端必须使用同步的 Consumer.receive （） 方法。

因此，常规规则是避免使用需要同步接收的设置。

14.4. 配置 JMS 事务

概述

CXF 3.0 在使用单向消息传递时支持 CXF 端点上的本地 JMS 事务和 JTA 事务。

本地事务

只有在发生异常时，使用本地资源的事务才会回滚 JMS 消息。它们不会直接协调其他资源，如数据库事务。

要设置本地事务，请将端点配置为您通常会将属性 sessionTrasnsacted 设置为 true。

注意

有关事务和池的更多信息，请参阅 Red Hat JBoss Fuse 事务指南。

JTA 事务

使用 JTA 事务时，您可以协调任意数量的 XA 资源。如果为 JTA 事务配置了 CXF 端点，它会在调用服务实施前启动事务。如果没有异常，交易将被提交。否则，它将回滚。

在 JTA 事务中，使用 JMS 消息并写入数据库的数据。发生异常时，两个资源都会回滚，因此信息会被消耗，并且数据写入数据库，或者消息将被回滚，数据也不会写入数据库。

配置 JTA 事务需要两个步骤：

定义事务管理器

bean 方法

定义事务管理器

<bean id="transactionManager"
   class="org.apache.geronimo.transaction.manager.GeronimoTransactionManager"/>

在 JMS URI 中设置事务管理器的名称
```
jms:queue:myqueue?jndiTransactionManager=TransactionManager
```
这个示例发现一个 ID 为 TransactionManager 的 bean。

OSGi 参考方法
- 使用 Blueprint 将事务管理器作为 OSGi 服务中查找
```
<reference id="TransactionManager" interface="javax.transaction.TransactionManager"/>
```
- 在 JMS URI 中设置事务管理器的名称
```
jms:jndi:myqueue?jndiTransactionManager=java:comp/env/TransactionManager
```
  本例在 JNDI 中查找事务管理器。

配置 JCA 池的连接工厂
使用 Spring 定义 JCA 池的连接工厂：
```
<bean id="xacf" class="org.apache.activemq.ActiveMQXAConnectionFactory">
  <property name="brokerURL" value="tcp://localhost:61616" />
</bean>

<bean id="ConnectionFactory" class="org.apache.activemq.jms.pool.JcaPooledConnectionFactory">
  <property name="transactionManager" ref="transactionManager" />
  <property name="connectionFactory" ref="xacf" />
</bean>
```
在本示例中，第一个 bean 定义了 ActiveMQ XA 连接工厂，提供给 JcaPooledConnectionFactory。然后，提供 JcaPooledConnectionFactory 作为默认 bean，其 id ConnectionFactory。
注意 JcaPooledConnectionFactory 类似于普通的 ConnectionFactory。但打开新连接和会话时，它将检查 XA 事务；如果找到，则会自动将 JMS 会话注册为 XA 资源。这允许 JMS 会话参与 JMS 事务。
重要
在 JMS 传输上直接设置 XA ConnectionFactory 将无法工作！

14.5. 使用 WSDL 配置 JMS

14.5.1. JMS WSDL 扩展名称空间

定义 JMS 端点的 WSDL 扩展在命名空间 http://cxf.apache.org/transports/jms 中定义。要使用 JMS 扩展，您需要将例 14.5 “JMS WSDL 扩展命名空间” 中显示的行添加到您的合同的定义元素中。

例 14.5. JMS WSDL 扩展命名空间

xmlns:jms="http://cxf.apache.org/transports/jms"

14.5.2. 基本 JMS 配置

概述

JMS 地址信息通过 jms:address 元素及其子项提供，即 jms:JMSNamingProperties 元素。jms:address 元素的属性指定识别 JMS 代理和目的地所需的信息。jms:JMSNamingProperties 元素指定用于连接 JNDI 服务的 Java 属性。

重要

使用 JMS 功能指定的信息将覆盖端点的 WSDL 文件中的信息。

指定 JMS 地址

JMS 端点的基本配置是通过将 jms:address 元素用作 服务端口 元素的子级来实现的。WSDL 中使用的 jms:address 元素与配置文件中所用的相同。其属性列在表 14.2 “JMS 端点属性” 中。

表 14.2. JMS 端点属性
属性	描述
`destinationStyle`	指定 JMS 目的地是否为 JMS 队列或 JMS 主题。
`jndiConnectionFactoryName`	指定连接到 JMS 目的地时要使用的 JMS 连接工厂的 JNDI 名称。
`jmsDestinationName`	指定发送到请求的 JMS 目的地的 JMS 名称。
`jmsReplyDestinationName`	指定发送回复的 JMS 目的地的 JMS 名称。此属性允许您使用定义的用户定义的目的地进行回复。详情请查看第 14.6 节 “使用 Named Reply Destination”。
`jndiDestinationName`	指定 JNDI 名称，绑定到发送到请求的 JMS 目标。
`jndiReplyDestinationName`	指定绑定到发送回复的 JMS 目的地的 JNDI 名称。此属性允许您使用定义的用户定义的目的地进行回复。详情请查看第 14.6 节 “使用 Named Reply Destination”。
`connectionUserName`	指定连接到 JMS 代理时要使用的用户名。
`connectionPassword`	指定连接到 JMS 代理时使用的密码。

jms:address WSDL 元素使用 jms:JMSNamingProperties 子元素来指定连接到 JNDI 提供程序所需的其他信息。

指定 JNDI 属性

为增加与 JMS 和 JNDI 提供程序的互操作性，jms:address 元素具有一个子元素，jms:JMSNamingProperties，允许您指定用于连接 JNDI 提供程序时所用的属性的值。jms:JMSNamingProperties 元素有两个属性： name 和 value。name 指定要设置的属性的名称。value 属性指定指定属性的值。JMS：JMSNamingProperties 元素也可用于规范提供程序特定的属性。

下表列出了可以设置的常见 JNDI 属性：

java.naming.factory.initial
java.naming.provider.url
java.naming.factory.object
java.naming.factory.state
java.naming.factory.url.pkgs
java.naming.dns.url
java.naming.authoritative
java.naming.batchsize
java.naming.referral
java.naming.security.protocol
java.naming.security.authentication
java.naming.security.principal
java.naming.security.credentials
java.naming.language
java.naming.applet

如需更多有关这些属性中使用的信息的详细信息，请检查您的 JNDI 供应商文档，并查阅 Java API 参考材料。

示例

例 14.6 “JMS WSDL 端口规格” 显示 JMS WSDL 端口 规格示例。

例 14.6. JMS WSDL 端口规格

<service name="JMSService">
  <port binding="tns:Greeter_SOAPBinding" name="SoapPort">
    <jms:address jndiConnectionFactoryName="ConnectionFactory"
                 jndiDestinationName="dynamicQueues/test.Celtix.jmstransport" >
      <jms:JMSNamingProperty name="java.naming.factory.initial"
                             value="org.activemq.jndi.ActiveMQInitialContextFactory" />
      <jms:JMSNamingProperty name="java.naming.provider.url"
                             value="tcp://localhost:61616" />
    </jms:address>
  </port>
</service>

14.5.3. JMS 客户端配置

概述

JMS 使用者端点指定它们所使用的消息类型。JMS 使用者端点可以使用 JMS ByteMessage 或 JMS TextMessage。

使用 ByteMessage 时，使用者端点使用 字节[] 作为将数据存储到 JMS 消息正文中的数据的方法。发送消息时，消息数据（包括任何格式信息）被打包成 字节[]，并在消息正文放置之前被放入一个线路中。收到消息后，消费者端点将尝试传播消息正文中存储的数据，就像以字节 [] 打包一样。

使用 TextMessage 时，使用者端点使用字符串作为消息正文中存储和检索数据的方法。发送消息时，消息信息（包括任何格式特定信息）将转换为字符串并放入 JMS 消息正文。当收到消息时，消费者端点将尝试推断 JMS 消息正文中存储的数据，就如同它被打包成一个字符串一样。

当原生 JMS 应用与 Apache CXF 用户交互时，JMS 应用负责解读消息和格式化信息。例如，如果 Apache CXF 合同指定用于 JMS 端点的绑定是 SOAP，并且消息被打包为 TextMessage，则接收的 JMS 应用程序将收到包含所有 SOAP envelope 信息的文本消息。

指定消息类型

JMS consumer 端点接受的消息类型使用可选的 jms:client 元素进行配置。jms:client 元素是 WSDL 端口 元素的子项，它有一个属性：

表 14.3. JMS 客户端 WSDL 扩展
`messageType`
指定消息数据将如何打包为 JMS 消息。`text` 指定数据将打包为 `TextMessage`。`二进制` 指定数据将打包为 `ByteMessage`。

示例

例 14.7 “用于 JMS 消费者端点的 WSDL” 显示用于配置 JMS 使用者端点的 WSDL。

例 14.7. 用于 JMS 消费者端点的 WSDL

<service name="JMSService">
  <port binding="tns:Greeter_SOAPBinding" name="SoapPort">
    <jms:address jndiConnectionFactoryName="ConnectionFactory"
                 jndiDestinationName="dynamicQueues/test.Celtix.jmstransport" >
      <jms:JMSNamingProperty name="java.naming.factory.initial"
                             value="org.activemq.jndi.ActiveMQInitialContextFactory" />
      <jms:JMSNamingProperty name="java.naming.provider.url"
                             value="tcp://localhost:61616" />
    </jms:address>
    <jms:client messageType="binary" />
  </port>
</service>

14.5.4. JMS 提供程序配置

概述

JMS 提供程序端点具有多种可配置行为。包括：

如何关联消息
使用 durable 订阅
如果服务使用本地 JMS 事务
端点使用的消息代理

指定配置

提供程序端点行为可通过可选 jms:server 元素进行配置。jms:server 元素是 WSDL wsdl:port 元素的子项，具有以下属性：

表 14.4. JMS 提供程序端点 WSDL 扩展
属性	描述
`useMessageIDAsCorrealationID`	指定 JMS 是否将使用消息 ID 来关联消息。默认值为 `false`。
`durableSubscriberName`	指定用于注册持久订阅的名称。
`messageSelector`	指定要使用的消息选择器的字符串值。如需有关用于指定消息选择器的语法的更多信息，请参阅 JMS 1.1 规范。
`transactional`	指定本地 JMS 代理是否围绕消息处理创建事务。默认值为 `false`。^[a]
^[a] 目前，运行时不支持将 `事务` 属性设置为 `true`。

示例

例 14.8 “用于 JMS 提供程序端点的 WSDL” 显示用于配置 JMS 提供程序端点的 WSDL。

例 14.8. 用于 JMS 提供程序端点的 WSDL

<service name="JMSService">
  <port binding="tns:Greeter_SOAPBinding" name="SoapPort">
    <jms:address jndiConnectionFactoryName="ConnectionFactory"
                 jndiDestinationName="dynamicQueues/test.Celtix.jmstransport" >
      <jms:JMSNamingProperty name="java.naming.factory.initial"
                             value="org.activemq.jndi.ActiveMQInitialContextFactory" />
      <jms:JMSNamingProperty name="java.naming.provider.url"
                             value="tcp://localhost:61616" />
    </jms:address>
    <jms:server messageSelector="cxf_message_selector"
                useMessageIDAsCorrelationID="true"
                transactional="true"
                durableSubscriberName="cxf_subscriber" />
  </port>
</service>

14.6. 使用 Named Reply Destination

概述

默认情况下，使用 JMS 的 Apache CXF 端点创建一个临时队列，用于发回回复。如果您希望使用命名队列，您可以将用于发送回复的队列配置为作为端点 JMS 配置的一部分。

设置回复目的地名称

您可以使用 jmsReplyDestinationName 属性或端点 JMS 配置中的 jndiReplyDestinationName 属性指定回复目的地。客户端端点将侦听指定目的地的回复，它将在所有传出请求的 ReplyTo 字段中指定属性的值。如果请求的 ReplyTo 字段中没有指定目的地，则服务端点将使用 jndiReplyDestinationName 属性的值作为放置回复的位置。

示例

例 14.9 “使用 Named Reply Queue 的 JMS Consumer 规格” 显示 JMS 客户端端点的配置。

例 14.9. 使用 Named Reply Queue 的 JMS Consumer 规格

<jms:conduit name="{http://cxf.apache.org/jms_endpt}HelloWorldJMSPort.jms-conduit">
    <jms:address destinationStyle="queue"
                 jndiConnectionFactoryName="myConnectionFactory"
                 jndiDestinationName="myDestination"
                 jndiReplyDestinationName="myReplyDestination" >
      <jms:JMSNamingProperty name="java.naming.factory.initial"
                             value="org.apache.cxf.transport.jms.MyInitialContextFactory" />
      <jms:JMSNamingProperty name="java.naming.provider.url"
                             value="tcp://localhost:61616" />
    </jms:address>
  </jms:conduit>

第 15 章与 Apache ActiveMQ 集成

概述

如果您使用 Apache ActiveMQ 作为 JMS 提供程序，可以以特殊格式指定目的地的 JNDI 名称，以便为队列或主题动态创建 JNDI 绑定。这意味着 不需要 预先使用队列或主题的 JNDI 绑定配置 JMS 提供程序。

初始上下文工厂

将 Apache ActiveMQ 与 JNDI 集成的关键是 ActiveMQInitialContextFactory 类。此类用于创建 JNDI InitialContext 实例，然后您可以使用它来访问 JMS 代理中的 JMS 目的地。

例 15.1 “用于连接到 Apache ActiveMQ 的 SOAP/JMS WSDL” 显示 SOAP/JMS WSDL 扩展以创建与 Apache ActiveMQ 集成的 JNDI InitialContext。

例 15.1. 用于连接到 Apache ActiveMQ 的 SOAP/JMS WSDL

<soapjms:jndiInitialContextFactory>
  org.apache.activemq.jndi.ActiveMQInitialContextFactory
</soapjms:jndiInitialContextFactory>
<soapjms:jndiURL>tcp://localhost:61616</soapjms:jndiURL>

在例 15.1 “用于连接到 Apache ActiveMQ 的 SOAP/JMS WSDL” 中，Apache ActiveMQ 客户端连接到位于 tcp://localhost:61616 的代理端口。

查找连接工厂

此外，还要创建 JNDI InitialContext 实例，您必须指定绑定到 javax.jms.ConnectionFactory 实例的 JNDI 名称。如果是 Apache ActiveMQ，则 InitialContext 实例中有一个预定义绑定，它将 JNDI 名称 ConnectionFactory 映射到 ActiveMQConnectionFactory 实例。例 15.2 “用于指定 Apache ActiveMQ 连接工厂的 SOAP/JMS WSDL” 用于指定 Apache ActiveMQ 连接工厂的 SOAP/JMS 扩展元素。

例 15.2. 用于指定 Apache ActiveMQ 连接工厂的 SOAP/JMS WSDL

<soapjms:jndiConnectionFactoryName>
  ConnectionFactory
</soapjms:jndiConnectionFactoryName>

动态目的地的语法

要动态访问队列或主题，请将目的地的 JNDI 名称指定为 JNDI 复合名称，采用以下格式之一：

dynamicQueues/QueueName
dynamicTopics/TopicName

QueueName 和 TopicName 是 Apache ActiveMQ 代理使用的名称。它们不 抽象 JNDI 名称。

例 15.3 “带有动态创建的队列的 WSDL 端口规格” 显示使用动态创建的队列的 WSDL 端口。

例 15.3. 带有动态创建的队列的 WSDL 端口规格

<service name="JMSService">
  <port binding="tns:GreeterBinding" name="JMSPort">
    <jms:address jndiConnectionFactoryName="ConnectionFactory"
                 jndiDestinationName="dynamicQueues/greeter.request.queue" >
      <jms:JMSNamingProperty name="java.naming.factory.initial"
                             value="org.activemq.jndi.ActiveMQInitialContextFactory" />
      <jms:JMSNamingProperty name="java.naming.provider.url"
                             value="tcp://localhost:61616" />
    </jms:address>
  </port>
</service>

当应用尝试打开 JMS 连接时，Apache ActiveMQ 将检查是否存在 JNDI 名称 greeter.request.queue 的队列。如果不存在，它将创建新队列，并将它绑定到 JNDI 名称 greeter.request.queue。

第 16 章 conduits

摘要

拥塞是实施出站连接的低级传输架构。其行为和生命周期可影响系统性能和处理负载。

概述

conduits 管理 Apache CXF 运行时中的客户端侧或出站传输详情。它们负责打开端口、建立出站连接、发送消息和侦听应用与单一外部端点之间的任何响应。如果应用连接到多个端点，则每个端点将有一个 conduit 实例。

每个传输类型都使用 Conduit 接口来实施自己的 conduit。这样，在应用程序级别功能和传输之间实现了标准化接口。

通常，在配置客户端传输详细信息时，您只需要担心应用程序所使用的 conduit。运行时如何处理 conduit 的基本语义，通常是开发人员需要担心的。

但是，了解相应行为可能会有帮助的情况：

实施自定义传输
高级应用程序调整以管理有限资源

conduit 生命周期

conduits 由客户端实施对象管理。创建之后，在客户端实施对象的持续时间内保持一致。conduit 的生命周期为：

创建客户端实施对象时，它会获得对 ConduitSelector 对象的引用。
当客户端需要发送消息是请求对 conduit 选择器的 conduit 的引用时。
如果消息用于新端点，则 conduit 选择器会创建一个新的 conduit，并将它传递到客户端实施。否则，它会把客户端对目标端点的 conduit 的引用传递。
在需要时，conduit 会发送消息。
当客户端实施对象被销毁时，与它关联的所有行为都会被销毁。

conduit weight

conduit 对象的权重取决于传输的实现。HTTP conduits 非常轻巧。JMS conduits 非常重，因为它们与 JMS Session 对象相关联，以及一个或多个 JMSListenerContainer 对象。

部分 IV. 配置 Web 服务端点

本指南论述了如何在红帽 Fuse 中创建 Apache CXF 端点。

第 17 章配置 JAX-WS 端点

摘要

JAX-WS 端点使用三个 Spring 配置元素之一进行配置。正确的元素取决于您要配置的端点类型以及您要使用的功能。对于使用 jaxws:client 元素的用户。对于服务供应商，您可以使用 jaxws:endpoint 元素或 jaxws:server 元素。

用于定义端点的信息通常在端点的合同中定义。您可以使用配置元素覆盖合同中的信息。您还可以使用配置元素来提供合同中未提供的信息。

您必须使用配置元素激活 WS-RM 等高级功能。这可以通过向端点配置元素提供子元素来完成。请注意，当处理使用 Java 先行方法开发的端点时，SEI 可能会在端点合同中缺少有关绑定和传输要使用的绑定和传输信息的信息。

17.1. 配置服务供应商

17.1.1. 配置服务提供程序的元素

Apache CXF 有两个元素可用于配置服务提供商：

第 17.1.2 节 “使用 jaxws:endpoint Element”
第 17.1.3 节 “使用 jaxws:server Element”

这两个元素之间的差异在很大程度上是运行时的内部。jaxws:endpoint 元素将属性注入 org.apache.cxf.jaxws.EndpointImpl 对象，以支持服务端点。jaxws:server 元素将属性注入 org.apache.cxf.jaxws.support.JaxWsServerFactoryBean 对象来支持端点。EndpointImpl 对象将配置数据传递给 JaxWsServerFactoryBean 对象。JaxWsServerFactoryBean 对象用于创建实际服务对象。因为任何一个配置元素都会配置服务端点，因此您可以根据您喜欢的语法进行选择。

17.1.2. 使用 jaxws:endpoint Element

概述

jaxws:endpoint 元素是配置 JAX-WS 服务提供商的默认元素。其属性和子项指定实例化服务提供商所需的所有信息。许多属性都映射到服务合同中的信息。子进程用于配置拦截器和其他高级功能。

识别正在配置的端点

要使运行时将配置应用到正确的服务提供商，它必须能够识别它。识别服务供应商的基本方法是指定实施端点的类。这可以通过使用 jaxws:endpoint 元素的 implementor 属性来完成。

对于不同端点共享常见实现的实例，可以为每个端点提供不同的配置。在配置中，有两种方法可用于区分特定端点：

serviceName 属性和 endpointName 属性的组合
serviceName 属性指定定义服务端点的 wsdl:service 元素。endpointName 属性指定定义服务端点的特定 wsdl:port 元素。这两个属性都以 QNames 指定，格式为 ns:name。ns 是元素的命名空间，name 是元素的 name 属性的值。
注意
如果 wsdl:service 元素只有一个 wsdl:port 元素，则可以省略 endpointName 属性。
name 属性
name 属性指定定义服务端点的特定 wsdl:port 元素的 QName。QName 以 {ns}localPart格式提供。ns 是 wsdl:port 元素的命名空间，localPart 是 wsdl:port 元素的 name 属性的值。

属性

jaxws:endpoint 元素的属性配置端点的基本属性。这些属性包括端点的地址、实施端点的类，以及托管端点的 总线。

表 17.1 “使用 jaxws:endpoint 元素配置 JAX-WS 服务提供商的属性” 描述 jaxws:endpoint 元素的属性。

表 17.1. 使用 jaxws:endpoint 元素配置 JAX-WS 服务提供商的属性
属性	描述
`id`	指定唯一标识符，其他配置元素可用于引用端点。
`implementor`	指定实施该服务的类。您可以使用类名称或对 Spring bean 配置实施类的 ID 引用来指定实施类。此类必须在 classpath 上。
`implementorClass`	指定实施该服务的类。当为 `implementor` 属性提供的值是一个对使用 Spring AOP 进行嵌套的 bean 的引用时，此属性很有用。
`address`	指定 HTTP 端点的地址。这个值会覆盖服务合同中指定的值。
`wsdlLocation`	指定端点 WSDL 合同的位置。WSDL 合同的位置相对于部署该服务的文件夹。
`endpointName`	指定服务的 `wsdl:port` 元素的 `name` 属性的值。它被指定为 QName，格式为 `ns:name`，其中 ns 是 `wsdl:port` 元素的命名空间。
`serviceName`	指定服务的 `wsdl:service` 元素的 `name` 属性的值。它被指定为 QName，格式为 `ns:name`，其中 ns 是 `wsdl:service` 元素的命名空间。
`publish`	指定是否应自动发布该服务。如果它被设置为 `false`，则开发人员必须明确发布第 31 章发布服务中描述的端点。
`bus`	指定 Spring bean 配置用于管理服务端点的总线的 ID。这在将多个端点配置为使用一组通用的功能时很有用。
`bindingUri`	指定服务使用的消息绑定 ID。第 23 章 Apache CXF Binding ID 中提供了有效绑定 ID 列表。
`name`	指定服务的 `wsdl:port` 元素的字符串 QName。它使用格式 `{ns}localPart` 指定为 QName。ns 是 `wsdl:port` 元素的命名空间，localPart 是 `wsdl:port` 元素的 `name` 属性的值。
`abstract`	指定 bean 是抽象 bean。抽象 bean 作为 concrete bean 定义的父项，它们不会被实例化。默认值为 `false`。把它设置为 `true` 会指示 bean 工厂不要实例化 bean。
`depends-on`	指定端点在实例化前依赖的 Bean 列表。
`createdFromAPI`	指定使用 Apache CXF API 创建的用户，如 `Endpoint.publish （）` 或 `Service.getPort （）`。默认值为 `false`。把它设置为 `true` 执行以下操作：通过将 `.jaxws-endpoint` 附加到其 ID 来更改 bean 的内部名称使 bean 抽象
`publishedEndpointUrl`	放入生成的 WSDL `地址` 元素中的 URL。如果没有指定这个值，则使用 `address` 属性的值。当 "public" URL 不与部署该服务的 URL 不同时，此属性很有用。

除了表 17.1 “使用 jaxws:endpoint 元素配置 JAX-WS 服务提供商的属性” 中列出的属性外，您可能需要使用多个 xmlns:shortName 属性来声明 endpointName 和 serviceName 属性使用的命名空间。

示例

例 17.1 “简单 JAX-WS 端点配置” 显示 JAX-WS 端点的配置，用于指定端点发布的地址。这个示例假设您想将默认值用于所有其他值，或者实施在注解中指定了值。

例 17.1. 简单 JAX-WS 端点配置

<beans ...
  xmlns:jaxws="http://cxf.apache.org/jaxws"
  ...
  schemaLocation="...
    http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
    ...">
  <jaxws:endpoint id="example"
                  implementor="org.apache.cxf.example.DemoImpl"
                  address="http://localhost:8080/demo" />
</beans>

例 17.2 “带有服务名称的 JAX-WS 端点配置” 显示 JAX-WS 端点的配置，其合同中包含两个服务定义。在这种情况下，您必须使用 serviceName 属性指定要实例化的服务定义。

例 17.2. 带有服务名称的 JAX-WS 端点配置

<beans ...
  xmlns:jaxws="http://cxf.apache.org/jaxws"
  ...
  schemaLocation="...
    http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
    ...">

  <jaxws:endpoint id="example2"
                  implementor="org.apache.cxf.example.DemoImpl"
                  serviceName="samp:demoService2"
                  xmlns:samp="http://org.apache.cxf/wsdl/example" />

</beans>

xmlns:samp 属性指定定义 WSDL 服务 元素的命名空间。

例 17.3 “启用 HTTP/2 的 JAX-WS 端点配置” 显示 JAX-WS 端点的配置，该端点指定了启用了 HTTP/2 的地址。

为 Apache CXF 配置 HTTP/2

在 Apache Karaf 上使用独立 Apache CXF Undertow 传输(http-undertow)时，支持 HTTP/2。要启用 HTTP/2 协议，您必须将 jaxws:endpoint 元素的 address 属性设置为绝对 URL，并将 org.apache.cxf.transports.http_undertow.EnableHttp2 属性设置为 true。

注意

这个 HTTP/2 实现只支持使用普通 HTTP 或 HTTPS 的服务器端 HTTP/2 传输。

例 17.3. 启用 HTTP/2 的 JAX-WS 端点配置

<beans ...
  xmlns:jaxws="http://cxf.apache.org/jaxws"
  ...
  schemaLocation="...
  http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
  ...">

  <cxf:bus>
    <cxf:properties>
        <entry key="org.apache.cxf.transports.http_undertow.EnableHttp2" value="true"/>
    </cxf:properties>
  </cxf:bus>

  <jaxws:endpoint id="example3"
                implementor="org.apache.cxf.example.DemoImpl"
                address="http://localhost:8080/demo" />
  </jaxws:endpoint>

</beans>

注意

为了提高性能，红帽建议在 Apache Karaf 上使用 servlet 传输(pax-web-undertow)，它允许对 web 容器的集中配置和调优，但 pax-web-undertow 不支持 HTTP/2 传输协议。

17.1.3. 使用 jaxws:server Element

概述

jaxws:server 元素是配置 JAX-WS 服务提供商的元素。它将配置信息注入到 org.apache.cxf.jaxws.support.JaxWsServerFactoryBean 中。这是特定于 Apache CXF 的对象。如果您使用纯 Spring 方法来构建您的服务，则不会强制使用 Apache CXF 特定的 API 与服务交互。

jaxws:server 元素的属性和子项指定实例化服务提供商所需的所有信息。属性指定实例化端点所需的信息。子进程用于配置拦截器和其他高级功能。

识别正在配置的端点

要让运行时将配置应用到正确的服务提供商，它必须能够识别它。识别服务供应商的基本方法是指定实施端点的类。这通过使用 jaxws:server 元素的 serviceBean 属性来实现。

对于不同端点共享常见实现的实例，可以为每个端点提供不同的配置。在配置中，有两种方法可用于区分特定端点：

serviceName 属性和 endpointName 属性的组合
serviceName 属性指定定义服务端点的 wsdl:service 元素。endpointName 属性指定定义服务端点的特定 wsdl:port 元素。这两个属性都以 QNames 指定，格式为 ns:name。ns 是元素的命名空间，name 是元素的 name 属性的值。
注意
如果 wsdl:service 元素只有一个 wsdl:port 元素，则可以省略 endpointName 属性。
name 属性
name 属性指定定义服务端点的特定 wsdl:port 元素的 QName。QName 以 {ns}localPart格式提供。ns 是 wsdl:port 元素的命名空间，localPart 是 wsdl:port 元素的 name 属性的值。

属性

jaxws:server 元素的属性配置端点的基本属性。这些属性包括端点的地址、实施端点的类，以及托管端点的 总线。

表 17.2 “使用 jaxws:server 元素配置 JAX-WS 服务提供商的属性” 描述 jaxws:server 元素的属性。

表 17.2. 使用 jaxws:server 元素配置 JAX-WS 服务提供商的属性
属性	描述
`id`	指定唯一标识符，其他配置元素可用于引用端点。
`serviceBean`	指定实施该服务的类。您可以使用类名称或对 Spring bean 配置实施类的 ID 引用来指定实施类。此类必须在 classpath 上。
`serviceClass`	指定实施该服务的类。当为 `implementor` 属性提供的值是一个对使用 Spring AOP 进行嵌套的 bean 的引用时，此属性很有用。
`address`	指定 HTTP 端点的地址。这个值将覆盖服务合同中指定的值。
`wsdlLocation`	指定端点 WSDL 合同的位置。WSDL 合同的位置相对于部署该服务的文件夹。
`endpointName`	指定服务的 `wsdl:port` 元素的 `name` 属性的值。它被指定为 QName，格式为 `ns:name`，其中 ns 是 `wsdl:port` 元素的命名空间。
`serviceName`	指定服务的 `wsdl:service` 元素的 `name` 属性的值。它被指定为 QName，格式为 `ns:name`，其中 ns 是 `wsdl:service` 元素的命名空间。
`publish`	指定是否应自动发布该服务。如果它被设置为 `false`，则开发人员必须明确发布第 31 章发布服务中描述的端点。
`bus`	指定 Spring bean 配置用于管理服务端点的总线的 ID。这在将多个端点配置为使用一组通用的功能时很有用。
`bindingId`	指定服务使用的消息绑定 ID。第 23 章 Apache CXF Binding ID 中提供了有效绑定 ID 列表。
`name`	指定服务的 `wsdl:port` 元素的字符串 QName。它使用 `{ns}localPart` 格式来指定为 QName，其中 ns 是 `wsdl:port` 元素的命名空间，localPart 是 `wsdl:port` 元素的 `name` 属性的值。
`abstract`	指定 bean 是抽象 bean。抽象 bean 作为 concrete bean 定义的父项，它们不会被实例化。默认值为 `false`。把它设置为 `true` 会指示 bean 工厂不要实例化 bean。
`depends-on`	指定端点在实例化端点之前实例化的 Bean 列表。
`createdFromAPI`	指定使用 Apache CXF API 创建的用户，如 `Endpoint.publish （）` 或 `Service.getPort （）`。默认值为 `false`。把它设置为 `true` 执行以下操作：通过将 `.jaxws-endpoint` 附加到其 ID 来更改 bean 的内部名称使 bean 抽象

除了表 17.2 “使用 jaxws:server 元素配置 JAX-WS 服务提供商的属性” 中列出的属性外，您可能需要使用多个 xmlns:shortName 属性来声明 endpointName 和 serviceName 属性使用的命名空间。

示例

例 17.4 “简单 JAX-WS 服务器配置” 显示 JAX-WS 端点的配置，用于指定端点发布的地址。

例 17.4. 简单 JAX-WS 服务器配置

<beans ...
  xmlns:jaxws="http://cxf.apache.org/jaxws"
  ...
  schemaLocation="...
    http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
    ...">
  <jaxws:server id="exampleServer"
                  serviceBean="org.apache.cxf.example.DemoImpl"
                  address="http://localhost:8080/demo" />
</beans>

17.1.4. 在服务提供程序中添加功能

概述

jaxws:endpoint 和 jaxws:server 元素提供实例化服务提供商所需的基本配置信息。要为您的服务提供商添加功能或执行高级配置，您必须在配置中添加子元素。

通过子元素，您可以执行以下操作：

第 19 章 Apache CXF Logging
第 59 章 配置端点以使用拦截器
第 20 章 部署 WS-Addressing
第 21 章 启用可靠的消息传递
第 17.1.5 节 “在 JAX-WS 端点上启用 Schema Validation”

元素

表 17.3 “用于配置 JAX-WS 服务提供程序的元素” 描述 jaxws:endpoint 支持的子元素。

表 17.3. 用于配置 JAX-WS 服务提供程序的元素
element	描述
`jaxws:handlers`	指定用于处理消息的 JAX-WS 处理程序列表。有关 JAX-WS 处理程序实施的更多信息，请参阅第 43 章编写处理程序。
`jaxws:inInterceptors`	指定处理入站请求的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxws:inFaultInterceptors`	指定处理入站错误信息的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxws:outInterceptors`	指定处理出站回复的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxws:outFaultInterceptors`	指定处理出站错误消息的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxws:binding`	指定 bean 配置端点使用的消息绑定。使用 `org.apache.cxf.binding.BindingFactory` 接口的实现来配置消息绑定。^[a]
`jaxws:dataBinding` ^[b]	指定实施端点使用的数据绑定的类。这可以通过一个嵌入式 bean 定义来指定。
`jaxws:executor`	指定用于该服务的 Java executor。这可以通过一个嵌入式 bean 定义来指定。
`jaxws:features`	指定配置 Apache CXF 高级功能的 Bean 列表。您可以提供 bean 参考列表或嵌入式 Bean 列表。
`jaxws:invoker`	指定服务使用的 org.apache.cxf.service.Invoker 接口的实施。^[c]
`jaxws:properties`	指定传递给端点的属性的 Spring 映射。这些属性可用于控制启用 MTOM 支持等功能。
`jaxws:serviceFactory`	指定用来实例化该服务的 `JaxWsServiceFactoryBean` 对象的 bean。
^[a] SOAP 绑定使用 `soap:soapBinding` bean 配置。 ^[b] `jaxws:endpoint` 元素不支持 `jaxws:dataBinding` 元素。 ^[c] Invoker 实施控制如何调用服务。例如，它控制每个请求是否由服务实施的新实例处理，或者是否在调用期间保留状态。

17.1.5. 在 JAX-WS 端点上启用 Schema Validation

概述

您可以设置 schema-validation-enabled 属性，以在 jaxws:endpoint 元素或 jaxws:server 元素中启用 schema 验证。启用架构验证后，检查客户端和服务器之间发送的消息是否符合该架构。默认情况下，模式验证处于关闭状态，因为它对性能有严重影响。

示例

要在 JAX-WS 端点上启用架构验证，请在 jaxws:endpoint 元素或 jaxws:server 元素的 jaxws:properties 子元素中设置 schema-validation-enabled 属性。例如，要在 jaxws:endpoint 元素中启用 schema 验证：

<jaxws:endpoint name="{http://apache.org/hello_world_soap_http}SoapPort"
    wsdlLocation="wsdl/hello_world.wsdl"
    createdFromAPI="true">
    <jaxws:properties>
        <entry key="schema-validation-enabled" value="BOTH" />
    </jaxws:properties>
</jaxws:endpoint>

有关 schema-validation-enabled 属性允许的值列表，请参考第 24.3.4.7 节 “模式验证类型值”。

17.2. 配置消费者端点

概述

JAX-WS 消费者端点使用 jaxws:client 元素进行配置。元素的属性提供创建消费者所需的基本信息。

要将其他功能（如 WS-RM）添加到 jaxws:client 元素的使用者中。子元素也用于配置端点的日志记录行为，并将其他属性注入端点的实现中。

基本配置属性

表 17.4 “用于配置 JAX-WS Consumer 的属性” 中描述的属性提供了配置 JAX-WS consumer 所需的基本信息。您只需要为您要配置的特定属性提供值。大多数属性都有合理的默认值，或者它们依赖于端点合同提供的信息。

表 17.4. 用于配置 JAX-WS Consumer 的属性
属性	描述
`address`	指定消费者要发出请求的端点的 HTTP 地址。这个值覆盖合同中设置的值。
`bindingId`	指定消费者使用的消息绑定 ID。第 23 章 Apache CXF Binding ID 中提供了有效绑定 ID 列表。
`bus`	指定管理端点的 Spring bean 配置总线的 ID。
`endpointName`	指定消费者发出请求的服务的 `wsdl:port` 元素的 `name` 属性的值。它被指定为 QName，格式为 `ns:name`，其中 ns 是 `wsdl:port` 元素的命名空间。
`serviceName`	指定消费者发出请求的服务的 `wsdl:service` 元素的 `name` 属性的值。它被指定为 QName，格式为 `ns:name`，其中 ns 是 `wsdl:service` 元素的命名空间。
`username`	指定用于简单用户名/密码身份验证的用户名。
`password`	指定用于简单用户名/密码身份验证的密码。
`serviceClass`	指定服务端点接口(SEI)的名称。
`wsdlLocation`	指定端点 WSDL 合同的位置。WSDL 合同的位置相对于部署客户端的文件夹。
`name`	指定消费者发出请求的服务的 `wsdl:port` 元素的字符串 QName。它使用 `{ns}localPart` 格式来指定为 QName，其中 ns 是 `wsdl:port` 元素的命名空间，localPart 是 `wsdl:port` 元素的 `name` 属性的值。
`abstract`	指定 bean 是抽象 bean。抽象 bean 作为 concrete bean 定义的父项，它们不会被实例化。默认值为 `false`。把它设置为 `true` 会指示 bean 工厂不要实例化 bean。
`depends-on`	指定端点在实例化前依赖的 Bean 列表。
`createdFromAPI`	指定使用 Apache CXF API （如 `Service.getPort （）` ）创建 bean 的用户。默认值为 `false`。把它设置为 `true` 执行以下操作：通过将 `.jaxws-client` 附加到其 ID 来更改 bean 的内部名称使 bean 抽象

除了表 17.4 “用于配置 JAX-WS Consumer 的属性” 中列出的属性外，可能需要使用多个 xmlns:shortName 属性来声明 endpointName 和 serviceName 属性使用的命名空间。

添加功能

要向使用者添加功能或执行高级配置，您必须在配置中添加子元素。

通过子元素，您可以执行以下操作：

第 19 章 Apache CXF Logging
第 59 章 配置端点以使用拦截器
第 20 章 部署 WS-Addressing
第 21 章 启用可靠的消息传递
“在 JAX-WS consumer 上启用模式验证”一节

表 17.5 “配置消费者端点的元素” 描述可用于配置 JAX-WS 使用者的子元素。

表 17.5. 配置消费者端点的元素
element	描述
`jaxws:binding`	指定 bean 配置端点使用的消息绑定。使用 `org.apache.cxf.binding.BindingFactory` 接口的实现来配置消息绑定。^[a]
`jaxws:dataBinding`	指定实施端点使用的数据绑定的类。您可以使用嵌入式 bean 定义来指定这一点。实施 JAXB 数据的类是 `org.apache.cxf.jaxb.JAXBDataBinding`。
`jaxws:features`	指定配置 Apache CXF 高级功能的 Bean 列表。您可以提供 bean 参考列表或嵌入式 Bean 列表。
`jaxws:handlers`	指定用于处理消息的 JAX-WS 处理程序列表。有关 JAX-WS 处理程序实施的更多信息，请参阅第 43 章编写处理程序。
`jaxws:inInterceptors`	指定处理入站响应的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxws:inFaultInterceptors`	指定处理入站错误信息的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxws:outInterceptors`	指定处理出站请求的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxws:outFaultInterceptors`	指定处理出站错误消息的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxws:properties`	指定传递给端点的属性映射。
`jaxws:conduitSelector`	为要使用的客户端指定 org.apache.cxf.endpoint.ConduitSelector 实施。ConduitSelector 实施将覆盖用于选择用于处理出站请求的 `Conduit` 对象的默认进程。
^[a] SOAP 绑定使用 `soap:soapBinding` bean 配置。

示例

例 17.5 “简单消费者配置” 显示简单的消费者配置。

例 17.5. 简单消费者配置

<beans ...
  xmlns:jaxws="http://cxf.apache.org/jaxws"
  ...
  schemaLocation="...
    http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
    ...">
  <jaxws:client id="bookClient"
                serviceClass="org.apache.cxf.demo.BookClientImpl"
                address="http://localhost:8080/books"/>
  ...
</beans>

在 JAX-WS consumer 上启用模式验证

要在 JAX-WS consumer 上启用模式验证，请在 jaxws:client 元素的 jaxws:properties 子元素中设置 schema-validation-enabled 属性：

<jaxws:client name="{http://apache.org/hello_world_soap_http}SoapPort"
    createdFromAPI="true">
    <jaxws:properties>
        <entry key="schema-validation-enabled" value="BOTH" />
    </jaxws:properties>
</jaxws:client>

有关 schema-validation-enabled 属性允许的值列表，请参考第 24.3.4.7 节 “模式验证类型值”。

第 18 章配置 JAX-RS 端点

摘要

本章论述了如何在 Blueprint XML 和 Spring XML 中实例化和配置 JAX-RS 服务器端点，以及如何在 XML 中实例化和配置 JAX-RS 客户端端点（客户端代理 Bean）

18.1. 配置 JAX-RS 服务器端点

18.1.1. 定义 JAX-RS 服务器端点

基本服务器端点定义

要在 XML 中定义 JAX-RS 服务器端点，您需要至少指定以下内容：

jaxrs:server 元素，用于在 XML 中定义端点。请注意，jaxrs: 命名空间前缀在 Blueprint 和 Spring 中分别映射到 不同的命名空间。
JAX-RS 服务的基本 URL 使用 jaxrs:server 元素的 address 属性。请注意，可以指定地址 URL 的方法有两种，这会影响如何部署端点：
- 作为相对 URL- 例如： /customers.在这种情况下，端点会部署到默认 HTTP 容器中，并通过将 CXF servlet 基本 URL 与指定的相对 URL 合并来隐式获取端点的基本 URL。
  例如，如果您将 JAX-RS 端点部署到 Fuse 容器，指定的 /customers URL 将解析为 URL ，http://Hostname:8181/cxf/customers （假设容器使用默认的 8181 端口）。
- 例如 http://0.0.0.0:8200/cxf/customers，作为绝对 URL PlacementBinding-SOURCE。在本例中，为 JAX-RS 端点打开了新的 HTTP 侦听器端口（如果还没有打开）。例如，在 Fuse 上下文中，会隐式创建新的 Undertow 容器来托管 JAX-RS 端点。特殊 IP 地址 0.0.0.0 作为通配符，匹配分配给当前主机的任何主机名（对于多主页主机机器非常有用）。
一个或多个 JAX-RS 根资源类，提供 JAX-RS 服务的实施。指定资源类最简单的方式是在 jaxrs:serviceBeans 元素中列出它们。

蓝图示例

以下 Blueprint XML 示例演示了如何定义 JAX-RS 端点，该端点指定了相对地址 /customers （使其部署到默认 HTTP 容器中），并由 service.CustomerService 资源池实施：

<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jaxrs="http://cxf.apache.org/blueprint/jaxrs"
    xmlns:cxf="http://cxf.apache.org/blueprint/core"
    xsi:schemaLocation="
http://www.osgi.org/xmlns/blueprint/v1.0.0 https://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd
http://cxf.apache.org/blueprint/jaxrs http://cxf.apache.org/schemas/blueprint/jaxrs.xsd
http://cxf.apache.org/blueprint/core http://cxf.apache.org/schemas/blueprint/core.xsd
">

    <cxf:bus>
        <cxf:features>
            <cxf:logging/>
        </cxf:features>
    </cxf:bus>

     <jaxrs:server id="customerService" address="/customers">
        <jaxrs:serviceBeans>
           <ref component-id="serviceBean" />
        </jaxrs:serviceBeans>
     </jaxrs:server>

     <bean id="serviceBean" class="service.CustomerService"/>
</blueprint>

蓝图 XML 命名空间

要在 Blueprint 中定义 JAX-RS 端点，您通常至少需要以下 XML 命名空间：

prefix	命名空间
（默认）	`http://www.osgi.org/xmlns/blueprint/v1.0.0`
`cxf`	`http://cxf.apache.org/blueprint/core`
`jaxrs`	`http://cxf.apache.org/blueprint/jaxrs`

Spring 示例

以下 Spring XML 示例演示了如何定义 JAX-RS 端点，该端点指定了相对地址 /customers （使其部署到默认 HTTP 容器中），并由 service.CustomerService 资源池实施：

<beans xmlns="http://www.springframework.org/schema/beans"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:jaxrs="http://cxf.apache.org/jaxrs"
      xsi:schemaLocation="
         http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
         http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd">

     <jaxrs:server id="customerService" address="/customers">
        <jaxrs:serviceBeans>
           <ref bean="serviceBean"/>
        </jaxrs:serviceBeans>
     </jaxrs:server>

     <bean id="serviceBean" class="service.CustomerService"/>
</beans>

Spring XML 命名空间

要在 Spring 中定义 JAX-RS 端点，通常需要至少以下 XML 命名空间：

prefix	命名空间
（默认）	`http://www.springframework.org/schema/beans`
`cxf`	`http://cxf.apache.org/core`
`jaxrs`	`http://cxf.apache.org/jaxrs`

Spring XML 中的自动发现

（仅Spring） 用来显式指定 JAX-RS 根资源类，Spring XML 可让您配置自动发现，以便搜索具体的 Java 软件包（由 @Path标注的类）以及所有发现的资源类都自动附加到端点。在这种情况下，您只需要在 jaxrs:server 元素中指定 address 属性和 basePackages 属性。

例如，要定义一个 JAX-RS 端点，它使用 a.b.c Java 软件包下的所有 JAX-RS 资源类，您可以在 Spring XML 中定义端点，如下所示：

<jaxrs:server address="/customers" basePackages="a.b.c"/>

自动发现机制也会发现并安装到端点（在指定的 Java 软件包下找到的 JAX-RS 提供程序类）。

Spring XML 中的生命周期管理

（仅Spring） Spring XML 允许您通过设置 bean 元素上的 scope 属性来控制 Bean 的生命周期。Spring 支持以下范围值：

singleton: （默认） 创建单个 bean 实例，它在 Spring 容器的整个生命周期内使用并持续使用。
prototype: 每次将 bean 注入到另一 bean 时，或通过调用 bean 注册表的 getBean （） 来创建一个新的 Bean 实例。
request: （只在 Web 感知容器中可用） 为每个在 bean 上调用的每个请求创建一个新的 Bean 实例。
会话: （只在 Web 感知容器中可用） 在单个 HTTP 会话的生命周期中创建一个新的 Bean。
globalSession: （只在 Web 感知容器中可用） 在 portlets 之间共享的单个 HTTP 会话生命周期中创建一个新的 Bean。

如需有关 Spring 范围的详细信息，请参阅 Bean 范围的 Spring 框架文档。

请注意，如果通过 jaxrs:serviceBeans 元素指定 JAX-RS 资源 Bean，则 Spring 范围 无法正常工作。如果您在此例中指定 resource Bean 的 scope 属性，则有效忽略 scope 属性。

要使 bean 范围在 JAX-RS 服务器端点内正常工作，您需要一系列由服务工厂提供的间接化。配置 Bean 范围最简单的方法是，使用 jaxrs:server 元素中的 beanNames 属性来指定资源 Bean，如下所示：

<beans ... >
  <jaxrs:server id="customerService" address="/service1"
    beanNames="customerBean1 customerBean2"/>

  <bean id="customerBean1" class="demo.jaxrs.server.CustomerRootResource1" scope="prototype"/>
  <bean id="customerBean2" class="demo.jaxrs.server.CustomerRootResource2"  scope="prototype"/>
</beans>

这里的示例配置了两个资源 Bean，即 customerBean1 和 customerBean2。beanNames 属性指定为以空格分隔的资源 bean ID 列表来指定。

为了获得灵活性，您可以选择使用 jaxrs:serviceFactories 元素在配置 JAX-RS 服务器端点时显式定义服务工厂对象。这种更详细的方法具有优势，您可以将默认服务工厂实施替换为您的自定义实施，从而让您最终掌控 bean 生命周期。以下示例演示了如何使用此方法配置两个资源 Bean、client Bean1 和 customerBean2 ：

<beans ... >
  <jaxrs:server id="customerService" address="/service1">
    <jaxrs:serviceFactories>
      <ref bean="sfactory1" />
      <ref bean="sfactory2" />
    </jaxrs:serviceFactories>
  </jaxrs:server>

  <bean id="sfactory1" class="org.apache.cxf.jaxrs.spring.SpringResourceFactory">
     <property name="beanId" value="customerBean1"/>
  </bean>
  <bean id="sfactory2" class="org.apache.cxf.jaxrs.spring.SpringResourceFactory">
     <property name="beanId" value="customerBean2"/>
  </bean>

  <bean id="customerBean1" class="demo.jaxrs.server.CustomerRootResource1" scope="prototype"/>
  <bean id="customerBean2" class="demo.jaxrs.server.CustomerRootResource2"  scope="prototype"/>
</beans>

注意

如果您指定一个非单例生命周期，通常最好实现和注册 org.apache.cxf.service.Invoker bean （通过从 jaxrs:server/jaxrs:invoker 元素引用该实例）。

附加 WADL 文档

您可以选择使用 jaxrs:server 元素中的 docLocation 属性将 WADL 文档与 JAX-RS 服务器端点关联。例如：

<jaxrs:server address="/rest" docLocation="wadl/bookStore.wadl">
   <jaxrs:serviceBeans>
      <bean class="org.bar.generated.BookStore"/>
   </jaxrs:serviceBeans>
</jaxrs:server>

模式验证

如果您有一些外部 XML 模式，用于描述 JAX-B 格式的消息内容，您可以通过 jaxrs:schemaLocations 元素将这些外部架构与 JAX-RS 服务器端点相关联。

例如，如果您将服务器端点与 WADL 文档关联，并且您希望在传入消息中启用模式验证，您可以指定关联的 XML 模式文件，如下所示：

<jaxrs:server address="/rest"
              docLocation="wadl/bookStore.wadl">
   <jaxrs:serviceBeans>
     <bean class="org.bar.generated.BookStore"/>
   </jaxrs:serviceBeans>
   <jaxrs:schemaLocations>
     <jaxrs:schemaLocation>classpath:/schemas/a.xsd</jaxrs:schemaLocation>
     <jaxrs:schemaLocation>classpath:/schemas/b.xsd</jaxrs:schemaLocation>
   </jaxrs:schemaLocations>
</jaxrs:server>

或者，如果您想要在给定目录中包含所有模式文件 *.xsd，您可以只指定目录名称，如下所示：

<jaxrs:server address="/rest"
              docLocation="wadl/bookStore.wadl">
   <jaxrs:serviceBeans>
     <bean class="org.bar.generated.BookStore"/>
   </jaxrs:serviceBeans>
   <jaxrs:schemaLocations>
     <jaxrs:schemaLocation>classpath:/schemas/</jaxrs:schemaLocation>
   </jaxrs:schemaLocations>
</jaxrs:server>

以这种方式指定架构对于需要访问 JAX-B 模式的任何功能通常很有用。

指定数据绑定

您可以使用 jaxrs:dataBinding 元素指定在请求和回复消息中对消息正文进行编码的数据绑定。例如，要指定 JAX-B 数据绑定，您可以按照如下所示配置 JAX-RS 端点：

<jaxrs:server id="jaxbbook" address="/jaxb">
  <jaxrs:serviceBeans>
    <ref bean="serviceBean" />
  </jaxrs:serviceBeans>
  <jaxrs:dataBinding>
    <bean class="org.apache.cxf.jaxb.JAXBDataBinding"/>
  </jaxrs:dataBinding>
</jaxrs:server>>

或者指定 Aegis 数据绑定，您可以按照如下所示配置 JAX-RS 端点：

<jaxrs:server id="aegisbook" address="/aegis">
  <jaxrs:serviceBeans>
    <ref bean="serviceBean" />
  </jaxrs:serviceBeans>
  <jaxrs:dataBinding>
    <bean class="org.apache.cxf.aegis.databinding.AegisDatabinding">
      <property name="aegisContext">
        <bean class="org.apache.cxf.aegis.AegisContext">
          <property name="writeXsiTypes" value="true"/>
        </bean>
      </property>
    </bean>
  </jaxrs:dataBinding>
</jaxrs:server>

使用 JMS 传输

可以将 JAX-RS 配置为使用 JMS 消息传递库作为传输协议，而不使用 HTTP。由于 JMS 本身不是传输协议，因此实际的消息传递协议取决于您配置的特定 JMS 实施。

例如，以下 Spring XML 示例演示了如何配置 JAX-RS 服务器端点以使用 JMS 传输协议：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:jms="http://cxf.apache.org/transports/jms"
       xmlns:jaxrs="http://cxf.apache.org/jaxrs"
       xsi:schemaLocation="
http://cxf.apache.org/transports/jms http://cxf.apache.org/schemas/configuration/jms.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd">

    <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"/>
    <bean id="ConnectionFactory" class="org.apache.activemq.ActiveMQConnectionFactory">
        <property name="brokerURL" value="tcp://localhost:${testutil.ports.EmbeddedJMSBrokerLauncher}" />
    </bean>

    <jaxrs:server xmlns:s="http://books.com"
    	serviceName="s:BookService"
    	transportId= "http://cxf.apache.org/transports/jms"
    	address="jms:queue:test.jmstransport.text?replyToName=test.jmstransport.response">
        <jaxrs:serviceBeans>
            <bean class="org.apache.cxf.systest.jaxrs.JMSBookStore"/>
        </jaxrs:serviceBeans>
    </jaxrs:server>

</beans>

请注意，以下示例的以下几点：

JMS 实施- JMS 实施由 ConnectionFactory bean 提供，它实例化 Apache ActiveMQ 连接工厂对象。在实例化连接工厂后，它会自动作为默认的 JMS 实施层安装。
JMS conduit 或 destination 对象-Apache CXF 隐式实例化 JMS conduit 对象（代表 JMS 使用者）或 JMS 目标对象（代表 JMS 提供程序）。这个对象必须由 QName 唯一标识，它通过属性 setttings xmlns:s="http://books.com" （定义命名空间前缀）和 serviceName="s:BookService" ( 定义 QName)。
传输 ID- 要选择 JMS 传输，transportId 属性必须设置为 http://cxf.apache.org/transports/jms。
JMS 地址- jaxrs:server/@address 属性使用标准化语法来指定 JMS 队列或 JMS 主题。有关这个语法的详情，请查看 https://tools.ietf.org/id/draft-merrick-jms-uri-06.txt。

扩展映射和语言映射

可以配置 JAX-RS 服务器端点，以便它将文件后缀（在 URL 中缓存）映射到 MIME 内容类型标头，并将语言后缀映射到语言类型标头。例如，考虑以下形式的 HTTP 请求：

GET /resource.xml

您可以配置 JAX-RS 服务器端点来自动映射 .xml 后缀，如下所示：

<jaxrs:server id="customerService" address="/">
  <jaxrs:serviceBeans>
    <bean class="org.apache.cxf.jaxrs.systests.CustomerService" />
  </jaxrs:serviceBeans>
  <jaxrs:extensionMappings>
    <entry key="json" value="application/json"/>
    <entry key="xml" value="application/xml"/>
  </jaxrs:extensionMappings>
</jaxrs:server>

当上述服务器端点收到 HTTP 请求时，它会自动创建类型为 application/xml 的新内容类型标头，并从资源 URL 剥离 .xml 后缀。

对于语言映射，请考虑以下形式的 HTTP 请求：

GET /resource.en

您可以配置 JAX-RS 服务器端点来自动映射 .en 后缀，如下所示：

<jaxrs:server id="customerService" address="/">
  <jaxrs:serviceBeans>
    <bean class="org.apache.cxf.jaxrs.systests.CustomerService" />
  </jaxrs:serviceBeans>
  <jaxrs:languageMappings>
     <entry key="en" value="en-gb"/>
  </jaxrs:languageMappings>
</jaxrs:server>

当上述服务器端点收到 HTTP 请求时，它会自动创建一个新的接受语言标头，其值为 en-gb，并从资源 URL 剥离 .en 后缀。

18.1.2. jaxrs:server 属性

属性

表 18.1 “JAX-RS 服务器端点属性” 描述 jaxrs:server 元素中可用的属性。

表 18.1. JAX-RS 服务器端点属性
属性	描述
`id`	指定唯一标识符，其他配置元素可用于引用端点。
`address`	指定 HTTP 端点的地址。这个值将覆盖服务合同中指定的值。
`basePackages`	（仅 Spring）启用自动发现，具体方法是指定以逗号分隔的 Java 软件包列表，用于发现 JAX-RS 根资源类和/或 JAX-RS 提供程序类和/或 JAX-RS 提供程序类。
`beanNames`	指定 JAX-RS 根资源 Bean 的 bean ID 空格分隔的列表。在 Spring XML 上下文中，可以通过设置 root 资源 bean 元素的 `scope` 属性来定义根资源 `Bean` 的生命周期。
`bindingId`	指定服务使用的消息绑定 ID。第 23 章 Apache CXF Binding ID 中提供了有效绑定 ID 列表。
`bus`	指定 Spring bean 配置用于管理服务端点的总线的 ID。这在将多个端点配置为使用一组通用的功能时很有用。
`docLocation`	指定外部 WADL 文档的位置。
`modelRef`	将模型模式指定为类路径资源（例如，格式为 `classpath:/path/to/model.xml`的 URL）。有关如何定义 JAX-RS 模型模式的详情，请参考第 18.3 节 “使用模型定义 REST 服务”。
`publish`	指定是否应自动发布该服务。如果设置为 `false`，则开发人员必须显式发布端点。
`publishedEndpointUrl`	指定 URL 基本地址，它被插入到自动生成的 WADL 接口的 `wadl:resources/@base` 属性中。
`serviceAnnotation`	（仅Spring）指定 Spring 中自动发现的服务注解类名称。与 `basePackages` 属性结合使用时，此选项将自动发现类的集合限制为仅包含由此注解类型注释的类。guess!这是否正确？
`serviceClass`	指定 JAX-RS 根资源类（实施 JAX-RS 服务）的名称。在这种情况下，该类由 Apache CXF 进行实例化，而不是由 Blueprint 或 Spring 进行实例化。如果要在 Blueprint 或 Spring 中实例化类，请使用 `jaxrs:serviceBeans` 子元素。
`serviceName`	在特殊情况下，在使用 JMS 传输时指定 JAX-RS 端点的 service QName （使用 `ns:name`）。详情请查看 “使用 JMS 传输”一节。
`staticSubresourceResolution`	如果为 `true`，则禁用静态子资源动态解析。默认为 `false`。
`transportId`	选择非标准传输层（代替 HTTP）。特别是，您可以通过将此属性设置为 `http://cxf.apache.org/transports/jms` 来选择 JMS 传输。详情请查看 “使用 JMS 传输”一节。
`abstract`	（仅 Spring）如果 bean 是一个抽象 bean，则指定。抽象 bean 作为 concrete bean 定义的父项，它们不会被实例化。默认值为 `false`。把它设置为 `true` 会指示 bean 工厂不要实例化 bean。
`depends-on`	（仅Spring）指定端点依赖在端点实例化前实例化的 Bean 列表。

18.1.3. jaxrs:server Child Elements

子元素

表 18.2 “JAX-RS 服务器端点子元素” 描述 jaxrs:server 元素的子元素。

表 18.2. JAX-RS 服务器端点子元素
element	描述
`jaxrs:executor`	指定用于该服务的 Java `Executor` （线程池实现）。这可以通过一个嵌入式 bean 定义来指定。
`jaxrs:features`	指定配置 Apache CXF 高级功能的 Bean 列表。您可以提供 bean 参考列表或嵌入式 Bean 列表。
`jaxrs:binding`	未使用.
`jaxrs:dataBinding`	指定实施端点使用的数据绑定的类。这可以通过一个嵌入式 bean 定义来指定。如需了解更多详细信息，请参阅 “指定数据绑定”一节。
`jaxrs:inInterceptors`	指定处理入站请求的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxrs:inFaultInterceptors`	指定处理入站错误信息的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxrs:outInterceptors`	指定处理出站回复的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxrs:outFaultInterceptors`	指定处理出站错误消息的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxrs:invoker`	指定服务使用的 org.apache.cxf.service.Invoker 接口的实施。^[a]
`jaxrs:serviceFactories`	为您提供了与此端点关联的 JAX-RS root 资源生命周期的最大控制程度。此元素的子项（必须是 `org.apache.cxf.jaxrs.lifecycle.ResourceProvider` type）的实例用于创建 JAX-RS 根资源实例。
`jaxrs:properties`	指定传递给端点的属性的 Spring 映射。这些属性可用于控制启用 MTOM 支持等功能。
`jaxrs:serviceBeans`	此元素的子项是(`bean` 元素)或对(`ref` 元素) JAX-RS 根资源的引用。请注意，如果 `bean` 元素中存在 `scope` 属性（仅适用于 Spring），则忽略。
`jaxrs:modelBeans`	由一个或多个 `org.apache.cxf.jaxrs.model.UserResource` beans 的引用列表组成，它们是资源模型的基本元素(corresponding to `jaxrs:resource` 元素)。详情请查看第 18.3 节 “使用模型定义 REST 服务”。
`jaxrs:model`	在此端点中直接定义资源模型（即，此 `jaxrs:model` 元素可以包含一个或多个 `jaxrs:resource` 元素）。详情请查看第 18.3 节 “使用模型定义 REST 服务”。
`jaxrs:providers`	允许您将一个或多个自定义 JAX-RS 提供程序注册到此端点。此元素的子项是 (`bean` 元素)或对(`ref` 元素) JAX-RS 提供程序的引用。
`jaxrs:extensionMappings`	当 REST 调用的 URL 以文件扩展结尾时，您可以使用这个元素自动将其与特定内容类型关联。例如，`.xml` 文件扩展名可以与 `application/xml` 内容类型关联。详情请查看 “扩展映射和语言映射”一节。
`jaxrs:languageMappings`	当 REST 调用的 URL 以语言后缀结尾时，您可以使用此元素将它映射到特定的语言。例如，`.en` 语言后缀可与 `en-GB` 语言关联。详情请查看 “扩展映射和语言映射”一节。
`jaxrs:schemaLocations`	指定用于验证 XML 消息内容的一个或多个 XML 模式。此元素可以包含一个或多个 `jaxrs:schemaLocation` 元素，各自指定 XML 模式文件的位置（通常是 `类路径` URL）。详情请查看 “模式验证”一节。
`jaxrs:resourceComparator`	允许您注册自定义资源比较器，它实施用于匹配特定资源类或方法的传入 URL 路径的算法。
`jaxrs:resourceClasses`	（仅限蓝色打印）如果想要从类名称创建多个资源，而不使用 `jaxrs:server/@serviceClass` 属性。`jaxrs:resourceClasses` 的子项必须是 `类` 元素，并且 `name` 属性设为资源类的名称。在这种情况下，这些类由 Apache CXF 进行实例化，而不是由 Blueprint 或 Spring 进行实例化。
^[a] Invoker 实施控制如何调用服务。例如，它控制每个请求是否由服务实施的新实例处理，或者是否在调用期间保留状态。

18.2. 配置 JAX-RS 客户端端点

18.2.1. 定义 JAX-RS 客户端端点

注入客户端代理

在 XML 语言(Blueprint XML 或 Spring XML)中实例化客户端代理的主要点是用来将它注入到另一个 bean 中，然后使用客户端代理调用 REST 服务。要在 XML 中创建客户端代理 bean，请使用 jaxrs:client 元素。

命名空间

JAX-RS 客户端端点使用与服务器端点 不同的 XML 命名空间来定义。下表显示了要用于哪些 XML 语言的命名空间：

XML 语言	客户端端点的命名空间
蓝图（Blueprint）	`http://cxf.apache.org/blueprint/jaxrs-client`
Spring	`http://cxf.apache.org/jaxrs-client`

基本客户端端点定义

以下示例演示了如何在 Blueprint XML 或 Spring XML 中创建客户端代理 bean：

<jaxrs:client id="restClient"
       address="http://localhost:8080/test/services/rest"
       serviceClass="org.apache.cxf.systest.jaxrs.BookStoreJaxrsJaxws"/>

在什么位置，您必须设置以下属性来定义基本客户端端点：

id: 客户端代理的 bean ID 可用于将客户端代理注入到 XML 配置中的其他 Bean 中。
address: address 属性指定 REST 调用的基本 URL。
serviceClass: serviceClass 属性通过指定根资源类（由 @Path标示）来提供 REST 服务的描述。实际上，这是一个 服务器 类，但不由客户端直接使用。指定的类仅用于其元数据（通过 Java 反映和 JAX-RS 注解），用于动态构建客户端代理。

指定标头

您可以使用 jaxrs:headers 子元素在客户端代理调用中添加 HTTP 标头，如下所示：

<jaxrs:client id="restClient"
       address="http://localhost:8080/test/services/rest"
       serviceClass="org.apache.cxf.systest.jaxrs.BookStoreJaxrsJaxws"
       inheritHeaders="true">
       <jaxrs:headers>
           <entry key="Accept" value="text/xml"/>
       </jaxrs:headers>
</jaxrs:client>

18.2.2. jaxrs:client 属性

属性

表 18.3 “JAX-RS 客户端端点属性” 描述 jaxrs:client 元素中可用的属性。

表 18.3. JAX-RS 客户端端点属性
属性	描述
`address`	指定消费者要发出请求的端点的 HTTP 地址。这个值覆盖合同中设置的值。
`bindingId`	指定消费者使用的消息绑定 ID。第 23 章 Apache CXF Binding ID 中提供了有效绑定 ID 列表。
`bus`	指定管理端点的 Spring bean 配置总线的 ID。
`inheritHeaders`	指定从这个代理创建子资源代理时是否会继承此代理的标头。默认为 `false`。
`username`	指定用于简单用户名/密码身份验证的用户名。
`password`	指定用于简单用户名/密码身份验证的密码。
`modelRef`	将模型模式指定为类路径资源（例如，格式为 `classpath:/path/to/model.xml`的 URL）。有关如何定义 JAX-RS 模型模式的详情，请参考第 18.3 节 “使用模型定义 REST 服务”。
`serviceClass`	指定服务接口的名称或资源类（使用 `@PATH`标注），从 JAX-RS 服务器实施重新使用。在这种情况下，指定的类不会直接调用（实际上是一个服务器类）。指定的类仅用于其元数据（通过 Java 反映和 JAX-RS 注解），用于动态构建客户端代理。
`serviceName`	在特殊情况下，在使用 JMS 传输时指定 JAX-RS 端点的 service QName （使用 `ns:name`）。详情请查看 “使用 JMS 传输”一节。
`threadSafe`	指定客户端代理是否为 thread-safe。默认为 `false`。
`transportId`	选择非标准传输层（代替 HTTP）。特别是，您可以通过将此属性设置为 `http://cxf.apache.org/transports/jms` 来选择 JMS 传输。详情请查看 “使用 JMS 传输”一节。
`abstract`	（仅 Spring）如果 bean 是一个抽象 bean，则指定。抽象 bean 作为 concrete bean 定义的父项，它们不会被实例化。默认值为 `false`。把它设置为 `true` 会指示 bean 工厂不要实例化 bean。
`depends-on`	（仅Spring）指定端点在实例化前取决于实例化的 Bean 列表。

18.2.3. jaxrs:client Child Elements

子元素

表 18.4 “JAX-RS 客户端端点子元素” 描述 jaxrs:client 元素的子元素。

表 18.4. JAX-RS 客户端端点子元素
element	描述
`jaxrs:executor`
`jaxrs:features`	指定配置 Apache CXF 高级功能的 Bean 列表。您可以提供 bean 参考列表或嵌入式 Bean 列表。
`jaxrs:binding`	未使用.
`jaxrs:dataBinding`	指定实施端点使用的数据绑定的类。这可以通过一个嵌入式 bean 定义来指定。如需了解更多详细信息，请参阅 “指定数据绑定”一节。
`jaxrs:inInterceptors`	指定处理入站响应的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxrs:inFaultInterceptors`	指定处理入站错误信息的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxrs:outInterceptors`	指定处理出站请求的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxrs:outFaultInterceptors`	指定处理出站错误消息的拦截器列表。更多信息请参阅第 VII 部分 “开发 Apache CXF Interceptors”。
`jaxrs:properties`	指定传递给端点的属性映射。
`jaxrs:providers`	允许您将一个或多个自定义 JAX-RS 提供程序注册到此端点。此元素的子项是 (`bean` 元素)或对(`ref` 元素) JAX-RS 提供程序的引用。
`jaxrs:modelBeans`	由一个或多个 `org.apache.cxf.jaxrs.model.UserResource` beans 的引用列表组成，它们是资源模型的基本元素(corresponding to `jaxrs:resource` 元素)。详情请查看第 18.3 节 “使用模型定义 REST 服务”。
`jaxrs:model`	在此端点中直接定义资源模型（即 `jaxrs:model` 元素），其中包含一个或多个 `jaxrs:resource` 元素。详情请查看第 18.3 节 “使用模型定义 REST 服务”。
`jaxrs:headers`	用于设置传出消息上的标头。详情请查看 “指定标头”一节。
`jaxrs:schemaLocations`	指定用于验证 XML 消息内容的一个或多个 XML 模式。此元素可以包含一个或多个 `jaxrs:schemaLocation` 元素，各自指定 XML 模式文件的位置（通常是 `类路径` URL）。详情请查看 “模式验证”一节。

18.3. 使用模型定义 REST 服务

不含注解的 RESTful 服务

JAX-RS 模型架构使得定义 RESTful 服务成为可能，无需注解 Java 类。也就是说，您可以使用模型模式在单独的 XML 文件中添加 @Path、@PathParam、@Consumes、@Produces 等注释，而是直接在 Java 类（或接口）中提供所有相关 REST 元数据。例如，当您无法修改实现服务的 Java 源时，这很有用。

模式 schema 示例

例 18.1 “JAX-RS Model Schema 示例” 显示为 BookStoreNoAnnotations 根资源类定义服务元数据的模型模式示例。

例 18.1. JAX-RS Model Schema 示例

<model xmlns="http://cxf.apache.org/jaxrs">
  <resource name="org.apache.cxf.systest.jaxrs.BookStoreNoAnnotations" path="bookstore"
    produces="application/json" consumes="application/json">
    <operation name="getBook" verb="GET" path="/books/{id}" produces="application/xml">
       <param name="id" type="PATH"/>
    </operation>
    <operation name="getBookChapter" path="/books/{id}/chapter">
       <param name="id" type="PATH"/>
    </operation>
    <operation name="updateBook" verb="PUT">
       <param name="book" type="REQUEST_BODY"/>
    </operation>
  </resource>
  <resource name="org.apache.cxf.systest.jaxrs.ChapterNoAnnotations">
    <operation name="getItself" verb="GET"/>
    <operation name="updateChapter" verb="PUT" consumes="application/xml">
        <param name="content" type="REQUEST_BODY"/>
    </operation>
  </resource>
</model>

命名空间

您用来定义模型模式的 XML 命名空间取决于是否在 Blueprint XML 中定义对应的 JAX-RS 端点，还是在 Spring XML 中定义。下表显示了要用于哪些 XML 语言的命名空间：

XML 语言	命名空间
蓝图（Blueprint）	`http://cxf.apache.org/blueprint/jaxrs`
Spring	`http://cxf.apache.org/jaxrs`

如何将模型模式附加到端点

要将模型模式定义并附加到端点，请执行以下步骤：

定义模型架构，使用您选择的注入平台(Blueprint XML 或 Spring XML)的适当 XML 命名空间。
将模型模式文件添加到您的项目的资源中，以便 schema 文件可在最终软件包(JAR、WAR 或 OSGi 捆绑包文件)中的 classpath 上可用。
注意
另外，还可以使用端点的 jaxrs:model 子元素直接将模型模式嵌入到 JAX-RS 端点中。
将端点配置为使用模型模式，将端点的 modelRef 属性设置为类路径上模型模式的位置（使用类路径 URL）。
如有必要，使用 jaxrs:serviceBeans 元素明确实例化 root 资源。如果模型模式引用 root 资源类（而不是引用基本接口），您可以跳过此步骤。

引用类的模型模式配置

如果模型架构直接应用到根资源类，则不需要使用 jaxrs:serviceBeans 元素定义任何根资源 Bean，因为模型模式会自动实例化根资源 Bean。

例如，如果 customer-resources.xml 是一种模型模式，将元数据与客户资源类相关联，您可以按照如下所示实例化 customerService 服务端点：

<jaxrs:server id="customerService"
              address="/customers"
              modelRef="classpath:/org/example/schemas/customer-resources.xml" />

引用接口的模型模式配置

如果模型架构适用于 Java 接口（这是 root 资源的基本接口），则必须使用端点中的 jaxrs:serviceBeans 元素实例化根资源类。

例如，假设 customer-interfaces.xml 是一种将元数据与客户接口关联的模型模式，您可以按照如下所示实例化 customerService 服务端点：

<jaxrs:server id="customerService"
              address="/customers"
              modelRef="classpath:/org/example/schemas/customer-interfaces.xml">
    <jaxrs:serviceBeans>
       <ref component-id="serviceBean" />
    </jaxrs:serviceBeans>
</jaxrs:server>

<bean id="serviceBean" class="service.CustomerService"/>

Model Schema Reference

模型模式使用以下 XML 元素定义：

model

模型架构的根元素。如果您需要引用模型模式（例如，使用 modelRef 属性从 JAX-RS 端点），您应该设置此元素上的 id 属性。

model/resource

资源 元素用于将元数据与特定根资源类（或与对应的接口）关联。您可以在 resource 元素上定义以下属性：

属性	描述 +
`name`	应用此资源模型的资源类（或对应接口）的名称。 +
`path`	映射到此资源的 REST URL 路径的组件。 +
`使用`	指定此资源使用的内容类型(Internet 介质类型)，如 `application/xml` 或 `application/json`。 +
`生成`	指定此资源生成的内容类型(Internet 介质类型)，如 `application/xml` 或 `application/json`。 +

model/resource/operation

操作 元素用于将元数据与 Java 方法关联。您可以在 操作 元素上定义以下属性：

属性	描述 +
`name`	应用此元素的 Java 方法的名称。 +
`path`	映射到此方法的 REST URL 路径的组件。此属性值可以包含参数引用，例如： `path="/books/{id}/chapter"`，其中 `{id}` 从路径中提取 `id` 参数的值。 +
`verb`	指定映射到此方法的 HTTP 动词。通常之一： `GET`、`POST`、`PUT` 或 `DELETE`。如果没有指定 HTTP 动词，则假设 Java 方法是一种子资源定位器，这将返回对子资源对象的引用（其中，必须使用 `资源` 元素提供子资源类）。 +
`使用`	指定此操作使用的内容类型(Internet 介质类型)，例如 `application/xml` 或 `application/json`。 +
`生成`	指定此操作生成的内容类型(Internet 介质类型)，例如 `application/xml` 或 `application/json`。 +
`oneway`	如果为 `true`，请将操作配置为单向，表示不需要回复消息。默认值为 `false`。 +

model/resource/operation/param

使用 param 元素从 REST URL 中提取值并将其注入到方法参数之一中。您可以在 param 元素上定义以下属性：

属性	描述 +
`name`	应用此元素的 Java 方法参数的名称。 +
`type`	指定从 REST URL 或消息中提取参数值的方式。它可设置为以下值之一： `PATH`,`QUERY`,`MATRIX`,`HEADER`,`COOKIE`,`FORM`,`CONTEXT`,`REQUEST_BODY`. +
`defaultValue`	要注入参数的默认值，如果无法从 REST URL 或消息中提取值。 +
`encoded`	如果为 `true`，则参数值使用 URI 编码格式注入（即使用 `%nn` 编码）。默认为 `false`。例如，从 URL 路径中提取参数时，`/name/Joe%20Bloggs` 的编码设为 `true` 时，该参数注入为 `Joe%20Bloggs`; 否则，该参数将被注入为 `Joe Bloggs`。 +

第 19 章 Apache CXF Logging

摘要

本章论述了如何在 Apache CXF 运行时配置登录。

19.1. Apache CXF 日志概述

概述

Apache CXF 使用 Java 日志记录实用程序 java.util.logging。使用标准的 java.util.Properties 格式编写的日志记录配置文件中配置日志。要在应用程序上运行日志记录，您可以以编程方式指定日志记录，或者在启动应用程序时定义指向日志记录配置文件的属性。

默认属性文件

Apache CXF 附带一个默认的 logging.properties 文件，该文件位于您的 InstallDir/etc 目录中。此文件为日志消息和发布的消息级别配置输出目的地。默认配置会将日志记录器设置为打印带有 WARNING 级别的消息标记到控制台。您可以在不更改任何配置设置的情况下使用默认的文件，也可以更改配置设置以适合您的特定应用程序。

日志记录功能

Apache CXF 包含一个日志功能，可插入到客户端或您的服务以启用日志记录。例 19.1 “配置启用日志记录” 显示启用日志记录功能的配置。

例 19.1. 配置启用日志记录

<jaxws:endpoint...>
  <jaxws:features>
    <bean class="org.apache.cxf.feature.LoggingFeature"/>
  </jaxws:features>
</jaxws:endpoint>

更多信息请参阅第 19.6 节 “日志记录消息内容”。

从何处开始？

要运行一个简单的日志示例，请按照第 19.2 节 “使用日志记录的简单示例” 中介绍的说明。

有关如何在 Apache CXF 中进行日志记录的更多信息，请仔细阅读本章节。

有关 java.util.logging 的更多信息

java.util.logging 实用程序是最常用的 Java 日志记录框架之一。在线有很多可用的信息描述了如何使用和扩展此框架。然而，以下文档提供了 java.util.logging 的概览：

19.2. 使用日志记录的简单示例

更改日志级别和输出目的地

要更改 wsdl_first 示例应用程序中日志消息的日志级别和输出目的地，请完成以下步骤：

使用 InstallDir/samples/wsdl_first 目录中的 README.txt 文件的 java 部分，运行示例服务器，如运行演示 中所述。请注意，服务器启动命令 指定默认的 logging.properties 文件，如下所示：

平台命令 +

平台	命令 +
Windows	`启动 java -Djava.util.logging.config.file=%CXF_HOME%\etc\logging.properties demo.hw.server.Server` +
UNIX	`java -Djava.util.logging.config.file=$CXF_HOME/etc/logging.properties demo.hw.server.Server &` +

Windows

启动 java -Djava.util.logging.config.file=%CXF_HOME%\etc\logging.properties demo.hw.server.Server

UNIX

java -Djava.util.logging.config.file=$CXF_HOME/etc/logging.properties demo.hw.server.Server &

默认 logging.properties 文件位于 InstallDir/etc 目录中。它配置 Apache CXF 日志记录器，以将 WARNING 级别日志消息打印到控制台。因此，您会看到很少打印到控制台。

按照 README.txt 文件中所述停止服务器。
复制默认的 logging.properties 文件，将它命名为 mylogging.properties 文件，并将它保存为默认的 logging.properties 文件。
通过编辑以下配置行，将 mylogging.properties 文件中的全局日志记录级别和控制台日志记录级别更改为 INFO ：
```
.level= INFO
java.util.logging.ConsoleHandler.level = INFO
```

使用以下命令重启服务器：

平台命令 +

平台	命令 +
Windows	`启动 java -Djava.util.logging.config.file=%CXF_HOME%\etc\mylogging.properties demo.hw.server.Server` +
UNIX	`java -Djava.util.logging.config.file=$CXF_HOME/etc/mylogging.properties demo.hw.server.Server &` +

Windows

启动 java -Djava.util.logging.config.file=%CXF_HOME%\etc\mylogging.properties demo.hw.server.Server

UNIX

java -Djava.util.logging.config.file=$CXF_HOME/etc/mylogging.properties demo.hw.server.Server &

由于您已将全局记录和控制台日志记录器配置为记录 level INFO 的信息，所以您会看到很多日志消息被打印到控制台。

19.3. 默认日志配置文件

19.3.1. 日志配置概述

默认日志记录配置文件 logging.properties 位于 InstallDir/etc 目录中。它配置 Apache CXF 日志记录器，以将 WARNING 级别消息打印到控制台。如果此级别的日志记录适用于您的应用程序，则不需要在使用该文件前对该文件进行任何更改。但是，您可以在日志消息中更改详情级别。例如，您可以更改日志消息是否发送到控制台，并发送到文件或两者。另外，您可以在单个软件包的级别指定日志记录。

注意

本节讨论默认的 logging.properties 文件中出现的配置属性。但是，您还可设置许多其他 java.util.logging 配置属性。有关 java.util.logging API 的更多信息，请访问 java.util.logging javadoc ：

19.3.2. 配置日志输出

概述

Java 日志记录实用程序 java.util.logging 使用处理程序类输出日志消息。表 19.1 “java.util.logging Handler 类” 显示默认 logging.properties 文件中配置的处理程序。

表 19.1. java.util.logging Handler 类
处理程序类	输出到
`ConsoleHandler`	输出到控制台的日志消息
`FileHandler`	输出日志消息到文件

重要

处理程序类必须在系统类路径上，以便在 Java 虚拟机启动时由 Java 虚拟机安装。这是在设置 Apache CXF 环境时完成的。

配置控制台处理程序

例 19.2 “配置控制台处理程序” 显示配置控制台日志记录器的代码。

例 19.2. 配置控制台处理程序

handlers= java.util.logging.ConsoleHandler

控制台处理程序还支持例 19.3 “控制台处理程序属性” 中显示的配置属性。

例 19.3. 控制台处理程序属性

java.util.logging.ConsoleHandler.level = WARNING
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

例 19.3 “控制台处理程序属性” 中显示的配置属性如下：

控制台处理程序支持单独的日志级别配置属性。这可让您限制输出到控制台的日志信息，同时全局日志记录设置可能会有所不同（请参阅第 19.3.3 节 “配置日志记录级别”）。默认设置为 WARNING。

指定控制台处理程序类用于格式化日志消息的 java.util.logging 格式ter 类。默认设置为 java.util.logging.SimpleFormatter。

配置文件处理程序

例 19.4 “配置文件处理程序” 显示配置文件处理程序的代码。

例 19.4. 配置文件处理程序

handlers= java.util.logging.FileHandler

文件处理程序还支持例 19.5 “文件处理程序配置属性” 中显示的配置属性。

例 19.5. 文件处理程序配置属性

java.util.logging.FileHandler.pattern = %h/java%u.log
java.util.logging.FileHandler.limit = 50000
java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter

例 19.5 “文件处理程序配置属性” 中显示的配置属性如下：

指定输出文件的位置和模式。默认设置为您的主目录。

以字节为单位，指定日志记录器写入任何一个文件的最大值。默认设置为 50000。如果将其设置为零，则日志记录器写入任何一个文件没有限制。

指定要循环的输出文件数量。默认设置为 1。

指定文件处理程序类用于格式化日志消息的 java.util.logging 格式ter 类。默认设置为 java.util.logging.XMLFormatter。

配置控制台处理器和文件处理程序

您可以通过指定控制台处理器和文件处理器（用逗号分开）将日志记录实用程序输出到控制台和文件处理程序，如配置两个控制台日志和文件所示。

配置两个控制台日志和文件

Logging

handlers= java.util.logging.FileHandler, java.util.logging.ConsoleHandler

19.3.3. 配置日志记录级别

日志级别

java.util.logging 框架支持以下日志级别，从最详细到详细信息：

严重
WARNING
INFO
CONFIG
FINE
FINER
FINEST

配置全局日志级别

要配置所有日志记录器中记录的事件类型，请配置全局日志记录级别，如例 19.6 “配置全局日志记录级别” 所示。

例 19.6. 配置全局日志记录级别

.level= WARNING

在独立软件包中配置日志记录

level

java.util.logging 框架支持配置单个软件包级别的日志记录。例如，例 19.7 “在软件包级别配置日志记录” 中显示的代码行在 com.xyz.foo 软件包中的类上的 SEVERE 级别配置日志。

例 19.7. 在软件包级别配置日志记录

com.xyz.foo.level = SEVERE

19.4. 在命令行中启用日志记录

概述

在启动应用程序时，您可以通过定义 java.util.logging.config.file 属性在应用程序上运行日志记录实用程序。您可以指定默认的 logging.properties 文件或与该应用程序唯一的 logging.properties 文件。

在应用程序中指定日志配置文件

start-up

在启动应用程序时，在应用程序启动时指定日志添加例 19.8 “在命令行中启动日志记录的标记” 中显示的标志。

例 19.8. 在命令行中启动日志记录的标记

-Djava.util.logging.config.file=myfile

19.5. 子系统和服务的日志记录

概述

您可以使用 “在独立软件包中配置日志记录”一节中描述的 com.xyz.foo.level 配置属性为指定的 Apache CXF 日志记录子系统设置精细的日志记录。

Apache CXF 日志记录子系统

表 19.2 “Apache CXF Logging Subsystems” 显示可用 Apache CXF 日志记录子系统列表。

表 19.2. Apache CXF Logging Subsystems
子系统	描述
`org.apache.cxf.aegis`	Aegis 绑定
`org.apache.cxf.binding.coloc`	共存绑定
`org.apache.cxf.binding.http`	HTTP 绑定
`org.apache.cxf.binding.jbi`	JBI 绑定
`org.apache.cxf.binding.object`	Java 对象绑定
`org.apache.cxf.binding.soap`	SOAP 绑定
`org.apache.cxf.binding.xml`	XML 绑定
`org.apache.cxf.bus`	Apache CXF 总线
`org.apache.cxf.configuration`	配置框架
`org.apache.cxf.endpoint`	服务器和客户端端点
`org.apache.cxf.interceptor`	拦截器
`org.apache.cxf.jaxws`	JAX-WS 风格的消息交换的前端、JAX-WS 处理程序处理以及与 JAX-WS 和配置的拦截器
`org.apache.cxf.jbi`	JBI 容器集成类
`org.apache.cxf.jca`	JCA 容器集成类
`org.apache.cxf.js`	JavaScript 前端
`org.apache.cxf.transport.http`	HTTP 传输
`org.apache.cxf.transport.https`	使用 HTTPS 的安全 HTTP 传输版本
`org.apache.cxf.transport.jbi`	JBI 传输
`org.apache.cxf.transport.jms`	JMS 传输
`org.apache.cxf.transport.local`	使用本地文件系统进行传输
`org.apache.cxf.transport.servlet`	用于将 JAX-WS 端点加载到 servlet 容器中的 HTTP 传输和 servlet 实施
`org.apache.cxf.ws.addressing`	WS-Addressing 实现
`org.apache.cxf.ws.policy`	WS-Policy 实现
`org.apache.cxf.ws.rm`	WS-ReliableMessaging (WS-RM)实施
`org.apache.cxf.ws.security.wss4j`	WSS4J 安全实现

示例

WS-Addressing 示例包含在 InstallDir/samples/ws_addressing 目录中。日志记录在位于该目录中的 logging.properties 文件中进行配置。相关的配置行在例 19.9 “为 WS-Address 配置日志记录” 中显示。

例 19.9. 为 WS-Address 配置日志记录

java.util.logging.ConsoleHandler.formatter = demos.ws_addressing.common.ConciseFormatter
...
org.apache.cxf.ws.addressing.soap.MAPCodec.level = INFO

例 19.9 “为 WS-Address 配置日志记录” 中的配置启用了与 WS-Addressing 标头相关的日志消息的侦听，并以简洁的形式将它们显示到控制台中。

有关运行此示例的详情，请查看位于 InstallDir/samples/ws_addressing 目录中的 README.txt 文件。

19.6. 日志记录消息内容

概述

您可以记录服务和消费者之间发送的消息的内容。例如，您可能想要记录在服务和消费者之间发送的 SOAP 消息的内容。

配置消息内容日志记录

要记录服务与消费者之间发送的消息，反之亦然，请完成以下步骤：

在端点的配置中添加日志记录功能。
将日志记录功能添加到您的使用者配置中。
配置日志记录系统 log INFO 级别的信息。

在端点中添加日志记录功能

添加日志功能您的端点配置，如例 19.10 “将日志记录添加到端点配置” 所示。

例 19.10. 将日志记录添加到端点配置

<jaxws:endpoint ...>
  <jaxws:features>
    <bean class="org.apache.cxf.feature.LoggingFeature"/>
  </jaxws:features>
</jaxws:endpoint>

例 19.10 “将日志记录添加到端点配置” 中显示的 XML 示例启用了记录 SOAP 信息。

在使用者中添加日志记录功能

添加日志功能您的客户端配置，如例 19.11 “将日志记录添加到客户端配置” 所示。

例 19.11. 将日志记录添加到客户端配置

<jaxws:client ...>
   <jaxws:features>
      <bean class="org.apache.cxf.feature.LoggingFeature"/>
    </jaxws:features>
</jaxws:client>

例 19.11 “将日志记录添加到客户端配置” 中显示的 XML 示例启用了记录 SOAP 信息。

设置日志记录以记录 INFO 级别的信息

确保服务关联的 logging.properties 文件被配置为记录 INFO 级别的信息，如例 19.12 “将日志记录级别设置为 INFO” 所示。

例 19.12. 将日志记录级别设置为 INFO

.level= INFO
java.util.logging.ConsoleHandler.level = INFO

记录 SOAP 信息

要查看 SOAP 消息的日志，修改位于 InstallDir/samples/wsdl_first 目录中的 wsdl_first 示例应用程序，如下所示：

将例 19.13 “Logging SOAP 消息的端点配置” 中显示的 jaxws:features 元素添加到位于 wsdl_first 示例目录中的 cxf.xml 配置文件中：

例 19.13. Logging SOAP 消息的端点配置

<jaxws:endpoint name="{http://apache.org/hello_world_soap_http}SoapPort"
                createdFromAPI="true">
  <jaxws:properties>
    <entry key="schema-validation-enabled" value="true" />
  </jaxws:properties>
  <jaxws:features>
    <bean class="org.apache.cxf.feature.LoggingFeature"/>
  </jaxws:features>
</jaxws:endpoint>

示例使用默认的 logging.properties 文件，该文件位于 InstallDir/etc 目录中。制作此文件的副本，并将其命名为 mylogging.properties。
在 mylogging.properties 文件中，通过编辑 .level 和 java.util.logging.ConsoleHandler.level 配置属性将日志记录级别更改为 INFO ：
```
.level= INFO
java.util.logging.ConsoleHandler.level = INFO
```

使用 cxf.xml 文件和 mylogging.properties 文件中的新配置设置启动服务器，如下所示：

平台命令 +

Windows

启动 java -Djava.util.logging.config.file=%CXF_HOME%\etc\mylogging.properties demo.hw.server.Server

UNIX

java -Djava.util.logging.config.file=$CXF_HOME/etc/mylogging.properties demo.hw.server.Server &

使用以下命令启动 hello 全局客户端：

平台命令 +

Windows

java -Djava.util.logging.config.file=%CXF_HOME%\etc\mylogging.properties demo.hw.client.Client .\wsdl\hello_world.wsdl

UNIX

java -Djava.util.logging.config.file=$CXF_HOME/etc/mylogging.properties demo.hw.client.Client ./wsdl/hello_world.wsdl

SOAP 消息记录到控制台。

第 20 章部署 WS-Addressing

摘要

Apache CXF 支持 JAX-WS 应用程序的 WS-寻址。本章论述了如何在 Apache CXF 运行时环境中部署 WS-Addressing。

20.1. WS-Addressing 简介

概述

WS-寻址是一种规范，允许服务以传输中立的方式进行通信信息。它由两个部分组成：

与 Web 服务端点通信参考的结构
组消息寻址属性(MAP)，用于将寻址信息与特定信息相关联

支持的规格

Apache CXF 支持 WS-Addressing 2004/08 规范和 WS-Addressing 2005/03 规格。

20.2. WS-Addressing Interceptors

概述

在 Apache CXF 中，WS-Addressing 功能实施为拦截器。Apache CXF 运行时使用拦截器来截获和处理正在发送和接收的原始消息。当传输收到消息时，它会创建一个消息对象，并通过拦截器链发送该消息。如果 WS-Addressing 拦截器添加到应用程序的拦截器链，则会处理消息中包含的任何 WS-Addressing 信息。

WS-Addressing Interceptors

WS-Addressing 实施由两个拦截器组成，如表 20.1 “WS-Addressing Interceptors” 所述。

表 20.1. WS-Addressing Interceptors
拦截器	描述
`org.apache.cxf.ws.addressing.MAPAggregator`	负责聚合用于传出消息的消息地址属性(MAPs)的逻辑拦截器。
`org.apache.cxf.ws.addressing.soap.MAPCodec`	负责将消息寻址属性(MAPs)编码和解码为 SOAP 标头的协议特定的拦截器。

20.3. 启用 WS-Addressing

概述

要启用 WS-Addressing WS-Addressing 拦截器，必须添加到入站和出站拦截器链中。这可以通过以下方法之一完成：

Apache CXF 功能
RMAssertion 和 WS-Policy Framework
在 WS-Addressing 功能中使用 Policy Assertion

添加 WS-Addressing 作为功能

通过在客户端和服务器配置中添加 WS-Addressing 功能来启用 WS-Addressing 功能，如例 20.1 “client.xml 和将 WS-Addressing 功能添加到客户端配置” 和例 20.2 “server.xml 和 Adding WS-Addressing 功能到服务器配置” 所示。

例 20.1. client.xml 和将 WS-Addressing 功能添加到客户端配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:jaxws="http://cxf.apache.org/jaxws"
       xmlns:wsa="http://cxf.apache.org/ws/addressing"
       xsi:schemaLocation="
          http://www.springframework.org/schema/beans
          http://www.springframework.org/schema/beans/spring-beans.xsd
          http://cxf.apache.org/ws/addressing
          http://cxf.apache.org/schemas/ws-addr-conf.xsd">

    <jaxws:client ...>
        <jaxws:features>
            <wsa:addressing/>
        </jaxws:features>
    </jaxws:client>
</beans>

例 20.2. server.xml 和 Adding WS-Addressing 功能到服务器配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:jaxws="http://cxf.apache.org/jaxws"
       xmlns:wsa="http://cxf.apache.org/ws/addressing"
       xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <jaxws:endpoint ...>
        <jaxws:features>
            <wsa:addressing/>
        </jaxws:features>
    </jaxws:endpoint>
</beans>

20.4. 配置 WS-Addressing 属性

概述

Apache CXF WS-Addressing 功能元素在命名空间 http://cxf.apache.org/ws/addressing 中定义。它支持表 20.2 “WS-Addressing 属性” 中描述的两个属性。

表 20.2. WS-Addressing 属性
属性名称	值
`allowDuplicates`	确定是否容忍重复的 MessageID 的布尔值。默认设置为 `true`。
`usingAddressingAdvisory`	指明 WSDL 中是否存在 `UsingAddressing` 元素的布尔值仅用于公告；也就是说，它没有阻止 WS-Addressing 标头的编码。

配置 WS-Addressing 属性

通过添加属性和您要将其设置为服务器或客户端配置文件中的 WS-Addressing 功能来配置 WS-Addressing 属性。例如，以下配置提取服务器端点上的 allowDuplicates 属性设为 false ：

<beans ... xmlns:wsa="http://cxf.apache.org/ws/addressing" ...>
    <jaxws:endpoint ...>
        <jaxws:features>
            <wsa:addressing allowDuplicates="false"/>
        </jaxws:features>
    </jaxws:endpoint>
</beans>

使用嵌入在功能中的 WS-Policy 断言

在例 20.3 “使用策略配置 WS-Addressing” 中，寻址策略断言来启用非匿名响应，并嵌入在 策略 元素中。

例 20.3. 使用策略配置 WS-Addressing

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:wsa="http://cxf.apache.org/ws/addressing"
        xmlns:wsp="http://www.w3.org/2006/07/ws-policy"
        xmlns:policy="http://cxf.apache.org/policy-config"
        xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
        xmlns:jaxws="http://cxf.apache.org/jaxws"
        xsi:schemaLocation="
http://www.w3.org/2006/07/ws-policy http://www.w3.org/2006/07/ws-policy.xsd
http://cxf.apache.org/ws/addressing http://cxf.apache.org/schema/ws/addressing.xsd
http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <jaxws:endpoint name="{http://cxf.apache.org/greeter_control}GreeterPort"
                    createdFromAPI="true">
        <jaxws:features>
            <policy:policies>
                <wsp:Policy xmlns:wsam="http://www.w3.org/2007/02/addressing/metadata">
                    <wsam:Addressing>
                        <wsp:Policy>
                            <wsam:NonAnonymousResponses/>
                        </wsp:Policy>
                    </wsam:Addressing>
                </wsp:Policy>
            <policy:policies>
        </jaxws:features>
    </jaxws:endpoint>
</beans>

第 21 章启用可靠的消息传递

摘要

Apache CXF 支持 WS-可靠消息传递(WS-RM)。本章论述了如何在 Apache CXF 中启用和配置 WS-RM。

21.1. WS-RM 简介

概述

WS-可靠Messaging (WS-RM)是一种协议，可确保在分布式环境中可靠地传送消息。它使得在存在软件、系统或网络故障的分布式应用程序之间可靠传递消息。

例如，WS-RM 可用于确保网络只按正确的顺序传送正确的消息。

WS-RM 的工作原理

WS-RM 可确保在源和目标端点之间可靠发送消息。源是消息的初始发件人，目的地是最终接收器，如图 21.1 “Web 服务可靠消息传递” 所示。

图 21.1. Web 服务可靠消息传递

WS-RM 消息的流可以如下所述：

RM 源向 RM 目的地发送 CreateSequence 协议消息。它包含接收确认的端点的引用( wsrm:AcksTo 端点)。
RM 目的地将 CreateSequenceResponse 协议消息发送回 RM 源。此消息包含 RM 序列会话的序列 ID。
RM 源在应用程序源发送的每个消息中添加 RM Sequence 标头。此标头包含序列 ID 和唯一消息 ID。
RM 源将每条消息传输到 RM 目的地。
RM 目的地通过发送包含 RM SequenceAcknowledgement 标头的消息来确认来自 RM 源的消息。
RM 目的地以精确的顺序向应用程序目的地提供消息。
RM 源重新传输尚未收到确认的消息。
第一个重新传输尝试会在基本重新传输间隔后进行。默认情况下，连续重新传输尝试会按指数避退间隔，或者以固定间隔进行。如需了解更多详细信息，请参阅第 21.5 节 “配置 WS-RM”。

这整个过程对请求和响应消息都进行对称；即，在响应消息的情况下，服务器充当 RM 源，客户端充当 RM 目的地。

WS-RM 交付保证

WS-RM 可在分布式环境中保证可靠的消息交付，无论使用的传输协议如何。如果无法可靠交付，则源或目的地端点会记录错误。

支持的规格

Apache CXF 支持以下 WS-RM 规格版本：

WS-ReliableMessaging 1.0

（默认） Corresp onds 到 2005 年 2 月发布版本，现已过期。但是，由于向后兼容的原因，这个版本被用作默认设置。

WS-RM 的版本 1.0 使用以下命名空间：

http://schemas.xmlsoap.org/ws/2005/02/rm/

这个版本的 WS-RM 可与以下 WS-Addressing 版本之一一起使用：

http://schemas.xmlsoap.org/ws/2004/08/addressing (default)
http://www.w3.org/2005/08/addressing

严格讲，为了遵守 2005 年 2 月发布版本的 WS-RM，您期望使用这些 WS-寻址版本中的第一个版本（这是 Apache CXF 中的默认设置）。但是，大多数其他 Web 服务实施已切换到最新的 WS-Addressing 规格，因此 Apache CXF 允许您选择 WS-A 版本，以促进互操作性（请参阅第 21.4 节 “运行时控制”）。

WS-ReliableMessaging 1.1/1.2

对应于官方 1.1/1.2 Web 服务可靠消息传递规范。

WS-RM 版本 1.1 和 1.2 使用以下命名空间：

http://docs.oasis-open.org/ws-rx/wsrm/200702

WS-RM 的 1.1 和 1.2 版本使用以下 WS-Addressing 版本：

http://www.w3.org/2005/08/addressing

选择 WS-RM 版本

您可以选择要使用的 WS-RM 规格版本，如下所示：

服务器侧: 在提供程序上，Apache CXF 可调整客户端使用 WS-ReliableMessaging 的每个版本并对其做出相应的响应。
客户端: 在客户端一端，WS-RM 版本由您在客户端配置中使用的命名空间（请参阅第 21.5 节 “配置 WS-RM”）或者在运行时覆盖 WS-RM 版本（请参阅第 21.4 节 “运行时控制”）。

21.2. WS-RM 拦截器

概述

在 Apache CXF 中，WS-RM 功能实施为拦截器。Apache CXF 运行时使用拦截器来截获和处理正在发送和接收的原始消息。当传输收到消息时，它会创建一个消息对象，并通过拦截器链发送该消息。如果应用的拦截器链包含 WS-RM 拦截器，应用程序可以参与可靠的消息传递会话。WS-RM 拦截器处理消息块的集合和聚合。他们还处理所有确认和重新传输逻辑。

Apache CXF WS-RM 拦截器

Apache CXF WS-RM 实施由四个拦截器组成，该拦截器在表 21.1 “Apache CXF WS-ReliableMessaging Interceptors” 所述。

表 21.1. Apache CXF WS-ReliableMessaging Interceptors
拦截器	描述
`org.apache.cxf.ws.rm.RMOutInterceptor`	处理为外发消息提供可靠性保证的逻辑方面。负责发送 `CreateSequence` 请求并等待其 `CreateSequenceResponse` 响应。另外，还负责聚合序列 properties-ID 和消息编号（用于应用程序消息）。
`org.apache.cxf.ws.rm.RMInInterceptor`	负责截获和处理 RM 协议消息和 `序列Acknowledgement` 信息，这些消息受制于应用程序消息的支持。
`org.apache.cxf.ws.rm.RMCaptureInInterceptor`	缓存持久存储的传入消息。
`org.apache.cxf.ws.rm.RMDeliveryInterceptor`	确保向应用交付消息。
`org.apache.cxf.ws.rm.soap.RMSoapInterceptor`	负责将可靠性属性编码和解码为 SOAP 标头。
`org.apache.cxf.ws.rm.RetransmissionInterceptor`	负责为将来的重新发送创建应用程序消息副本。

启用 WS-RM

在拦截器链上存在 WS-RM 拦截器可确保在必要时会交换 WS-RM 协议消息。例如，当截获出站拦截器链上的第一条应用程序消息时，RMOutInterceptor 发送 CreateSequence 请求并等待处理原始应用程序消息，直到它收到 CreateSequenceResponse 响应。此外，WS-RM 拦截器将序列标头添加到应用程序消息中，并在目标一侧提取它们。不需要对应用程序代码进行任何更改，从而能够可靠交换消息。

有关如何启用 WS-RM 的更多信息，请参阅第 21.3 节 “启用 WS-RM”。

配置 WS-RM 属性

您可以通过配置控制对可靠交换的可靠交换的序列和其他方面的内容。例如，默认情况下，Apache CXF 会尝试最大化序列的生命周期，从而降低带外 WS-RM 协议消息产生的开销。要强制使用每个应用程序消息的独立序列，请配置 WS-RM 源序列终止策略（将最大序列长度设置为 1）。

有关配置 WS-RM 行为的更多信息，请参阅第 21.5 节 “配置 WS-RM”。

21.3. 启用 WS-RM

概述

要启用可靠的消息传递，必须将 WS-RM 拦截器添加到入站和出站消息和故障的拦截器链中。由于 WS-RM 拦截器使用 WS-Addressing，因此拦截器必须在拦截器链上也存在 WS-Addressing 拦截器。

您可以通过以下两种方式之一确保存在这些拦截器：

显式，使用 Spring beans 将它们添加到分配链中
隐式，使用 WS-Policy 断言，这会导致 Apache CXF 运行时代表您的添加拦截器。

Spring Bean：明确添加拦截器

要启用 WS-RM，将 WS-RM 和 WS-Addressing 拦截器添加到 Apache CXF 总线，或使用 Spring bean 配置将 WS-RM 和 WS-Addressing 拦截器添加到消费者或服务端点。这是在 WS-RM 示例中执行的方法，可在 InstallDir/samples/ws_rm 目录中找到。配置文件 ws-rm.cxf 显示了 WS-RM 和 WS-Addressing 拦截器被添加一站为 Spring Bean （请参阅例 21.1 “使用 Spring Bean 启用 WS-RM”）。

例 21.1. 使用 Spring Bean 启用 WS-RM

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/
   beans http://www.springframework.org/schema/beans/spring-beans.xsd">
   <bean id="mapAggregator" class="org.apache.cxf.ws.addressing.MAPAggregator"/>
   <bean id="mapCodec" class="org.apache.cxf.ws.addressing.soap.MAPCodec"/>
   <bean id="rmLogicalOut" class="org.apache.cxf.ws.rm.RMOutInterceptor">
        <property name="bus" ref="cxf"/>
   </bean>
   <bean id="rmLogicalIn" class="org.apache.cxf.ws.rm.RMInInterceptor">
        <property name="bus" ref="cxf"/>
   </bean>
   <bean id="rmCodec" class="org.apache.cxf.ws.rm.soap.RMSoapInterceptor"/>
   <bean id="cxf" class="org.apache.cxf.bus.CXFBusImpl">
        <property name="inInterceptors">
            <list>
                <ref bean="mapAggregator"/>
                <ref bean="mapCodec"/>
                <ref bean="rmLogicalIn"/>
                <ref bean="rmCodec"/>
            </list>
        </property>
        <property name="inFaultInterceptors">
            <list>
                <ref bean="mapAggregator"/>
                <ref bean="mapCodec"/>
                <ref bean="rmLogicalIn"/>
                <ref bean="rmCodec"/>
            </list>
        </property>
        <property name="outInterceptors">
            <list>
                <ref bean="mapAggregator"/>
                <ref bean="mapCodec"/>
                <ref bean="rmLogicalOut"/>
                <ref bean="rmCodec"/>
            </list>
        </property>
        <property name="outFaultInterceptors">
            <list>
                <ref bean="mapAggregator">
                <ref bean="mapCodec"/>
                <ref bean="rmLogicalOut"/>
                <ref bean="rmCodec"/>
            </list>
        </property>
    </bean>
</beans>

例 21.1 “使用 Spring Bean 启用 WS-RM” 中显示的代码可以按如下方式进行说明：

Apache CXF 配置文件是一个 Spring XML 文件。您必须包含一个打开 Spring Bean 元素，用于声明由 Bean 元素封装的子元素的命名空间和 schema 文件。

配置每个 WS-Addressing interceptors-MAPAggregator 和 MAPCodec。有关 WS-Addressing 的更多信息，请参阅第 20 章 部署 WS-Addressing。

配置每个 WS-RM 拦截器-RMOutInterceptor、RMInInterceptor、RMSoapInterceptor。

将 WS-Addressing 和 WS-RM 拦截器添加到用于入站消息的拦截器链。

将 WS-Addressing 和 WS-RM 拦截器添加到用于入站故障的拦截器链中。

将 WS-Addressing 和 WS-RM 拦截器添加到用于出站消息的拦截器链。

将 WS-Addressing 和 WS-RM 拦截器添加到用于出站故障的拦截器链。

WS-Policy 框架：隐式添加拦截器

WS-Policy 框架提供可用于使用 WS-Policy 的基础架构和 API。它符合 2006 年 11 月的草案，发布 Web Services Policy 1.5-Framework 和 Web Services Policy 1.5-Attachment 规格。

要使用 Apache CXF WS-Policy 框架启用 WS-RM，请执行以下操作：

在您的客户端和服务器端点中添加策略功能。例 21.2 “使用 WS-RM 配置 WS-Policy” 显示 jaxws:feature 元素内嵌套的 bean 引用。reference bean 指定 AddressingPolicy，它定义为同一配置文件中的一个单独的元素。

例 21.2. 使用 WS-RM 配置 WS-Policy

<jaxws:client>
    <jaxws:features>
      <ref bean="AddressingPolicy"/>
    </jaxws:features>
</jaxws:client>
<wsp:Policy wsu:Id="AddressingPolicy" xmlns:wsam="http://www.w3.org/2007/02/addressing/metadata">
    <wsam:Addressing>
      <wsp:Policy>
        <wsam:NonAnonymousResponses/>
      </wsp:Policy>
    </wsam:Addressing>
</wsp:Policy>

将可靠的消息传递策略添加到 wsdl:service 元素 - 或其他 WSDL 元素，这些元素可用作策略或策略引用元素的附件点 - 到 WSDL 文件，如例 21.3 “在 WSDL 文件中添加 RM 策略” 所示。

例 21.3. 在 WSDL 文件中添加 RM 策略

<wsp:Policy wsu:Id="RM"
   xmlns:wsp="http://www.w3.org/2006/07/ws-policy"
   xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <wsam:Addressing xmlns:wsam="http://www.w3.org/2007/02/addressing/metadata">
        <wsp:Policy/>
    </wsam:Addressing>
    <wsrmp:RMAssertion xmlns:wsrmp="http://schemas.xmlsoap.org/ws/2005/02/rm/policy">
        <wsrmp:BaseRetransmissionInterval Milliseconds="10000"/>
    </wsrmp:RMAssertion>
</wsp:Policy>
...
<wsdl:service name="ReliableGreeterService">
    <wsdl:port binding="tns:GreeterSOAPBinding" name="GreeterPort">
        <soap:address location="http://localhost:9020/SoapContext/GreeterPort"/>
        <wsp:PolicyReference URI="#RM" xmlns:wsp="http://www.w3.org/2006/07/ws-policy"/>
    </wsdl:port>
</wsdl:service>

21.4. 运行时控制

概述

可在客户端代码中设置多个消息上下文属性值，以便在运行时控制 WS-RM，其主要值由 org.apache.cxf.ws.rm.RMManager 类中的公共常数定义。

运行时控制选项

下表列出了 org.apache.cxf.ws.rm.RMManager 类定义的密钥。

键	描述
`WSRM_VERSION_PROPERTY`	字符串 WS-RM 版本命名空间(`http://schemas.xmlsoap.org/ws/2005/02/rm/` 或 `http://docs.oasis-open.org/ws-rx/wsrm/200702)。`
`WSRM_WSA_VERSION_PROPERTY`	字符串 WS-Addressing 版本命名空间(`http://schemas.xmlsoap.org/ws/2004/08/addressing` 或 `http://www.w3.org/2005/08/addressing`)- 除非您使用 `http://schemas.xmlsoap.org/ws/2005/02/rm/` RM 命名空间，否则此属性将被忽略。
`WSRM_LAST_MESSAGE_PROPERTY`	布尔值 `true` 可告知 WS-RM 代码被发送，允许代码关闭 WS-RM 序列和释放资源（自 3.0.0 版本 CXF 起，WS-RM 将默认关闭 RM 序列）。
`WSRM_INACTIVITY_TIMEOUT_PROPERTY`	以毫秒为单位进行长期不活跃超时。
`WSRM_RETRANSMISSION_INTERVAL_PROPERTY`	较长的基础重新传输间隔（以毫秒为单位）。
`WSRM_EXPONENTIAL_BACKOFF_PROPERTY`	布尔值 exponential back-off 标志。
`WSRM_ACKNOWLEDGEMENT_INTERVAL_PROPERTY`	长期确认间隔（以毫秒为单位）。

通过 JMX 控制 WS-RM

您还可以使用 Apache CXF 的 JMX 管理功能监控和管理 WS-RM 的许多方面。JMX 操作的完整列表由 org.apache.cxf.ws.rm.ManagedRMManager 和 org.apache.cxf.ws.rm.ManagedRMEndpoint 定义，但这些操作包括查看当前 RM 状态到单独的消息级别。您还可以使用 JXM 关闭或终止 WS-RM 序列，并在远程 RM 端点确认时接收之前的消息的通知。

JMX 控制示例

例如，如果您的客户端配置中启用了 JMX 服务器，则可使用以下代码来跟踪收到的最后一次确认号：

// Java
private static class AcknowledgementListener implements NotificationListener {
    private volatile long lastAcknowledgement;

    @Override
    public void handleNotification(Notification notification, Object handback) {
        if (notification instanceof AcknowledgementNotification) {
            AcknowledgementNotification ack = (AcknowledgementNotification)notification;
            lastAcknowledgement = ack.getMessageNumber();
        }
    }

    // initialize client
...
    // attach to JMX bean for notifications
    //  NOTE: you must have sent at least one message to initialize RM before executing this code
    Endpoint ep = ClientProxy.getClient(client).getEndpoint();
    InstrumentationManager im = bus.getExtension(InstrumentationManager.class);
    MBeanServer mbs = im.getMBeanServer();
    RMManager clientManager = bus.getExtension(RMManager.class);
    ObjectName name = RMUtils.getManagedObjectName(clientManager, ep);
    System.out.println("Looking for endpoint name " + name);
    AcknowledgementListener listener = new AcknowledgementListener();
    mbs.addNotificationListener(name, listener, null, null);

    // send messages using RM with acknowledgement status reported to listener
...

21.5. 配置 WS-RM

21.5.1. 配置 Apache CXF 特定 WS-RM 属性

概述

要配置特定于 Apache CXF 的属性，请使用 rmManager Spring bean。在您的配置文件中添加以下内容：

到命名空间列表的 http://cxf.apache.org/ws/rm/manager 命名空间。
用于您要配置的特定属性的 rmManager Spring bean。

例 21.4 “配置 Apache CXF 特定 WS-RM 属性” 显示一个简单的示例。

例 21.4. 配置 Apache CXF 特定 WS-RM 属性

&lt;beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:wsrm-mgr="http://cxf.apache.org/ws/rm/manager"
      xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
 http://cxf.apache.org/ws/rm/manager http://cxf.apache.org/schemas/configuration/wsrm-manager.xsd"&gt;
...
&lt;wsrm-mgr:rmManager&gt;
&lt;!--
  ...Your configuration goes here
--&gt;
&lt;/wsrm-mgr:rmManager&gt;

rmManager Spring bean 的子项

表 21.2 “rmManager Spring Bean 的子项” 显示 http://cxf.apache.org/ws/rm/manager 命名空间中定义的 rmManager Spring bean 的子元素。

表 21.2. rmManager Spring Bean 的子项
element	描述
`RMAssertion`	类型的 `RMAssertion`元素
`deliveryAssurance`	一个类型为 `DeliveryAsuranceType` 元素，用于描述应应用的发送保证
`sourcePolicy`	一个类型为 `SourcePolicyType` 的元素，供您配置 RM 源详情
`destinationPolicy`	一个类型为 `DestinationPolicyType` 的元素，供您配置 RM 目的地详情

示例

例如，请参阅 “最多未确认的消息阈值”一节。

21.5.2. 配置标准 WS-RM 策略属性

概述

您可以使用以下方法之一配置标准 WS-RM 策略属性：

“rmManager Spring bean 中的 RMAssertion”一节
“功能中的策略”一节
“WSDL 文件”一节
“外部附加”一节

WS-Policy RMAssertion Children

表 21.3 “WS-Policy RMAsertion Element 的子项” 显示 http://schemas.xmlsoap.org/ws/2005/02/rm/policy 命名空间中定义的元素：

表 21.3. WS-Policy RMAsertion Element 的子项
名称	描述
`InactivityTimeout`	指定在端点可以视为因为不活跃而终止的 RM 序列前必须收到消息前必须经过的时间长度。
`BaseRetransmissionInterval`	设置确认在 RM Source 中给定邮件必须接收的间隔。如果 `BaseRetransmissionInterval` 设定的时间内未收到确认，RM Source 将重新传输该消息。
`ExponentialBackoff`	表示将使用通常已知的 exponential backoff 算法(Tanenbaum)调整重新传输间隔。如需更多信息，请参阅 Computer Networks, Andrew S. Tanenbaum, Prentice Hall PTR, 2003。
`AcknowledgementInterval`	在 WS-RM 中，确认会在返回信息上发送或发送独立消息。如果返回消息无法发送确认，则 RM Destination 可以在发送独立确认前等待确认间隔。如果没有未被确认的消息，则 RM Destination 不能被确认。

更详细的参考信息

如需更详细的参考信息，包括每个元素和属性的描述，请参阅 http://schemas.xmlsoap.org/ws/2005/02/rm/wsrm-policy.xsd。

rmManager Spring bean 中的 RMAssertion

您可以通过在 Apache CXF rmManager Spring bean 中添加 RMAssertion 来配置标准 WS-RM 策略属性。如果您想在同一配置文件中保留所有 WS-RM 配置，这是最佳的方法。也就是说，如果要在同一文件中配置特定于 Apache CXF 的属性和标准 WS-RM 策略属性。

例如，例 21.5 “在 rmManager Spring Bean 中使用 RMAsertion 配置 WS-RM 属性” 中的配置会显示：

使用 rmManager Spring bean 中的 RMAsertion 配置的标准 WS- RM 策略属性 BaseRetransmissionInterval。
同一配置文件中配置的 Apache CXF 特定 RM 属性 intraMessageThreshold。

例 21.5. 在 rmManager Spring Bean 中使用 RMAsertion 配置 WS-RM 属性

<beans xmlns:wsrm-policy="http://schemas.xmlsoap.org/ws/2005/02/rm/policy"
       xmlns:wsrm-mgr="http://cxf.apache.org/ws/rm/manager"
...>
<wsrm-mgr:rmManager id="org.apache.cxf.ws.rm.RMManager">
    <wsrm-policy:RMAssertion>
        <wsrm-policy:BaseRetransmissionInterval Milliseconds="4000"/>
    </wsrm-policy:RMAssertion>
    <wsrm-mgr:destinationPolicy>
        <wsrm-mgr:acksPolicy intraMessageThreshold="0" />
    </wsrm-mgr:destinationPolicy>
</wsrm-mgr:rmManager>
</beans>

功能中的策略

您可以在功能中配置标准 WS-RM 策略属性，如例 21.6 “在功能中将 WS-RM 属性配置为策略” 所示。

例 21.6. 在功能中将 WS-RM 属性配置为策略

<xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:wsa="http://cxf.apache.org/ws/addressing"
        xmlns:wsp="http://www.w3.org/2006/07/ws-policy"
        xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
        xmlns:jaxws="http://cxf.apache.org/jaxws"
        xsi:schemaLocation="
http://www.w3.org/2006/07/ws-policy http://www.w3.org/2006/07/ws-policy.xsd
http://cxf.apache.org/ws/addressing http://cxf.apache.org/schema/ws/addressing.xsd
http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    <jaxws:endpoint name="{http://cxf.apache.org/greeter_control}GreeterPort" createdFromAPI="true">
        <jaxws:features>
               <wsp:Policy>
                   <wsrm:RMAssertion xmlns:wsrm="http://schemas.xmlsoap.org/ws/2005/02/rm/policy">
                     <wsrm:AcknowledgementInterval Milliseconds="200" />
                   </wsrm:RMAssertion>
                   <wsam:Addressing xmlns:wsam="http://www.w3.org/2007/02/addressing/metadata">
                       <wsp:Policy>
                            <wsam:NonAnonymousResponses/>
                       </wsp:Policy>
                   </wsam:Addressing>
              </wsp:Policy>
        </jaxws:features>
    </jaxws:endpoint>
</beans>

WSDL 文件

如果使用 WS-Policy 框架启用 WS-RM，您可以在 WSDL 文件中配置标准 WS-RM 策略属性。如果您希望服务进行互操作并使用 WS-RM 与部署到其他策略感知的 Web 服务堆栈的用户无缝使用，这是不错的方法。

例如，请参阅 “WS-Policy 框架：隐式添加拦截器”一节，其中基本重新传输间隔在 WSDL 文件中配置。

外部附加

您可以在外部附件文件中配置标准 WS-RM 策略属性。如果您无法或不想更改 WSDL 文件，这是不错的方法。

例 21.7 “在外部附加中配置 WS-RM” 显示为特定 EPR 启用 WS-A 和 WS-RM （基础重新传输间隔 30 秒）的外部附加。

例 21.7. 在外部附加中配置 WS-RM

<attachments xmlns:wsp="http://www.w3.org/2006/07/ws-policy" xmlns:wsa="http://www.w3.org/2005/08/addressing">
    <wsp:PolicyAttachment>
        <wsp:AppliesTo>
           <wsa:EndpointReference>
                <wsa:Address>http://localhost:9020/SoapContext/GreeterPort</wsa:Address>
            </wsa:EndpointReference>
        </wsp:AppliesTo>
        <wsp:Policy>
            <wsam:Addressing xmlns:wsam="http://www.w3.org/2007/02/addressing/metadata">
                <wsp:Policy/>
            </wsam:Addressing>
            <wsrmp:RMAssertion xmlns:wsrmp="http://schemas.xmlsoap.org/ws/2005/02/rm/policy">
                <wsrmp:BaseRetransmissionInterval Milliseconds="30000"/>
            </wsrmp:RMAssertion>
        </wsp:Policy>
    </wsp:PolicyAttachment>
</attachments>/

21.5.3. WS-RM 配置用例

概述

本小节重点介绍从用例角度配置 WS-RM 属性。如果属性是 http://schemas.xmlsoap.org/ws/2005/02/rm/policy/ 命名空间中定义的标准 WS-RM 策略属性，则只显示在 rmManager Spring bean 中的 RMAssertion 中设置它的示例。有关如何在功能内设置这样的属性 ; 在 WSDL 文件或外部附加中，请参阅第 21.5.2 节 “配置标准 WS-RM 策略属性”。

涵盖了以下用例：

“基本重新传输间隔”一节
“重新传输的 exponential backoff”一节
“确认间隔”一节
“最多未确认的消息阈值”一节
“RM 序列的最大长度”一节
“消息发送保证策略”一节

基本重新传输间隔

BaseRetransmissionInterval 元素指定 RM 源重新传输消息尚未被确认的间隔。它在 http://schemas.xmlsoap.org/ws/2005/02/rm/wsrm-policy.xsd 模式文件中定义。默认值为 3000 毫秒。

例 21.8 “设置 WS-RM Base Retransmission Interval” 显示如何设置 WS-RM 基本重新传输间隔。

例 21.8. 设置 WS-RM Base Retransmission Interval

<beans xmlns:wsrm-policy="http://schemas.xmlsoap.org/ws/2005/02/rm/policy
...>
<wsrm-mgr:rmManager id="org.apache.cxf.ws.rm.RMManager">
    <wsrm-policy:RMAssertion>
        <wsrm-policy:BaseRetransmissionInterval Milliseconds="4000"/>
    </wsrm-policy:RMAssertion>
</wsrm-mgr:rmManager>
</beans>

重新传输的 exponential backoff

ExponentialBackoff 元素确定是否以指数级间隔执行非确认的消息尝试连续重传输尝试。

存在 ExponentialBackoff 元素可启用此功能。默认会使用 exponential backoff 比率为 2。ExponentialBackoff 是一个标志。当元素存在时，会启用 exponential backoff。当元素不存在时，则禁用 exponential backoff。不需要值。

例 21.9 “设置 WS-RM Exponential Backoff Property” 显示如何为重新传输设置 WS-RM exponential backoff。

例 21.9. 设置 WS-RM Exponential Backoff Property

<beans xmlns:wsrm-policy="http://schemas.xmlsoap.org/ws/2005/02/rm/policy
...>
<wsrm-mgr:rmManager id="org.apache.cxf.ws.rm.RMManager">
    <wsrm-policy:RMAssertion>
        <wsrm-policy:ExponentialBackoff/>
    </wsrm-policy:RMAssertion>
</wsrm-mgr:rmManager>
</beans>

确认间隔

AcknowledgementInterval 元素指定 WS-RM 目的地发送异步确认的间隔。另外，除了它在收到传入消息时发送的同步确认之外。默认异步确认间隔为 0 毫秒。这意味着，如果 AcknowledgementInterval 没有被配置为特定值，则会立即发送确认信息（即在第一可用商机中）。

只有在满足以下任一条件时，RM 目标才会发送异步确认：

RM 目的地使用非匿名 wsrm:acksTo 端点。
在确认间隔到期前不会发生响应消息确认机会。

例 21.10 “设置 WS-RM 致谢 Interval” 显示如何设置 WS-RM 确认间隔。

例 21.10. 设置 WS-RM 致谢 Interval

<beans xmlns:wsrm-policy="http://schemas.xmlsoap.org/ws/2005/02/rm/policy
...>
<wsrm-mgr:rmManager id="org.apache.cxf.ws.rm.RMManager">
    <wsrm-policy:RMAssertion>
        <wsrm-policy:AcknowledgementInterval Milliseconds="2000"/>
    </wsrm-policy:RMAssertion>
</wsrm-mgr:rmManager>
</beans>

最多未确认的消息阈值

maxUnack nowled 属性设置在终止序列前可以获取每个序列的最大未确认消息数。

例 21.11 “设置 WS-RM Maximum Unacknowled Message Threshold” 显示如何设置 WS-RM 最大无法确认的消息阈值。

例 21.11. 设置 WS-RM Maximum Unacknowled Message Threshold

<beans xmlns:wsrm-mgr="http://cxf.apache.org/ws/rm/manager
...>
<wsrm-mgr:reliableMessaging>
    <wsrm-mgr:sourcePolicy>
        <wsrm-mgr:sequenceTerminationPolicy maxUnacknowledged="20" />
    </wsrm-mgr:sourcePolicy>
</wsrm-mgr:reliableMessaging>
</beans>

RM 序列的最大长度

maxLength 属性设置 WS-RM 序列的最大长度。默认值为 0， 这表示 WS-RM 序列的长度为 unbound。

当设置了此属性时，RM 端点会在达到限制时创建一个新的 RM 序列，并在收到之前发送的消息的所有确认后。新消息使用新的排序发送。

例 21.12 “设置 WS-RM 消息序列的最大长度” 显示如何设置 RM 序列的最大长度。

例 21.12. 设置 WS-RM 消息序列的最大长度

<beans xmlns:wsrm-mgr="http://cxf.apache.org/ws/rm/manager
...>
<wsrm-mgr:reliableMessaging>
    <wsrm-mgr:sourcePolicy>
        <wsrm-mgr:sequenceTerminationPolicy maxLength="100" />
    </wsrm-mgr:sourcePolicy>
</wsrm-mgr:reliableMessaging>
</beans>

消息发送保证策略

您可以将 RM 目标配置为使用以下发送保证策略：

AtMostOnce - RM 目的地仅向应用程序目的地发送一次。如果引发了错误，则发送一条消息超过一次。可能不会发送序列中的一些消息。
AtLeastOnce - RM 目标至少将消息传送到应用程序目的地。发送的每个消息都会进行交付，或引发错误。有些消息可能会多一次发送。
InOrder - RM 目的地按发送的顺序将消息传送到应用程序目的地。这种交付保障可与 AtMostOnce 或 AtLeastOnce ures 结合使用。

例 21.13 “设置 WS-RM 消息发送保证策略” 介绍如何设置 WS-RM 消息发送保证。

例 21.13. 设置 WS-RM 消息发送保证策略

<beans xmlns:wsrm-mgr="http://cxf.apache.org/ws/rm/manager
...>
<wsrm-mgr:reliableMessaging>
    <wsrm-mgr:deliveryAssurance>
        <wsrm-mgr:AtLeastOnce />
    </wsrm-mgr:deliveryAssurance>
</wsrm-mgr:reliableMessaging>
</beans>

21.6. 配置 WS-RM Persistence

概述

在本章中已描述的 Apache CXF WS-RM 功能为网络故障等情况提供了可靠性。WS-RM 持久性提供跨其他类型的故障的可靠性，如 RM 源或 RM 目标崩溃。

WS-RM 持久性涉及将各种 RM 端点的状态存储在持久存储中。这可让端点在收到通知时继续发送和接收信息。

Apache CXF 在配置文件中启用 WS-RM 持久性。默认的 WS-RM 持久性存储是基于 JDBC。为方便起见，Apache CXF 包括 Derby 进行即用部署。另外，永久存储也使用 Java API 公开。要实施自己的持久性机制，您可以使用这个 API 与您首选的 DB 来实施。

重要

WS-RM 持久性仅支持单向调用，默认是禁用的。

如何使用

Apache CXF WS-RM 持久性如下：

在 RM 源端点中，传出的消息会在传输前保留。它在收到确认后从持久性存储中驱除。
从崩溃恢复后，它会恢复保留的消息并重新传输，直到所有消息都已确认为止。此时，RM 序列将关闭。
在 RM 目标端点中，进入的消息会被保留，并在成功存储后发送确认信息。当消息被成功分配时，它将从持久性存储中驱除。
从崩溃恢复后，它会恢复持久的消息并分配它们。它还将 RM 序列设置为接受、确认和交付新消息的状态。

启用 WS-persistence

要启用 WS-RM 持久性，您必须为 WS-RM 指定实施持久性存储的对象。您可以自行开发，也可以使用基于 Apache CXF 随附的 JDBC 存储。

例 21.14 “配置默认 WS-RM Persistence 存储” 中显示的配置启用了基于 JDBC 的存储，该存储与 Apache CXF 一同启用。

例 21.14. 配置默认 WS-RM Persistence 存储

<bean id="RMTxStore" class="org.apache.cxf.ws.rm.persistence.jdbc.RMTxStore"/>
<wsrm-mgr:rmManager id="org.apache.cxf.ws.rm.RMManager">
    <property name="store" ref="RMTxStore"/>
</wsrm-mgr:rmManager>

配置 WS-persistence

由 Apache CXF 附带的基于 JDBC 的存储支持表 21.4 “JDBC 存储属性” 中显示的属性。

表 21.4. JDBC 存储属性
属性名称	类型	默认设置
`driverClassName`	`字符串`	`org.apache.derby.jdbc.EmbeddedDriver`
`userName`	`字符串`	null
`passWord`	`字符串`	null
`url`	`字符串`	jdbc:derby:rmdb;create=true

例 21.15 “为 WS-RM Persistence 配置 JDBC 存储” 中显示的配置启用了基于 JDBC 的存储，该存储与 Apache CXF 一同启用，同时将 driverClassName 和 url 设置为非默认值。

例 21.15. 为 WS-RM Persistence 配置 JDBC 存储

<bean id="RMTxStore" class="org.apache.cxf.ws.rm.persistence.jdbc.RMTxStore">
    <property name="driverClassName" value="com.acme.jdbc.Driver"/>
    <property name="url" value="jdbc:acme:rmdb;create=true"/>
</bean>

第 22 章启用高可用性

摘要

本章论述了如何在 Apache CXF 运行时启用和配置高可用性。

22.1. 高可用性简介

概述

可扩展且可靠的应用程序需要高可用性，以避免分布式系统中任何单点故障。您可以使用以下方法使系统不受单点故障进行保护 复制的服务 ：

复制的服务由同一服务 的多个实例 或副本组成。它们作为一个逻辑服务相结合。客户端在复制的服务上调用请求，而 Apache CXF 将请求提供给其中一个成员副本。对客户端而言，对副本的路由是透明的。

带有静态故障切换的 HA

Apache CXF 支持具有静态故障转移的高可用性(HA)，其中副本详细信息在服务 WSDL 文件中进行编码。WSDL 文件包含多个端口，可为同一服务包含多个主机。只要 WSDL 文件保持不变，集群中的副本数量仍保持静态。更改集群大小涉及编辑 WSDL 文件。

22.2. 使用 Static Failover 启用 HA

概述

要使用静态故障切换启用 HA，您必须执行以下操作：

“在服务 WSDL 文件中编码副本详情”一节
“在客户端配置中添加集群功能”一节

在服务 WSDL 文件中编码副本详情

您必须在服务 WSDL 文件中对集群中副本的详情进行编码。例 22.1 “使用静态故障转移启用 HA：WSDL 文件” 显示定义三个副本的服务集群的 WSDL 文件提取。

例 22.1. 使用静态故障转移启用 HA：WSDL 文件

<wsdl:service name="ClusteredService">
    <wsdl:port binding="tns:Greeter_SOAPBinding" name="Replica1">
        <soap:address location="http://localhost:9001/SoapContext/Replica1"/>
    </wsdl:port>

    <wsdl:port binding="tns:Greeter_SOAPBinding" name="Replica2">
        <soap:address location="http://localhost:9002/SoapContext/Replica2"/>
    </wsdl:port>

    <wsdl:port binding="tns:Greeter_SOAPBinding" name="Replica3">
        <soap:address location="http://localhost:9003/SoapContext/Replica3"/>
    </wsdl:port>

</wsdl:service>

例 22.1 “使用静态故障转移启用 HA：WSDL 文件” 中显示的 WSDL 提取可如下所示：

定义服务 ClusterService，在三个端口上公开：

Replica1
Replica2
Replica3

定义 Replica1 以通过 HTTP 端点在端口 9001 上公开 ClusterService 作为 SOAP。

定义 Replica2 将 ClusterService 公开为通过 HTTP 端点在端口 9002 上的 SOAP。

定义 Replica3 以通过 HTTP 端点在 9003 上公开 ClusterService 作为 SOAP。

在客户端配置中添加集群功能

在客户端配置文件中，添加集群功能，如例 22.2 “使用静态故障转移启用 HA：客户端配置” 所示。

例 22.2. 使用静态故障转移启用 HA：客户端配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:jaxws="http://cxf.apache.org/jaxws"
       xmlns:clustering="http://cxf.apache.org/clustering"
         xsi:schemaLocation="http://cxf.apache.org/jaxws
         http://cxf.apache.org/schemas/jaxws.xsd
         http://www.springframework.org/schema/beans
         http://www.springframework.org/schema/beans/spring-beans.xsd">

    <jaxws:client name="{http://apache.org/hello_world_soap_http}Replica1"
                  createdFromAPI="true">
        <jaxws:features>
            <clustering:failover/>
        </jaxws:features>
    </jaxws:client>

    <jaxws:client name="{http://apache.org/hello_world_soap_http}Replica2"
                  createdFromAPI="true">
        <jaxws:features>
            <clustering:failover/>
        </jaxws:features>
    </jaxws:client>

    <jaxws:client name="{http://apache.org/hello_world_soap_http}Replica3"
                  createdFromAPI="true">
        <jaxws:features>
            <clustering:failover/>
        </jaxws:features>
    </jaxws:client>

</beans>

22.3. 使用 Static Failover 配置 HA

概述

默认情况下，如果客户端通信的原始服务不可用，具有静态故障转移的 HA 会使用一个后续策略。顺序策略会在每次使用时以相同的顺序选择副本服务。选择由 Apache CXF 的内部服务模型决定，从而产生确定的故障转移模式。

配置随机策略

您可以使用静态故障转移配置 HA，以便在选择副本时使用随机策略而不是后续策略。随机策略在每次服务不可用时选择随机副本服务，或者失败时。从集群中的 surviving 成员中选择故障转移目标是完全随机的。

要配置随机策略，请将例 22.3 “为 Static Failover 配置随机策略” 中显示的配置添加到您的客户端配置文件中。

例 22.3. 为 Static Failover 配置随机策略

<beans ...>
    <bean id="Random" class="org.apache.cxf.clustering.RandomStrategy"/>

    <jaxws:client name="{http://apache.org/hello_world_soap_http}Replica3"
                  createdFromAPI="true">
        <jaxws:features>
            <clustering:failover>
                <clustering:strategy>
                    <ref bean="Random"/>
                </clustering:strategy>
            </clustering:failover>
        </jaxws:features>
    </jaxws:client>
</beans>

例 22.3 “为 Static Failover 配置随机策略” 中显示的配置可以按如下方式进行说明：

定义实施随机策略的 Random bean 和实施类。

指定在选择副本时使用随机策略。

第 23 章 Apache CXF Binding ID

绑定 ID 表

表 23.1. Message Bindings 的绑定 ID
绑定	ID
CORBA	`http://cxf.apache.org/bindings/corba`
HTTP/REST	`http://apache.org/cxf/binding/http`
SOAP 1.1	`http://schemas.xmlsoap.org/wsdl/soap/http`
SOAP 1.1 w/ MTOM	`http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true`
SOAP 1.2	`http://www.w3.org/2003/05/soap/bindings/HTTP/`
SOAP 1.2 w/ MTOM	`http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true`
XML	`http://cxf.apache.org/bindings/xformat`

附录 A. 使用 Maven OSGi 工具

摘要

为大型项目手动创建捆绑包或捆绑包集合可能会非常繁琐。Maven bundle 插件通过自动化流程并提供多个快捷方式来指定捆绑包清单的内容，使作业变得更加容易。

A.1. Maven Bundle Plug-In

红帽 Fuse OSGi 工具使用来自 Apache Felix 的 Maven 捆绑包插件。bundle 插件基于 Peter Kriens 中的 bnd 工具。它通过内省要打包在捆绑包中的类的内容来自动构建 OSGi 捆绑包清单。利用捆绑包中包含的类知识，插件可以计算正确的值来填充捆绑包清单中的 Import-Packages 和 Export-Package 属性。该插件也具有用于捆绑包清单中其他必要属性的默认值。

要使用 bundle 插件，请执行以下操作：

第 A.2 节 “设置红帽 Fuse OSGi 项目” 项目的 POM 文件的 bundle 插件。
第 A.3 节 “配置捆绑插件” 插件可正确填充捆绑包的清单。

A.2. 设置红帽 Fuse OSGi 项目

概述

构建 OSGi 捆绑包的 Maven 项目可以是一个简单的单级项目。它不需要任何子项目。但是，它需要您进行以下操作：

将 bundle 插件添加到 POM。
指示 Maven 将结果打包为 OSGi 捆绑包。

注意

您可以使用多个 Maven archetypes 来使用适当的设置设置项目。

目录结构

构建 OSGi 捆绑包的项目可以是单一级别的项目。它仅要求您拥有顶级 POM 文件和 src 文件夹。如在所有 Maven 项目中，您要将所有 Java 源代码放在 src/java 文件夹中，并将任何非 Java 资源放在 src/resources 文件夹中。

非 Java 资源包括 Spring 配置文件、JBI 端点配置文件和 WSDL 合同。

注意

使用 Apache CXF、Apache Camel 或其他配置的 Spring bean 的红帽 Fuse OSGi 项目还包括位于 src/resources/META-INF/spring 文件夹下的 Bean.xml 文件。

添加捆绑包插件

在使用 bundle 插件前，您必须添加对 Apache Felix 的依赖项。添加依赖项后，您可以将捆绑包插件添加到 POM 的插件部分。

例 A.1 “将 OSGi 捆绑包插件添加到 POM” 显示将捆绑包插件添加到您的项目中所需的 POM 条目。

例 A.1. 将 OSGi 捆绑包插件添加到 POM

...
<dependencies>
  <dependency>
    <groupId>org.apache.felix</groupId>
    <artifactId>org.osgi.core</artifactId>
    <version>1.0.0</version>
  </dependency>
...
</dependencies>
...
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.felix</groupId>
      <artifactId>maven-bundle-plugin</artifactId>
      <configuration>
        <instructions>
          <Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName>
          <Import-Package>*,org.apache.camel.osgi</Import-Package>
          <Private-Package>org.apache.servicemix.examples.camel</Private-Package>
        </instructions>
      </configuration>
    </plugin>
  </plugins>
</build>
...

例 A.1 “将 OSGi 捆绑包插件添加到 POM” 中的条目如下：

添加对 Apache Felix 的依赖关系

将 bundle 插件添加到项目中

配置插件，以使用项目的工件 ID 作为捆绑包的符号链接名称

配置插件，使其包含由捆绑类导入的所有 Java 软件包；也导入 org.apache.camel.osgi 软件包

配置插件以捆绑列出的类，但不包含在导出的软件包列表中

注意

编辑配置，以满足您的项目要求。

有关配置捆绑包插件的更多信息，请参阅第 A.3 节 “配置捆绑插件”。

激活捆绑包插件

要让 Maven 使用 bundle 插件，以指示它将项目的结果打包为捆绑包。通过将 POM 文件的 打包 元素设置为 捆绑包来实现此目的。

有用的 Maven archetypes

有几个 Maven archetypes 可用于生成预配置以使用 bundle 插件的项目：

“Spring OSGi archetype”一节
“Apache CXF code-first archetype”一节
“Apache CXF wsdl-first archetype”一节
“Apache Camel archetype”一节

Spring OSGi archetype

Spring OSGi archetype 为使用 Spring DM 构建 OSGi 项目创建通用项目，如下所示：

org.springframework.osgi/spring-bundle-osgi-archetype/1.1.2

您可以使用以下命令调用 archetype：

mvn archetype:generate -DarchetypeGroupId=org.springframework.osgi -DarchetypeArtifactId=spring-osgi-bundle-archetype -DarchetypeVersion=1.1.2 -DgroupId=groupId -DartifactId=artifactId -Dversion=version

Apache CXF code-first archetype

Apache CXF code-first archetype 创建一个项目，用于从 Java 构建服务，如下所示：

org.apache.servicemix.tooling/servicemix-osgi-cxf-code-first-archetype/2010.02.0-fuse-02-00

您可以使用以下命令调用 archetype：

mvn archetype:generate -DarchetypeGroupId=org.apache.servicemix.tooling -DarchetypeArtifactId=servicemix-osgi-cxf-code-first-archetype -DarchetypeVersion=2010.02.0-fuse-02-00 -DgroupId=groupId -DartifactId=artifactId -Dversion=version

Apache CXF wsdl-first archetype

Apache CXF wsdl-first archetype 为从 WSDL 创建服务的项目创建一个项目，如下所示：

org.apache.servicemix.tooling/servicemix-osgi-cxf-wsdl-first-archetype/2010.02.0-fuse-02-00

您可以使用以下命令调用 archetype：

mvn archetype:generate -DarchetypeGroupId=org.apache.servicemix.tooling -DarchetypeArtifactId=servicemix-osgi-cxf-wsdl-first-archetype -DarchetypeVersion=2010.02.0-fuse-02-00 -DgroupId=groupId -DartifactId=artifactId -Dversion=version

Apache Camel archetype

Apache Camel archetype 创建一个项目来构建部署到 Red Hat Fuse 中的路由，如下所示：

org.apache.servicemix.tooling/servicemix-osgi-camel-archetype/2010.02.0-fuse-02-00

您可以使用以下命令调用 archetype：

mvn archetype:generate -DarchetypeGroupId=org.apache.servicemix.tooling -DarchetypeArtifactId=servicemix-osgi-camel-archetype -DarchetypeVersion=2010.02.0-fuse-02-00 -DgroupId=groupId -DartifactId=artifactId -Dversion=version

A.3. 配置捆绑插件

概述

捆绑包插件需要很少的信息才能正常工作。所有必要属性均使用默认设置来生成有效的 OSGi 捆绑包。

虽然您可以使用仅使用默认值创建有效的捆绑包，但您可能想修改一些值。您可以在插件的 instructions 元素中指定大多数属性。

配置属性

以下是一些常用的配置属性：

Bundle-SymbolicName
Bundle-Name
Bundle-Version
export-Package
Private-Package
Import-Package

设置捆绑包的符号链接名称

默认情况下，bundle 插件将 Bundle-SymbolicName 属性的值设置为 groupId + "." + artifactId，但有以下例外：

如果 groupId 只有一个部分（没有点），则返回第一个带有类的软件包名称。
例如，如果组 Id 是 commons-logging:commons-logging，则捆绑包的符号链接名称为 org.apache.commons.logging。
如果 artifactId 等于 groupId 的最后一个部分，则使用 groupId。
例如，如果 POM 将组 ID 和工件 ID 指定为 org.apache.maven:maven，则捆绑包的符号名称为 org.apache.maven。
如果 artifactId 以 groupId 的最后一个部分开头，则删除该部分。
例如，如果 POM 将组 ID 和工件 ID 指定为 org.apache.maven:maven-core，则捆绑包的符号名称为 org.apache.maven.core。

要为捆绑包的符号名称指定您自己的值，请在插件的 instructions 元素中添加 Bundle-SymbolicName 子，如例 A.2 “设置捆绑包的符号链接名称” 所示。

例 A.2. 设置捆绑包的符号链接名称

<plugin>
  <groupId>org.apache.felix</groupId>
  <artifactId>maven-bundle-plugin</artifactId>
  <configuration>
   <instructions>
     <Bundle-SymbolicName>${project.artifactId}</Bundle-SymbolicName>
     ...
    </instructions>
  </configuration>
</plugin>

设置捆绑包的名称

默认情况下，捆绑包的名称设置为 ${project.name}。

要为捆绑包名称指定您自己的值，在插件的 instructions 元素中添加 Bundle-Name 子项，如例 A.3 “设置捆绑包的名称” 所示。

例 A.3. 设置捆绑包的名称

<plugin>
  <groupId>org.apache.felix</groupId>
  <artifactId>maven-bundle-plugin</artifactId>
  <configuration>
   <instructions>
     <Bundle-Name>JoeFred</Bundle-Name>
     ...
    </instructions>
  </configuration>
</plugin>

设置捆绑包的版本

默认情况下，捆绑包的版本设置为 ${project.version}。任何短划线(-)都用点(.)替代，数字最多为四个数字。例如，4.2-SNAPSHOT 变为 4.2.0.SNAPSHOT。

要为捆绑包版本指定您自己的值，在插件的 instructions 元素中添加 Bundle-Version 子，如例 A.4 “设置捆绑包的版本” 所示。

例 A.4. 设置捆绑包的版本

<plugin>
  <groupId>org.apache.felix</groupId>
  <artifactId>maven-bundle-plugin</artifactId>
  <configuration>
   <instructions>
     <Bundle-Version>1.0.3.1</Bundle-Version>
     ...
    </instructions>
  </configuration>
</plugin>

指定导出的软件包

默认情况下，OSGi 清单的 Export-Package 列表由本地 Java 源代码中的所有软件包（在 src/main/java下）填充，但默认软件包 . . 以及包含 .impl 或 .internal 的任何软件包。

重要

如果您在插件配置中使用 Private-Package 元素，且您没有指定要导出的软件包列表，则默认行为仅包括捆绑包中列出的 Private-Package 元素中列出的软件包。没有导出软件包。

默认行为可能会导致非常大的软件包，并导出应保持私有的软件包。要更改导出的软件包列表，您可以将 Export-Package 子级添加到插件的 instructions 元素中。

Export-Package 元素指定要包含在捆绑包中的软件包列表，以及要导出的软件包列表。可以使用 * 通配符符号指定软件包名称。例如，条目 com.fuse.demo.* 包含项目以 com.fuse.demo 开头的类路径上的所有软件包。

您可以指定要排除的软件包前缀为 ! 的条目。例如，条目 !com.fuse.demo.private 排除软件包 com.fuse.demo.private。

当排除软件包时，列表中的条目顺序非常重要。该列表从开始的顺序处理，并忽略后续任何后续字典条目。

例如，要包含从 com.fuse.demo 开头的所有软件包，但 com.fuse.demo.private 除外，请使用以下内容列出软件包：

!com.fuse.demo.private,com.fuse.demo.*

但是，如果您使用 com.fuse.demo.*,!com.fuse.demo.private 列出了软件包，那么 com.fuse.demo.private 将包含在捆绑包中，因为它与第一个模式匹配。

指定私有软件包

如果要指定包括在捆绑包中的软件包列表而不导出它们，您可以在捆绑包插件配置中添加一个 Private-Package 指令。默认情况下，如果没有指定 Private-Package 指令，您的本地 Java 源中的所有软件包都包含在捆绑包中。

重要

如果软件包与 Private-Package 元素和 Export-Package 元素中的条目匹配，则 Export-Package 元素具有优先权。软件包会添加到捆绑包中并导出。

Private-Package 元素与中的 Export-Package 元素的工作方式与您在捆绑包中包含的软件包列表类似。bundle 插件使用 list 来查找要包含在捆绑包中的项目类路径上的所有类。这些软件包打包在捆绑包中，但不导出（除非它们也由 Export-Package 指令选择）。

例 A.5 “在捆绑包中包含私有软件包” 显示在捆绑包中包含私有软件包的配置

例 A.5. 在捆绑包中包含私有软件包

<plugin>
  <groupId>org.apache.felix</groupId>
  <artifactId>maven-bundle-plugin</artifactId>
  <configuration>
   <instructions>
     <Private-Package>org.apache.cxf.wsdlFirst.impl</Private-Package>
     ...
    </instructions>
  </configuration>
</plugin>

指定导入的软件包

默认情况下，bundle 插件使用捆绑包内容引用的所有软件包列表填充 OSGi 清单的 Import-Package 属性。

虽然默认行为通常足以满足大多数项目，但您可能会发现您要导入没有自动添加到列表中的软件包的实例。默认行为也可以导致导入不需要的软件包。

要指定捆绑包要导入的软件包列表，请将 Import-Package 子添加到插件的 instructions 元素中。软件包列表的语法与 Export-Package 元素和 Private-Package 元素相同。

重要

当您使用 Import-Package 元素时，插件不会自动扫描捆绑包的内容，以确定是否需要导入。要确保捆绑包的内容被扫描，您必须将 * 作为软件包列表中的最后一个条目。

例 A.6 “指定捆绑包导入的软件包” 显示指定捆绑包导入的软件包的配置

例 A.6. 指定捆绑包导入的软件包

<plugin>
  <groupId>org.apache.felix</groupId>
  <artifactId>maven-bundle-plugin</artifactId>
  <configuration>
   <instructions>
     <Import-Package>javax.jws, javax.wsdl, org.apache.cxf.bus, org.apache.cxf.bus.spring, org.apache.cxf.bus.resource, org.apache.cxf.configuration.spring, org.apache.cxf.resource, org.springframework.beans.factory.config, * </Import-Package>
     ...
   </instructions>
  </configuration>
</plugin>

部分 V. 使用 JAX-WS 开发应用程序

本指南论述了如何使用标准的 JAX-WS API 开发 Web 服务。

第 24 章底启用服务开发

摘要

有许多实例已实现 Java 代码，您想要作为面向服务的应用程序的一部分提供的一组功能。您也可能简单地避免使用 WSDL 定义您的接口。使用 JAX-WS 注解，您可以添加服务启用 Java 类所需的信息。您还可以创建一个可用于取代 WSDL 合同的服务端点接口 (SEI)。如果您需要 WSDL 合同，Apache CXF 提供从注释的 Java 代码生成合同的工具。

24.1. JAX-WS 服务开发简介

要创建从 Java 启动的服务，您必须执行以下操作：

第 24.2 节 “创建 SEI” 一个 Service Endpoint Interface (SEI)，用于定义您要公开为服务的方法。
注意
您可以直接从 Java 类工作，但建议从接口中工作。界面更适合与负责开发服务的应用程序的开发人员共享。接口比较小，不提供任何服务的实施详细信息。
第 24.3 节 “为代码添加注解” 代码所需的注解。
第 24.4 节 “生成 WSDL” 面向服务的 WSDL 合同。
注意
如果您希望使用 SEI 作为服务合同，则不需要生成 WSDL 合同。
第 31 章 发布服务 服务作为服务提供商。

24.2. 创建 SEI

概述

服务端点接口 (SEI)是 Java 代码的一部分，在服务实施和在该服务上发出请求的用户之间共享。SEI 定义服务实施的方法，并提供有关如何将服务公开为端点的详细信息。从 WSDL 合同开始，SEI 由代码生成器生成。但是，从 Java 开始时，开发人员负责创建 SEI。创建 SEI 有两种基本模式：

绿色字段开发 - 在这个模式中，您正在没有现有 Java 代码或 WSDL 的情况下开发新服务。最好先创建 SEI。然后，您可以将 SEI 分发给负责实施使用 SEI 的服务提供商和消费者的任何开发人员。
注意
推荐执行绿色字段服务开发方式，即首先创建一个定义服务及其接口的 WSDL 合同。请参阅第 26 章 启动点 WSDL 合同。
服务启用 - 在这种模式中，您通常具有作为 Java 类实施的现有功能集合，并且您希望启用该服务。这意味着您必须执行两个操作：
1. 创建一个 SEI，仅包含 作为服务一部分公开的操作。
2. 修改现有的 Java 类，使其实施 SEI。
  注意
  虽然您可以将 JAX-WS 注解添加到 Java 类中，但不推荐这样做。

编写接口

SEI 是标准的 Java 接口。它定义了类实施的一组方法。它还可以定义多个成员字段，以及实施类可访问的常量。

如果定义的方法为 SEI，应当映射到服务公开的操作。SEI 对应于 wsdl:portType 元素。SEI 定义的方法对应于 wsdl: portType 元素。

注意

JAX-WS 定义了一个注解，允许您指定没有公开为服务一部分的方法。但是，最佳实践是将这些方法离开 SEI。

例 24.1 “简单 SEI” 为库存更新服务显示简单的 SEI。

例 24.1. 简单 SEI

package com.fusesource.demo;

public interface quoteReporter
{
  public Quote getQuote(String ticker);
}

实现接口

因为 SEI 是标准的 Java 接口，所以实施它的类是标准的 Java 类。如果以 Java 类开头，您必须进行修改以实施接口。如果您从 SEI 开始，实施类将实施 SEI。

例 24.2 “简单实施类” 显示在例 24.1 “简单 SEI” 中实现接口的类。

例 24.2. 简单实施类

package com.fusesource.demo;

import java.util.*;

public class stockQuoteReporter implements quoteReporter
{
  ...
public Quote getQuote(String ticker)
  {
    Quote retVal = new Quote();
    retVal.setID(ticker);
    retVal.setVal(Board.check(ticker));^[1]
    Date retDate = new Date();
    retVal.setTime(retDate.toString());
    return(retVal);
  }
}

^[1] Board is an assumed class whose implementation is left to the reader.

24.3. 为代码添加注解

24.3.1. JAX-WS Annotations 概述

JAX-WS 注解指定用于将 SEI 映射到完全指定的服务定义的元数据。在注解中提供的信息包括：

服务的目标命名空间。
用于保存请求消息的类名称
用于存放响应信息的类名称
如果某个操作是一个操作方法
服务使用的绑定风格
用于任何自定义例外的类名称
服务使用的类型下定义的命名空间

注意

大多数注解都有合理的默认值，因此不需要为其提供值。但是，在注解中提供的信息越多，指定了您的服务定义越好。精心指定的服务定义会增加分布式应用程序的所有部分将协同工作的可能性。

24.3.2. 所需的注解

概述

要从 Java 代码创建服务，您只需要为代码添加一个注解。您必须在 SEI 和实施类上添加 @WebService 注释。

@WebService 注释

@WebService 注释由 javax.jws.WebService 接口定义，它被放置在接口或旨在用作服务的类上。@webService 具有描述的属性表 24.1 “@WebService Properties”

表 24.1. @WebService Properties
属性	描述
`name`	指定服务接口的名称。此属性映射到 `wsdl:portType` 元素的 `name` 属性，用于定义 WSDL 合同中的服务接口。默认为将 `PortType` 附加到实现类的名称。^[a]
`targetNamespace`	指定定义服务的目标命名空间。如果没有指定此属性，则目标命名空间会派生自软件包名称。
`serviceName`	指定已发布的服务的名称。此属性映射到定义已发布服务的 `wsdl:service` 元素的 `name` 属性。默认为使用服务实施类的名称。
`wsdlLocation`	指定存储服务 WSDL 合同的 URL。这必须使用相对 URL 指定。默认值是部署该服务的 URL。
`endpointInterface`	指定实施类实施的 SEI 的完整名称。仅当属性用于服务实施类时，才会指定此属性。
`portName`	指定服务发布的端点的名称。此属性映射到 `wsdl:port` 元素的 `name` 属性，用于指定已发布服务的端点详细信息。默认为服务实施类的名称中添加 `Port`。
^[a] 从 SEI 生成 WSDL 时，会使用接口名称代替实施类的名称。

注意

不需要为任何 @WebService 注释的属性提供值。但是，建议您提供尽可能多的信息。

注解 SEI

SEI 要求您添加 @WebService 注释。由于 SEI 是定义服务的合同，因此您应在 @WebService 注释的属性中指定服务尽可能多的详细信息。

例 24.3 “带有 @WebService 注释的接口” 显示例 24.1 “简单 SEI” 中定义的接口，带有 @WebService 注释。

例 24.3. 带有 @WebService 注释的接口

package com.fusesource.demo;

import javax.jws.*;

@WebService(name="quoteUpdater",
            targetNamespace="http:\\demos.redhat.com",
	        serviceName="updateQuoteService",
            wsdlLocation="http:\\demos.redhat.com\quoteExampleService?wsdl",
            portName="updateQuotePort")
public interface quoteReporter
{
  public Quote getQuote(String ticker);
}

例 24.3 “带有 @WebService 注释的接口” 中的 @WebService 注释如下：

指定定义服务接口的 wsdl:portType 元素的 name 属性的值为 quoteUpdater。

指定服务的目标命名空间是 http:\\demos.redhat.com。

指定定义已发布服务的 wsdl:service 元素 的名称 值为 updateQuoteService。

指定该服务将在 http:\\demos.redhat.com\quoteExampleService?wsdl 上发布其 WSDL 合同。

指定定义服务所公开的端点的 wsdl:port 元素的 name 属性的值是 updateQuotePort。

为服务实施添加注解

除了使用 @WebService 注释注解 SEI 外，还必须使用 @WebService 注释给服务实施类标注。在服务实施类中添加注解时，您只需要指定 endpointInterface 属性。如例 24.4 “注解的服务实施类” 所示，属性必须设置为 SEI 的完整名称。

例 24.4. 注解的服务实施类

package org.eric.demo;

import javax.jws.*;

@WebService(endpointInterface="com.fusesource.demo.quoteReporter")
public class stockQuoteReporter implements quoteReporter
{
public Quote getQuote(String ticker)
  {
  ...
  }
}

24.3.3. 可选注解

摘要

虽然 @WebService 注释足以启用 Java 接口或 Java 类，但它并不完全描述该服务如何作为服务提供程序公开。JAX-WS 编程模型使用多个可选注解来添加服务详情，如它所使用的绑定，到 Java 代码。您可以将这些注解添加到服务的 SEI 中。

您在 SEI 中提供的更详细信息是，开发人员更容易实施可以使用它所定义的功能的应用程序。它还使 WSDL 文档更加具体地由工具生成。

概述

使用 Annotations 定义 Binding Properties

如果您将 SOAP 绑定用于您的服务，您可以使用 JAX-WS 注解来指定多个绑定属性。这些属性直接与您在服务 WSDL 合同中指定的属性对应。某些设置（如参数样式）可以限制您如何实施方法。这些设置也可以影响在注解方法参数时可以使用哪些注解。

@SOAPBinding 注解

@SOAPBinding 注释由 javax.jws.soap.SOAPBinding 接口定义。它提供有关在部署该服务时使用的 SOAP 绑定的详情。如果没有指定 @SOAPBinding 注解，则使用嵌套的 doc/literal SOAP 绑定发布服务。

您可以在 SEI 和任何 SEI 的方法上放置 @SOAPBinding 注释。在方法上使用时，优先使用方法的 @SOAPBinding 注解设置。

表 24.2 “@SOAPBinding Properties” 显示 @SOAPBinding 注释的属性。

表 24.2. @SOAPBinding Properties
属性	值	描述
`style`	样式.DOCUMENT （默认） Style.RPC	指定 SOAP 消息的样式。如果指定了 RPC 样式，则 SOAP 正文中的每个消息部分都是参数或返回值，并出现在 `soap:body` 元素中的 wrapper 元素中。wrapper 元素中的消息部分与操作参数对应，且必须与操作中的参数相同的顺序出现。如果指定了 DOCUMENT 样式，SOAP 正文的内容必须是有效的 XML 文档，但其表单不是严格限制的。
`use`	使用.LITERAL （默认）使用.ENCODED^[a]	指定 SOAP 消息的数据如何进行流处理。
`parameterStyle` ^[b]	ParameterStyle.BARE ParameterStyle.WRAPPED （默认）	指定在 WSDL 合同中与消息部分对应的方法参数如何放入 SOAP 消息正文。如果指定了 BARE，则每个参数都作为消息 root 的子元素放入消息正文中。如果指定了 WRAPPED，则所有输入参数都嵌套到请求消息上的单个元素中，并且所有输出参数都嵌套在响应消息中的单个元素中。
^[a] 目前不支持使用.ENCODED。 ^[b] 如果将 `风格` 设置为 RPC，则必须使用 WRAPPED 参数风格。

文档裸机参数

文档裸机是 Java 代码与服务生成的 XML 表示之间的直接映射。使用这种样式时，从操作的参数列表中定义的输入和输出参数直接生成模式类型。

您可以使用 @SOAPBinding 注释将其风格设置为 Style.DOCUMENT，并将其 parameterStyle 属性设置为 ParameterStyle.BARE，将其 parameterStyle 属性设为 ParameterStyle.BARE。

要确保在使用裸机参数时操作不会违反使用文档风格的限制，您的操作必须满足以下条件：

此操作不能有多个输入或输入/输出参数。
如果操作具有 void 以外的返回类型，则它不能有任何输出或输入/输出参数。
如果操作返回类型为 void，它不能有多个输出或输入/输出参数。

注意

任何使用 @WebParam 注释或 @WebResult 注释放置到 SOAP 标头的参数都不会计算出允许的参数数量。

文档嵌套参数

文档嵌套式样式允许更 RPC （如 Java 代码与服务生成的 XML 表示之间的映射）。使用这种样式时，方法参数列表中的参数被绑定嵌套到单个元素中。这样做的缺点是，它在 Java 实现之间引入了一个额外的间接层，以及如何将消息放在线上。

要指定您要使用嵌套的 document\literal 样式的 @SOAPBinding 注解，将其 样式 属性设置为 Style.DOCUMENT，且 参数Style 属性设为 ParameterStyle.WRAPPED。

您可以使用 “@RequestWrapper 注释”一节注解和 “@ResponseWrapper 注释”一节注解来控制如何生成 wrappers。

示例

例 24.5 “使用 SOAP 绑定注解指定文档 Bare SOAP Binding” 显示使用文档裸机 SOAP 消息的 SEI。

例 24.5. 使用 SOAP 绑定注解指定文档 Bare SOAP Binding

package org.eric.demo;

import javax.jws.*;
import javax.jws.soap.*;
import javax.jws.soap.SOAPBinding.*;

@WebService(name="quoteReporter")
@SOAPBinding(parameterStyle=ParameterStyle.BARE)
public interface quoteReporter
{
  ...
}

概述

使用注解定义操作属性

当运行时将您的 Java 方法定义映射到 XML 操作定义时，它将提供如下详细信息：

XML 中交换的消息是什么
如果消息可作为一种方法优化
定义消息的命名空间

@WebMethod 注释

@WebMethod 注释由 javax.jws.WebMethod 接口定义。它被放置在 SEI 中的方法上。@WebMethod 注释提供在 wsdl:operation 元素中通常会表示的信息，描述方法要关联的操作。

表 24.3 “@WebMethod Properties” 描述 @WebMethod 注释的属性。

表 24.3. @WebMethod Properties
属性	描述
`operationName`	指定关联的 `wsdl:operation` 元素 `的名称`。默认值为方法的名称。
`action`	指定为方法生成的 `soap:operation` 元素的 `soapAction` 属性的值。默认值为空字符串。
`exclude`	指定方法是否应该排除在服务接口中。默认值为 false。

@RequestWrapper 注释

@RequestWrapper 注释由 javax.xml.ws.RequestWrapper 接口定义。它被放置在 SEI 中的方法上。@RequestWrapper 注释指定用于启动消息交换方法参数的 wrapper bean 的 Java 类。它还指定在 marshalling 和 unmarshalling 和 unmarshalling 时使用的元素名称和命名空间。

表 24.4 “@RequestWrapper Properties” 描述 @RequestWrapper 注释的属性。

表 24.4. @RequestWrapper Properties
属性	描述
`localName`	指定请求消息 XML 表示中的 wrapper 元素的本地名称。默认值为方法的名称，或者 “@WebMethod 注释”一节注解的 `operationName` 属性的值。
`targetNamespace`	指定定义 XML 打包程序元素的命名空间。默认值为 SEI 的目标命名空间。
`className`	指定实现 wrapper 元素的 Java 类的完整名称。

注意

只有 className 属性才是必需的。

重要

如果方法还标有 @SOAPBinding 注释，并且其 parameterStyle 属性设为 ParameterStyle.BARE，则会忽略此注解。

@ResponseWrapper 注释

@ResponseWrapper 注释由 javax.xml.ws.ResponseWrapper 接口定义。它被放置在 SEI 中的方法上。@ResponseWrapper 指定在消息交换的响应消息中为方法参数实施打包程序 bean 的 Java 类。它还指定在 marshaling 和 unmarshalling the response 消息时使用的元素名称和命名空间。

表 24.5 “@ResponseWrapper Properties” 描述 @ResponseWrapper 注释的属性。

表 24.5. @ResponseWrapper Properties
属性	描述
`localName`	指定响应消息 XML 表示中的 wrapper 元素的本地名称。默认值为附加 Response 的方法的名称，或者附加了 Response 的 “@WebMethod 注释”一节注解的 `operationName` 属性的值。
`targetNamespace`	指定定义 XML 打包程序元素的命名空间。默认值为 SEI 的目标命名空间。
`className`	指定实现 wrapper 元素的 Java 类的完整名称。

注意

只有 className 属性才是必需的。

重要

如果方法还标上 @SOAPBinding 注释，其参数 Style 属性被设置为 ParameterStyle.BARE，则会忽略此注解。

@WebFault 注释

@WebFault 注释由 javax.xml.ws.WebFault 接口定义。它放置在您的 SEI 引发的例外上。@WebFault 注释用于将 Java 异常映射到 wsdl:fault 元素。此信息用于将例外分到可由服务及其用户处理的表示中。

表 24.6 “@WebFault Properties” 描述 @WebFault 注释的属性。

表 24.6. @WebFault Properties
属性	描述
`name`	指定 fault 元素的本地名称。
`targetNamespace`	指定定义 fault 元素的命名空间。默认值为 SEI 的目标命名空间。
`faultName`	指定实现异常的 Java 类的完整名称。

重要

name 属性是必需的。

@Oneway 注释

@Oneway 注释由 javax.jws.Oneway 接口定义。它被置于 SEI 中不需要从服务响应的方法。@Oneway 注释告知运行时，它可以通过等待响应来优化方法的执行，而不保留任何资源来处理响应。

此注解只能用于满足以下条件的方法：

它们返回 void
它们没有实现 Holder 接口的参数
它们不会抛出任何可传回消费者的异常

示例

例 24.6 “带有注解方法的 SEI” 显示 SEI，并标上了它的方法。

例 24.6. 带有注解方法的 SEI

package com.fusesource.demo;

import javax.jws.*;
import javax.xml.ws.*;

@WebService(name="quoteReporter")
public interface quoteReporter
{
  @WebMethod(operationName="getStockQuote")
  @RequestWrapper(targetNamespace="http://demo.redhat.com/types",
                  className="java.lang.String")
  @ResponseWrapper(targetNamespace="http://demo.redhat.com/types",
                   className="org.eric.demo.Quote")
  public Quote getQuote(String ticker);
}

概述

使用注释定义参数属性

SEI 中的方法参数对应于 wsdl:message 元素及其 wsdl:part 元素。JAX-WS 提供了注释，可用于描述为方法参数生成的 wsdl:part 元素。

@WebParam 注释

@WebParam 注释由 javax.jws.WebParam 接口定义。它放置在 SEI 中定义的方法参数中。通过 @WebParam 注释，您可以指定参数的方向，如果参数将放在 SOAP 标头中，并且生成的 wsdl:part 的其他属性中。

表 24.7 “@WebParam Properties” 描述 @WebParam 注释的属性。

表 24.7. @WebParam Properties
属性	值	描述
`name`		指定参数的名称，因为它出现在生成的 WSDL 文档中。对于 RPC 绑定，这是代表参数的 `wsdl:part` 的名称。对于文档绑定，这是代表参数的 XML 元素的本地名称。根据 JAX-WS 规格，默认值为 `arg N` ，其中 N 替换为零的参数索引（例如 arg0、arg1 等）。
`targetNamespace`		指定参数的命名空间。它仅与参数映射到 XML 元素的文档绑定一起使用。默认值为使用服务的命名空间。
`模式`	mode.IN （默认）^[a] mode.OUT Mode.INOUT	指定参数的方向。
`header`	false （默认） true	指定参数是否作为 SOAP 标头的一部分传递。
`partName`		指定参数 `wsdl:part` 元素的 `name` 属性的值。此属性用于文档风格的 SOAP 绑定。
^[a] 任何实施 Holder 接口的参数都会默认映射到 Mode.INOUT。

@WebResult 注释

@WebResult 注释由 javax.jws.WebResult 接口定义。它被置于 SEI 中定义的方法。通过 @WebResult 注释，您可以指定为方法返回值生成的 wsdl:part 的属性。

表 24.8 “@WebResult Properties” 描述 @WebResult 注释的属性。

表 24.8. @WebResult Properties
属性	描述
`name`	指定在生成的 WSDL 文档中出现的返回值的名称。对于 RPC 绑定，这是代表返回值的 `wsdl:part` 的名称。对于文档绑定，这是代表返回值的 XML 元素的本地名称。默认值为 return。
`targetNamespace`	指定返回值的命名空间。它仅用于返回值映射到 XML 元素的文档绑定。默认值为使用服务的命名空间。
`header`	指定返回值是否作为 SOAP 标头的一部分传递。
`partName`	指定返回值的 `wsdl:part` 元素的 `name` 属性的值。此属性用于文档风格的 SOAP 绑定。

示例

例 24.7 “完全注解 SEI” 显示已完全标注的 SEI。

例 24.7. 完全注解 SEI

package com.fusesource.demo;

import javax.jws.*;
import javax.xml.ws.*;
import javax.jws.soap.*;
import javax.jws.soap.SOAPBinding.*;
import javax.jws.WebParam.*;

@WebService(targetNamespace="http://demo.redhat.com",
            name="quoteReporter")
@SOAPBinding(style=Style.RPC, use=Use.LITERAL)
public interface quoteReporter
{
  @WebMethod(operationName="getStockQuote")
  @RequestWrapper(targetNamespace="http://demo.redhat.com/types",
                  className="java.lang.String")
  @ResponseWrapper(targetNamespace="http://demo.redhat.com/types",
                   className="org.eric.demo.Quote")
  @WebResult(targetNamespace="http://demo.redhat.com/types",
             name="updatedQuote")
  public Quote getQuote(
                        @WebParam(targetNamespace="http://demo.redhat.com/types",
                                  name="stockTicker",
                                  mode=Mode.IN)
                        String ticker
  );
}

24.3.4. Apache CXF Annotations

24.3.4.1. WSDL 文档

@WSDL 文档注解

@WSDL 文档 注释由 org.apache.cxf.annotations.WSDL 文档接口定义。它可以放置在 SEI 或 SEI 方法上。

此注解可让您添加文档，然后在 SEI 转换为 WSDL 后将出现在 wsdl:documentation 元素中。默认情况下，文档元素显示在端口类型内，但您可以指定放置属性，使文档出现在 WSDL 文件中的其他位置。第 24.3.4.2 节 “@WSDL 文档属性” 显示 @WSDL 文档注释支持的属性。

24.3.4.2. @WSDL 文档属性

属性	描述
`value`	（必需）包含文档文本的字符串。
`placement`	（可选）指定此文档会出现的 WSDL 文件中的位置。有关可能放置值的列表，请参阅 “在 WSDL 合同中放置”一节。
`faultClass`	（可选）如果将放置设置为 `FAULT_MESSAGE`、`PORT_TYPE_OPERATION_FAULT` 或 `BINDING_OPERATION_FAULT`，还必须将此属性设置为代表故障的 Java 类。

@WSDLDocumentationCollection 注解

@WSDLDocumentationCollection 注释由 org.apache.cxf.annotations.WSDLDocumentationCollection 接口定义。它可以放置在 SEI 或 SEI 方法上。

此注解用于在一个位置或不同位置插入多个文档元素。

在 WSDL 合同中放置

要指定文档在 WSDL 合同中应显示的位置，您可以指定 placement 属性，即 WSDL 文档。Placement .放置可以有以下值之一：

WSDLDocumentation.Placement.BINDING
WSDLDocumentation.Placement.BINDING_OPERATION
WSDLDocumentation.Placement.BINDING_OPERATION_FAULT
WSDLDocumentation.Placement.BINDING_OPERATION_INPUT
WSDLDocumentation.Placement.BINDING_OPERATION_OUTPUT
WSDLDocumentation.Placement.DEFAULT
WSDLDocumentation.Placement.FAULT_MESSAGE
WSDLDocumentation.Placement.INPUT_MESSAGE
WSDLDocumentation.Placement.OUTPUT_MESSAGE
WSDLDocumentation.Placement.PORT_TYPE
WSDLDocumentation.Placement.PORT_TYPE_OPERATION
WSDLDocumentation.Placement.PORT_TYPE_OPERATION_FAULT
WSDLDocumentation.Placement.PORT_TYPE_OPERATION_INPUT
WSDLDocumentation.Placement.PORT_TYPE_OPERATION_OUTPUT
WSDLDocumentation.Placement.SERVICE
WSDLDocumentation.Placement.SERVICE_PORT
WSDLDocumentation.Placement.TOP

@WSDL 文档示例

第 24.3.4.3 节 “使用 @WSDL 文档” 介绍如何将 @WSDL 文档 注释添加到 SEI 和方法之一。

24.3.4.3. 使用 @WSDL 文档

@WebService
@WSDLDocumentation("A very simple example of an SEI")
public interface HelloWorld {
    @WSDLDocumentation("A traditional form of greeting")
    String sayHi(@WebParam(name = "text") String text);
}

当第 24.3.4.4 节 “WSDL 使用文档生成” 中显示的 WSDL 从第 24.3.4.3 节 “使用 @WSDL 文档” 中的 SEI 生成时，文档 元素的默认放置分别为 PORT_TYPE 和 PORT_TYPE_OPERATION。

24.3.4.4. WSDL 使用文档生成

<wsdl:definitions ... >
  ...
  <wsdl:portType name="HelloWorld">
    <wsdl:documentation>A very simple example of an SEI</wsdl:documentation>
    <wsdl:operation name="sayHi">
      <wsdl:documentation>A traditional form of greeting</wsdl:documentation>
      <wsdl:input name="sayHi" message="tns:sayHi">
    </wsdl:input>
      <wsdl:output name="sayHiResponse" message="tns:sayHiResponse">
    </wsdl:output>
    </wsdl:operation>
  </wsdl:portType>
  ...
</wsdl:definitions>

@WSDL 文档Collection 示例

第 24.3.4.5 节 “使用 @WSDLDocumentationCollection” 介绍如何向 SEI 添加 @WSDL 文档Collection 注释。

24.3.4.5. 使用 @WSDLDocumentationCollection

@WebService
@WSDLDocumentationCollection(
    {
        @WSDLDocumentation("A very simple example of an SEI"),
        @WSDLDocumentation(value = "My top level documentation",
                           placement = WSDLDocumentation.Placement.TOP),
        @WSDLDocumentation(value = "Binding documentation",
                           placement = WSDLDocumentation.Placement.BINDING)
    }
)
public interface HelloWorld {
    @WSDLDocumentation("A traditional form of Geeky greeting")
    String sayHi(@WebParam(name = "text") String text);
}

24.3.4.6. Messages 模式验证

@SchemaValidation annotation

@SchemaValidation 注释由 org.apache.cxf.annotations.SchemaValidation 接口定义。它可以放置在 SEI 和单独的 SEI 方法上。

此注解开启发送到此端点的 XML 消息的 schema 验证。当您怀疑存在传入 XML 信息格式时，这可用于测试目的。默认情况下禁用验证，因为它对性能有严重影响。

模式验证类型

模式验证行为由 type 参数控制，其值是 org.apache.cxf.annotations.SchemaValidation.SchemaValidation.SchemaValidationType 类型的枚举。第 24.3.4.7 节 “模式验证类型值” 显示可用验证类型列表。

24.3.4.7. 模式验证类型值

类型	描述
`IN`	将架构验证应用到客户端和服务器中的传入消息。
`OUT`	将架构验证应用到客户端和服务器上的传出消息。
`两者`	将架构验证应用到客户端和服务器上的传入和传出消息。
`NONE`	所有架构验证都被禁用。
`REQUEST （请求）`	应用架构验证以请求消息 - 也就是说，使验证应用到传出客户端消息和传入服务器消息。
`RESPONSE`	将架构验证应用到响应消息 - 也就是说，使验证应用到传入的客户端消息，以及传出服务器消息。

示例

以下示例演示了如何根据 MyService SEI 为端点启用模式验证消息。请注意，注解如何作为整体应用到 SEI，以及 SEI 中的个别方法。

@WebService
@SchemaValidation(type = SchemaValidationType.BOTH)
public interface MyService {
    Foo validateBoth(Bar data);

    @SchemaValidation(type = SchemaValidationType.NONE)
    Foo validateNone(Bar data);

    @SchemaValidation(type = SchemaValidationType.IN)
    Foo validateIn(Bar data);

    @SchemaValidation(type = SchemaValidationType.OUT)
    Foo validateOut(Bar data);

    @SchemaValidation(type = SchemaValidationType.REQUEST)
    Foo validateRequest(Bar data);

    @SchemaValidation(type = SchemaValidationType.RESPONSE)
    Foo validateResponse(Bar data);
}

24.3.4.8. 指定数据绑定

@DataBinding annotation

@DataBinding 注释由 org.apache.cxf.annotations.DataBinding 接口定义。它被放置在 SEI 上。

此注解用于将数据绑定与 SEI 关联，从而替换默认的 JAXB 数据绑定。@DataBinding 注解的值必须是提供数据绑定 ClassName.class 的类。

支持的数据绑定

Apache CXF 目前支持以下数据绑定：

org.apache.cxf.jaxb.JAXBDataBinding
（默认） 标准 JAXB 数据绑定。
org.apache.cxf.sdo.SDODataBinding
Service Data Objects (SDO)数据绑定基于 Apache Tuscany SDO 实施。如果要在 Maven 构建上下文中使用这个数据绑定，则需要添加一个依赖 cxf-rt-databinding-sdo 工件。
org.apache.cxf.aegis.databinding.AegisDatabinding
如果要在 Maven 构建上下文中使用此数据绑定，则需要添加对 cxf-rt-databinding-aegis 工件的依赖关系。
org.apache.cxf.xmlbeans.XmlBeansDataBinding
如果要在 Maven 构建上下文中使用此数据绑定，则需要添加对 cxf-rt-databinding-xmlbeans 工件的依赖关系。
org.apache.cxf.databinding.source.SourceDataBinding
这个数据绑定属于 Apache CXF 内核。
org.apache.cxf.databinding.stax.StaxDataBinding
这个数据绑定属于 Apache CXF 内核。

示例

第 24.3.4.9 节 “设置数据绑定” 显示如何将 SDO 绑定与 HelloWorld SEI 关联

24.3.4.9. 设置数据绑定

@WebService
@DataBinding(org.apache.cxf.sdo.SDODataBinding.class)
public interface HelloWorld {
    String sayHi(@WebParam(name = "text") String text);
}

24.3.4.10. 压缩消息

@GZIP 注释

@GZIP 注释由 org.apache.cxf.annotations.GZIP 接口定义。它被放置在 SEI 上。

启用 GZIP 压缩信息。GZIP 是一个协商的增强。也就是说，客户端的初始请求不会被压缩，但会添加 Accept 标头；如果服务器支持 GZIP 压缩，则响应将被 gzip 压缩，并且任何后续请求也会被压缩。

第 24.3.4.11 节 “@GZIP 属性” 显示 @GZIP 注释支持的可选属性。

24.3.4.11. @GZIP 属性

属性	描述
`threshold`	比此属性指定的大小小的消息不会被压缩。默认为 -1 （无限制）。

@FastInfoset

@FastInfoset 注释由 org.apache.cxf.annotations.FastInfoset 接口定义。它被放置在 SEI 上。

为消息使用 FastInfoset 格式。fastinfoset 是 XML 的二进制编码格式，旨在优化消息大小和 XML 消息的处理性能。详情请查看 Fast Infoset 中的以下 Sun 文章。

fastinfoset 是一个协商的增强。也就是说，来自客户端的初始请求不会采用 FastInfoset 格式，但会添加 Accept 标头。如果服务器支持 FastInfoset，响应将是 FastInfoset，任何后续请求也会被添加。

第 24.3.4.12 节 “@FastInfoset Properties” 显示 @FastInfoset 注释支持的可选属性。

24.3.4.12. @FastInfoset Properties

属性	描述
`force`	可强制使用 FastInfoset 格式而非negotiating 的布尔值属性。为 `true` 时，强制使用 FastInfoset 格式；否则，协商。默认为 `false`。

@GZIP 示例

第 24.3.4.13 节 “启用 GZIP” 演示了如何为 HelloWorld SEI 启用 GZIP 压缩。

24.3.4.13. 启用 GZIP

@WebService
@GZIP
public interface HelloWorld {
    String sayHi(@WebParam(name = "text") String text);
}

@FastInfoset 的考查

第 24.3.4.14 节 “Enabling FastInfoset” 演示了如何为 HelloWorld SEI 启用 FastInfoset 格式。

24.3.4.14. Enabling FastInfoset

@WebService
@FastInfoset
public interface HelloWorld {
    String sayHi(@WebParam(name = "text") String text);
}

24.3.4.15. 在端点中启用日志记录

@logging 注解

@Logging 注释由 org.apache.cxf.annotations.Logging 接口定义。它被放置在 SEI 上。

此注解为与 SEI 关联的所有端点启用日志记录。第 24.3.4.16 节 “@logging 属性” 显示可在此注解中设置的可选属性。

24.3.4.16. @logging 属性

属性	描述
`limit`	指定大小限制，超过其信息在日志中截断。默认值为 64K。
`inLocation`	指定记录传入消息的位置。可以是 < `stderr>`、& `lt;stdout&gt`;、`<logger` > 或文件名。默认为 &lt `;logger>`。
`outLocation`	指定记录传出消息的位置。可以是 < `stderr>`、& `lt;stdout&gt`;、`<logger` > 或文件名。默认为 &lt `;logger>`。

示例

第 24.3.4.17 节 “使用注解记录配置” 显示如何为 HelloWorld SEI 启用日志记录，其中传入的消息发送到 < stdout >，并将传出消息发送到 < logger>。

24.3.4.17. 使用注解记录配置

@WebService
@Logging(limit=16000, inLocation="<stdout>")
public interface HelloWorld {
    String sayHi(@WebParam(name = "text") String text);
}

24.3.4.18. 在端点中添加属性和策略

摘要

属性和策略都可用于将配置数据与端点关联。它们之间的基本区别在于属性是 Apache CXF 特定的配置机制，而策略则是标准的 WSDL 配置机制。策略通常源自 WS 规范和标准，并且通常通过定义 WSDL 合同中显示的 wsdl:policy 元素来设置。相反，属性包括特定于 Apache CXF 的属性，它们通常通过在 Apache CXF Spring 配置文件中定义 jaxws:properties 元素来设置。

不过，也可以使用注释在 Java 中定义属性设置和 WSDL 策略设置，如下所述。

24.3.4.19. 添加属性

@EndpointProperty 注释

@EndpointProperty 注释由 org.apache.cxf.annotations.EndpointProperty 接口定义。它被放置在 SEI 上。

此注解将特定于 Apache CXF 的配置设置添加到端点。端点属性也可以在 Spring 配置文件中指定。例如，要在端点上配置 WS-Security，您可以使用 Spring 配置文件中的 jaxws:properties 元素添加端点属性，如下所示：

<beans xmlns="http://www.springframework.org/schema/beans"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:jaxws="http://cxf.apache.org/jaxws"
   ... >

   <jaxws:endpoint
      id="MyService"
      address="https://localhost:9001/MyService"
      serviceName="interop:MyService"
      endpointName="interop:MyServiceEndpoint"
      implementor="com.foo.MyService">

      <jaxws:properties>
         <entry key="ws-security.callback-handler" value="interop.client.UTPasswordCallback"/>
         <entry key="ws-security.signature.properties" value="etc/keystore.properties"/>
         <entry key="ws-security.encryption.properties" value="etc/truststore.properties"/>
         <entry key="ws-security.encryption.username" value="useReqSigCert"/>
      </jaxws:properties>

   </jaxws:endpoint>
</beans>

另外，您还可以在 Java 中指定上述配置设置，方法是在 SEI 中添加 @EndpointProperty 注解，如第 24.3.4.20 节 “使用 @EndpointProperty Annotations 配置 WS-Security” 所示。

24.3.4.20. 使用 @EndpointProperty Annotations 配置 WS-Security

@WebService
@EndpointProperty(name="ws-security.callback-handler" value="interop.client.UTPasswordCallback")
@EndpointProperty(name="ws-security.signature.properties" value="etc/keystore.properties")
@EndpointProperty(name="ws-security.encryption.properties" value="etc/truststore.properties")
@EndpointProperty(name="ws-security.encryption.username" value="useReqSigCert")
public interface HelloWorld {
    String sayHi(@WebParam(name = "text") String text);
}

@EndpointProperties annotation

@EndpointProperties 注释由 org.apache.cxf.annotations.EndpointProperties 接口定义。它被放置在 SEI 上。

此注释提供了一种将多个 @EndpointProperty 注释分组为列表的方法。使用 @EndpointProperties，可以重新编写第 24.3.4.20 节 “使用 @EndpointProperty Annotations 配置 WS-Security”，如第 24.3.4.21 节 “使用 @EndpointProperties 注解配置 WS-Security” 所示。

24.3.4.21. 使用 @EndpointProperties 注解配置 WS-Security

@WebService
@EndpointProperties(
  {
  @EndpointProperty(name="ws-security.callback-handler" value="interop.client.UTPasswordCallback"),
  @EndpointProperty(name="ws-security.signature.properties" value="etc/keystore.properties"),
  @EndpointProperty(name="ws-security.encryption.properties" value="etc/truststore.properties"),
  @EndpointProperty(name="ws-security.encryption.username" value="useReqSigCert")
})
public interface HelloWorld {
    String sayHi(@WebParam(name = "text") String text);
}

24.3.4.22. 添加策略

@policy 注释

@Policy 注释由 org.apache.cxf.annotations.Policy 接口定义。它可以放置在 SEI 或 SEI 方法上。

此注释用于将 WSDL 策略与 SEI 或 SEI 方法关联。通过提供引用包含标准 wsdl:policy 元素的 XML 文件来指定策略。如果要从 SEI 生成 WSDL 合同（例如，使用 java2ws 命令行工具），您可以指定是否要在 WSDL 中包含此策略。

第 24.3.4.23 节 “@policy 属性” 显示 @Policy 注释支持的属性。

24.3.4.23. @policy 属性

属性	描述
`uri`	（必需）包含策略定义的文件的位置。
`includeInWSDL`	（可选）在生成 WSDL 时在生成的合同中包含策略。默认为 `true`。
`placement`	（可选）指定此文档会出现的 WSDL 文件中的位置。有关可能放置值的列表，请参阅 “在 WSDL 合同中放置”一节。
`faultClass`	（可选）如果将放置设置为 `BINDING_OPERATION_FAULT` 或 `PORT_TYPE_OPERATION_FAULT`，则必须设置此属性以指定此策略应用到的错误。值是代表故障的 Java 类。

@policies 注解

@Policies 注释由 org.apache.cxf.annotations.Policies 接口定义。它可以放置在 SEI 或 thse SEI 方法上。

此注解提供了将多个 @Policy 注释分组到一个列表的方法。

在 WSDL 合同中放置

要指定策略在 WSDL 合同中显示的位置，您可以指定 放置 属性，即 Policy.Placement。放置可以有以下值之一：

Policy.Placement.BINDING
Policy.Placement.BINDING_OPERATION
Policy.Placement.BINDING_OPERATION_FAULT
Policy.Placement.BINDING_OPERATION_INPUT
Policy.Placement.BINDING_OPERATION_OUTPUT
Policy.Placement.DEFAULT
Policy.Placement.PORT_TYPE
Policy.Placement.PORT_TYPE_OPERATION
Policy.Placement.PORT_TYPE_OPERATION_FAULT
Policy.Placement.PORT_TYPE_OPERATION_INPUT
Policy.Placement.PORT_TYPE_OPERATION_OUTPUT
Policy.Placement.SERVICE
Policy.Placement.SERVICE_PORT

@Policy 示例

以下示例演示了如何将 WSDL 策略与 HelloWorld SEI 关联，以及如何将策略与 sayHi 方法关联。策略本身存储在文件系统的 XML 文件中，该文件存储在 annotations policies 目录下。

@WebService
@Policy(uri = "annotationpolicies/TestImplPolicy.xml",
        placement = Policy.Placement.SERVICE_PORT),
@Policy(uri = "annotationpolicies/TestPortTypePolicy.xml",
        placement = Policy.Placement.PORT_TYPE)
public interface HelloWorld {
    @Policy(uri = "annotationpolicies/TestOperationPTPolicy.xml",
            placement = Policy.Placement.PORT_TYPE_OPERATION),
    String sayHi(@WebParam(name = "text") String text);
}

@Policies 示例

您可以使用 @Policies 注释将多个 @Policy 注释分组到列表中，如下例所示：

@WebService
@Policies({
    @Policy(uri = "annotationpolicies/TestImplPolicy.xml",
            placement = Policy.Placement.SERVICE_PORT),
    @Policy(uri = "annotationpolicies/TestPortTypePolicy.xml",
            placement = Policy.Placement.PORT_TYPE)
})
public interface HelloWorld {
    @Policy(uri = "annotationpolicies/TestOperationPTPolicy.xml",
            placement = Policy.Placement.PORT_TYPE_OPERATION),
    String sayHi(@WebParam(name = "text") String text);
}

24.4. 生成 WSDL

使用 Maven

注解代码后，您可以使用 java2ws Maven 插件 -wsdl 选项为您的服务生成 WSDL 合同。有关 java2ws Maven 插件选项的详细列表，请参阅第 44.3 节 “java2ws”。

例 24.8 “从 Java 生成 WSDL” 介绍如何设置 java2ws Maven 插件来生成 WSDL。

例 24.8. 从 Java 生成 WSDL

<plugin>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-java2ws-plugin</artifactId>
  <version>${cxf.version}</version>
  <executions>
    <execution>
      <id>process-classes</id>
      <phase>process-classes</phase>
      <configuration>
        <className>className</className>
        <genWsdl>true</genWsdl>
      </configuration>
      <goals>
        <goal>java2ws</goal>
      </goals>
    </execution>
  </executions>
</plugin>

注意

将 className 的值替换为 qualified className。

示例

例 24.9 “从 SEI生成 WSDL” 显示为例 24.7 “完全注解 SEI” 中显示的 SEI 生成的 WSDL 合同。

例 24.9. 从 SEI生成 WSDL

<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions targetNamespace="http://demo.eric.org/"
          xmlns:tns="http://demo.eric.org/"
		  xmlns:ns1=""
		  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
		  xmlns:ns2="http://demo.eric.org/types"
		  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
		  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
  <wsdl:types>
    <xsd:schema>
      <xs:complexType name="quote">
        <xs:sequence>
          <xs:element name="ID" type="xs:string" minOccurs="0"/>
          <xs:element name="time" type="xs:string" minOccurs="0"/>
          <xs:element name="val" type="xs:float"/>
        </xs:sequence>
      </xs:complexType>
    </xsd:schema>
  </wsdl:types>
  <wsdl:message name="getStockQuote">
    <wsdl:part name="stockTicker" type="xsd:string">
    </wsdl:part>
  </wsdl:message>
  <wsdl:message name="getStockQuoteResponse">
    <wsdl:part name="updatedQuote" type="tns:quote">
    </wsdl:part>
  </wsdl:message>
  <wsdl:portType name="quoteReporter">
    <wsdl:operation name="getStockQuote">
      <wsdl:input name="getQuote" message="tns:getStockQuote">
    </wsdl:input>
      <wsdl:output name="getQuoteResponse" message="tns:getStockQuoteResponse">
    </wsdl:output>
    </wsdl:operation>
  </wsdl:portType>
  <wsdl:binding name="quoteReporterBinding" type="tns:quoteReporter">
    <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http" />
    <wsdl:operation name="getStockQuote">
      <soap:operation style="rpc" />
      <wsdl:input name="getQuote">
        <soap:body use="literal" />
      </wsdl:input>
      <wsdl:output name="getQuoteResponse">
        <soap:body use="literal"/>
      </wsdl:output>
    </wsdl:operation>
  </wsdl:binding>
  <wsdl:service name="quoteReporterService">
    <wsdl:port name="quoteReporterPort" binding="tns:quoteReporterBinding">
      <soap:address location="http://localhost:9000/quoteReporterService" />
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>

第 25 章在没有 WSDL 合同的情况下开发消费者

摘要

您不需要 WSDL 合同来开发服务消费者。您可以从注解的 SEI 创建服务使用者。除 SEI 外，您需要知道发布该服务的端点的地址、定义该服务的 Service 元素的 QName，以及定义消费者发出请求的端点的 QName。此信息可以在 SEI 的注解中单独指定，或单独提供。

25.1. Java-First Consumer Development

要创建没有 WSDL 合同的消费者，您必须执行以下操作：

为服务创建一个 Service 对象，使用者将在其上调用操作。
向 Service 对象添加一个端口。
使用 Service 对象的 getPort （） 方法获取服务的代理。
实施消费者的业务逻辑。

25.2. 创建服务对象

概述

javax.xml.ws.Service 类表示 wsdl:service 元素，其中包含公开服务的所有端点的定义。因此，它提供通过 wsdl:port 元素定义的端点的方法，这些元素为在服务上进行远程调用的代理。

注意

Service 类提供抽象，允许客户端代码使用 Java 类型，而不是使用 XML 文档。

create （）方法

Service 类有两个静态 create （） 方法，可用于创建新的 Service 对象。如例 25.1 “Service create() Methods” 所示，create （） 方法的 QName 都会取 Service 对象所代表的 QName，另一个则是指定 WSDL 合同位置的 URI。

注意

所有服务发布其 WSDL 合同。对于 SOAP/HTTP 服务，URI 通常附加了 ?wsdl 的服务的 URI。

例 25.1. Service create() Methods

公共静态服务创建URLwsdlLocationQNameserviceNameWebServiceExceptionpublic staticServicecreateQNameserviceNameWebServiceException

serviceName 参数的值是一个 QName。其命名空间部分的值是服务的目标命名空间。服务的目标命名空间在 @WebService 注解的 targetNamespace 属性中指定。QName 的本地部分的值是 wsdl:service 元素的 name 属性的值。您可以使用以下方法之一确定这个值： .它在 @WebService 注解的 serviceName 属性中指定。

您可以将 Service 附加到 @WebService 注释的 name 属性的值。
您可以将 Service 附加到 SEI 的名称。

重要

以编程方式在 OSGi 环境中部署的 CXF 消费者需要特殊处理，以避免发生 ClassNotFoundException的可能性。对于包含编程创建的 CXF 用户的每个捆绑包，您需要创建一个 CXF 默认总线，并确保所有捆绑包的 CXF 消费者都使用它。如果没有此保护，可以为一个捆绑包分配在另一个捆绑包中创建的 CXF 默认总线，这可能会导致继承捆绑包失败。

例如，假设 bundle A 没有明确设置 CXF 默认总线，并在捆绑包 B 中创建 CXF 默认总线。如果使用额外功能（如 SSL 或 WS-Security）需要配置额外功能（如 SSL 或 WS-Security），或者需要从 A 捆绑的应用程序加载某些类或资源，则会失败。这是因为 CXF 总线实例将线程上下文类加载程序(TCCL)设置为创建它的捆绑包（本例中为 bundle B）。另外，某些框架（如 wss4j （在 CXF 中实施 WS-Security）使用 TCCL 来加载资源，如 calback 处理程序类或其他属性文件（从捆绑包中）。因为 bundle A 被分配为 B 的默认 CXF 总线及其 TCCL，所以 wss4j 层无法从捆绑包 A 加载所需资源，这会导致 ClassNotFoundException 错误。

要创建单例 CXF 默认总线，请在创建服务对象 的主 方法的开头插入此代码，如 “示例”一节所示：

BusFactory.setThreadDefaultBus(BusFactory.newInstance().createBus());

示例

例 25.2 “创建服务 对象” 显示为例 24.7 “完全注解 SEI” 中显示的 SEI 创建 Service 对象的代码。

例 25.2. 创建服务 对象

package com.fusesource.demo;

import javax.xml.namespace.QName;
import javax.xml.ws.Service;

public class Client
{
public static void main(String args[])
  {
    BusFactory.setThreadDefaultBus(BusFactory.newInstance().createBus());
    QName serviceName = new QName("http://demo.redhat.com", "stockQuoteReporter");
    Service s = Service.create(serviceName);
   ...
  }
}

例 25.2 “创建服务 对象” 中的代码执行以下操作：

创建可用于服务的所有 CXF 用户的单个 CXF 默认总线。

使用 targetNamespace 属性和 @WebService 注解的 name 属性，为服务构建 QName。

调用单参数 create （） 方法来创建新 Service 对象。

注意

使用单一参数 create （） 释放您访问 WSDL 合同的任何依赖项。

25.3. 将端口添加到服务

概述

服务的端点信息在 wsdl:port 元素中定义，而 Service 对象会为 WSDL 合同中定义的每个端点创建一个代理实例（如果指定了）。如果您在创建 Service 对象时没有指定 WSDL 合同， Service 对象没有有关实施服务的端点的信息，因此无法创建任何代理实例。在这种情况下，您必须使用 addPort （） 方法为 Service 对象提供代表 wsdl:port 元素所需的信息。

addPort （）方法

Service 类定义了一个 addPort （） 方法，在例 25.3 “addPort （） 方法” 中显示，当没有可供消费者实施使用的 WSDL 合同时。通过 addPort （） 方法，您可以为服务对象提供信息，这些信息通常存储在 wsdl:port 元素中，为服务实施创建代理所必需的。

例 25.3. addPort （） 方法

添加PortQNameportNameStringbindingIdStringendpointAddressWebServiceException

portName 的值是一个 QName。其命名空间部分的值是服务的目标命名空间。服务的目标命名空间在 @WebService 注解的 targetNamespace 属性中指定。QName 的本地部分的值是 wsdl:port 元素的 name 属性的值。您可以使用以下方法之一确定这个值：

在 @WebService 注释的 portName 属性中指定它。
将 Port 附加到 @WebService 注释的 name 属性的值。
将 Port 附加到 SEI 的名称。

bindingId 参数的值是一个字符串，用于唯一标识端点使用的绑定类型。对于 SOAP 绑定，您可以使用标准 SOAP 命名空间： http://schemas.xmlsoap.org/soap/。如果端点没有使用 SOAP 绑定，则 bindingId 参数的值由绑定开发人员决定。 endpointAddress 参数的值是端点发布的地址。对于 SOAP/HTTP 端点，地址是一个 HTTP 地址。HTTP 以外的传输使用不同的地址方案。

示例

例 25.4 “将端口添加到 服务对象” 显示在例 25.2 “创建服务 对象” 中创建的服务 对象中 添加端口的代码。

例 25.4. 将端口添加到 服务对象

package com.fusesource.demo;

import javax.xml.namespace.QName;
import javax.xml.ws.Service;

public class Client
{
public static void main(String args[])
  {
    ...
    QName portName = new QName("http://demo.redhat.com", "stockQuoteReporterPort");
    s.addPort(portName,
              "http://schemas.xmlsoap.org/soap/",
              "http://localhost:9000/StockQuote");
    ...
  }
}

例 25.4 “将端口添加到 服务对象” 中的代码执行以下操作：

为 portName 参数创建 QName。

调用 addPort （） 方法。

指定端点使用 SOAP 绑定。

指定端点发布的地址。

25.4. 为端点获取代理

概述

服务代理是一个对象，提供由远程服务公开的所有方法，并处理进行远程调用所需的所有详情。Service 对象为通过 getPort （） 方法了解的所有端点提供服务代理。有了服务代理后，即可调用其方法。代理使用服务合同中指定的连接详情将调用转发到远程服务端点。

getPort （）方法

getPort （） 方法显示在例 25.5 “getPort （） 方法” 中，为指定端点返回服务代理。返回的代理与 SEI 相同类。

例 25.5. getPort （） 方法

public &lt;T> TgetPortQNameportNameClass<T&gt;serviceEndpointInterfaceWebServiceException

portName 参数的值是一个 QName，用于标识为其创建代理的 wsdl:port 元素。serviceEndpointInterface 参数的值是 SEI 的完全限定名称。

注意

当您在没有 WSDL 参数的值的情况下工作时，portName 参数的值通常与调用 addPort （） 时用于 portName 参数的值相同。

示例

例 25.6 “获取服务代理” 显示获取例 25.4 “将端口添加到 服务对象” 中端点的服务代理的代码。

例 25.6. 获取服务代理

package com.fusesource.demo;

import javax.xml.namespace.QName;
import javax.xml.ws.Service;

public class Client
{
public static void main(String args[])
  {
    ...
    quoteReporter proxy = s.getPort(portName, quoteReporter.class);
    ...
  }
}

25.5. 实施消费者的业务日志

概述

旦实例化远程端点的服务代理，即可调用其方法，就像它是本地对象一样。调用块，直到远程方法完成为止。

注意

如果方法标有 @OneWay 注释，则调用会立即返回。

示例

例 25.7 “在没有 WSDL 合同的情况下实施的用户” 显示例 24.7 “完全注解 SEI” 中定义的服务使用者。

例 25.7. 在没有 WSDL 合同的情况下实施的用户

package com.fusesource.demo;

import java.io.File;
import java.net.URL;
import javax.xml.namespace.QName;
import javax.xml.ws.Service;

public class Client
{
public static void main(String args[])
  {
    QName serviceName = new QName("http://demo.eric.org", "stockQuoteReporter");
  Service s = Service.create(serviceName);

    QName portName = new QName("http://demo.eric.org", "stockQuoteReporterPort");
  s.addPort(portName, "http://schemas.xmlsoap.org/soap/", "http://localhost:9000/EricStockQuote");

  quoteReporter proxy = s.getPort(portName, quoteReporter.class);

  Quote quote = proxy.getQuote("ALPHA");
    System.out.println("Stock "+quote.getID()+" is worth "+quote.getVal()+" as of "+quote.getTime());
  }
}

例 25.7 “在没有 WSDL 合同的情况下实施的用户” 中的代码执行以下操作：

创建 Service 对象。

在 Service 对象中添加端点定义。

从 Service 对象获取服务代理。

在服务代理上调用操作。

第 26 章启动点 WSDL 合同

26.1. WSDL 合同示例

例 26.1 “helloworld WSDL 合同” 显示 HelloWorld WSDL 合同。该合同在 wsdl:portType 元素中定义单一界面 Greeter。该合同还定义了在 wsdl:port 元素中实施该服务的端点。

例 26.1. helloworld WSDL 合同

<?xml version="1.0" encoding=";UTF-8"?>
<wsdl:definitions name="HelloWorld"
                  targetNamespace="http://apache.org/hello_world_soap_http"
                  xmlns="http://schemas.xmlsoap.org/wsdl/"
                  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
                  xmlns:tns="http://apache.org/hello_world_soap_http"
                  xmlns:x1="http://apache.org/hello_world_soap_http/types"
                  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
                  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <wsdl:types>
    <schema targetNamespace="http://apache.org/hello_world_soap_http/types"
            xmlns="http://www.w3.org/2001/XMLSchema"
            elementFormDefault="qualified">
      <element name="sayHiResponse">
        <complexType>
          <sequence>
            <element name="responseType" type="string"/>
          </sequence>
        </complexType>
      </element>
      <element name="greetMe">
        <complexType>
          <sequence>
            <element name="requestType" type="string"/>
          </sequence>
        </complexType>
      </element>
      <element name="greetMeResponse">
        <complexType>
          <sequence>
            <element name="responseType" type="string"/>
          </sequence>
        </complexType>
      </element>
      <element name="greetMeOneWay">
        <complexType>
          <sequence>
            <element name="requestType" type="string"/>
          </sequence>
        </complexType>
      </element>
      <element name="pingMe">
        <complexType/>
      </element>
      <element name="pingMeResponse">
        <complexType/>
      </element>
      <element name="faultDetail">
        <complexType>
          <sequence>
            <element name="minor" type="short"/>
            <element name="major" type="short"/>
          </sequence>
        </complexType>
      </element>
    </schema>
  </wsdl:types>

  <wsdl:message name="sayHiRequest">
    <wsdl:part element="x1:sayHi" name="in"/>
  </wsdl:message>
  <wsdl:message name="sayHiResponse">
    <wsdl:part element="x1:sayHiResponse" name="out"/>
  </wsdl:message>
  <wsdl:message name="greetMeRequest">
    <wsdl:part element="x1:greetMe" name="in"/>
  </wsdl:message>
  <wsdl:message name="greetMeResponse">
    <wsdl:part element="x1:greetMeResponse" name="out"/>
  </wsdl:message>
  <wsdl:message name="greetMeOneWayRequest">
    <wsdl:part element="x1:greetMeOneWay" name="in"/>
  </wsdl:message>
  <wsdl:message name="pingMeRequest">
    <wsdl:part name="in" element="x1:pingMe"/>
  </wsdl:message>
  <wsdl:message name="pingMeResponse">
    <wsdl:part name="out" element="x1:pingMeResponse"/>
  </wsdl:message>
  <wsdl:message name="pingMeFault">
    <wsdl:part name="faultDetail" element="x1:faultDetail"/>
  </wsdl:message>

  <wsdl:portType name="Greeter">
    <wsdl:operation name="sayHi">
      <wsdl:input message="tns:sayHiRequest" name="sayHiRequest"/>
      <wsdl:output message="tns:sayHiResponse" name="sayHiResponse"/>
    </wsdl:operation>

    <wsdl:operation name="greetMe">
      <wsdl:input message="tns:greetMeRequest" name="greetMeRequest"/>
      <wsdl:output message="tns:greetMeResponse" name="greetMeResponse"/>
    </wsdl:operation>

    <wsdl:operation name="greetMeOneWay">
      <wsdl:input message="tns:greetMeOneWayRequest" name="greetMeOneWayRequest"/>
    </wsdl:operation>

    <wsdl:operation name="pingMe">
      <wsdl:input name="pingMeRequest" message="tns:pingMeRequest"/>
      <wsdl:output name="pingMeResponse" message="tns:pingMeResponse"/>
      <wsdl:fault name="pingMeFault" message="tns:pingMeFault"/>
    </wsdl:operation>
  </wsdl:portType>

  <wsdl:binding name="Greeter_SOAPBinding" type="tns:Greeter">
    ...
  </wsdl:binding>

  <wsdl:service name="SOAPService">
    <wsdl:port binding="tns:Greeter_SOAPBinding" name="SoapPort">
      <soap:address location="http://localhost:9000/SoapContext/SoapPort"/>
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>

例 26.1 “helloworld WSDL 合同” 中定义的 Greeter 接口定义以下操作：

sayHi - 具有单个输出参数，xsd:string.

greetMe - 获取输入参数 xsd:string，以及输出参数，xsd:string。

greetMeOneWay - 具有 xsd:string 的单个输入参数。由于此操作没有输出参数，因此优化为单向调用（也就是说，使用者不会等待来自服务器的响应）。

pingMe - 没有输入参数，也没有输出参数，但可能会引发错误异常。

第 27 章 top-Down 服务开发

摘要

在开发服务提供商的顶层方法中，您要从定义服务提供商实施的操作和方法的 WSDL 文档开始。使用 WSDL 文档，您可以为服务提供商生成起点代码。在生成的代码中添加业务逻辑是使用普通 Java 编程 API 进行的。

27.1. JAX-WS 服务提供商开发概述

在进行 WSDL 文档后，开发 JAX-WS 服务提供商的流程如下：

第 27.2 节 “生成起始点代码” 起点代码。
实施服务提供商的操作。
第 31 章 发布服务 实施的服务。

27.2. 生成起始点代码

概述

JAX-WS 指定从 WSDL 中定义的服务到将该服务作为服务提供商实施的 Java 类的详细映射。由 wsdl:portType 元素定义的逻辑接口映射到服务端点接口(SEI)。WSDL 中定义的任何复杂类型都会映射到 Java 类，按照 XML 绑定(JAXB)规范的 Java 架构定义映射。wsdl:service 元素定义的端点也被生成到 Java 类中，供消费者用于访问实施该服务的服务供应商。

cxf-codegen-plugin Maven 插件会生成这个代码。它还提供用于为您的实施生成起点代码的选项。代码生成器提供了多个控制生成的代码的选项。

运行代码生成器

例 27.1 “服务代码生成” 显示如何使用代码生成器为服务生成起点代码。

例 27.1. 服务代码生成

<plugin>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-codegen-plugin</artifactId>
    <version>${cxf.version}</version>
    <executions>
        <execution>
            <id>generate-sources</id>
            <phase>generate-sources</phase>
            <configuration>
                <sourceRoot>outputDir</sourceRoot>
                <wsdlOptions>
                    <wsdlOption>
                        <wsdl>wsdl</wsdl>
                        <extraargs>
                            <extraarg>-server</extraarg>
                            <extraarg>-impl</extraarg>
                        </extraargs>
                    </wsdlOption>
                </wsdlOptions>
            </configuration>
            <goals>
                <goal>wsdl2java</goal>
            </goals>
       </execution>
    </executions>
</plugin>

它执行以下操作：

impl 选项为 WSDL 合同中的每个 wsdl:portType 元素生成 shell 实施类。
server 选项生成一个简单的 main （），以作为独立应用程序运行您的服务提供商。
sourceRoot 指定生成的代码被写入名为 outputDir 的目录。
WSDL 元素指定 生成代码的 WSDL 合同。

有关代码生成器选项的完整列表，请参阅第 44.2 节 “cxf-codegen-plugin”。

生成的代码

表 27.1 “为服务提供商生成的类” 描述为创建服务提供商生成的文件。

表 27.1. 为服务提供商生成的类
File	描述
`portTypeName.java`	SEI。此文件包含您的服务供应商实施的接口。您不应该编辑这个文件。
`serviceName.java`	端点。此文件包含 Java 类使用者，用于向服务发出请求。
`portTypeNameImpl.java`	skeleton 实施类。修改此文件以构建您的服务供应商。
`portTypeNameServer.java`	允许将服务提供商部署为独立过程的基本服务器主线。更多信息请参阅第 31 章发布服务。

此外，代码生成器将为 WSDL 合同中定义的所有类型生成 Java 类。

生成的软件包

生成的代码将基于 WSDL 合同中使用的命名空间放入软件包中。为支持服务（基于 wsdl:portType 元素、wsdl:service 元素和 wsdl:port 元素）生成的类放置在基于 WSDL 合同的目标命名空间中的软件包中。为实施合同元素中定义的 类型 类将基于 type 元素的 targetNamespace 属性放入 软件包中。

映射算法如下：

前面的 http:// 或 urn:// 剥离命名空间。
如果命名空间中的第一个字符串是有效的互联网域，例如以 .com 或 .gov 结尾，则从字符串中剥离。www. 会从字符串中剥离，其余两个组件则被视为软盘。
如果命名空间中的最终字符串以 .xxx 或 .xx 的文件扩展结尾，则会剥离扩展。
命名空间中的剩余的字符串会附加到生成的字符串中，并按点分开。
所有字母都为小写。

27.3. 实施服务提供商

生成实施代码

您可以使用代码生成器的 -impl 标志生成用于构建服务提供商的实施类。

注意

如果您的服务合同中包含 XML Schema 中定义的任何自定义类型，您必须确保生成和可用的类。

有关使用代码生成器的更多信息，请参阅第 44.2 节 “cxf-codegen-plugin”。

生成的代码

实现代码由两个文件组成：

portTypeName.java - 服务的服务接口(SEI)。
portTypeNameImpl.java - 用于实施服务所定义的操作的类。

实施操作的逻辑

为服务操作提供业务逻辑，请完成 portTypeNameImpl.java 中的存根方法。您通常使用标准的 Java 来实施业务逻辑。如果您的服务使用自定义 XML Schema 类型，则必须为每种类型使用生成的类来操作它们。还有一些 Apache CXF 特定的 API，可用于访问一些高级功能。

示例

例如，在例 26.1 “helloworld WSDL 合同” 中定义的服务的实现类可能类似于例 27.2 “Greeter Service 的实现”。程序员必须直接插入粗体代码部分。

例 27.2. Greeter Service 的实现

package demo.hw.server;

import org.apache.hello_world_soap_http.Greeter;

@javax.jws.WebService(portName = "SoapPort", serviceName = "SOAPService",
                      targetNamespace = "http://apache.org/hello_world_soap_http",
                      endpointInterface = "org.apache.hello_world_soap_http.Greeter")

public class GreeterImpl implements Greeter {

    public String greetMe(String me) {
       System.out.println("Executing operation greetMe"); System.out.println("Message received: " + me + "\n"); return "Hello " + me;
    }

    public void greetMeOneWay(String me) {
       System.out.println("Executing operation greetMeOneWay\n"); System.out.println("Hello there " + me);
    }

    public String sayHi() {
       System.out.println("Executing operation sayHi\n"); return "Bonjour";
    }

    public void pingMe() throws PingMeFault {
       FaultDetail faultDetail = new FaultDetail(); faultDetail.setMajor((short)2); faultDetail.setMinor((short)1); System.out.println("Executing operation pingMe, throwing PingMeFault exception\n"); throw new PingMeFault("PingMeFault raised by server", faultDetail);
    }
}

第 28 章从 WSDL 合同开发消费者

摘要

创建使用者的一种方法是从 WSDL 合同开始。该合同定义了消费者发出请求的服务的操作、消息和传输详细信息。消费者的起点代码是从 WSDL 合同生成的。消费者所需的功能将添加到生成的代码中。

28.1. 生成 Stub Code

概述

cxf-codegen-plugin Maven 插件从 WSDL 合同中生成存根代码。stub 代码提供了在远程服务上调用操作所需的支持代码。

对于消费者，cxf-codegen-plugin Maven 插件会生成以下类型的代码：

stub 代码 - 支持实施消费者的文件。
起始点代码 - 示例代码连接到远程服务，并调用远程服务中的每个操作。

生成消费者代码

生成消费者代码，请使用 cxf-codegen-plugin Maven 插件。例 28.1 “消费者代码生成” 显示如何使用代码生成器来生成消费者代码。

例 28.1. 消费者代码生成

<plugin>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-codegen-plugin</artifactId>
  <version>${cxf.version}</version>
  <executions>
    <execution>
      <id>generate-sources</id>
      <phase>generate-sources</phase>
      <configuration>
        <sourceRoot>outputDir</sourceRoot>
        <wsdlOptions>
          <wsdlOption>
            <wsdl>wsdl</wsdl>
            <extraargs>
              <extraarg>-client</extraarg>
            </extraargs>
          </wsdlOption>
        </wsdlOptions>
      </configuration>
      <goals>
        <goal>wsdl2java</goal>
      </goals>
    </execution>
  </executions>
</plugin>

其中 outputDir 是生成文件放置的目录位置，而 wsdl 指定 WSDL 合同的位置。client 选项为 消费者的 main （） 方法生成起点代码。

有关 cxf-codegen-plugin Maven 插件可用参数的完整列表，请参阅第 44.2 节 “cxf-codegen-plugin”。

生成的代码

代码生成插件为例 26.1 “helloworld WSDL 合同” 中显示的合同生成以下 Java 软件包：

org.apache.hello_world_soap_http - 这个软件包是从 http://apache.org/hello_world_soap_http 目标命名空间生成的。此命名空间中定义的所有 WSDL 实体（例如，Greeter 端口类型和 SOAPService 服务）都映射到 Java 类此 Java 软件包。
org.apache.hello_world_soap_http.types - 这个软件包是从 http://apache.org/hello_world_soap_http/types 目标命名空间中生成的。此命名空间中定义的所有 XML 类型（即，HelloWorld 合同合同下的 wsdl:types 元素）映射到此 Java 包中的 Java 类。

cxf-codegen-plugin Maven 插件生成的 stub 文件属于以下类别：

代表 org.apache.hello_world_soap_http 包中的 WSDL 实体的类。生成的以下类来表示 WSDL 实体：
- Greeter - 代表 Greeter wsdl:portType 元素的 Java 接口。在 JAX-WS 术语中，此 Java 接口是服务端点接口(SEI)。
- SOAPService - Java 服务类(extending javax.xml.ws.Service)，代表 SOAPService wsdl:service 元素。
- PingMeFault - Java 异常类(extending java.lang.Exception)代表 pingMeFault wsdl:fault 元素。
代表 org.objectweb.hello_world_soap_http.types 软件包中的 XML 类型的类。在 HelloWorld 示例中，唯一生成的类型是请求和回复消息的各种打包程序。其中一些数据类型对异步调用模型很有用。

28.2. 实施一个消费者

概述

要在从 WSDL 合同开始实施消费者，您必须使用以下存根：

服务类
SEI

使用这些存根代码可实例化服务代理，以向远程服务发出请求。它还实现了消费者的业务逻辑。

生成的服务类

例 28.2 “生成的服务类概述” 显示生成的服务类 ServiceName_Service的典型概述^[2]，扩展 javax.xml.ws.Service 基础类。

例 28.2. 生成的服务类概述

@WebServiceClient(name="..." targetNamespace="..."
                  wsdlLocation="...")
public class ServiceName extends javax.xml.ws.Service
{
  ...
  public ServiceName(URL wsdlLocation, QName serviceName) { }

  public ServiceName() { }

  // Available only if you specify '-fe cxf' option in wsdl2java
  public ServiceName(Bus bus) { }

  @WebEndpoint(name="...")
  public SEI getPortName() { }
  .
  .
  .
}

例 28.2 “生成的服务类概述” 中的 ServiceName 类定义以下方法：

ServiceName(URL wsdlLocation, QName serviceName) - 根据 wsdl:service 元素中的数据构建服务对象，使用在 wsdlLocation 处获取的 QName ServiceName 服务。
ServiceName（） - 默认构造器。它根据服务名称和在生成 stub 代码时提供的 WSDL 合同构建服务对象（例如，在运行 wsdl2java 工具时）。使用这种构造器会规定 WSDL 合同在指定位置仍可用。
ServiceName(Bus 总线) - （特定于CXF） 是一个额外构造器，允许您指定用于配置该服务的总线实例。这在多线程应用程序上下文中非常有用，其中多个总线实例可以与不同的线程相关联。此构造器提供了一种简单方式，可确保您指定的总线是与此服务一起使用的总线。只有在调用 wsdl2java 工具时指定 -fe cxf 选项时才可用。
getPortName（） - 返回由 wsdl:port 元素定义的端点的代理，其 name 属性等于 PortName。为 ServiceName 服务定义的每个 wsdl:port 元素生成 getter 方法。包含多个端点定义的 wsdl:service 元素会生成带有多个 getPortName（） 方法生成的服务类。

服务端点接口

对于原始 WSDL 合同中定义的每个接口，您可以生成对应的 SEI。服务端点接口是 wsdl:portType 元素的 Java 映射。原始 wsdl:portType 元素中定义的每个操作都映射到 SEI 中的对应方法。操作的参数映射如下： .输入参数映射到方法参数。

第一个输出参数映射到一个返回值。
如果有多个输出参数，第二个和后续输出参数映射到方法参数（此外，必须使用 Holder 类型）传递这些参数的值。

例如：例 28.3 “Greeter Service Endpoint 接口” 显示 Greeter SEI，它是从例 26.1 “helloworld WSDL 合同” 中定义的 wsdl:portType 元素生成的。为了简单起见，例 28.3 “Greeter Service Endpoint 接口” 会省略标准的 JAXB 和 JAX-WS 注解。

例 28.3. Greeter Service Endpoint 接口

package org.apache.hello_world_soap_http;
  ...
public interface Greeter
{
  public String sayHi();
  public String greetMe(String requestType);
  public void greetMeOneWay(String requestType);
  public void pingMe() throws PingMeFault;
}

消费者主要功能

例 28.4 “消费者实施代码” 显示实施 HelloWorld consumer 的代码。用户连接到 SOAPService 服务上的 SoapPort 端口，然后继续调用 Greeter 端口类型支持的各个操作。

例 28.4. 消费者实施代码

package demo.hw.client;

import java.io.File;
import java.net.URL;
import javax.xml.namespace.QName;
import org.apache.hello_world_soap_http.Greeter;
import org.apache.hello_world_soap_http.PingMeFault;
import org.apache.hello_world_soap_http.SOAPService;

public final class Client {

  private static final QName SERVICE_NAME =
  new QName("http://apache.org/hello_world_soap_http",
            "SOAPService");

  private Client()
  {
  }

  public static void main(String args[]) throws Exception
  {
 if (args.length == 0)
    {
      System.out.println("please specify wsdl");
      System.exit(1);
    }

 URL wsdlURL;
    File wsdlFile = new File(args[0]);
    if (wsdlFile.exists())
    {
      wsdlURL = wsdlFile.toURL();
    }
    else
    {
      wsdlURL = new URL(args[0]);
    }

    System.out.println(wsdlURL);
 SOAPService ss = new SOAPService(wsdlURL,SERVICE_NAME);
 Greeter port = ss.getSoapPort();
    String resp;

 System.out.println("Invoking sayHi...");
    resp = port.sayHi();
    System.out.println("Server responded with: " + resp);
    System.out.println();

    System.out.println("Invoking greetMe...");
    resp = port.greetMe(System.getProperty("user.name"));
    System.out.println("Server responded with: " + resp);
    System.out.println();

    System.out.println("Invoking greetMeOneWay...");
    port.greetMeOneWay(System.getProperty("user.name"));
    System.out.println("No response from server as method is OneWay");
    System.out.println();

 try {
      System.out.println("Invoking pingMe, expecting exception...");
      port.pingMe();
    } catch (PingMeFault ex) {
      System.out.println("Expected exception: PingMeFault has occurred.");
      System.out.println(ex.toString());
    }
    System.exit(0);
  }
}

来自例 28.4 “消费者实施代码” 的 Client.main （） 方法进行如下：

如果 Apache CXF 运行时类位于您的类路径上，运行时会隐式初始化。不需要调用特殊的函数来初始化 Apache CXF。

使用者需要一个字符串参数，为 HelloWorld 提供 WSDL 合同的位置。WSDL 合同的位置存储在 wsdlURL 中。

您可以使用需要 WSDL 合同和服务名称的构造器创建服务对象。调用适当的 getPortName（） 方法来获取所需端口的实例。在这种情况下，SOAPService 服务只支持 SoapPort 端口，该端口实施 Greeter 服务端点接口。

使用者调用 Greeter 服务端点接口支持的不同方法。

对于 pingMe （） 方法，示例代码演示了如何捕获 PingMeFault 错误异常。

使用 -fe cxf 选项生成的客户端代理

如果您在 wsdl2java 中指定 -fe cxf 选项（因此选择 cxf frontend）来生成客户端代理，则生成的客户端代理代码与 Java 7 更好地集成。在这种情况下，当您调用 getServiceNamePort （） 方法时，您会返回一个类型为 SEI 的子接口并实现以下额外接口：

java.lang.AutoCloseable
javax.xml.ws.BindingProvider (JAX-WS 2.0)
org.apache.cxf.endpoint.Client

要了解如何简化使用客户端代理的过程，请考虑以下 Java 代码示例，使用标准的 JAX-WS 代理对象编写：

// Programming with standard JAX-WS proxy object
//
(ServiceNamePortType port = service.getServiceNamePort();
((BindingProvider)port).getRequestContext()
        .put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, address);
port.serviceMethod(...);
((Closeable)port).close();

将前面的代码与以下等效代码示例进行比较，并使用 cxf frontend 生成的代码编写：

// Programming with proxy generated using '-fe cxf' option
//
try (ServiceNamePortTypeProxy port = service.getServiceNamePort()) {
    port.getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, address);
    port.serviceMethod(...);
}

^[2] 如果 wsdl:service 元素的 name 属性以 _Service 结尾，则不使用 _Service。

第 29 章在运行时查找 WSDL

摘要

将 WSDL 文档的位置硬编码到应用程序中不可扩展。在实际部署环境中，您希望允许 WSDL 文档在运行时解析位置。Apache CXF 提供很多工具来实现此目标。

29.1. 定位 WSDL 文档的机制

使用 JAX-WS API 开发消费者时，您必须提供定义您的服务的 WSDL 文档的硬编码路径。虽然在小型环境中这点正常，但在企业部署中，使用硬编码路径在企业部署中无法正常工作。

要解决这个问题，Apache CXF 提供了三种机制来删除使用硬编码路径的要求：

第 29.2 节 “通过 Injection 实例化代理”
第 29.3 节 “使用 JAX-WS 目录”
第 29.4 节 “使用合同解析器”

注意

将代理注入实施代码通常是最佳选择，因为这是实施最容易的。它只需要一个客户端端点和配置文件来注入和实例化服务代理。

29.2. 通过 Injection 实例化代理

概述

Apache CXF 使用 Spring Framework 可让您避免使用 JAX-WS API 创建服务代理的问题。它允许您在配置文件中定义客户端端点，然后将代理直接注入到实施代码中。当运行时实例化实现对象时，它还将根据配置实例化外部服务的代理。实现通过引用实例化代理来移交。

由于代理使用配置文件中的信息实例化，所以不需要硬编码 WSDL 位置。它在部署时可以更改。您还可以指定运行时应该为 WSDL 搜索应用程序的类路径。

流程

将外部服务的代理注入服务提供商的实现中：

在应用程序的所有部分都可以访问的已知位置部署所需的 WSDL 文档。
注意
如果您要将应用程序部署为 WAR 文件，建议您在 WAR 的 WEB-INF/wsdl 文件夹中放置所有 WSDL 文档和 XML Schema 文档。
注意
如果您要将应用程序部署为 JAR 文件，建议您在 JAR 的 META-INF/wsdl 文件夹中放置所有 WSDL 文档和 XML Schema 文档。
为正在注入的代理配置 JAX-WS 客户端端点。
使用 @Resource 注释，将代理注入到服务提供的中。

配置代理

您可以使用应用配置文件中的 jaxws:client 元素配置 JAX-WS 客户端端点。这告知运行时使用指定属性实例化 org.apache.cxf.jaxws.JaxWsClientProxy 对象。此对象是要注入服务供应商的代理。

您至少需要提供以下属性的值：

id- 指定用于识别要注入的客户端的 ID。
serviceClass-Spec 表示代理发出请求的服务的 SEI。

例 29.1 “注入到服务实施的代理的配置” 显示 JAX-WS 客户端端点的配置。

例 29.1. 注入到服务实施的代理的配置

<beans ...
  xmlns:jaxws="http://cxf.apache.org/jaxws"
  ...
  schemaLocation="...
    http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
    ...">
  <jaxws:client id="bookClient"
                serviceClass="org.apache.cxf.demo.BookService"
                wsdlLocation="classpath:books.wsdl"/>
  ...
</beans>

注意

在例 29.1 “注入到服务实施的代理的配置” 中 ，wsdlLocation 属性指示运行时从 classpath 加载 WSDL。如果 books.wsdl 位于 classpath 上，则运行时将可以找到它。

有关配置 JAX-WS 客户端的更多信息，请参阅第 17.2 节 “配置消费者端点”。

为供应商实施编码

您可以使用 @Resource 将配置代理注入服务实施中，作为例 29.2 “将代理注入服务实现” 所示。

例 29.2. 将代理注入服务实现

package demo.hw.server;

import org.apache.hello_world_soap_http.Greeter;

@javax.jws.WebService(portName = "SoapPort", serviceName = "SOAPService",
                      targetNamespace = "http://apache.org/hello_world_soap_http",
                      endpointInterface = "org.apache.hello_world_soap_http.Greeter")
public class StoreImpl implements Store {

@Resource(name="bookClient") private BookService proxy;

}

该注解的 name 属性对应于 JAX-WS 客户端的 id 属性的值。配置的代理会在注解后马上被注入到 BookService 对象中。您可以使用此对象在代理的外部服务上进行调用。

29.3. 使用 JAX-WS 目录

概述

JAX-WS 规范要求所有实现都支持：

解决 Web 服务描述的任何 Web 服务文档时要使用的标准目录功能，特别是 WSDL 和 XML Schema 文档。

这个目录工具使用 OASIS 指定的 XML 目录功能。所有采用 WSDL URI 的 JAX-WS API 和注释均使用目录来解决 WSDL 文档的位置。

这意味着您可以提供一个 XML 目录服务来重写 WSDL 文档的位置，以为特定部署环境进行套件。

编写目录

JAX-WS 目录是 OASIS XML 目录 1.1 规范中定义的标准 XML 目录。它们允许您指定映射：

文档的公共标识符和/或系统标识符到 URI。
到另一个 URI 的资源 URI。

表 29.1 “常见 JAX-WS 目录元素” 列出用于 WSDL 位置解析的一些常见元素。

表 29.1. 常见 JAX-WS 目录元素
element	描述
`uri`	将 URI 映射到备用 URI。
`rewriteURI`	重写 URI 的开头。例如，这个元素允许您将所有以 http://cxf.apache.org 开头的 URI 映射到以 classpath: 开头的 URI。
`uriSuffix`	根据原始 URI 后缀将 URI 映射到备用 URI。例如，您可以将以 foo.xsd 结尾的所有 URI 映射到 classpath:foo.xsd。

打包目录

JAX-WS 规范要求目录用来解析 WSDL 和 XML Schema 文档，它们使用名为 META-INF/jax-ws-catalog.xml 的所有可用资源进行汇编。如果您的应用程序被打包成单个 JAR 或 WAR，您可以将目录放在单个文件中。

如果您的应用程序被打包为多个 JAR，您可以将目录分成多个文件中。每个目录文件都模块化化，以仅处理特定 JAR 中代码访问的 WSDL。

29.4. 使用合同解析器

概述

在运行时解析 WSDL 文档位置的最涉及机制是实施您自己的自定义合同解析器。这要求您提供 Apache CXF 特定 ServiceContractResolver 接口的实现。您还需要使用总线注册自定义解析器。

注册正确注册后，将使用自定义合同解析器来解决所需的 WSDL 和架构文档的位置。

实施合同解析器

合同解析器是 org.apache.cxf.endpoint.ServiceContractResolver 接口的实现。如例 29.3 “ServiceContractResolver Interface” 所示，此界面具有单一方法 getContractLocation （），需要实施该界面。getContractLocation （） 采用服务的 QName，并返回服务的 WSDL 合同的 URI。

例 29.3. ServiceContractResolver Interface

public interface ServiceContractResolver
{
   URI getContractLocation(QName qname);
}

解决 WSDL 合同位置的逻辑是特定于应用程序。您可以添加从 UDDI 注册表、数据库、文件系统上自定义位置或您选择的任何其他机制解析合同位置的逻辑。

以编程方式注册合同解析器

在 Apache CXF 运行时将使用合同解析器之前，您必须使用合同解析器 registry 注册。合同解析器 registry 实施 org.apache.cxf.endpoint.ServiceContractResolverRegistry 接口。但是，您不需要实施自己的 registry。Apache CXF 在 org.apache.cxf.endpoint.ServiceContractResolverRegistryImpl 类中提供默认实现。

使用您进行的默认 registry 注册合同解析器：

获取对默认总线对象的引用。
使用总线的 getExtension （） 方法从总线获取服务合同 registry。
创建合同解析器实例。
使用 registry 的 register （） 方法将合同解析器注册到注册表。

例 29.4 “注册合同 Resolver” 显示用于将合同解析器注册到默认注册表的代码。

例 29.4. 注册合同 Resolver

BusFactory bf=BusFactory.newInstance();
Bus bus=bf.createBus();

ServiceContractResolverRegistry registry = bus.getExtension(ServiceContractResolverRegistry);

JarServiceContractResolver resolver = new JarServiceContractResolver();

registry.register(resolver);

例 29.4 “注册合同 Resolver” 中的代码执行以下操作：

获取总线实例。

获取总线合同解析器 registry。

创建合同解析器的实例。

使用 registry 注册合同解析器。

使用配置注册合同解析器

您也可以实施合同解析器，以便通过配置将其添加到客户端。合同解析器通过实现，从而使运行时读取配置并实例化解析器（解析器注册自身）的方法。由于运行时处理初始化，因此如果客户端需要使用合同解析器，您可以在运行时决定。

要实现合同解析器，请通过配置将其添加到客户端：

在您的合同解析器实施中添加 init （） 方法。
在您的 init （） 方法中添加逻辑，它使用合同解析器 registry 注册合同解析器，如例 29.4 “注册合同 Resolver” 所示。
使用 @PostConstruct 注释声明 init （） 方法。

例 29.5 “可以使用配置注册的 service Contract Resolver” 显示可以使用配置向客户端添加合同解析器实施。

例 29.5. 可以使用配置注册的 service Contract Resolver

import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import javax.xml.namespace.QName;

import org.apache.cxf.Bus;
import org.apache.cxf.BusFactory;

public class UddiResolver implements ServiceContractResolver
{
  private Bus bus;
  ...

  @PostConstruct
  public void init()
  {
    BusFactory bf=BusFactory.newInstance();
    Bus bus=bf.createBus();
    if (null != bus)
    {
      ServiceContractResolverRegistry resolverRegistry = bus.getExtension(ServiceContractResolverRegistry.class);
      if (resolverRegistry != null)
      {
        resolverRegistry.register(this);
      }
    }
  }

  public URI getContractLocation(QName serviceName)
  {
    ...
  }
}

要将合同解析器注册到客户端，您需要向客户端配置添加一个 bean 元素。bean 元素 的类 属性是实施合同解析器的类的名称。

例 29.6 “配置合同 Resolver” 显示用于添加由 org.apache.cxf.demos.myContractResolver 类实施的配置解析器的 bean。

例 29.6. 配置合同 Resolver

<beans xmlns="http://www.springframework.org/schema/beans"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
  ...
  <bean id="myResolver" class="org.apache.cxf.demos.myContractResolver" />
  ...
</beans>

合同解析顺序

当创建新代理时，运行时使用合同 registry 解析器来查找远程服务的 WSDL 合同。合同解析器 registry 调用每个合同解析器的 getContractLocation （） 方法。它会返回从其中一个注册合同解析器返回的第一个 URI。

如果您注册了一个试图在已知共享文件系统中解决 WSDL 合同的合同解析器，则会使用它的唯一合同解析器。但是，如果您随后使用 UDDI 注册表来注册一个可解析 WSDL 位置的合同解析器，注册表可以使用两个解析器来查找服务的 WSDL 合同。注册表将首先尝试使用共享文件系统合同解析器查找合同。如果该合同解析器失败，registry 会尝试使用 UDDI 合同解析器查找它。

第 30 章通用故障处理

摘要

JAX-WS 规范定义了两种类型的故障。个是通用 JAX-WS 运行时例外。另一个是消息处理过程中抛出的协议特定例外。

30.1. 运行时故障

概述

大多数 JAX-WS API 会抛出一个通用的 javax.xml.ws.WebServiceException 异常。

引发 WebServiceException 的 API

表 30.1 “Throw WebServiceException 的 API” 列出可引发通用 WebServiceException 异常的一些 JAX-WS API。

表 30.1. Throw WebServiceException 的 API
API	原因
`Binding.setHandlerChain()`	处理程序链配置中有一个错误。
`BindingProvider.getEndpointReference()`	指定类没有从 `W3CEndpointReference` 分配。
`Dispatch.invoke()`	Dispatch 实例配置中有一个错误，或者在与服务通信时出现错误。
`Dispatch.invokeAsync()`	Dispatch 实例的配置中出现错误。
`Dispatch.invokeOneWay()`	Dispatch 实例配置中有一个错误，或者在与服务通信时出现错误。
`LogicalMessage.getPayload()`	当使用提供的 `JAXBContext` 解封有效负载时，会出现错误。WebServiceException 的 `cause` 字段包含原始 JAXBException。
`LogicalMessage.setPayload()`	设置消息有效负载时出现错误。如果使用 `JAXBContext` 时引发异常，WebServiceException 的 `cause` 字段包含原始 JAXBException。
`WebServiceContext.getEndpointReference()`	指定类没有从 `W3CEndpointReference` 分配。

30.2. 协议故障

概述

当处理请求期间出现错误时，会抛出协议例外。所有同步远程调用都可以抛出协议异常。造成底层的原因在消费者的消息处理链或服务提供商中发生。

JAX-WS 规范定义通用协议例外。它还指定了一个特定于 SOAP 的协议异常和 HTTP 特定的协议例外。

协议例外的类型

JAX-WS 规范定义了三种类型的协议例外。您捕获的异常取决于应用程序使用的传输和绑定。

表 30.2 “Generic Protocol Exceptions 的类型” 描述三种协议异常以及何时抛出。

表 30.2. Generic Protocol Exceptions 的类型
例外类别	chhrown 的时间
javax.xml.ws.ProtocolException	这个例外是通用协议异常。无论正在使用中的协议，它都能发现。如果您使用 SOAP 绑定或 HTTP 绑定，可以将它转换为特定的故障类型。当将 XML 绑定与 HTTP 或 JMS 传输结合使用时，通用协议异常无法转换为更具体的故障类型。
javax.xml.ws.soap.SOAPFaultException	使用 SOAP 绑定时，远程调用会抛出此异常。更多信息请参阅 “使用 SOAP 协议例外”一节。
javax.xml.ws.http.HTTPException	当使用 Apache CXF HTTP 绑定来开发 RESTful Web 服务时，会抛出此异常。更多信息请参阅第 VI 部分 “开发 RESTful Web 服务”。

使用 SOAP 协议例外

SOAPFaultException 异常包装 SOAP 故障。底层 SOAP 故障作为 javax.xml.soap.SOAPFault 对象存储在 fault 字段中。

如果服务实施需要抛出一个不适合为应用创建的任何自定义异常的异常，可以使用例外创建者将故障包装到 SOAPFaultException 中，并将其丢弃回消费者。例 30.1 “抛出 SOAP 协议例外” 如果方法传递了无效的参数，则显示创建和引发 SOAPFaultException 的代码。

例 30.1. 抛出 SOAP 协议例外

public Quote getQuote(String ticker)
{
  ...
  if(tickers.length()<3)
  {
    SOAPFault fault = SOAPFactory.newInstance().createFault();
    fault.setFaultString("Ticker too short");
    throw new SOAPFaultException(fault);
  }
  ...
}

当消费者捕获 SOAPFaultException 异常时，可以通过检查嵌套的 SOAPFault 异常来检索异常的根本原因。如例 30.2 “从 SOAP 协议例外获取故障” 所示，SOAPFault 异常使用 SOAPFaultException 异常的 getFault （） 方法检索。

例 30.2. 从 SOAP 协议例外获取故障

...
try
{
  proxy.getQuote(ticker);
}
catch (SOAPFaultException sfe)
{
  SOAPFault fault = sfe.getFault();
  ...
}

第 31 章发布服务

摘要

当您要将 JAX-WS 服务部署为独立 Java 应用程序时，您必须明确实施发布服务提供商的代码。

31.1. 何时发布服务

Apache CXF 提供了多种方法来发布服务作为服务提供商。您发布服务的方式取决于您使用的部署环境。Apache CXF 支持的许多容器都不需要编写逻辑来发布端点。有两个例外：

将服务器部署为独立 Java 应用程序
将服务器部署到没有蓝图的 OSGi 容器中

有关将应用程序部署到支持的容器中的详细信息，请参阅第 IV 部分 “配置 Web 服务端点”。

31.2. 用于发布服务的 API

概述

javax.xml.ws.Enddpoint 类进行发布 JAX-WS 服务提供商的工作。要发布端点，请执行以下操作：

为您的服务提供商创建一个 Endpoint 对象。
发布端点。
在应用程序关闭时停止端点。

Endpoint 类提供了创建和发布服务提供商的方法。它还提供了一种方法，可以在单一方法调用中创建和发布服务提供商。

实例化服务提供商

服务提供商使用 Endpoint 对象进行实例化。您可以使用以下方法之一实例化您的服务提供商的 Endpoint 对象：

静态端点创建对象实现器 This create（） 方法返回指定服务的端点。Endpoint 对象使用实现类的 javax.xml.ws.BindingType 注解提供的信息创建（如果存在）。如果没有注解，则 Endpoint 将使用默认的 SOAP 1.1/HTTP 绑定。
静态端点创建URI绑定ID对象实现器 This create （） 方法使用指定的绑定返回指定实施对象的 Endpoint 对象。如果存在，此方法会覆盖 javax.xml.ws.BindingType 注解提供的绑定信息。如果 bindingID 无法解析，或者为空，则使用 javax.xml.ws.BindingType 中指定的绑定来创建 Endpoint。如果不使用 bindingID 或 javax.xml.ws.BindingType，则会使用默认的 SOAP 1.1/HTTP 绑定创建 端点。
staticEndpointpublishStringaddressObjectimplementor The publish （） 方法为指定实施创建 Endpoint 对象，并发布它。Endpoint 对象使用的绑定由提供 的地址 的 URL 方案决定。可用于实施的绑定列表会在扫描支持 URL 方案的绑定。如果找到 Endpoint 对象已创建并发布。如果未找到，则方法将失败。
使用 publish （） 与调用其中一个 create （） 方法相同，然后调用 ???TITLE??? 中使用的 publish （） 方法。

重要

传递给任何 Endpoint 创建方法的实施对象必须是以 javax.jws.WebService.WebService 和满足作为 SEI 实施的要求的类实例，或者它是以 javax.xml.ws.ws.WebServiceProvider 和实施 Provider 接口标注的类的实例。

发布服务供应商

您可以使用以下 Endpoint 方法之一发布服务提供商：

发布Stringaddress This publish （） 方法通过指定的地址发布服务提供商。
重要
地址 的 URL 方案必须与其中一个服务提供商的绑定兼容。
发布对象服务器Context This publish （） 方法会基于指定服务器上下文提供的信息发布服务提供程序。服务器上下文必须为端点定义地址，上下文也必须与服务提供商的可用绑定之一兼容。

停止已发布的服务供应商

当不再需要服务提供商时，您应该使用 stop （） 方法停止它。stop （） 方法显示在例 31.1 “停止发布端点的方法” 中，关闭端点并清理它正在使用的资源。

例 31.1. 停止发布端点的方法

stop

重要

端点停止后，便无法重新发布。

31.3. 在 Plain Java 应用程序中发布服务

概述

如果您想将应用部署为普通 java 应用，您需要实施相应的逻辑，以便在应用的 main （） 方法中发布端点。Apache CXF 为您提供了两个编写应用程序 main （） 方法的选项。

使用 wsdl2java 工具生成的 main （） 方法
编写发布端点的自定义 main （） 方法

生成服务器主线

代码生成器 -server 标志使工具生成一个简单的服务器主线。如例 31.2 “生成的服务器主线” 所示，生成的服务器主线发布一个服务提供程序，适用于指定 WSDL 合同中的每个 端口 元素。

更多信息请参阅第 44.2 节 “cxf-codegen-plugin”。

例 31.2 “生成的服务器主线” 显示生成的服务器主行。

例 31.2. 生成的服务器主线

package org.apache.hello_world_soap_http;

import javax.xml.ws.Endpoint;

public class GreeterServer {

    protected GreeterServer() throws Exception {
        System.out.println("Starting Server");
        Object implementor = new GreeterImpl();
        String address = "http://localhost:9000/SoapContext/SoapPort";
        Endpoint.publish(address, implementor);
    }

    public static void main(String args[]) throws Exception {
        new GreeterServer();
        System.out.println("Server ready...");

        Thread.sleep(5 * 60 * 1000);
        System.out.println("Server exiting");
        System.exit(0);
    }
}

例 31.2 “生成的服务器主线” 中的代码执行以下操作：

实例化服务实施对象的副本。

根据端点合同中的 wsdl:port 元素的内容，为端点创建 地址。

发布端点。

编写服务器主线

如果您使用了 Java 首个开发模型，或者您不想使用生成的服务器主线，您可以自己编写。要写入服务器主行，您必须执行以下操作：

“实例化服务提供商”一节适用于服务供应商的 javax.xml.ws.Endpoint 对象。
创建在发布服务提供商时要使用的可选服务器上下文。
“发布服务供应商”一节使用其中一个 publish （） 方法的服务提供商。
当应用程序准备好退出时，停止服务供应商。

例 31.3 “自定义服务器主线” 显示发布服务提供商的代码。

例 31.3. 自定义服务器主线

package org.apache.hello_world_soap_http;

import javax.xml.ws.Endpoint;

public class GreeterServer
{
  protected GreeterServer() throws Exception
  {
  }

  public static void main(String args[]) throws Exception
  {
    GreeterImpl impl = new GreeterImpl();
    Endpoint endpt.create(impl);
    endpt.publish("http://localhost:9000/SoapContext/SoapPort");

    boolean done = false;
   while(!done)
    {
      ...
    }

   endpt.stop();
    System.exit(0);
  }
}

例 31.3 “自定义服务器主线” 中的代码执行以下操作：

实例化服务实施对象的副本。

为服务实施创建未发布 端点。

在 http://localhost:9000/SoapContext/SoapPort 发布服务供应商。

循环，直到服务器关机为止。

停止已发布的端点。

31.4. 在 OSGi 容器中发布服务

概述

当您开发将部署到 OSGi 容器中的应用程序时，您需要通过打包捆绑包的生命周期协调发布和停止端点。您希望在捆绑包启动时发布端点，并且您希望在捆绑包停止时停止端点。

您可以通过实施 OSGi 捆绑包激活器将端点生命周期捆绑到捆绑包的生命周期中。OSGi 容器在启动时使用捆绑激活器为捆绑包创建资源。容器也使用捆绑包激活器在停止捆绑包资源时清除捆绑包资源。

bundle activator 接口

您可以通过实施 org.osgi.framework.BundleActivator 接口为应用程序创建捆绑包激活器。BundleActivator 接口显示在例 31.4 “bundle Activator Interface” 中，它有两种方法需要被实施。

例 31.4. bundle Activator Interface

interface BundleActivator
{
  public void start(BundleContext context)
  throws java.lang.Exception;

  public void stop(BundleContext context)
  throws java.lang.Exception;
}

启动捆绑包时，容器调用 start （） 方法。这是您实例化并发布端点的位置。

stop （） 方法在停止捆绑包时由容器调用。这是您要停止端点的位置。

实施起始方法

bundle activator 的 start 方法是您发布端点的位置。要发布端点，start 方法必须执行以下操作：

“实例化服务提供商”一节适用于服务供应商的 javax.xml.ws.Endpoint 对象。
创建在发布服务提供商时要使用的可选服务器上下文。
“发布服务供应商”一节使用其中一个 publish （） 方法的服务提供商。

例 31.5 “bundle Activator Start Method for Publishing a Endpoint” 显示发布服务提供商的代码。

例 31.5. bundle Activator Start Method for Publishing a Endpoint

package com.widgetvendor.osgi;

import javax.xml.ws.Endpoint;
import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

public class widgetActivator implements BundleActivator
{
  private Endpoint endpt;
  ...

  public void start(BundleContext context)
  {
    WidgetOrderImpl impl = new WidgetOrderImpl();
    endpt = Endpoint.create(impl);
    endpt.publish("http://localhost:9000/SoapContext/SoapPort");
  }

  ...

}

例 31.5 “bundle Activator Start Method for Publishing a Endpoint” 中的代码执行以下操作：

实例化服务实施对象的副本。

为服务实施创建未发布 端点。

在 http://localhost:9000/SoapContext/SoapPort 发布服务供应商。

实施 stop 方法

bundle activator 的 stop 方法是您清理应用程序使用的资源的地方。其实施包括用于停止应用程序发布的所有端点的逻辑。

例 31.6 “bundle Activator Stop Method for Stopping a Endpoint” 显示停止已发布端点的 stop 方法。

例 31.6. bundle Activator Stop Method for Stopping a Endpoint

package com.widgetvendor.osgi;

import javax.xml.ws.Endpoint;
import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

public class widgetActivator implements BundleActivator
{
  private Endpoint endpt;
  ...

  public void stop(BundleContext context)
  {
    endpt.stop();
  }

  ...

}

通知容器

您必须添加通知容器，应用程序捆绑包包含捆绑包(Bundleivator)。您可以通过在捆绑包的清单中添加 Bundle-Activator 属性来完成此操作。此属性告知容器在激活捆绑包时要使用的捆绑包中。其值是实施捆绑包激活的类的完全限定名称。

例 31.7 “bundle Activator Manifest Entry” 显示捆绑包的清单条目，其激活器由 class com.widgetvendor.osgi.widgetActivator 实施。

例 31.7. bundle Activator Manifest Entry

Bundle-Activator: com.widgetvendor.osgi.widgetActivator

第 32 章基本数据绑定概念

摘要

有一些常规主题适用于 Apache CXF 处理类型映射的方式。

32.1. 包含和导入架构定义

概述

Apache CXF 支持使用 include 和 import schema 标签包含和导入模式定义。通过这些标签，您可以将来自外部文件或资源的定义插入到 schema 元素的范围中。包括和导入之间的基本区别是：

包含在属于所属模式元素相同的目标命名空间的定义中。
导入（导入）包括属于所属 schema 元素的不同目标命名空间的定义。

xsd:include syntax

include 指令具有以下语法：

<include schemaLocation="anyURI" />

引用的 schema （由 anyURI 指定）必须与所属模式属于同一目标命名空间，或者不属于任何目标命名空间。如果引用的 schema 不属于任何目标命名空间，它将在包含的 schema 命名空间中自动采用。

例 32.1 “包含另一个 Schema 的 Schema 示例” 显示包含另一个 XML Schema 文档的 XML Schema 文档示例。

例 32.1. 包含另一个 Schema 的 Schema 示例

<definitions targetNamespace="http://schemas.redhat.com/tests/schema_parser"
             xmlns:tns="http://schemas.redhat.com/tests/schema_parser"
             xmlns:xsd="http://www.w3.org/2001/XMLSchema"
             xmlns="http://schemas.xmlsoap.org/wsdl/">
  <types>
    <schema targetNamespace="http://schemas.redhat.com/tests/schema_parser"
            xmlns="http://www.w3.org/2001/XMLSchema">
      <include schemaLocation="included.xsd"/>
      <complexType name="IncludingSequence">
        <sequence>
          <element name="includedSeq" type="tns:IncludedSequence"/>
        </sequence>
      </complexType>
    </schema>
  </types>
  ...
</definitions>

例 32.2 “包含的 Schema 示例” 显示已包含的 schema 文件的内容。

例 32.2. 包含的 Schema 示例

<schema targetNamespace="http://schemas.redhat.com/tests/schema_parser"
        xmlns="http://www.w3.org/2001/XMLSchema">
  <!-- Included type definitions -->
  <complexType name="IncludedSequence">
    <sequence>
      <element name="varInt" type="int"/>
      <element name="varString" type="string"/>
    </sequence>
  </complexType>
</schema>

xsd:import syntax

import 指令具有以下语法：

<import namespace="namespaceAnyURI"
        schemaLocation="schemaAnyURI" />

导入的定义必须属于 namespaceAnyURI 目标命名空间。如果 namespaceAnyURI 为空或保持未指定，则导入的 schema 定义不是完全限定的。

例 32.3 “Imports Another Schema 的 Schema 示例” 显示导入另一个 XML Schema 的 XML Schema 的示例。

例 32.3. Imports Another Schema 的 Schema 示例

<definitions targetNamespace="http://schemas.redhat.com/tests/schema_parser"
             xmlns:tns="http://schemas.redhat.com/tests/schema_parser"
             xmlns:imp="http://schemas.redhat.com/tests/imported_types"
             xmlns:xsd="http://www.w3.org/2001/XMLSchema"
             xmlns="http://schemas.xmlsoap.org/wsdl/">
  <types>
    <schema targetNamespace="http://schemas.redhat.com/tests/schema_parser"
            xmlns="http://www.w3.org/2001/XMLSchema">
      <import namespace="http://schemas.redhat.com/tests/imported_types"
              schemaLocation="included.xsd"/>
      <complexType name="IncludingSequence">
        <sequence>
          <element name="includedSeq" type="imp:IncludedSequence"/>
        </sequence>
      </complexType>
    </schema>
  </types>
  ...
</definitions>

例 32.4 “Imported Schema 示例” 显示导入的 schema 文件的内容。

例 32.4. Imported Schema 示例

<schema targetNamespace="http://schemas.redhat.com/tests/imported_types"
        xmlns="http://www.w3.org/2001/XMLSchema">
  <!-- Included type definitions -->
  <complexType name="IncludedSequence">
    <sequence>
      <element name="varInt" type="int"/>
      <element name="varString" type="string"/>
    </sequence>
  </complexType>
</schema>

使用非引用模式文档

使用在服务 WSDL 文档中没有引用的 schema 文件中定义的类型包含三个步骤：

使用 xsd2wsdl 工具将架构文档转换为 WSDL 文档。
在生成的 WSDL 文档中，使用 wsdl2java 工具为类型生成 Java。
重要
您将从 wsdl2java 工具收到警告，表示 WSDL 文档没有定义任何服务。您可以忽略这个警告。
将生成的类添加到您的类路径。

32.2. XML 命名空间映射

概述

XML Schema 类型、组和元素定义通过使用命名空间来有作用域。命名空间可防止使用相同名称的实体之间的可能命名冲突。Java 软件包具有类似目的。因此，Apache CXF 将架构文档的目标命名空间映射到包含实施架构文档中定义的结构所需的类软件包中。

软件包命名

生成的软件包的名称是通过以下算法从 schema 的目标命名空间衍生而来：

URI 方案（如果存在）。
注意
Apache CXF 只会剥离 http：、https： 和 urn: 方案。
例如，命名空间 http:\\www.widgetvendor.com\types\widgetTypes.xsd 变为 \\widgetvendor.com\types\widgetTypes.xsd。
尾部的文件类型标识符（如果存在）被剥离。
例如，\\www.widgetvendor.com\types\widgetTypes.xsd 变为 \\widgetvendor.com\types\widgetTypes。
生成的字符串被分为一个字符串列表，使用 / 和 : 作为分隔符。
因此，\\www.widgetvendor.com\types\widgetTypes 变为列表 {"www.widegetvendor.com", "types", "widgetTypes"}.
如果列表中的第一个字符串是互联网域名，则按如下方式进行处理：
1. 主要的 www. 被剥离。
2. 剩余的字符串使用划分为其组件部分 。 作为分隔符。
3. 列表的顺序将被逆向。
  so, {"www.widegetvendor.com", "types", "widgetTypes"} become {"com", "widegetvendor", "types", "widgetTypes"}
  注意
  Internet 域名以以下一种结尾： .com、.net、、.edu、.org、.gov 或在双字母国家/地区代码之一结尾。
字符串转换为所有小写。
因此, {"com", "widegetvendor", "types", "widgetTypes"} become {"com", "widegetvendor", "types", "widgettypes"}.
字符串被规范化为有效的 Java 软件包名称组件，如下所示：
1. 如果字符串包含任何特殊字符，则特殊字符将转换为下划线(_)。
2. 如果有任何字符串是 Java 关键字，则关键字的前缀为下划线(_)。
3. 如果有任何字符串以 numeral 开头，则字符串前缀为下划线(_)。
字符串使用 . 作为分隔符。
因此, {"com", "widegetvendor", "types", "widgettypes"} become the package name com.widgetvendor.types.widgettypes.

在命名空间 http:\\www.widgetvendor.com\types\widgetTypes.xsd 中定义的 XML Schema 结构被映射到 Java 软件包 com.widgetvendor.types.widgettypes。

软件包内容

一个 JAXB 生成的软件包包含以下内容：

实施架构中定义的各种复杂类型的类
有关复杂类型映射的更多信息，请参阅第 35 章 使用复杂类型。
使用 enumeration facet 定义的任何简单类型 枚举 类型
有关如何映射枚举的更多信息，请参阅第 34.3 节 “枚举”。
公共 对象工厂 类，其中包含从 schema 中实例化对象的方法
有关 ObjectFactory 类的更多信息，请参阅第 32.3 节 “对象因素”。
package-info.java 文件，它提供有关软件包中类的元数据

32.3. 对象因素

概述

JAXB 使用对象工厂为实例化的 JAXB 生成的构造提供机制。对象工厂包含在软件包范围内实例化所有 XML 架构的方法。唯一的例外是，枚举不获得对象工厂中的创建方法。

复杂的类型工厂方法

对于为实现 XML 模式复杂类型而生成的每个 Java 类，对象工厂包含创建类实例的方法。这个方法采用以下格式：

typeName createtypeName();

例如，如果您的模式包含一个名为 widgetType 的复杂类型，Apache CXF 会生成名为 WidgetType 的类来实施。例 32.5 “复杂的类型对象工厂条目” 显示对象工厂中生成的创建方法。

例 32.5. 复杂的类型对象工厂条目

public class ObjectFactory
{
  ...
  WidgetType createWidgetType()
  {
    return new WidgetType();
  }
  ...
}

元素工厂方法

对于在模式全局范围内声明的元素，Apache CXF 在对象工厂中插入工厂方法。如第 33 章 使用 XML 元素 中所述，XML Schema 元素映射到 JAXBElement<T> 对象。创建方法采用以下形式：

public JAXBElement<elementType> createelementName(elementType value);

例如，如果您有一个类型为 xsd:string 的元素，Apache CXF 生成对象工厂方法。例 32.6 “元素对象 Factory Entry”

例 32.6. 元素对象 Factory Entry

public class ObjectFactory
{
    ...
    @XmlElementDecl(namespace = "...", name = "comment")
    public JAXBElement<String> createComment(String value) {
        return new JAXBElement<String>(_Comment_QNAME, String.class, null, value);
    }
    ...
}

32.4. 在 Runtime Marshaller 中添加类

概述

当 Apache CXF 运行时读写 XML 数据时，它使用将 XML Schema 类型与代表 Java 类型关联的映射。默认情况下，映射包含 WSDL 合同 架构 元素的目标命名空间中定义的所有类型。它还包含从导入到 WSDL 合同的任何模式的命名空间生成的任何类型的类型。

利用 @XmlSeeAlso 注释，实现从应用架构元素使用的模式命名空间以外的命名空间添加类型。如果您的应用程序需要使用在应用的 WSDL 文档范围之外生成的类型，您可以编辑 @XmlSeeAlso 注释，将它们添加到 JAXB 映射中。

使用 @XmlSeeAlso 注释

@XmlSeeAlso 注释可添加到您的服务的 SEI 中。它包含以逗号分隔的类列表，可包含在 JAXB 上下文中。例 32.7 “将类添加到 JAXB 上下文的语法” 显示使用 @XmlSeeAlso 注释的语法。

例 32.7. 将类添加到 JAXB 上下文的语法

import javax.xml.bind.annotation.XmlSeeAlso;
     @WebService()
     @XmlSeeAlso({Class1.class, Class2.class, ..., ClassN.class})
     public class GeneratedSEI {
         ...
     }

如果您有权访问 JAXB 生成的类，使用生成的 ObjectFactory 类支持所需的类型效率更高。包括 ObjectFactory 类包括已知到对象工厂的所有类。

示例

例 32.8 “将类添加到 JAXB 上下文” 显示标有 @XmlSeeAlso 的 SEI。

例 32.8. 将类添加到 JAXB 上下文

...
import javax.xml.bind.annotation.XmlSeeAlso;
...
    @WebService()
    @XmlSeeAlso({org.apache.schemas.types.test.ObjectFactory.class, org.apache.schemas.tests.group_test.ObjectFactory.class})
    public interface Foo {
        ...
    }

第 33 章使用 XML 元素

摘要

XML Schema 元素用于定义 XML 文档中的元素实例。元素在 XML Schema 文档的全局范围内定义，或者它们定义为复杂类型的成员。在全局范围内定义它们时，Apache CXF 将它们映射到可更轻松地操作的 JAXB 元素类。

概述

XML 文档中的一个元素实例由 XML Schema 文档全局范围内 XML Schema 元素 元素定义，以便 Java 开发人员能够更轻松地使用元素，Apache CXF 将全局范围的元素映射到特殊的 JAXB 元素类，或生成与其内容类型匹配的 Java 类。

元素的 map 如何取决于使用 type 属性引用的指定类型定义，或者 元素是使用 in-line 类型定义定义的。使用中类型定义定义的元素映射到 Java 类。

建议元素使用指定类型来定义，因为架构中的其他元素无法重复使用类型。

XML Schema 映射

在 XML Schema 元素中，使用 元素 定义。元素 元素具有一个必需属性。name 指定它出现在 XML 文档中的元素名称。

除了 name 属性 元素元素 外，还具有表 33.1 “用于定义元素的属性” 中列出的可选属性。

表 33.1. 用于定义元素的属性
属性	描述
`type`	指定元素的类型。类型可以是任何 XML Schema 原语类型，也可以是合同中定义的任何指定复杂类型。如果没有指定此属性，则需要包含 in-line type 定义。
`nillable`	指定元素是否可以完全从文档中保留。如果将 `nillable` 设为 `true`，则这个元素可以从使用 schema 生成的任何文档中省略。
`abstract`	指定是否在实例文档中使用某一元素。`true` 表示元素无法在实例文档中出现。相反，如果 `替换Group 属性包含` 这个元素的 QName，则这个元素必须出现另一个元素。有关此属性影响代码生成的详情，请参考 “Java 抽象元素的映射”一节。
`substitutionGroup`	指定可替换为这个元素的元素名称。有关使用类型替换的详情，请参考第 37 章 element Substitution。
`default`	指定元素的默认值。有关此属性影响代码生成的详情，请参考 “带有默认值的元素的 Java 映射”一节。
`FIXED`	为元素指定固定值。

例 33.1 “简单 XML Schema 元素定义” 显示简单的元素定义。

例 33.1. 简单 XML Schema 元素定义

<element name="joeFred" type="xsd:string" />

元素也可以使用 in-line type 定义来定义自己的类型。使用 complexType 元素或 simpleType 元素来指定在线类型。指定数据类型是否比较复杂或简单后，您可以使用每种数据类型可用的工具定义任何类型的数据。

例 33.2 “带有在线类型的 XML Schema 元素定义” 显示带有在线类型定义的元素定义。

例 33.2. 带有在线类型的 XML Schema 元素定义

<element name="skate">
  <complexType>
    <sequence>
      <element name="numWheels" type="xsd:int" />
      <element name="brand" type="xsd:string" />
    </sequence>
  </complexType>
</element>

带有指定类型的元素的 Java 映射

默认情况下，全局定义的元素映射到 JAXBElement<T > 对象，其中模板类由 element 元素的 type 属性的值决定。对于原语类型，模板类使用 “打包程序类”一节中描述的打包程序类映射进行派生。对于复杂的类型，生成的 Java 类用于支持复杂类型，用作模板类。

为支持映射并减轻开发人员对元素的 QName 无关，为每个全局定义元素生成一个对象工厂方法，如例 33.3 “全局范围元素的对象因素方法” 所示。

例 33.3. 全局范围元素的对象因素方法

public class ObjectFactory {

    private final static QName _name_QNAME = new QName("targetNamespace", "localName");

    ...

    @XmlElementDecl(namespace = "targetNamespace", name = "localName")
    public JAXBElement<type> createname(type value);

}

例如：例 33.1 “简单 XML Schema 元素定义” 中定义的元素会导致对象工厂方法在例 33.4 “简单元素的对象因素” 中显示。

例 33.4. 简单元素的对象因素

public class ObjectFactory {

    private final static QName _JoeFred_QNAME = new QName("...", "joeFred");

    ...

    @XmlElementDecl(namespace = "...", name = "joeFred")
    public JAXBElement<String> createJoeFred(String value);

}

例 33.5 “使用全局范围元素” 显示了在 Java 中使用全局范围元素的示例。

例 33.5. 使用全局范围元素

JAXBElement<String> element = createJoeFred("Green");
String color = element.getValue();

在 WSDL 中使用带有指定类型的元素

如果使用全局范围元素来定义消息部分，则生成的 Java 参数不是 JAXBElement<T> 的实例。相反，它映射到常规的 Java 类型或类。

由于例 33.6 “WSDL 使用元素作为消息部分” 中显示的 WSDL 片段，生成的方法的参数类型为 String。

例 33.6. WSDL 使用元素作为消息部分

<?xml version="1.0" encoding=";UTF-8"?>
<wsdl:definitions name="HelloWorld"
                  targetNamespace="http://apache.org/hello_world_soap_http"
                  xmlns="http://schemas.xmlsoap.org/wsdl/"
                  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
                  xmlns:tns="http://apache.org/hello_world_soap_http"
                  xmlns:x1="http://apache.org/hello_world_soap_http/types"
                  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
                  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <wsdl:types>
    <schema targetNamespace="http://apache.org/hello_world_soap_http/types"
            xmlns="http://www.w3.org/2001/XMLSchema"
            elementFormDefault="qualified"><element name="sayHi">
      <element name="sayHi" type="string"/>
      <element name="sayHiResponse" type="string"/>
    </schema>
  </wsdl:types>

  <wsdl:message name="sayHiRequest">
    <wsdl:part element="x1:sayHi" name="in"/>
  </wsdl:message>
  <wsdl:message name="sayHiResponse">
    <wsdl:part element="x1:sayHiResponse" name="out"/>
  </wsdl:message>

  <wsdl:portType name="Greeter">
    <wsdl:operation name="sayHi">
      <wsdl:input message="tns:sayHiRequest" name="sayHiRequest"/>
      <wsdl:output message="tns:sayHiResponse" name="sayHiResponse"/>
    </wsdl:operation>
  </wsdl:portType>
  ...
</wsdl:definitions>

例 33.7 “使用全局元素的 Java 方法作为部分” 显示为 sayHi 操作生成的方法签名。

例 33.7. 使用全局元素的 Java 方法作为部分

StringsayHiStringin

带有在线类型的元素的 Java 映射

当使用在线类型定义元素时，它按照用于映射其他类型到 Java 的规则映射到 Java。第 34 章 使用简单类型 中描述了简单类型的规则。复杂类型的规则包括在第 35 章 使用复杂类型 中。

当为带有在线类型定义的元素生成 Java 类时，生成的类使用 @XmlRootElement 注释进行解码。@XmlRootElement 注释具有两个有用的属性： name 和 namespace。这些属性包括在表 33.2 “@XmlRootElement 注解的属性” 中。

表 33.2. @XmlRootElement 注解的属性
属性	描述
`name`	指定 XML Schema `元素的` `name` 属性的值。
`namespace`	指定定义元素的命名空间。如果此元素在目标命名空间中定义，则不会指定该属性。

如果元素满足一个或多个条件，则不会使用 @XmlRootElement 注释：

元素的 nillable 属性设置为 true
元素是替换组的头元素
有关替换组的更多信息，请参阅第 37 章 element Substitution。

Java 抽象元素的映射

当元素的 abstract 属性被设置为 true 时，不会生成用于实例化类型的实例的对象工厂方法。如果元素是使用在线类型定义的，则生成支持在线类型的 Java 类。

带有默认值的元素的 Java 映射

当元素 的默认 属性被使用 defaultValue 属性添加到生成的 @XmlElementDecl 注释中。例如：例 33.8 “带有默认值的 XML Schema 元素” 中定义的元素会导致对象工厂方法在例 33.9 “带有默认值的元素对象因素方法” 中显示。

例 33.8. 带有默认值的 XML Schema 元素

<element name="size" type="xsd:int" default="7"/>

例 33.9. 带有默认值的元素对象因素方法

   @XmlElementDecl(namespace = "...", name = "size", defaultValue = "7")
   public JAXBElement<Integer> createUnionJoe(Integer value) {
       return new JAXBElement<Integer>(_Size_QNAME, Integer.class, null, value);
   }

第 34 章使用简单类型

摘要

XML Schema 简单的类型是 XML Schema primitive 类型，如 xsd:int，或使用 simpleType 元素来定义。它们用于指定不包含任何子或属性的元素。它们通常映射到原生 Java 结构，不需要生成特殊类来实施它们。枚举的简单类型不会产生生成的代码，因为它们映射到 Java 枚举类型。

34.1. 原语类型

概述

当使用 XML Schema 原语类型来定义消息部分时，所生成的参数类型映射到对应的 Java 原生类型。在映射复杂类型范围内定义的元素时，使用相同的模式。生成的字段是对应的 Java 原生类型。

映射

表 34.1 “XML Schema Primitive Type to Java Native Type Mapping” 列出 XML Schema 原语类型和 Java 原生类型之间的映射。

表 34.1. XML Schema Primitive Type to Java Native Type Mapping
XML Schema 类型	Java 类型
`xsd:string`	`字符串`
`xsd:integer`	`BigInteger`
`xsd:int`	`int`
`xsd:long`	`long`
`xsd:short`	`short`
`xsd:decimal`	`BigDecimal`
`xsd:float`	`浮点值`
`xsd:double`	`double`
`xsd:boolean`	`布尔值`
`xsd:byte`	`byte`
`xsd:QName`	`QName`
`xsd:dateTime`	`XMLGregorianCalendar`
`xsd:base64Binary`	`byte[]`
`xsd:hexBinary`	`byte[]`
`xsd:unsignedInt`	`long`
`xsd:unsignedShort`	`int`
`xsd:unsignedByte`	`short`
`xsd:time`	`XMLGregorianCalendar`
`xsd:date`	`XMLGregorianCalendar`
`xsd:g`	`XMLGregorianCalendar`
`xsd:anySimpleType` ^[a]	`对象`
`xsd:anySimpleType` ^[b]	`字符串`
`xsd:duration`	`Duration`
`xsd:NOTATION`	`QName`
^[a] 这种类型的元素。 ^[b] 对于此类属性。

打包程序类

将 XML Schema 原语类型映射到 Java primitive 类型不适用于所有可能的 XML Schema 结构。一些情况要求 XML Schema 原语类型映射到 Java 原语类型对应的打包程序类型。这些情况包括：

一个 element element，其 nillable 属性设置为 true，如下所示：
```
<element name="finned" type="xsd:boolean"
         nillable="true" />
```
一个 元素 元素，其 minOccurs 属性设置为 0，其 maxOccurs 属性设为 1，或者其 maxOccurs 属性没有被指定，如下所示：
```
<element name="plane" type="xsd:string" minOccurs="0" />
```

属性 元素的 use 属性设为 可选，或者未指定，并且没有任何 默认 属性或指定的 固定 属性，如下所示：

<element name="date">
  <complexType>
    <sequence/>
    <attribute name="calType" type="xsd:string"
               use="optional" />
  </complexType>
</element>

表 34.2 “primitive Schema Type to Java Wrapper Class Mapping” 显示在这样的情形中如何将 XML Schema 原语类型映射到 Java 打包程序类。

表 34.2. primitive Schema Type to Java Wrapper Class Mapping
模式类型	Java 类型
`xsd:int`	`java.lang.Integer`
`xsd:long`	`java.lang.Long`
`xsd:short`	`java.lang.Short`
`xsd:float`	`java.lang.Float`
`xsd:double`	`java.lang.Double`
`xsd:boolean`	`java.lang.Boolean`
`xsd:byte`	`java.lang.Byte`
`xsd:unsignedByte`	`java.lang.Short`
`xsd:unsignedShort`	`java.lang.Integer`
`xsd:unsignedInt`	`java.lang.Long`
`xsd:unsignedLong`	`java.math.BigInteger`
`xsd:duration`	`java.lang.String`

34.2. 通过限制定义的简单类型

概述

XML Schema 允许您通过从另一原语类型或简单类型推断新的类型来创建简单类型。使用 simpleType 元素对简单类型进行描述。

通过限制一个或多个方面 的基础类型，可以描述新的类型。这些因素限制可在新类型中保存的有效值。例如，您可以定义一个简单的类型 SSN，该字符串为正好 9 个字符的字符串。

原语 XML Schema 类型都有自己的一组可选 facets。

流程

要定义您自己的简单类型，请执行以下操作：

确定您的新简单类型的基础类型。
根据所选基本类型的可用问题，确定新类型定义新类型。
使用本节中显示的语法，在您的合同的 type 部分中输入适当的 simpleType 元素。

在 XML Schema 中定义简单类型

例 34.1 “简单类型语法” 显示描述简单类型的语法。

例 34.1. 简单类型语法

<simpleType name="typeName">
  <restriction base="baseType">
    <facet value="value" />
    <facet value="value" />
    ...
  </restriction>
</simpleType>

类型描述包含在 simpleType 元素中，并由 name 属性的值标识。新的简单类型定义的基本类型通过 xsd:restriction 元素的 base 属性指定。每个 facet 元素在 限制 元素中指定。可用因素及其有效设置取决于基本类型。例如，xsd:string 有很多问题，其中包括：

length
minLength
maxLength
pattern
whitespace

例 34.2 “邮编简单类型” 显示表示用于美国状态的双字母邮政代码的简单类型定义。它只能包含两个大写字母。TX 是有效的值，但 tx 或 tX 不是有效值。

例 34.2. 邮编简单类型

<xsd:simpleType name="postalCode">
  <xsd:restriction base="xsd:string">
    <xsd:pattern value="[A-Z]{2}" />
  </xsd:restriction>
</xsd:simpleType>

映射到 Java

Apache CXF 将用户定义的简单类型映射到简单类型的基本类型的 Java 类型。因此，使用简单类型邮政代码（如例 34.2 “邮编简单类型” 所示）的消息都映射到一个字符串，因为 postalCode 的基本类型是 xsd:string。例如，例 34.3 “使用简单类型进行信用请求” 中显示的 WSDL 片段生成 Java 方法的 state （），它采用一个参数、邮政 代码，即 String。

例 34.3. 使用简单类型进行信用请求

<message name="stateRequest">
  <part name="postalCode" type="postalCode" />
</message>
...
<portType name="postalSupport">
  <operation name="state">
    <input message="tns:stateRequest" name="stateRec" />
    <output message="tns:stateResponse" name="credResp" />
  </operation>
</portType>

Enforcing facets

默认情况下，Apache CXF 不会强制任何用来限制简单类型的问题。但是，您可以通过启用模式验证，将 Apache CXF 端点配置为强制实施问题。

要将 Apache CXF 端点配置为使用 schema 验证，将启用了 schema-validation-enabled 属性设为 true。例 34.4 “Service Provider Configured to Use Schema Validation” 显示使用 schema 验证的服务提供商的配置

例 34.4. Service Provider Configured to Use Schema Validation

<jaxws:endpoint name="{http://apache.org/hello_world_soap_http}SoapPort"
                wsdlLocation="wsdl/hello_world.wsdl"
                createdFromAPI="true">
  <jaxws:properties>
    <entry key="schema-validation-enabled" value="BOTH" />
  </jaxws:properties>
</jaxws:endpoint>

有关配置模式验证的详情，请参考第 24.3.4.7 节 “模式验证类型值”。

34.3. 枚举

概述

在 XML Schema 中，枚举类型是使用 xsd:enumeration facet 定义的简单类型。与 atomic 简单类型不同的是，它们映射到 Java 枚举。

在 XML Schema 中定义枚举类型

枚举是使用 xsd:enumeration facet 的简单类型。每个 xsd:enumeration 都会为枚举类型定义一个可能的值。

例 34.5 “XML Schema Defined Enumeration” 显示枚举类型的定义。它有以下可能的值：

big
large
mungo
gargantuan

例 34.5. XML Schema Defined Enumeration

<simpleType name="widgetSize">
  <restriction base="xsd:string">
    <enumeration value="big"/>
    <enumeration value="large"/>
    <enumeration value="mungo"/>
    <enumeration value="gargantuan"/>
  </restriction>

映射到 Java

在基础类型为 xsd:string 的 XML Schema enumerations 会自动映射到 Java enum 类型。您可以使用第 38.4 节 “自定义枚举映射” 中描述的自定义，指示代码生成器将其他基本类型的枚举映射到 Java 枚举类型。

enum 类型创建如下：

类型的名称取自简单类型定义的 name 属性，并转换为 Java 标识符。
通常，这意味着将 XML Schema 名称的第一个字符转换为大写字母。如果 XML Schema 名称的第一个字符是无效字符，则会在名称前带有下划线(_)。
对于每个 枚举 面，会根据 value 属性的值生成枚举常量。
恒定的名称是通过将值中的所有小写字母转换为等效的大写。
生成构造器，它采用从枚举基础类型映射的 Java 类型。
生成名为 value （） 的公共方法，以访问由类型实例表示的 facet 值。
value （） 方法的返回类型是 XML Schema 类型的基本类型。
生成名为 fromValue （） 的公共方法，以根据 facet 值创建 enum 类型的实例。
value （） 方法的参数类型是 XML Schema 类型的基本类型。
该类通过 @XmlEnum 注释进行解码。

例 34.5 “XML Schema Defined Enumeration” 中定义的枚举类型映射到例 34.6 “为 String Bases XML Schema 枚举生成枚举类型” 中显示的枚举类型。

例 34.6. 为 String Bases XML Schema 枚举生成枚举类型

@XmlType(name = "widgetSize")
@XmlEnum
public enum WidgetSize {

    @XmlEnumValue("big")
    BIG("big"),
    @XmlEnumValue("large")
    LARGE("large"),
    @XmlEnumValue("mungo")
    MUNGO("mungo"),
    @XmlEnumValue("gargantuan")
    GARGANTUAN("gargantuan");
    private final String value;

    WidgetSize(String v) {
        value = v;
    }

    public String value() {
        return value;
    }

    public static WidgetSize fromValue(String v) {
        for (WidgetSize c: WidgetSize.values()) {
            if (c.value.equals(v)) {
                return c;
            }
        }
        throw new IllegalArgumentException(v);
    }

}

34.4. 列表

概述

XML Schema 支持通过一种机制来定义数据类型，这些数据类型是以空格分隔的简单类型的空间列表。例 34.7 “列出类型示例” 中显示了一个元素 primeList。

例 34.7. 列出类型示例

<primeList>1 3 5 7 9 11 13<\primeList>

XML Schema 列表类型通常映射到 Java List<T> 对象。此模式的唯一变体是消息部分直接映射到 XML Schema 列表类型的实例。

在 XML Schema 中定义列表类型

XML Schema 列表类型是简单类型，比如使用 simpleType 元素来定义。例 34.8 “XML Schema 列表类型的语法” 中显示了用于定义列表类型的最常用语法。

例 34.8. XML Schema 列表类型的语法

<simpleType name="listType">
  <list itemType="atomicType">
    <facet value="value" />
    <facet value="value" />
    ...
  </list>
</simpleType>

为 atomicType 指定的值定义列表中的元素类型。它只能是 XML Schema atomic 类型中的一个，如 xsd:int 或 xsd:string，也可以是不是列表的用户定义的简单类型。

除了定义列表类型中列出的元素类型外，您还可以使用 facets 来进一步限制列表类型的属性。表 34.3 “列出类型 Facets” 显示列表类型所使用的问题。

表 34.3. 列出类型 Facets
facet	效果
`length`	定义列表类型的实例中元素的数量。
`minLength`	定义列表类型的实例中允许的最小元素数量。
`maxLength`	定义列表类型实例中允许的最大元素数。
`enumeration`	在列表类型的实例中定义元素的允许值。
`pattern`	在列表类型的实例中定义元素的 lexical 形式。使用正则表达式来定义模式。

例如，例 34.7 “列出类型示例” 中显示的 简单List 元素的定义显示在例 34.9 “列表类型的定义” 中。

例 34.9. 列表类型的定义

<simpleType name="primeListType">
  <list itemType="int"/>
</simpleType>
<element name="primeList" type="primeListType"/>

除了例 34.8 “XML Schema 列表类型的语法” 中显示的语法外，您还可以使用例 34.10 “列表类型的替代语法” 中显示的常见语法来定义列表类型。

例 34.10. 列表类型的替代语法

<simpleType name="listType">
  <list>
    <simpleType>
      <restriction base="atomicType">
        <facet value="value"/>
        <facet value="value"/>
        ...
      </restriction>
    </simpleType>
  </list>
  </simpleType>

将列表类型元素映射到 Java

当元素定义了列表类型时，列表类型映射到 collection 属性。collection 属性是 Java List<T> 对象。List<T> 使用的模板类是从列表的基本类型映射的打包程序类。例如，例 34.9 “列表类型的定义” 中定义的列表类型映射到 List<Integer>。

有关 wrapper 类型映射的详情，请参考 “打包程序类”一节。

将列表类型参数映射到 Java

当消息部分定义为列表类型，或映射到列表类型的元素时，生成的方法参数会映射到数组，而不是 List<T&gt; 对象。数组的基本类型是列表类型的基本类。

例如，例 34.11 “带有列表类型消息的 WSDL 部分” 中的 WSDL 片段会导致方法签名在例 34.12 “带有列表类型参数的 Java 方法” 中。

例 34.11. 带有列表类型消息的 WSDL 部分

<definitions ...>
  ...
  <types ...>
    <schema ... >
      <simpleType name="primeListType">
        <list itemType="int"/>
      </simpleType>
      <element name="primeList" type="primeListType"/>
    </schemas>
  </types>
  <message name="numRequest"> <part name="inputData" element="xsd1:primeList" /> </message>
  <message name="numResponse">;
    <part name="outputData" type="xsd:int">
  ...
  <portType name="numberService">
    <operation name="primeProcessor">
      <input name="numRequest" message="tns:numRequest" />
      <output name="numResponse" message="tns:numResponse" />
    </operation>
    ...
  </portType>
  ...
</definitions>

例 34.12. 带有列表类型参数的 Java 方法

public interface NumberService {

    @XmlList
    @WebResult(name = "outputData", targetNamespace = "", partName = "outputData")
    @WebMethod
    public int primeProcessor(
        @WebParam(partName = "inputData", name = "primeList", targetNamespace = "...") java.lang.Integer[] inputData
    );
}

34.5. unions

概述

在 XML Schema 中，联合是一个构造，它允许您描述数据可以是多种简单类型之一的类型。例如，您可以定义一个类型，其值是整数 1 或字符串 first。unions 映射到 Java String。

在 XML Schema 中定义

XML Schema unions 使用 simpleType 元素进行定义。它们至少包含一个联合 元素，用于定义该标头的成员类型。提取的成员类型是可存储在联合实例中的有效数据类型。它们使用 union 元素的 memberTypes 属性来定义。memberTypes 属性的值包含一个或多个定义的简单类型名称的列表。例 34.13 “简单联合类型” 显示可存储整数或字符串的联合定义。

例 34.13. 简单联合类型

<simpleType name="orderNumUnion">
  <union memberTypes="xsd:string xsd:int" />
</simpleType>

除了将指定类型指定为联合的成员类型外，您还可以将匿名简单的类型定义为区的成员类型。这可以通过在 union 元素中添加匿名类型定义来实现。例 34.14 “Union with Anonymous Member Type” 显示包含匿名成员类型的联合示例，该类型将有效整数的可能值限制为范围 1 到 10。

例 34.14. Union with Anonymous Member Type

<simpleType name="restrictedOrderNumUnion">
  <union memberTypes="xsd:string">
    <simpleType>
      <restriction base="xsd:int">
        <minInclusive value="1" />
        <maxInclusive value="10" />
      </restriction>
    </simpleType>
  </union>
</simpleType>

映射到 Java

XML Schema union 类型映射到 Java String 对象。默认情况下，Apache CXF 不会验证所生成的对象的内容。要使 Apache CXF 验证内容，您必须配置运行时以使用架构验证，如 “Enforcing facets”一节所述。

34.6. simple Type Substitution

概述

XML 允许使用 xsi:type 属性在兼容类型之间进行简单替换。但是，简单类型的默认映射到 Java 原语类型的映射并不完全支持简单类型替换。运行时可以处理基本简单的类型替换，但信息会丢失。可以自定义代码生成器来生成 Java 类，从而促进无人简单的类型替换。

默认映射和过滤

因为 Java 原语类型不支持类型替换，所以使用简单类型到 Java 原语类型的默认映射提供了支持简单类型替换的问题。如果尝试将一个 简短 传递给某个变量的变量，那么 Java 虚拟机将会 balk，即使定义了类型允许该类型的架构也是如此。

要了解 Java 类型系统的限制，Apache CXF 在元素的 xsi:type 属性的值满足以下条件之一时，允许进行简单的类型替换：

它指定一个原始类型，与元素的 schema 类型兼容。
它指定一个类型，根据元素的 schema 类型进行限制。
它指定一个复杂的类型，它通过元素的模式类型扩展来派生。

当运行时进行类型替换时，它不会保留元素 xsi:type 属性中指定的类型的任何知识。如果类型替换是从复杂的类型到简单类型，则只保留与简单类型直接相关的值。由扩展添加的任何其他元素和属性都会丢失。

支持无损类型替换

您可以自定义生成简单的类型，以便通过以下方法使无链接支持简单类型替换：

将 globalBindings 自定义元素的 mapSimpleTypeDef 设置为 true。
这指示代码生成器为全局范围中定义的所有简单类型创建 Java 值类。
更多信息请参阅第 38.3 节 “为简单类型生成 Java 类”。
在 globalBindings 自定义元素中添加 javaType 元素。
这指示代码生成器将 XML Schema 原语类型的所有实例映射到特定的类对象。
更多信息请参阅第 38.2 节 “指定 XML Schema 原语的 Java 类”。
在您要自定义的特定元素中添加 baseType 自定义元素。
通过 baseType 自定义元素，您可以指定生成的 Java 类型来代表属性。为确保简单类型替换的最佳兼容性，请使用 java.lang.Object 作为基本类型。
更多信息请参阅第 38.6 节 “指定元素或属性的 Base Type”。

第 35 章使用复杂类型

摘要

复杂的类型可以包含多个元素，它们可以具有属性。它们映射到 Java 类中，可保存类型定义所代表的数据。通常，映射是包含一组代表元素的属性和内容模型属性的 bean。

35.1. 基本复杂度类型映射

概述

XML Schema 复杂的类型定义构造包含比简单类型更复杂的信息。最简单的复杂类型使用属性定义一个空元素。更复杂的类型由一系列元素组成。

默认情况下，XML Schema 复杂类型映射到 Java 类，其成员变量代表 XML Schema 定义中列出的每个元素和属性。类为每个成员变量设置了 setters 和 getters。

在 XML Schema 中定义

XML Schema 复杂类型使用 complexType 元素进行定义。complexType 元素嵌套了用于定义数据结构的其余元素。它可显示为指定类型定义的父元素，或者作为元素的子元素来匿名定义存储在元素中的信息结构。当使用 complexType 元素来定义指定类型时，它需要使用 name 属性。name 属性指定引用该类型的唯一标识符。

包含一个或多个元素的复杂类型定义具有表 35.1 “在复杂类型中定义如何元素” 中描述的其中一个子元素。这些元素决定了指定的元素在类型的实例中如何。

表 35.1. 在复杂类型中定义如何元素
element	描述
`all`	定义为复杂类型的一部分定义的所有元素都必须显示在类型的实例中。但是，它们可以以任何顺序出现。
`choice`	只有一个元素定义为复杂类型的一部分，才能出现在类型的实例中。
`sequence`	定义为复杂类型的一部分定义的所有元素都必须显示在类型的实例中，它们也必须按照类型定义中指定的顺序出现。

注意

如果复杂的类型定义只使用属性，则不需要表 35.1 “在复杂类型中定义如何元素” 中描述的一个元素。

确定元素的出现方式后，您可以通过向定义中添加一个或多个 元素 子项来定义元素。

例 35.1 “XML Schema complex 类型” 在 XML Schema 中显示复杂的类型定义。

例 35.1. XML Schema complex 类型

<complexType name="sequence">
  <sequence>
    <element name="name" type="xsd:string" />
    <element name="street" type="xsd:short" />
    <element name="city" type="xsd:string" />
    <element name="state" type="xsd:string" />
    <element name="zipCode" type="xsd:string" />
  </sequence>
</complexType>

映射到 Java

XML 架构复杂类型映射到 Java 类。复杂类型定义中的每个元素都映射到 Java 类中的成员变量。getter 和 setter 方法也为复杂类型中的每个元素生成。

所有生成的 Java 类都使用 @XmlType 注释进行解码。如果映射用于复杂类型，则注解名称设置为 complexType 元素的 name 属性的值。如果将复杂类型定义为元素定义的一部分，则 @XmlType 注释的 name 属性的值是 element 元素的 name 属性的值。

注意

如 “带有在线类型的元素的 Java 映射”一节所述，如果为定义为元素定义的复杂类型生成了 @XmlRootElement 注释，生成的类被解码。

为了提供运行时准则，指示应该如何处理 XML Schema 的元素，代码生成器会改变用于分离类及其成员变量的注解。

所有复杂度类型

所有复杂的类型都使用 all 元素来定义。它们按如下方式标注：

@XmlType 注释的 propOrder 属性为空。
每个元素使用 @XmlElement 注释进行解码。

@XmlElement 注释 的必需 属性设置为 true。

例 35.2 “All Complex Type 的映射” 显示所有复杂类型的映射，其中有两个元素。

例 35.2. All Complex Type 的映射

@XmlType(name = "all", propOrder = {

})
public class All {
    @XmlElement(required = true)
    protected BigDecimal amount;
    @XmlElement(required = true)
    protected String type;

    public BigDecimal getAmount() {
        return amount;
    }

    public void setAmount(BigDecimal value) {
        this.amount = value;
    }

    public String getType() {
        return type;
    }

    public void setType(String value) {
        this.type = value;
    }
}

Choice Complex Type

使用选择元素定义 选择 复杂类型。它们按如下方式标注：

@XmlType 注释的 propOrder 属性按照 XML Schema 定义中显示的顺序列出元素的名称。

没有注解成员变量。

例 35.3 “选择复杂度类型的映射” 显示了选择复杂的类型的映射，其中有两个元素。

例 35.3. 选择复杂度类型的映射

@XmlType(name = "choice", propOrder = {
    "address",
    "floater"
})
public class Choice {

    protected Sequence address;
    protected Float floater;

    public Sequence getAddress() {
        return address;
    }

    public void setAddress(Sequence value) {
        this.address = value;
    }

    public Float getFloater() {
        return floater;
    }

    public void setFloater(Float value) {
        this.floater = value;
    }

}

序列复杂度类型

使用序列元素定义 序列 复杂类型。它标明如下：

@XmlType 注释的 propOrder 属性按照 XML Schema 定义中显示的顺序列出元素的名称。
每个元素使用 @XmlElement 注释进行解码。

@XmlElement 注释 的必需 属性设置为 true。

例 35.4 “序列复杂度类型的映射” 显示例 35.1 “XML Schema complex 类型” 中定义的复杂类型的映射。

例 35.4. 序列复杂度类型的映射

@XmlType(name = "sequence", propOrder = {
    "name",
    "street",
    "city",
    "state",
    "zipCode"
})
public class Sequence {

    @XmlElement(required = true)
    protected String name;
    protected short street;
    @XmlElement(required = true)
    protected String city;
    @XmlElement(required = true)
    protected String state;
    @XmlElement(required = true)
    protected String zipCode;

    public String getName() {
        return name;
    }

    public void setName(String value) {
        this.name = value;
    }

    public short getStreet() {
        return street;
    }

    public void setStreet(short value) {
        this.street = value;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String value) {
        this.city = value;
    }

    public String getState() {
        return state;
    }

    public void setState(String value) {
        this.state = value;
    }

    public String getZipCode() {
        return zipCode;
    }

    public void setZipCode(String value) {
        this.zipCode = value;
    }
}

35.2. 属性

概述

Apache CXF 支持在 复杂Type 元素范围内使用 属性元素和属性Group 元素。在为 XML 文档属性声明定义结构时，提供了添加在标签中指定的信息而不是标签包含的值的方法。例如，在 XML Schema 中描述 XML 元素 <value currency ="euro">410<\value> 时，使用例 35.5 “XML Schema 重新定义和属性” 所示 的属性 元素描述。

attributeGroup 元素允许您定义一组可重复使用的属性，这些属性可以被 schema 定义的所有复杂类型引用。例如，如果您定义了一系列使用属性类别和 pubDate 的元素，您可以使用这些属性来定义属性组，并在所有使用该属性的元素中引用它们。这显示在例 35.7 “属性组定义” 中。

在描述开发应用逻辑中使用的数据类型时，使用 属性的属性设置为 可选 或 必需 属性被视为结构的元素。对于复杂类型描述中包含的每个属性声明，会在类中生成一个元素，以及适当的 getter 和 setter 方法。

在 XML Schema 中定义属性

XML Schema 属性 元素具有一个必需属性名称，用于标识该属性。它还有四个可选属性，如表 35.2 “用于定义 XML Schema 中的属性” 所述。

表 35.2. 用于定义 XML Schema 中的属性
属性	描述
`use`	指定是否需要该属性。有效值 `是必需的`、`可选` 或禁止。`Optional` 是默认值。
`type`	指定属性可取的值类型。如果未使用属性的模式类型，则必须在命令行中定义。
`default`	指定要用于属性的默认值。仅在 `属性` 元素的 `use` 属性设为 `可选` 时使用。
`FIXED`	指定用于属性的固定值。仅在 `属性` 元素的 `use` 属性设为 `可选` 时使用。

例 35.5 “XML Schema 重新定义和属性” 显示属性元素，定义属性货币，其值是一个字符串。

例 35.5. XML Schema 重新定义和属性

<element name="value">
  <complexType>
    <xsd:simpleContent>
      <xsd:extension base="xsd:integer">
        <xsd:attribute name="currency" type="xsd:string"
                       use="required"/>
      </xsd:extension>
    </xsd:simpleContent>
  </xsd:complexType>
</xsd:element>

如果属性元素省略了 type 属性，则必须描述数据的格式。例 35.6 “带有在线数据描述的属性” 显示属性、类别 的属性 元素，其可取值 自动、非 虚构 或虚假。

例 35.6. 带有在线数据描述的属性

<attribute name="category" use="required">
  <simpleType>
    <restriction base="xsd:string">
      <enumeration value="autobiography"/>
      <enumeration value="non-fiction"/>
      <enumeration value="fiction"/>
    </restriction>
  </simpleType>
</attribute>

在 XML Schema 中使用属性组

在复杂类型定义中使用属性组分为两个步骤：

定义属性组。
属性组通过使用 attribute Group 元素及多个属性子元素来定义。attributeGroup 需要一个 name 属性，用于定义用于引用属性组的字符串。属性 元素定义属性组的成员，并以 “在 XML Schema 中定义属性”一节的形式指定。例 35.7 “属性组定义” 显示属性组 catalogIndecies 的描述。属性组有两个成员： 类别，是可选的，以及 pubDate，这是所需的。
例 35.7. 属性组定义
```
<attributeGroup name="catalogIndices">
  <attribute name="category" type="catagoryType" />
  <attribute name="pubDate" type="dateTime"
             use="required" />
</attributeGroup>
```
在复杂类型的定义中使用属性组。
您可以使用带有 ref 属性的 attributeGroup 元素，在复杂类型定义中使用属性组。ref 属性的值是授予您想要用作类型定义一部分的属性组群的名称。例如，如果要使用复杂类型 dvdType 中的属性组 catalogIndecies，您可以使用 <attributeGroup ref="catalogIndecies" />。例 35.8 “带有属性组的复杂类型”
例 35.8. 带有属性组的复杂类型
```
<complexType name="dvdType">
  <sequence>
    <element name="title" type="xsd:string" />
    <element name="director" type="xsd:string" />
    <element name="numCopies" type="xsd:int" />
  </sequence>
  <attributeGroup ref="catalogIndices" />
</complexType>
```

将属性映射到 Java

属性与成员元素映射到 Java 的方式完全映射到 Java。所需的属性和可选属性映射到生成的 Java 类的成员变量。成员变量通过 @XmlAttribute 注释进行解码。如果需要属性，则 @XmlAttribute 注释 的必需 属性设为 true。

例 35.9 “techDoc Description” 中定义的复杂类型映射到例 35.10 “techDoc Java Class” 中显示的 Java 类。

例 35.9. techDoc Description

<complexType name="techDoc">
  <all>
    <element name="product" type="xsd:string" />
    <element name="version" type="xsd:short" />
  </all>
  <attribute name="usefullness" type="xsd:float"
             use="optional" default="0.01" />
</complexType>

例 35.10. techDoc Java Class

@XmlType(name = "techDoc", propOrder = {

})
public class TechDoc {

    @XmlElement(required = true)
    protected String product;
    protected short version;
    @XmlAttribute protected Float usefullness;

    public String getProduct() {
        return product;
    }

    public void setProduct(String value) {
        this.product = value;
    }

    public short getVersion() {
        return version;
    }

    public void setVersion(short value) {
        this.version = value;
    }

    public float getUsefullness() { if (usefullness == null) { return 0.01F; } else { return usefullness; } }

    public void setUsefullness(Float value) {
        this.usefullness = value;
    }
}

如例 35.10 “techDoc Java Class” 所示，default 属性和 fixed 属性指示代码生成器将代码添加到为属性生成的 getter 方法中。这个附加代码可确保如果没有设置值，则会返回指定的值。

重要

fixed 属性的处理方式与 default 属性相同。如果您希望 固定 属性被视为 Java 持续，您可以使用第 38.5 节 “自定义修复的值属性映射” 中描述的自定义。

将属性组映射到 Java

属性组映射到 Java，就如类型定义中明确使用组的成员一样。如果属性组有三个成员，且在复杂的类型中使用，该类型的生成的类将包含 member 变量，以及 getter 和 setter 方法，用于属性组的每个成员。例如，例 35.8 “带有属性组的复杂类型” 中定义的复杂类型，Apache CXF 生成包含成员变量类别和 pubDate 的类，以支持属性组成员，如例 35.11 “dvdType Java Class” 所示。

例 35.11. dvdType Java Class

@XmlType(name = "dvdType", propOrder = {
    "title",
    "director",
    "numCopies"
})
public class DvdType {

    @XmlElement(required = true)
    protected String title;
    @XmlElement(required = true)
    protected String director;
    protected int numCopies;
    @XmlAttribute protected CatagoryType category; @XmlAttribute(required = true) @XmlSchemaType(name = "dateTime") protected XMLGregorianCalendar pubDate;

    public String getTitle() {
        return title;
    }

    public void setTitle(String value) {
        this.title = value;
    }

    public String getDirector() {
        return director;
    }

    public void setDirector(String value) {
        this.director = value;
    }

    public int getNumCopies() {
        return numCopies;
    }

    public void setNumCopies(int value) {
        this.numCopies = value;
    }

    public CatagoryType getCatagory() {
        return catagory;
    }

    public void setCatagory(CatagoryType value) {
        this.catagory = value;
    }

    public XMLGregorianCalendar getPubDate() {
        return pubDate;
    }

    public void setPubDate(XMLGregorianCalendar value) {
        this.pubDate = value;
    }

}

35.3. 从简单类型中解除复杂类型

概述

Apache CXF 支持从简单类型分离复杂类型。一个简单的类型具有定义，既不是子元素或属性。因此，从简单类型推断复杂类型的主要原因之一是将属性添加到简单类型。

从简单类型划分复杂类型的方法有两种：

按扩展
按限制

通过扩展来激活

例 35.12 “通过 Extension 从简单类型中解除 complex 类型” 显示根据 xsd:decimal primitive 类型（包括货币属性）的扩展提供的复杂类型 internationalPrice 的示例。

例 35.12. 通过 Extension 从简单类型中解除 complex 类型

<complexType name="internationalPrice">
    <simpleContent>
        <extension base="xsd:decimal">
            <attribute name="currency" type="xsd:string"/>
        </extension>
    </simpleContent>
    </complexType>

simpleContent 元素表示新类型不包含任何子元素。extension 元素指定新类型扩展了 xsd:decimal。

按限制设置

例 35.13 “根据限制从简单类型中解除 complex 类型” 显示一个复杂类型 idType 的示例，它按 xsd:string 中的限制衍生。定义的类型将 xsd:string的可能值限制为长度为 10 个字符的值。它还向类型添加一个属性。

例 35.13. 根据限制从简单类型中解除 complex 类型

<complexType name="idType">
  <simpleContent>
    <restriction base="xsd:string">
     <length value="10" />
     <attribute name="expires" type="xsd:dateTime" />
    </restriction>
  </simpleContent>
</complexType>

在例 35.12 “通过 Extension 从简单类型中解除 complex 类型” 中，与 简单内容 元素信号一样，新类型不包含任何子项。本例使用 restricted 元素 来限制新类型中使用的可能值。属性 元素将元素添加到新类型。

映射到 Java

派生自简单类型的复杂类型映射到使用 @XmlType 注释分离的 Java 类。生成的类包含成员变量，即从中派生复杂类型的简单类型。member 变量通过 @XmlValue 注释进行解码。该类还具有 getValue （） 方法和 setValue （） 方法。另外，生成的类具有成员变量，以及关联的 getter 和 setter 方法，用于扩展简单类型的每个属性。

例 35.14 “idType Java Class” 显示为例 35.13 “根据限制从简单类型中解除 complex 类型” 中定义的 idType 类型生成的 Java 类。

例 35.14. idType Java Class

@XmlType(name = "idType", propOrder = {
    "value"
})
public class IdType {

    @XmlValue
    protected String value;
    @XmlAttribute
    @XmlSchemaType(name = "dateTime")
    protected XMLGregorianCalendar expires;

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    public XMLGregorianCalendar getExpires() {
        return expires;
    }

    public void setExpires(XMLGregorianCalendar value) {
        this.expires = value;
    }

}

35.4. 从复杂类型推断复杂类型

概述

使用 XML Schema 时，您可以通过使用 complexContent 元素扩展或限制其他复杂类型来产生新的复杂类型。在生成 Java 类来表示派生的复杂类型时，Apache CXF 扩展基本类型类。这样，生成的 Java 代码会保留 XML Schema 中预期的继承层次结构。

模式语法

您可以使用 复杂的Content 元素以及 extension 元素或限制元素，从其他复杂类型衍生复杂类型。complexContent 元素指定包含的数据描述包含多个字段。extension 元素和 restricted 元素（即 复杂Content 元素的子元素）指定被修改的基本类型，以创建新类型。基础类型由 base 属性指定。

扩展复杂类型

要扩展复杂类型，请使用 extension 元素来定义组成新类型的附加元素和属性。在复杂类型描述中允许的所有元素都作为新类型定义的一部分是允许的。例如，您可以在新类型中添加匿名枚举，或者 您可以使用 choice 元素指定一次只能使用其中一个新字段。

例 35.15 “通过扩展来划分复杂度类型” 显示 XML Schema 片段，它定义了两个复杂的类型，即 widgetOrderInfo 和 widgetOrderBillInfo。widgetOrderBillInfo 通过扩展 widgetOrderInfo 来包括两个新元素： orderNumber 和 amtDue。

例 35.15. 通过扩展来划分复杂度类型

<complexType name="widgetOrderInfo">
  <sequence>
    <element name="amount" type="xsd:int"/>
    <element name="order_date" type="xsd:dateTime"/>
    <element name="type" type="xsd1:widgetSize"/>
    <element name="shippingAddress" type="xsd1:Address"/>
  </sequence>
  <attribute name="rush" type="xsd:boolean" use="optional" />
</complexType>
<complexType name="widgetOrderBillInfo">
  <complexContent>
    <extension base="xsd1:widgetOrderInfo">
      <sequence>
        <element name="amtDue" type="xsd:decimal"/>
        <element name="orderNumber" type="xsd:string"/>
      </sequence>
      <attribute name="paid" type="xsd:boolean"
                 default="false" />
    </extension>
  </complexContent>
</complexType>

限制复杂类型

若要限制复杂类型，可使用 limit 元素来限制基本类型的元素或属性的可能值。在限制复杂类型时，您必须列出基本类型的所有元素和属性。对于每个元素，您可以在定义中添加限制性属性。例如，您可以将 maxOccurs 属性添加到元素中，以限制其可以发生的次数。您还可以使用 fixed 属性来强制一个或多个元素具有预先确定的值。

例 35.16 “根据限制定义紧急类型” 显示通过限制其他复杂类型来定义复杂类型的示例。受限类型 wallawallaAddress 只能用于 Walla Walla、Washington 中的地址，因为 城市 元素的值、州 元素和 zipCode 元素被修复。

例 35.16. 根据限制定义紧急类型

<complexType name="Address">
  <sequence>
    <element name="name" type="xsd:string"/>
    <element name="street" type="xsd:short" maxOccurs="3"/>
    <element name="city" type="xsd:string"/>
    <element name="state" type="xsd:string"/>
    <element name="zipCode" type="xsd:string"/>
  </sequence>
</complexType>
<complexType name="wallawallaAddress">
  <complexContent>
    <restriction base="xsd1:Address">
      <sequence>
        <element name="name" type="xsd:string"/>
        <element name="street" type="xsd:short"
                 maxOccurs="3"/>
        <element name="city" type="xsd:string"
                 fixed="WallaWalla"/>
        <element name="state" type="xsd:string"
                 fixed="WA" />
        <element name="zipCode" type="xsd:string"
                 fixed="99362" />
      </sequence>
    </restriction>
  </complexContent>
</complexType>

映射到 Java

与所有复杂的类型一样，Apache CXF 生成类来代表来自另一个复杂类型的复杂类型。为派生复杂类型生成的 Java 类扩展了生成的 Java 类来支持基础复杂类型。基本 Java 类也被修改为包含 @XmlSeeAlso 注释。基本类的 @XmlSeeAlso 注释列出了扩展基本类的所有类。

当根据扩展名派生了新的复杂类型时，生成的类将包含所有添加元素和属性的成员变量。新成员变量将根据与所有其他元素相同的映射生成。

当根据限制派生了新的复杂类型时，生成的类将没有新的成员变量。生成的类只是一个不提供任何额外功能的 shell。完全允许您确保强制使用 XML Schema 中定义的限制。

例如，例 35.15 “通过扩展来划分复杂度类型” 中的架构生成两个 Java 类的生成： WidgetOrderInfo 和 WidgetBillOrderInfo。WidgetOrderBillInfo 扩展 WidgetOrderInfo，因为 widgetOrderBillInfo 由 widgetOrderInfo 进行扩展。例 35.17 “WidgetOrderBillInfo” 显示为 widgetOrderBillInfo 生成的类。

例 35.17. WidgetOrderBillInfo

@XmlType(name = "widgetOrderBillInfo", propOrder = {
    "amtDue",
    "orderNumber"
})
public class WidgetOrderBillInfo
    extends WidgetOrderInfo
{
    @XmlElement(required = true)
    protected BigDecimal amtDue;
    @XmlElement(required = true)
    protected String orderNumber;
    @XmlAttribute
    protected Boolean paid;

    public BigDecimal getAmtDue() {
        return amtDue;
    }

    public void setAmtDue(BigDecimal value) {
        this.amtDue = value;
    }

    public String getOrderNumber() {
        return orderNumber;
    }

    public void setOrderNumber(String value) {
        this.orderNumber = value;
    }

    public boolean isPaid() {
        if (paid == null) {
            return false;
        } else {
            return paid;
        }
    }

    public void setPaid(Boolean value) {
        this.paid = value;
    }
}

35.5. 发生限制

35.5.1. 支持 Occurrence 限制的 schema 元素

通过 XML Schema，您可以在组成复杂类型定义的四个 XML Schema 元素上指定出现的限制：

第 35.5.2 节 “All 元素的出现限制”
第 35.5.3 节 “Choice 元素的出现限制”
第 35.5.4 节 “元素的出现限制”
第 35.5.5 节 “根据序列的出现限制”

35.5.2. All 元素的出现限制

XML Schema

使用 all 元素定义的复杂类型不允许对所有元素定义的多个结构进行多次。但是，您可以通过将 minOccurs 属性设置为 0 来使所有元素可选定义的结构。

映射到 Java

将 all 元素的 minOccurs 属性设置为 0 对生成的 Java 类没有影响。

35.5.3. Choice 元素的出现限制

概述

默认情况下，选择 元素的结果只能出现在复杂类型的实例中。您可以使用 minOccurs 属性及其 mxOccurs 属性更改元素所定义的结构的次数。您可以使用这些属性，指定所选类型可能为零到复杂类型的实例中无限次。为选择类型选择的元素对于每种类型来说都不需要相同。

在 XML Schema 中使用

minOccurs 属性指定必须出现所选类型的最小次数。其值可以是任意正整数。将 minOccurs 属性设置为 0 指定，可选择类型不需要在复杂类型的实例中出现。

maxOccurs 属性指定可选择类型可显示的最大次数。其值可以是任意非零、正整数或未绑定的。将 maxOccurs 属性设置为 unbounded 时，指定所选类型可能会显示无限次。

例 35.18 “Choice Occurrence Constraints” 显示选择类型 ClubEvent 的定义，其中选择出现的限制。整个选择类型可以重复 0 到未绑定时间。

例 35.18. Choice Occurrence Constraints

<complexType name="ClubEvent">
  <choice minOccurs="0" maxOccurs="unbounded">
    <element name="MemberName" type="xsd:string"/>
    <element name="GuestName" type="xsd:string"/>
  </choice>
</complexType>

映射到 Java

与单个实例选择结构不同，XML Schema 选择结构可以多次通过单个成员变量映射到 Java 类。这个单一成员变量是一个 List<T > 对象，它保存多个顺序发生的所有数据。例如，如果例 35.18 “Choice Occurrence Constraints” 中定义的序列发生两次，则列表将有两个项目。

Java 类的成员变量的名称通过串联 member 元素的名称来派生。元素名称由 Or 分隔，变量名称的第一个字母转换为小写。例如，从例 35.18 “Choice Occurrence Constraints” 生成的成员变量将命名为 memberNameOrGuestName。

存储在列表中的对象类型取决于成员元素的类型。例如：

如果成员元素是相同类型，生成的列表将包含 JAXBElement<T> 对象。JAXBElement<T&gt; 对象的基础类型由 member 元素类型的普通映射决定。
如果成员元素是不同类型的，且其 Java 表示实施了通用接口，则列表将包含常见接口的对象。
如果成员元素是不同类型的，其 Java 表示扩展通用基本类，则列表将包含常见基本类的对象。
如果没有满足其他条件，该列表将包含对象 对象。

生成的 Java 类将仅具有 member 变量的 getter 方法。getter 方法返回对 live 列表的引用。对返回列表所做的任何修改都将对实际对象产生影响。

Java 类使用 @XmlType 注释进行解码。注解的 name 属性设置为 XML Schema 定义中 parent 元素的 name 属性的值。该注解的 propOrder 属性包含代表序列中元素的单个成员变量。

代表所选结构中元素的 member 变量通过 @XmlElements 注释进行解码。@XmlElements 注释包含以逗号分隔的 @XmlElement 注释列表。列表有一个 @XmlElement 注释，适用于类型 XML Schema 定义中定义的每个 member 元素。列表中 @XmlElement 注解的 name 属性设为 XML Schema 元素 元素的 name 属性的值，以及它们的 type 属性设为由 XML Schema 元素类型映射生成的 Java 类。

例 35.19 “使用 Occurrence Constraint 的选择结构的 Java 代表” 显示例 35.18 “Choice Occurrence Constraints” 中定义的 XML Schema 选择结构的 Java 映射。

例 35.19. 使用 Occurrence Constraint 的选择结构的 Java 代表

@XmlType(name = "ClubEvent", propOrder = {
    "memberNameOrGuestName"
})
public class ClubEvent {

    @XmlElementRefs({
        @XmlElementRef(name = "GuestName", type = JAXBElement.class),
        @XmlElementRef(name = "MemberName", type = JAXBElement.class)
    })
    protected List<JAXBElement<String>> memberNameOrGuestName;

    public List<JAXBElement<String>> getMemberNameOrGuestName() {
        if (memberNameOrGuestName == null) {
            memberNameOrGuestName = new ArrayList<JAXBElement<String>>();
        }
        return this.memberNameOrGuestName;
    }

}

minOccurs 设为 0

如果只指定 minOccurs 元素，其值为 0， 则代码生成器会生成 Java 类，就像未设置 minOccurs 属性一样。

35.5.4. 元素的出现限制

概述

您可以使用 element 元素的 minOccurs 属性和 maxOccurs 属性来指定复杂类型的特定元素的次数。这两个属性的默认值都是 1。

minOccurs 设为 0

当您将某个复杂类型的 member 元素的 minOccurs 属性设置为 0 时，则 @XmlElement 注释将改变。不必将其 必需 属性设置为 true，而是将 @XmlElement 注释 的必需 属性设为 false。

minOccurs 设置为一个大于 1 的值

在 XML Schema 中，您可以通过将 element 元素的 minOccurs 属性设置为大于一的值来指定元素必须在类型的实例中发生多次。但是，生成的 Java 类将不支持 XML Schema 约束。Apache CXF 生成支持 Java 成员变量，就像未设置 minOccurs 属性一样。

带有 maxOccurs 设置的元素

当希望 member 元素在复杂类型的实例中显示多次时，您可以将元素的 maxOccurs 属性设置为大于 1 的值。您可以将 maxOccurs 属性的值设置为 未绑定，以指定 member 元素可以出现无限次数。

代码生成器映射一个 maxOccurs 属性设置为值大于 1 到 List<T > 对象的 Java 成员变量的成员元素。列表的基础类通过将元素的类型映射到 Java 来确定。对于 XML Schema 原语类型，打包程序类使用，如 “打包程序类”一节所述。例如，如果 member 元素类型为 xsd:int，则生成的 member 变量是 List<Integer> 对象。

35.5.5. 根据序列的出现限制

概述

默认情况下，序列 元素的内容只能在复杂类型的实例中出现一次。您可以使用 minOccurs 属性及其 maxOccurs 属性来更改 序列 元素定义的元素序列的次数。您可以使用这些属性，可以指定序列类型在复杂类型的实例中可以为零到无限次数。

使用 XML Schema

minOccurs 属性指定在定义的复杂类型的实例中必须进行序列的最小次数。其值可以是任意正整数。将 minOccurs 属性设置为 0 指定序列不需要出现在复杂类型的实例中。

maxOccurs 属性指定在定义的复杂类型的实例中可以进行序列的上限。其值可以是任意非零、正整数或未绑定的。将 maxOccurs 属性设置为 unbounded 指定序列可能会显示无限次。

例 35.20 “使用 Occurrence 限制序列” 显示序列类型 CultureInfo 的定义，以及顺序出现的限制。序列可以重复 0 到 2 次。

例 35.20. 使用 Occurrence 限制序列

<complexType name="CultureInfo">
  <sequence minOccurs="0" maxOccurs="2">
    <element name="Name" type="string"/>
    <element name="Lcid" type="int"/>
  </sequence>
</complexType>

映射到 Java

与单个实例序列不同，XML Schema 序列可以使用单个成员变量映射到 Java 类。这个单一成员变量是一个 List<T > 对象，它保存多个顺序发生的所有数据。例如，如果例 35.20 “使用 Occurrence 限制序列” 中定义的序列发生两次，则列表会有四个项目。

Java 类的成员变量的名称通过串联 member 元素的名称来派生。元素名称由 和 分隔，变量名称的第一个字母转换为小写。例如，从例 35.20 “使用 Occurrence 限制序列” 生成的成员变量名为 nameAndLcid。

存储在列表中的对象类型取决于成员元素的类型。例如：

如果成员元素是相同类型，生成的列表将包含 JAXBElement<T> 对象。JAXBElement<T&gt; 对象的基础类型由 member 元素类型的普通映射决定。
如果成员元素是不同类型的，且其 Java 表示实施了通用接口，则列表将包含常见接口的对象。
如果成员元素是不同类型的，其 Java 表示扩展通用基本类，则列表将包含常见基本类的对象。
如果没有满足其他条件，该列表将包含对象 对象。

生成的 Java 类仅具有 member 变量的 getter 方法。getter 方法返回对 live 列表的引用。对返回列表所做的任何修改对实际对象的影响。

代表序列中元素的 member 变量通过 @XmlElements 注释进行解码。@XmlElements 注释包含以逗号分隔的 @XmlElement 注释列表。列表有一个 @XmlElement 注释，适用于类型 XML Schema 定义中定义的每个 member 元素。列表中 @XmlElement 注解的 name 属性设为 XML Schema 元素 元素的 name 属性的值，以及它们的 type 属性设为由 XML Schema 元素类型映射生成的 Java 类。

例 35.21 “Java 代表带有 Occurrence Constraint 的序列” 显示例 35.20 “使用 Occurrence 限制序列” 中定义的 XML Schema 序列的 Java 映射。

例 35.21. Java 代表带有 Occurrence Constraint 的序列

@XmlType(name = "CultureInfo", propOrder = {
    "nameAndLcid"
})
public class CultureInfo {

    @XmlElements({
        @XmlElement(name = "Name", type = String.class),
        @XmlElement(name = "Lcid", type = Integer.class)
    })
    protected List<Serializable> nameAndLcid;

    public List<Serializable> getNameAndLcid() {
        if (nameAndLcid == null) {
            nameAndLcid = new ArrayList<Serializable>();
        }
        return this.nameAndLcid;
    }

}

minOccurs 设为 0

如果只指定 minOccurs 元素，其值为 0， 则代码生成器会生成 Java 类，就像未设置 minOccurs 属性一样。

35.6. 使用模型组

概述

XML Schema 模型组是方便的快捷方式，您可以引用用户定义的复杂类型中的元素组。例如，您可以定义一组在应用程序中常见的元素，然后重复引用该组。模型组使用 group 元素定义，与复杂的类型定义类似。模型组到 Java 的映射也与复杂类型的映射类似。

在 XML Schema 中定义模型组

您可以使用 name 属性的 group 元素在 XML Schema 中定义模型组。name 属性的值是一个字符串，用于在 schema 中引用组。group 元素与 complexType 元素类似，可以将 sequence 元素、all 元素或 choice 元素作为即时子项。

在子元素内，您可以使用 元素元素 定义组的成员。对于组的每个成员，指定一个 元素。组成员可以使用 element 元素 的任何标准属性，包括 minOccurs 和 maxOccurs。因此，如果您的组有三个元素，其中之一可能会出现三次，您定义一个具有三个 元素 的组，其中之一使用 maxOccurs="3"。例 35.22 “XML Schema 模型组” 显示具有三个元素的模型组。

例 35.22. XML Schema 模型组

<group name="passenger">
  <sequence>
    <element name="name" type="xsd:string" />
    <element name="clubNum" type="xsd:long" />
    <element name="seatPref" type="xsd:string"
             maxOccurs="3" />
  </sequence>
</group>

在类型定义中使用模型组

旦定义了模型组，就可以将其用作复杂类型定义的一部分。要在复杂类型定义中使用模型组，可将 group 元素与 ref 属性搭配使用。ref 属性的值是提供给组在定义时的名称。例如，使用例 35.22 “XML Schema 模型组” 中定义的组，如 {ref="tns:passenger" > 所示。例 35.23 “带有模型组的复杂类型”

例 35.23. 带有模型组的复杂类型

<complexType name="reservation">
  <sequence>
    <group ref="tns:passenger" />
    <element name="origin" type="xsd:string" />
    <element name="destination" type="xsd:string" />
    <element name="fltNum" type="xsd:long" />
  </sequence>
</complexType>

当模型组在类型定义中使用时，该组成为类型的成员。因此，保留 实例有四个成员元素。第一个元素是 乘客 元素，它包含由例 35.22 “XML Schema 模型组” 中显示的组定义的成员元素。例 35.24 “带有 Model Group 的 Type 实例” 中显示了一个 保留 实例示例。

例 35.24. 带有 Model Group 的 Type 实例

<reservation>
  <passenger> <name>A. Smart</name> <clubNum>99</clubNum> <seatPref>isle1</seatPref> </passenger>
  <origin>LAX</origin>
  <destination>FRA</destination>
  <fltNum>34567</fltNum>
</reservation>

映射到 Java

默认情况下，当模型组包含在复杂类型定义中时，模型组只映射到 Java 工件。在为包含模型组的复杂类型生成代码时，Apache CXF 只需要将模型组的成员变量包含在为类型生成的 Java 类中。代表模型组的成员变量会根据模型组的定义进行标注。

例 35.25 “使用组的类型” 显示为例 35.23 “带有模型组的复杂类型” 中定义的复杂类型生成的 Java 类。

例 35.25. 使用组的类型

@XmlType(name = "reservation", propOrder = {
    "name",
    "clubNum",
    "seatPref",
    "origin",
    "destination",
    "fltNum"
})
public class Reservation {

    @XmlElement(required = true)
    protected String name;
    protected long clubNum;
    @XmlElement(required = true)
    protected List<String> seatPref;
    @XmlElement(required = true)
    protected String origin;
    @XmlElement(required = true)
    protected String destination;
    protected long fltNum;

    public String getName() {
        return name;
    }

    public void setName(String value) {
        this.name = value;
    }

    public long getClubNum() {
        return clubNum;
    }

    public void setClubNum(long value) {
        this.clubNum = value;
    }

    public List<String> getSeatPref() {
        if (seatPref == null) {
            seatPref = new ArrayList<String>();
        }
        return this.seatPref;
    }

    public String getOrigin() {
        return origin;
    }

    public void setOrigin(String value) {
        this.origin = value;
    }

    public String getDestination() {
        return destination;
    }

    public void setDestination(String value) {
        this.destination = value;
    }

    public long getFltNum() {
        return fltNum;
    }

    public void setFltNum(long value) {
        this.fltNum = value;
    }

多个发生次数

您可以通过将 group 元素的 maxOccurs 属性设为大于一的值来指定模型 组 显示为一次。要允许多个出现模型组 Apache CXF 将模型组映射到 List<T> 对象。List<T > 对象按照组第一个子的规则生成：

如果组是使用 序列 元素定义的，请参阅第 35.5.5 节 “根据序列的出现限制”。
如果组是使用 选择 元素定义的，请参阅第 35.5.3 节 “Choice 元素的出现限制”。

第 36 章使用 Wild 卡类型

摘要

当架构作者希望防御元素或属性到定义的类型时，会存在实例。对于这些情况，XML Schema 为指定通配符位置拥有者提供了三种机制。它们都以保留其 XML Schema 功能的方式映射到 Java。

36.1. 使用 Any Elements

概述

XML Schema 任何 元素用于在复杂类型定义中创建通配符位置拥有者。当 XML 元素实例化为 XML Schema any 元素时，它可以是任何有效的 XML 元素。any 元素不对内容或实例化 XML 元素的名称施加任何限制。

例如，给定例 36.1 “使用 Any Element 定义的 XML Schema 类型” 中定义的复杂类型，您可以实例化例 36.2 “带有任何元素的 XML 文档” 中显示的任一 XML 元素。

例 36.1. 使用 Any Element 定义的 XML Schema 类型

<element name="FlyBoy">
  <complexType>
    <sequence>
      <any />
      <element name="rank" type="xsd:int" />
    </sequence>
  </complexType>
</element>

例 36.2. 带有任何元素的 XML 文档

<FlyBoy>
  <learJet>CL-215</learJet>
  <rank>2</rank>
</element>
<FlyBoy>
  <viper>Mark II</viper>
  <rank>1</rank>
</element>

XML Schema 任何 元素都映射到 Java 对象对象或 Java org.w3c.dom.Element 对象。

在 XML Schema 中指定

定义复杂类型和选择复杂类型时，可以使用任何 元素。在大多数情况下，任何 元素都是空的元素。不过，它可以 将注解 元素作为子项。

表 36.1 “XML Schema Any Element 的属性” 描述 任何 元素的属性。

表 36.1. XML Schema Any Element 的属性
属性	描述
`namespace`	指定可用于实例化 XML 文档中的元素的命名空间。有效值为： `##any` 指定可以使用任何命名空间中的元素。这是默认值。 `##other` 指定父元素命名空间以外的任何命名空间中的元素。 `##local` 必须使用没有命名空间的元素。 `##targetNamespace` 指定必须使用父元素命名空间中的元素。空格分隔的 URI `#\#local` 和 `\#\#targetNamespace` 指定可以使用列出的任何命名空间中的元素。
`maxOccurs`	指定元素中可显示的最大次数。默认值为：`1`。要指定元素的实例可以显示无限次数，您可以将属性的值设置为 `未绑定`。
`minOccurs`	指定父元素中可显示元素实例的最小次数。默认值为：`1`。
`processContents`	指定用于实例化任何元素的元素的方式。有效值为： `strict` 指定元素必须根据正确的模式进行验证。这是默认值。 `lax` 指定该元素是否应该根据正确的模式进行验证。如果无法验证，则不会抛出任何错误。 `skip` 指定不应验证这个元素。

例 36.3 “使用 Any 元素定义的复杂类型” 显示 使用任何 元素定义的复杂类型

例 36.3. 使用 Any 元素定义的复杂类型

<complexType name="surprisePackage">
  <sequence>
    <any processContents="lax" />
    <element name="to" type="xsd:string" />
    <element name="from" type="xsd:string" />
  </sequence>
</complexType>

映射到 Java

XML Schema 任何 元素都会导致创建名为 任何 的 Java 属性。属性关联了 getter 和 setter 方法。生成的属性的类型取决于元素的 processContents 属性的值。如果 将任何 元素的 processContents 属性设置为 skip，则该元素将映射到 org.w3c.dom.Element 对象。对于 processContents 属性的所有其他值，任何 元素都映射到 Java 对象对象。

生成的属性使用 @XmlAnyElement 注释进行解码。此注解具有一个可选 lax 属性，用于指示运行时在分离数据时要做什么。它的默认值是 false，它指示运行时自动将数据分到 org.w3c.dom.Element 对象。将 lax 设为 true 会指示运行时尝试将数据分到 JAXB 类型中。当任何 元素的 processContents 属性设置为 skip 时，lax 属性设为默认值。对于 processContents 属性的所有其他值，lax 设置为 true。

例 36.4 “带有任何元素的 Java 类” 显示例 36.3 “使用 Any 元素定义的复杂类型” 中定义的复杂类型如何映射到 Java 类。

例 36.4. 带有任何元素的 Java 类

public class SurprisePackage {

    @XmlAnyElement(lax = true) protected Object any;
    @XmlElement(required = true)
    protected String to;
    @XmlElement(required = true)
    protected String from;

    public Object getAny() { return any; }

    public void setAny(Object value) { this.any = value; }

    public String getTo() {
        return to;
    }

    public void setTo(String value) {
        this.to = value;
    }

    public String getFrom() {
        return from;
    }

    public void setFrom(String value) {
        this.from = value;
    }

}

marshalling

如果任何 元素的 Java 属性将其 lax 设为 false，或者未指定属性，则运行时不会尝试将 XML 数据解析为 JAXB 对象。数据始终存储在 DOM Element 对象中。

如果任何 元素的 Java 属性将其 lax 设为 true，则运行时会尝试将 XML 数据分到适当的 JAXB 对象中。运行时尝试使用以下步骤识别正确的 JAXB 类：

它将根据已知运行时的元素列表检查 XML 元素的元素标签。如果找到匹配项，则运行时会将 XML 数据整理到元素的正确 JAXB 类中。
它将检查 XML 元素的 xsi:type 属性。如果找到匹配项，则运行时会将 XML 元素派生到该类型的正确的 JAXB 类中。
如果无法找到匹配项，它将 XML 数据整理到 DOM Element 对象中。

应用程序运行时通常知道从该架构生成的所有类型的信息。这包括合同 wsdl:types 元素中定义的类型，通过导入其他模式而将任何数据类型添加到合同中，以及添加到合同的任何类型。您还可以使用第 32.4 节 “在 Runtime Marshaller 中添加类” 中描述的 @XmlSeeAlso 注解使运行时了解额外的类型。

unmarshalling

如果任何 元素的 Java 属性将其 lax 设为 false，或者未指定属性，则运行时将仅接受 DOM Element 对象。尝试使用任何其他类型的对象将导致 marshalling 错误。

如果任何 元素的 Java 属性将其 lax 设为 true，则运行时在 Java 数据类型和 XML Schema 结构之间使用其内部映射，以确定要写入到有线的 XML 结构。如果运行时知道类，并可将其映射到 XML Schema 结构，它会写入数据并插入 xsi:type 属性来识别元素所包含的数据类型。

如果运行时无法将 Java 对象映射到已知的 XML Schema 结构，它将抛出异常。您可以使用第 32.4 节 “在 Runtime Marshaller 中添加类” 中描述的 @XmlSeeAlso 注解在运行时映射中添加类型。

36.2. 使用 XML Schema anyType 类型

概述

XML Schema 类型 xsd:anyType 是所有 XML Schema 类型的根类型。所有原语都是此类的衍生版本，因为所有用户都定义了复杂的类型。因此，定义为 xsd:anyType 都可以以任何 XML Schema 原语以及 schema 文档中定义的任何复杂类型的形式包含数据。

在 Java 中，最匹配的类型是 对象 类。它是所有其他 Java 类的分类为子类型的类。

在 XML Schema 中使用

您可以使用 xsd:anyType 类型，如任何其他 XML Schema 复杂类型。它可以用作 元素类型 元素 的值。它还可用作定义其他类型的基础类型。

例 36.5 “使用 Wild Card Element 的复杂类型” 显示包含类型为 xsd:anyType 的元素的复杂类型示例。

例 36.5. 使用 Wild Card Element 的复杂类型

<complexType name="wildStar">
  <sequence>
    <element name="name" type="xsd:string" />
    <element name="ship" type="xsd:anyType" />
  </sequence>
</complexType>

映射到 Java

类型为 xsd:anyType 的元素映射到对象 对象。例 36.6 “Java 代表 Wild 卡元素” 显示例 36.5 “使用 Wild Card Element 的复杂类型” 到 Java 类的映射。

例 36.6. Java 代表 Wild 卡元素

public class WildStar {

    @XmlElement(required = true)
    protected String name;
    @XmlElement(required = true) protected Object ship;

    public String getName() {
        return name;
    }

    public void setName(String value) {
        this.name = value;
    }

    public Object getShip() { return ship; }

    public void setShip(Object value) { this.ship = value; }
}

通过此映射，您可以将任何数据放在代表通配符元素的属性中。Apache CXF 运行时处理数据的汇总和解压缩到可用 Java 表示中。

marshalling

当 Apache CXF marshals XML 数据编入 Java 类型时，它会尝试 将任何Type 元素整理到已知的 JAXB 对象中。要确定是否可以 将任何Type 元素分到一个 JAXB 生成的对象中，运行时会检查元素的 xsi:type 属性，以确定在元素中构建数据的实际类型。如果 xsi:type 属性不存在，则运行时会尝试按内省来识别元素的实际数据类型。如果元素的实际数据类型决定是应用的 JAXB 上下文已知的类型之一，该元素将被编入正确类型的 JAXB 对象中。

如果运行时无法决定元素的实际数据类型，或者元素的实际数据类型不是已知的类型，则运行时会将内容整理到 org.w3c.dom.Element 对象。然后，您将需要使用 DOM APis 来处理元素的内容。

应用的运行时通常了解从该架构生成的所有类型。这包括合同 wsdl:types 元素中定义的类型，通过导入其他模式文档即可向合同中添加任何数据类型。您还可以使用第 32.4 节 “在 Runtime Marshaller 中添加类” 中描述的 @XmlSeeAlso 注解使运行时了解额外的类型。

unmarshalling

当 Apache CXF 联合 Java 类型到 XML 数据时，它使用 Java 数据类型和 XML Schema 结构之间的内部映射，以确定 XML 结构以写入线路。如果运行时知道类，可将类映射到 XML Schema 结构，它会写入数据并插入 xsi:type 属性来识别元素所包含的数据类型。如果数据存储在 org.w3c.dom.Element 对象中，运行时会写入由对象代表的 XML 结构，但它不包含 xsi:type 属性。

如果运行时无法将 Java 对象映射到已知的 XML Schema 结构，它将抛出一个 marshaling 异常。您可以使用第 32.4 节 “在 Runtime Marshaller 中添加类” 中描述的 @XmlSeeAlso 注解在运行时映射中添加类型。

36.3. 使用 Unbound 属性

概述

XML Schema 提供了一种机制，允许您在复杂类型定义中保留任意属性的位置。使用这个机制，您可以定义具有任何属性的复杂类型。例如，您可以创建一个定义元素 <robot name="epsilon" />、<robot age="10000" /> 或 <robot type="weevil" /> 的类型，但不指定三个属性。这在需要灵活性时特别有用。

在 XML Schema 中定义

在 XML Schema 中使用 anyAttribute 元素定义 Undeclared 属性。它可在何时使用属性元素。anyAttribute 元素没有属性，如例 36.7 “带有 Undeclared Attribute 的复杂类型” 所示。

例 36.7. 带有 Undeclared Attribute 的复杂类型

<complexType name="arbitter">
  <sequence>
    <element name="name" type="xsd:string" />
    <element name="rate" type="xsd:float" />
  </sequence>
  <anyAttribute />
</complexType>

定义的类型（即 arbitter ）具有两个元素，它可以具有任意类型的一个属性。例 36.8 “使用 Wild 卡属性定义的 Elements 示例” 中显示的三个元素均可从复杂类型 arbitter 生成。

例 36.8. 使用 Wild 卡属性定义的 Elements 示例

<officer rank="12"><name>...</name><rate>...</rate></officer>
<lawyer type="divorce"><name>...</name><rate>...</rate></lawyer>
<judge><name>...</name><rate>...</rate></judge>

映射到 Java

当包含 anyAttribute 元素的复杂类型映射到 Java 时，代码生成器会将一个名为 otherAttributes 的成员添加到生成的类。otherAttributes 是 java.util.Map<QName、String > 且具有 getter 方法，它可以返回映射的实时实例。由于从 getter 返回的映射为 live，因此任何对映射的修改都会被自动应用。例 36.9 “带有 Undeclared Attribute 的 complexity Type 的类” 显示为例 36.7 “带有 Undeclared Attribute 的复杂类型” 中定义的复杂类型生成的类。

例 36.9. 带有 Undeclared Attribute 的 complexity Type 的类

public class Arbitter {

    @XmlElement(required = true)
    protected String name;
    protected float rate;

    @XmlAnyAttribute private Map<QName, String> otherAttributes = new HashMap<QName, String>();

    public String getName() {
        return name;
    }

    public void setName(String value) {
        this.name = value;
    }

    public float getRate() {
        return rate;
    }

    public void setRate(float value) {
        this.rate = value;
    }

    public Map<QName, String> getOtherAttributes() { return otherAttributes; }

}

使用不正确的属性

生成的类的 otherAttributes 成员需要使用 Map 对象进行填充。该映射使用 QNames 进行键。获取 map 后，您可以访问对象上设置的任何属性，并在对象上设置新属性。

例 36.10 “使用 Undeclared 属性” 显示使用 undeclared 属性的示例代码。

例 36.10. 使用 Undeclared 属性

Arbitter judge = new Arbitter();
Map<QName, String> otherAtts = judge.getOtherAttributes();

QName at1 = new QName("test.apache.org", "house");
QName at2 = new QName("test.apache.org", "veteran");

otherAtts.put(at1, "Cape");
otherAtts.put(at2, "false");

String vetStatus = otherAtts.get(at2);

例 36.10 “使用 Undeclared 属性” 中的代码执行以下操作：

获取包含未declared 属性的映射。

创建 QName 以用于属性。

将属性的值设置到映射中。

检索其中一个属性的值。

第 37 章 element Substitution

摘要

XML Schema 替换组允许您定义一组可替换顶级或 head 元素的元素。当您有多个共享共同基础类型或需要交换的元素时，这很有用。

37.1. 在 XML Schema 中替换组

概述

替换组是 XML 模式的一项功能，允许您指定元素，它可以替换从该架构生成的文档中另一元素。可替换元素称为 head 元素，必须在 schema 的全局范围内定义。替换组的元素必须与 head 元素相同，或者派生自 head 元素的类型。

本质上，可以使用一个替换组来构建一组可使用通用元素指定的元素。例如，如果您正在为某个公司建立一个排序系统，它会销售三类小部件，您可以定义一个通用小部件元素，该元素包含所有三种小部件类型的一组常用数据。然后，您可以定义一个包含一组更具体的小部件数据的替换组。在合同中，您可以将通用小部件元素指定为消息部分，而不是为每种类型的小部件定义特定的排序操作。构建实际消息后，消息可以包含替换组的任何元素。

语法

使用 XML Schema 元素的 substitutionGroup 属性定义替换组。substitutionGroup 属性的值是要替换的元素的名称。例如，如果您的 head 元素是 widget，将属性 substitutionGroup="widget" 添加到名为 woodWidget 的元素中，您可以使用 widget 元素，您可以替换 woodWidget 元素。这显示在例 37.1 “使用 Substitution Group” 中。

例 37.1. 使用 Substitution Group

<element name="widget" type="xsd:string" />
<element name="woodWidget" type="xsd:string"
         substitutionGroup="widget" />

类型限制

替换组的元素必须与 head 元素或来自 head 元素的类型相同。例如，如果 head 元素是 xsd:int，则替换组的所有成员都必须是 xsd:int 类型，或者派生自 xsd:int 类型。您还可以定义与例 37.2 “使用复杂类型替换组” 中显示的替换组，其中替换组的元素是从 head 元素的类型派生的类型。

例 37.2. 使用复杂类型替换组

<complexType name="widgetType">
  <sequence>
    <element name="shape" type="xsd:string" />
    <element name="color" type="xsd:string" />
  </sequence>
</complexType>
<complexType name="woodWidgetType">
  <complexContent>
    <extension base="widgetType">
      <sequence>
        <element name="woodType" type="xsd:string" />
      </sequence>
    </extension>
  </complexContent>
</complexType>
<complexType name="plasticWidgetType">
  <complexContent>
    <extension base="widgetType">
      <sequence>
        <element name="moldProcess" type="xsd:string" />
      </sequence>
    </extension>
  </complexContent>
</complexType>
<element name="widget" type="widgetType" />
<element name="woodWidget" type="woodWidgetType"
         substitutionGroup="widget" />
<element name="plasticWidget" type="plasticWidgetType"
         substitutionGroup="widget" />
<complexType name="partType">
  <sequence>
    <element ref="widget" />
  </sequence>
</complexType>
<element name="part" type="partType" />

替换组的 head 元素定义为 小部件类型。 替换组的每个元素都会扩展 widgetType 以包含特定于小部件的数据。

根据例 37.2 “使用复杂类型替换组” 中的架构 ，例 37.3 “使用 Substitution Group 的 XML 文档” 中的部分元素有效。

例 37.3. 使用 Substitution Group 的 XML 文档

<part>
  <widget>
    <shape>round</shape>
    <color>blue</color>
  </widget>
</part>
<part>
  <plasticWidget>
    <shape>round</shape>
    <color>blue</color>
    <moldProcess>sandCast</moldProcess>
  </plasticWidget>
</part>
<part>
  <woodWidget>
    <shape>round</shape>
    <color>blue</color>
    <woodType>elm</woodType>
  </woodWidget>
</part>

抽象头元素

您可以定义一个摘要头元素，它永远不会出现在使用您的 schema 生成的文档中。抽象头元素与 Java 中的抽象类类似，因为它们是用来定义通用类更具体实施的基础。抽象头还可防止在最终产品中使用通用元素。

您可以通过将元素元素的 abstract 属性设为 true 来声明 抽象 头 元素，如例 37.4 “抽象标题定义” 所示。使用此架构时，有效的 review 元素可以包含 正数 元素或 负数Comment 元素，但不能 包含注释 元素。

例 37.4. 抽象标题定义

<element name="comment" type="xsd:string" abstract="true" />
<element name="positiveComment" type="xsd:string"
         substitutionGroup="comment" />
<element name="negtiveComment" type="xsd:string"
         substitutionGroup="comment" />
<element name="review">
  <complexContent>
    <all>
      <element name="custName" type="xsd:string" />
      <element name="impression" ref="comment" />
    </all>
  </complexContent>
</element>

37.2. 在 Java 中替换组

概述

Apache CXF （如 JAXB 规范中指定的）支持使用 Java 的原生类层次结构替换组，并结合 JAXBElement 类对通配符定义的支持。由于替换组的成员必须全部共享一个共同的基础类型，因此生成的类以支持元素的类型也共享一个通用基本类型。另外，Apache CXF 将 head 元素的实例映射到 JAXBElement<？扩展了 T> 属性。

生成的对象工厂方法

对象工厂生成来支持包含替换组的软件包有方法，对于替换组中的每个元素都有方法。对于替换组的每个成员，除 head 元素外，@XmlElementDecl 注解会减少对象工厂方法包含两个额外属性，如表 37.1 “Declaring a JAXB Elements 的属性是 Substitution Group 的成员” 所述。

表 37.1. Declaring a JAXB Elements 的属性是 Substitution Group 的成员
属性	描述
`substitutionHeadNamespace`	指定定义 head 元素的命名空间。
`substitutionHeadName`	指定 head 元素的 `name` 属性的值。

替换组的 @XmlElementDecl 的 head 元素的对象工厂方法仅包含 default 命名空间 属性和默认 name 属性。

除了元素实例化方法外，对象工厂还包含一个代表头元素的对象实例化的方法。如果替换组的成员是所有复杂的类型，则对象工厂还包含用于实例化各种复杂类型的实例的方法。

例 37.5 “Substitution Group 的对象因素方法” 显示例 37.2 “使用复杂类型替换组” 中定义的替换组的对象工厂方法。

例 37.5. Substitution Group 的对象因素方法

public class ObjectFactory {

    private final static QName _Widget_QNAME = new QName(...);
    private final static QName _PlasticWidget_QNAME = new QName(...);
    private final static QName _WoodWidget_QNAME = new QName(...);

    public ObjectFactory() {
    }

    public WidgetType createWidgetType() {
        return new WidgetType();
    }

    public PlasticWidgetType createPlasticWidgetType() {
        return new PlasticWidgetType();
    }

    public WoodWidgetType createWoodWidgetType() {
        return new WoodWidgetType();
    }

    @XmlElementDecl(namespace="...", name = "widget")
    public JAXBElement<WidgetType> createWidget(WidgetType value) {
        return new JAXBElement<WidgetType>(_Widget_QNAME, WidgetType.class, null, value);
    }

    @XmlElementDecl(namespace = "...", name = "plasticWidget", substitutionHeadNamespace = "...", substitutionHeadName = "widget")
    public JAXBElement<PlasticWidgetType> createPlasticWidget(PlasticWidgetType value) {
        return new JAXBElement<PlasticWidgetType>(_PlasticWidget_QNAME, PlasticWidgetType.class, null, value);
    }

    @XmlElementDecl(namespace = "...", name = "woodWidget", substitutionHeadNamespace = "...", substitutionHeadName = "widget")
    public JAXBElement<WoodWidgetType> createWoodWidget(WoodWidgetType value) {
        return new JAXBElement<WoodWidgetType>(_WoodWidget_QNAME, WoodWidgetType.class, null, value);
    }

}

替换接口中的组

如果替换组的 head 元素用作操作消息之一中的消息部分，则生成的方法参数将是生成的类的对象，以支持该元素。它不一定是 JAXBElement< 扩展 T& gt; 类的实例。运行时依赖于 Java 的原生类型层次结构来支持类型替换，Java 将捕获任何尝试使用不受支持的类型。

为确保运行时知道需要支持元素替换的所有类，SEI 被解码为 @XmlSeeAlso 注释。此注解指定运行时为 marshalling 所需的类列表。有关使用 @XmlSeeAlso 注释的更多信息，请参阅第 32.4 节 “在 Runtime Marshaller 中添加类”。

例 37.7 “使用 Substitution Group 生成的接口” 显示为例 37.6 “使用 Substution Group 的 WSDL 接口” 中显示的接口生成的 SEI。接口使用例 37.2 “使用复杂类型替换组” 中定义的替换组。

例 37.6. 使用 Substution Group 的 WSDL 接口

<message name="widgetMessage">
    <part name="widgetPart" element="xsd1:widget" />
  </message>
  <message name="numWidgets">
    <part name="numInventory" type="xsd:int" />
  </message>
  <message name="badSize">
    <part name="numInventory" type="xsd:int" />
  </message>
  <portType name="orderWidgets">
    <operation name="placeWidgetOrder">
      <input message="tns:widgetOrder" name="order" />
      <output message="tns:widgetOrderBill" name="bill" />
      <fault message="tns:badSize" name="sizeFault" />
    </operation>
    <operation name="checkWidgets">
      <input message="tns:widgetMessage" name="request" />
      <output message="tns:numWidgets" name="response" />
    </operation>
  </portType>

例 37.7. 使用 Substitution Group 生成的接口

@WebService(targetNamespace = "...", name = "orderWidgets")
@XmlSeeAlso({com.widgetvendor.types.widgettypes.ObjectFactory.class})
public interface OrderWidgets {

    @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
    @WebResult(name = "numInventory", targetNamespace = "", partName = "numInventory")
    @WebMethod
    public int checkWidgets(
        @WebParam(partName = "widgetPart", name = "widget", targetNamespace = "...")
        com.widgetvendor.types.widgettypes.WidgetType widgetPart
    );
}

例 37.7 “使用 Substitution Group 生成的接口” 中显示的 SEI 列出 @XmlSeeAlso 注解中的对象工厂。列出命名空间的对象工厂提供对该命名空间生成的所有类的访问。

用复杂类型替换组

当替换组的 head 元素用作复杂类型中的元素时，代码生成器将元素映射到 JAXBElement<?扩展了 T> 属性。它不会将它映射到包含所生成的类实例的属性，以支持替换组。

例如：例 37.8 “使用 Substitution Group 的复杂类型” 中定义的复杂类型会导致 Java 类在例 37.9 “使用 Substitution Group 进行复杂类型的 Java 类” 中显示。复杂类型使用例 37.2 “使用复杂类型替换组” 中定义的替换组。

例 37.8. 使用 Substitution Group 的复杂类型

<complexType name="widgetOrderInfo">
  <sequence>
    <element name="amount" type="xsd:int"/>
    <element ref="xsd1:widget"/>
  </sequence>
</complexType>

例 37.9. 使用 Substitution Group 进行复杂类型的 Java 类

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "widgetOrderInfo", propOrder = {"amount","widget",})
public class WidgetOrderInfo {

    protected int amount;
    @XmlElementRef(name = "widget", namespace = "...", type = JAXBElement.class) protected JAXBElement<? extends WidgetType> widget;
    public int getAmount() {
        return amount;
    }

    public void setAmount(int value) {
        this.amount = value;
    }

    public JAXBElement<? extends WidgetType> getWidget() { return widget; }

    public void setWidget(JAXBElement<? extends WidgetType> value) { this.widget = ((JAXBElement<? extends WidgetType> ) value); }

}

设置替换组属性

如何使用替换组来取决于将该组映射到直接 Java 类或 JAXBElement< 中的代码生成器？扩展了 T > 类。当元素映射到生成值类的对象时，您可以使用对象的方式与作为类型层次结构一部分的其他 Java 对象搭配使用。您可以替换父类的任何子类。您可以检查对象，以确定其准确的类，并适当地广播对象。

JAXB 规格建议您使用对象工厂方法实例化所生成的类的对象。

当代码生成器创建 JAXBElement< 扩展了 T& gt; 对象来保存替换组的实例时，您必须将元素的值嵌套在 JAXBElement< 中？扩展了 T> 对象。执行此操作的最佳方式是使用对象工厂提供的元素创建方法。它们提供了一种基于其值创建元素的简单方法。

例 37.10 “设置 Substitution 组的成员” 显示设置替换组实例的代码。

例 37.10. 设置 Substitution 组的成员

ObjectFactory of = new ObjectFactory();
PlasticWidgetType pWidget = of.createPlasticWidgetType();
pWidget.setShape = "round';
pWidget.setColor = "green";
pWidget.setMoldProcess = "injection";

JAXBElement<PlasticWidgetType> widget = of.createPlasticWidget(pWidget);

WidgetOrderInfo order = of.createWidgetOrderInfo();
order.setWidget(widget);

例 37.10 “设置 Substitution 组的成员” 中的代码执行以下操作：

实例化对象工厂。

实例化 PlasticWidgetType 对象。

实例化 JAXBElement<PlasticWidgetType& gt; 对象来容纳 plastic widget 元素。

实例化 WidgetOrderInfo 对象。

将 WidgetOrderInfo 对象的小部件设置为含有 plastic widget 元素的 JAXBElement 对象。

获取替换组属性的值

在从 JAXBElement< 中提取元素的值<中扩展了 T > 对象时，对象工厂方法没有帮助。您必须使用 JAXBElement<?扩展了 T&gt; 对象的 getValue （） 方法。以下选项决定了 getValue （） 方法返回的对象类型：

使用 all possible 类的 isInstance （） 方法来确定元素的值对象的类。
使用 JAXBElement<? 扩展 T > 对象的 getName （） 方法来确定元素的名称。
getName （） 方法返回 QName。使用元素的本地名称，您可以为 value 对象确定正确的类。
使用 JAXBElement<? 扩展 T > 对象的 getDeclaredType （） 方法来确定值对象的类。
getDeclaredType （） 方法返回元素的值对象的 Class 对象。
警告
无论 value 对象的实际类是什么，getDeclaredType （） 方法可能会返回 head 元素的基础类。

例 37.11 “获得 Substitution 组成员的值” 显示从替换组检索值的代码。要确定元素的值对象的正确类，该示例使用了元素的 getName （） 方法。

例 37.11. 获得 Substitution 组成员的值

String elementName = order.getWidget().getName().getLocalPart();
if (elementName.equals("woodWidget")
{
  WoodWidgetType widget=order.getWidget().getValue();
}
else if (elementName.equals("plasticWidget")
{
  PlasticWidgetType widget=order.getWidget().getValue();
}
else
{
  WidgetType widget=order.getWidget().getValue();
}

37.3. 小部件供应商示例

37.3.1. 小部件顺序接口

本节演示了 Apache CXF 中用于解决实际应用程序的替换组示例。使用例 37.2 “使用复杂类型替换组” 中定义的小部件替换组来开发服务和使用者。该服务提供两种操作： checkWidgets 和 placeWidgetOrder。例 37.12 “小部件顺序接口” 显示排序服务的接口。

例 37.12. 小部件顺序接口

<message name="widgetOrder">
  <part name="widgetOrderForm" type="xsd1:widgetOrderInfo"/>
</message>
<message name="widgetOrderBill">
  <part name="widgetOrderConformation"
        type="xsd1:widgetOrderBillInfo"/>
</message>
<message name="widgetMessage">
  <part name="widgetPart" element="xsd1:widget" />
</message>
<message name="numWidgets">
  <part name="numInventory" type="xsd:int" />
</message>
<portType name="orderWidgets">
  <operation name="placeWidgetOrder">
    <input message="tns:widgetOrder" name="order"/>
    <output message="tns:widgetOrderBill" name="bill"/>
  </operation>
  <operation name="checkWidgets">
    <input message="tns:widgetMessage" name="request" />
    <output message="tns:numWidgets" name="response" />
  </operation>
</portType>

例 37.13 “小部件 Ordering SEI” 显示为接口生成的 Java SEI。

例 37.13. 小部件 Ordering SEI

@WebService(targetNamespace = "http://widgetVendor.com/widgetOrderForm", name = "orderWidgets")
@XmlSeeAlso({com.widgetvendor.types.widgettypes.ObjectFactory.class})
public interface OrderWidgets {

    @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
    @WebResult(name = "numInventory", targetNamespace = "", partName = "numInventory")
    @WebMethod
    public int checkWidgets(
        @WebParam(partName = "widgetPart", name = "widget", targetNamespace = "http://widgetVendor.com/types/widgetTypes")
        com.widgetvendor.types.widgettypes.WidgetType widgetPart
    );

    @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
    @WebResult(name = "widgetOrderConformation", targetNamespace = "", partName = "widgetOrderConformation")
    @WebMethod
    public com.widgetvendor.types.widgettypes.WidgetOrderBillInfo placeWidgetOrder(
        @WebParam(partName = "widgetOrderForm", name = "widgetOrderForm", targetNamespace = "")
        com.widgetvendor.types.widgettypes.WidgetOrderInfo widgetOrderForm
    ) throws BadSize;
}

注意

由于示例中仅显示了替换组的使用，所以不会显示一些业务逻辑。

37.3.2. checkWidgets Operation

概述

checkWidget 是一个简单操作，它有一个参数是替换组的头成员。此操作演示了如何处理作为替换组成员的单个参数。消费者必须确保参数是替换组的成员。该服务必须正确决定在请求中发送的替换组的成员。

消费者实施

生成的方法签名使用 Java 类，支持替换组的 head 元素类型。由于替换组的 member 元素与 head 元素或来自 head 元素的类型相同，所以生成的 Java 类是支持从 Java 类继承的替换组的成员来支持 head 元素。Java 的类型层次结构原生支持使用子类来代替父类。

由于 Apache CXF 如何为替换组和 Java 类型层次结构生成类型，客户端可以在不使用任何特殊代码的情况下调用 checkWidgets （）。在开发用于调用 checkWidgets （） 的逻辑时，您可以传递生成的其中一个类对象来支持小部件替换组。

例 37.14 “consumer Invoking checkWidgets （）” 显示调用 checkWidgets （） 的使用者。

例 37.14. consumer Invoking checkWidgets （）

System.out.println("What type of widgets do you want to order?");
System.out.println("1 - Normal");
System.out.println("2 - Wood");
System.out.println("3 - Plastic");
System.out.println("Selection [1-3]");
String selection = reader.readLine();
String trimmed = selection.trim();
char widgetType = trimmed.charAt(0);
switch (widgetType)
{
  case '1':
  {
    WidgetType widget = new WidgetType();
    ...
    break;
  }
  case '2':
  {
    WoodWidgetType widget = new WoodWidgetType();
    ...
    break;
  }
  case '3':
  {
    PlasticWidgetType widget = new PlasticWidgetType();
    ...
    break;
  }
  default :
    System.out.println("Invaid Widget Selection!!");
}

proxy.checkWidgets(widgets);

服务实施

服务实施的 checkWidgets （） 获取一个小部件描述作为 WidgetType 对象，检查小部件清单，并返回库存中的小部件数量。由于用于实施替换组的所有类都继承自同一基础类，因此您无需使用任何 JAXB 特定的 API，即可实施 checkWidgets （）。

所有生成的类都用于支持 widget 扩展 WidgetType 类的替换组的成员。鉴于这一事实，您可以使用 instanceof 来确定将要传递的小部件类型，只需将 widgetPart 对象转换为更严格的类型（如果合适）。在有正确的对象类型后，您可以检查正确的小部件清单。

例 37.15 “checkWidgets （）的服务实现。” 显示可能的实施。

例 37.15. checkWidgets （）的服务实现。

public int checkWidgets(WidgetType widgetPart)
{
  if (widgetPart instanceof WidgetType)
  {
    return checkWidgetInventory(widgetType);
  }
  else if (widgetPart instanceof WoodWidgetType)
  {
    WoodWidgetType widget = (WoodWidgetType)widgetPart;
    return checkWoodWidgetInventory(widget);
  }
  else if (widgetPart instanceof PlasticWidgetType)
  {
    PlasticWidgetType widget = (PlasticWidgetType)widgetPart;
    return checkPlasticWidgetInventory(widget);
  }
}

37.3.3. placeWidgetOrder Operation

概述

placeWidgetOrder 使用两个包含替换组的复杂类型。此操作演示了在 Java 实施中使用这种结构。使用者和服务都必须获取和设置替换组的成员。

消费者实施

若要调用 placeWidgetOrder （），消费者必须构建包含小部件替换组的某一元素的小部件顺序。将小部件添加到订单时，使用者应使用为替换组的每个元素生成的对象工厂方法。这样可确保运行时和服务可以正确处理顺序。例如，如果将某一顺序放在 plastic 小部件，则使用 ObjectFactory.createPlasticWidget （） 方法创建元素，然后再将其添加到订购前。

例 37.16 “设置 Substitution 组成员” 显示用于设置 WidgetOrderInfo 对象 的小部件 属性使用者代码。

例 37.16. 设置 Substitution 组成员

ObjectFactory of = new ObjectFactory();

WidgetOrderInfo order = new of.createWidgetOrderInfo();
...
System.out.println();
System.out.println("What color widgets do you want to order?");
String color = reader.readLine();
System.out.println();
System.out.println("What shape widgets do you want to order?");
String shape = reader.readLine();
System.out.println();
System.out.println("What type of widgets do you want to order?");
System.out.println("1 - Normal");
System.out.println("2 - Wood");
System.out.println("3 - Plastic");
System.out.println("Selection [1-3]");
String selection = reader.readLine();
String trimmed = selection.trim();
char widgetType = trimmed.charAt(0);
switch (widgetType)
{
  case '1':
  {
    WidgetType widget = of.createWidgetType();
    widget.setColor(color);
    widget.setShape(shape);
    JAXB<WidgetType> widgetElement = of.createWidget(widget); order.setWidget(widgetElement);
    break;
  }
  case '2':
  {
    WoodWidgetType woodWidget = of.createWoodWidgetType();
    woodWidget.setColor(color);
    woodWidget.setShape(shape);
    System.out.println();
    System.out.println("What type of wood are your widgets?");
    String wood = reader.readLine();
    woodWidget.setWoodType(wood);
    JAXB<WoodWidgetType> widgetElement = of.createWoodWidget(woodWidget); order.setWoodWidget(widgetElement);
    break;
  }
  case '3':
  {
    PlasticWidgetType plasticWidget = of.createPlasticWidgetType();
    plasticWidget.setColor(color);
    plasticWidget.setShape(shape);
    System.out.println();
    System.out.println("What type of mold to use for your
                        widgets?");
    String mold = reader.readLine();
    plasticWidget.setMoldProcess(mold);
    JAXB<WidgetType> widgetElement = of.createPlasticWidget(plasticWidget); order.setPlasticWidget(widgetElement);
    break;
  }
  default :
    System.out.println("Invaid Widget Selection!!");
    }

服务实施

placeWidgetOrder （） 方法以 WidgetOrderInfo 对象的形式收到顺序，处理订购过程，并以 WidgetOrderBill 的形式将 bill 返回给消费者。订单可以是纯文本小部件，也可以是一个wooden 小部件。排序的小部件类型由 widget OrderForm 对象的小部件属性中存储什么类型来决定。widget 属性是一个替换组，可以包含 小部件 元素、woodWidget 元素或 plasticWidget 元素。

该实施必须确定哪些可能元素按照顺序存储。这可以使用 JAXBElement< 扩展了 T& gt; 对象的 getName （） 方法来确定元素的 QName。然后，可以使用 QName 来决定替换组中的哪个元素按顺序排列。当 bill 中包含的元素被已知后，您可以将其值提取到正确的对象类型。

例 37.17 “Implementation of placeWidgetOrder()” 显示可能的实施。

例 37.17. Implementation of placeWidgetOrder()

public com.widgetvendor.types.widgettypes.WidgetOrderBillInfo placeWidgetOrder(WidgetOrderInfo widgetOrderForm)
{
  ObjectFactory of = new ObjectFactory();

  WidgetOrderBillInfo bill = new WidgetOrderBillInfo()

   // Copy the shipping address and the number of widgets
   // ordered from widgetOrderForm to bill
   ...

  int numOrdered = widgetOrderForm.getAmount();

  String elementName = widgetOrderForm.getWidget().getName().getLocalPart();
  if (elementName.equals("woodWidget")
  {
    WoodWidgetType widget=order.getWidget().getValue();
    buildWoodWidget(widget, numOrdered);

    // Add the widget info to bill
    JAXBElement<WoodWidgetType> widgetElement = of.createWoodWidget(widget);
    bill.setWidget(widgetElement);

    float amtDue = numOrdered * 0.75;
    bill.setAmountDue(amtDue);
  }
  else if (elementName.equals("plasticWidget")
  {
    PlasticWidgetType widget=order.getWidget().getValue();
    buildPlasticWidget(widget, numOrdered);

    // Add the widget info to bill
    JAXBElement<PlasticWidgetType> widgetElement = of.createPlasticWidget(widget);
    bill.setWidget(widgetElement);

    float amtDue = numOrdered * 0.90;
    bill.setAmountDue(amtDue);
  }
  else
  {
    WidgetType widget=order.getWidget().getValue();
    buildWidget(widget, numOrdered);

    // Add the widget info to bill
    JAXBElement<WidgetType> widgetElement = of.createWidget(widget);
    bill.setWidget(widgetElement);

    float amtDue = numOrdered * 0.30;
    bill.setAmountDue(amtDue);
  }

  return(bill);
}

例 37.17 “Implementation of placeWidgetOrder()” 中的代码执行以下操作：

实例化对象工厂以创建元素。

实例化 小部件OrderBillInfo 对象来容纳 bill。

获取排序的小部件数量。

获取以顺序存储的元素的本地名称。

检查该元素是否是 woodWidget 元素。

将元素的值从的顺序提取到正确的对象类型。

创建一个指向 bill 的 JAXBElement<T > 对象。

设置 bill 对象的 widget 属性。

设置对象的数量 属性。

第 38 章自定义如何生成类型

摘要

默认 JAXB 映射解决使用 XML Schema 定义 Java 应用对象时遇到的大多数情况。对于默认映射不足的实例，JAXB 提供了广泛的自定义机制。

38.1. 自定义类型映射的基础知识

概述

JAXB 规范定义了多个 XML 元素，用于自定义 Java 类型如何映射到 XML Schema 结构。这些元素可以通过 XML Schema 构造来指定。如果您无法或者不想修改 XML Schema 定义，您可以在外部绑定文档中指定自定义。

命名空间

用于自定义 JAXB 数据绑定的元素在命名空间 http://java.sun.com/xml/ns/jaxb 中定义。您必须添加与例 38.1 “JAXB 自定义命名空间” 中显示的命名空间声明类似。这添加到定义 JAXB 自定义的所有 XML 文档的根目录中。

例 38.1. JAXB 自定义命名空间

xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"

版本声明

在使用 JAXB 自定义时，您必须指示正在使用的 JAXB 版本。这可以通过将 jaxb:version 属性添加到外部绑定声明的 root 元素来实现。如果您使用的是在线自定义，则必须在包含自定义的 schema 元素中包含 jaxb:version 属性。属性的值始终是 2.0。

例 38.2 “指定 JAXB 自定义版本” 显示 架构 元素中使用的 jaxb:version 属性的示例。

例 38.2. 指定 JAXB 自定义版本

< schema ...
        jaxb:version="2.0">

使用在线自定义

自定义代码生成器的最直接方法是自定义 XML Schema 构造到 Java 构造，将自定义元素直接添加到 XML Schema 定义中。JAXB 自定义元素放在被修改的 XML 架构结构的 xsd:appinfo 元素中。

例 38.3 “自定义 XML Schema” 显示包含在线 JAXB 自定义的 schema 示例。

例 38.3. 自定义 XML Schema

<schema targetNamespace="http://widget.com/types/widgetTypes"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
        jaxb:version="2.0">
  <complexType name="size">
    <annotation> <appinfo> <jaxb:class name="widgetSize" /> </appinfo> </annotation>
    <sequence>
      <element name="longSize" type="xsd:string" />
      <element name="numberSize" type="xsd:int" />
    </sequence>
  </complexType>
<schema>

使用外部绑定声明

当无法或者不想对定义您的类型的 XML Schema 文档进行修改时，您可以使用外部绑定声明指定自定义。外部绑定声明由多个嵌套的 jaxb:bindings 元素组成。例 38.4 “JAXB External Binding Declaration 语法” 显示外部绑定声明的语法。

例 38.4. JAXB External Binding Declaration 语法

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="2.0">
  <jaxb:bindings [schemaLocation="schemaUri" | wsdlLocation="wsdlUri">
    <jaxb:bindings node="nodeXPath">
      binding declaration
    </jaxb:bindings>
    ...
  </jaxb:bindings>
<jaxb:bindings>

schemaLocation 属性和 wsdlLocation 属性用于识别要对其应用修改的 schema 文档。如果您要从 schema 文档生成代码，请使用 schemaLocation 属性。如果您要从 WSDL 文档生成代码，请使用 wsdlLocation 属性。

node 属性用于标识要修改的特定 XML 模式结构。它是解析到 XML Schema 元素的 XPath 语句。

由于架构文档 widgetSchema.xsd 显示在例 38.5 “XML Schema 文件” 中，则例 38.6 “外部绑定声明” 中显示的外部绑定声明会修改复杂类型 大小的 生成。

例 38.5. XML Schema 文件

<schema targetNamespace="http://widget.com/types/widgetTypes"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        version="1.0">
  <complexType name="size">
    <sequence>
      <element name="longSize" type="xsd:string" />
      <element name="numberSize" type="xsd:int" />
    </sequence>
  </complexType>
<schema>

例 38.6. 外部绑定声明

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="2.0">
  <jaxb:bindings schemaLocation="wsdlSchema.xsd">
    <jaxb:bindings node="xsd:complexType[@name='size']">
        <jaxb:class name="widgetSize" />
    </jaxb:bindings>
  </jaxb:bindings>
<jaxb:bindings>

要指示代码生成器，使用 wsdl2java 工具的 -b binding-file 选项，如下所示：

wsdl2java -b widgetBinding.xml widget.wsdl

38.2. 指定 XML Schema 原语的 Java 类

概述

默认情况下，XML Schema 类型映射到 Java 原语类型。虽然这是 XML Schema 和 Java 之间的最逻辑映射，但它并不始终满足应用程序开发人员的要求。您可能希望将 XML Schema 原语类型映射到可以存放额外信息的 Java 类，或者您可能希望将 XML 原语类型映射到允许简单替换的类。

JAXB javaType 自定义元素允许您自定义 XML Schema 原语类型和 Java 原语类型之间的映射。它可用于自定义全局级别和单个实例级别的映射。您可以使用 javaType 元素作为简单类型定义的一部分，或者作为复杂类型定义的一部分。

使用 javaType 自定义元素时，您必须指定用于将原语类型的 XML 表示转换为目标 Java 类或从目标 Java 类转换的方法。某些映射具有默认转换方法。对于没有默认映射的实例，Apache CXF 提供 JAXB 方法来简化所需方法的开发。

语法

javaType 自定义元素使用四个属性，如表 38.1 “用于自定义 XML Schema 类型的 Java 类的属性” 所述。

表 38.1. 用于自定义 XML Schema 类型的 Java 类的属性
属性	必需	描述
`name`	是	指定 XML Schemitive 类型映射的 Java 类的名称。它必须是有效的 Java 类名称或 Java 原语类型的名称。您必须确保此类存在且可以被您的应用程序访问。代码生成器不检查此课程。
`xmlType`	否	指定被自定义的 XML 原语类型。只有在 `javaType` 元素被用作 `globalBindings` 元素的子项时才使用此属性。
`parseMethod`	否	指定负责将数据的基于字符串的 XML 表示解析为 Java 类实例的方法。更多信息请参阅 “指定转换器”一节。
`printMethod`	否	指定负责将 Java 对象转换为基于字符串的 XML 表示数据的方法。更多信息请参阅 “指定转换器”一节。

javaType 自定义元素可通过三种方式使用：

要修改 XML Schema 原语类型的所有实例 - javaType 元素将修改 schema 文档中的所有 XML Schema 类型实例，当它用作 全局Bindings 自定义元素的子状态时。以这种方式使用时，您必须为 xmlType 属性指定一个值，用于标识要修改的 XML Schema 原语类型。
例 38.7 “全球原语类型自定义” 显示一个在线全局自定义，用于指示代码生成器对 schema 中的所有 xsd:short 实例使用 java.lang.Integer。
例 38.7. 全球原语类型自定义
```
<schema targetNamespace="http://widget.com/types/widgetTypes"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
        jaxb:version="2.0">
  <annotation>
    <appinfo>
      <jaxb:globalBindings ...>
        <jaxb:javaType name="java.lang.Integer"
                       xmlType="xsd:short" />
      </globalBindings
    </appinfo>
  </annotation>
  ...
</schema>
```

要修改简单的类型定义 - javaType 元素会在将 XML 简单类型的所有实例应用到简单类型定义时，修改生成的类。当使用 javaType 元素修改简单类型定义时，请勿使用 xmlType 属性。

例 38.8 “用于自定义简单类型的绑定文件” 显示外部绑定文件，用于修改名为 zipCode 的简单类型的生成。

例 38.8. 用于自定义简单类型的绑定文件

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="2.0">
  <jaxb:bindings wsdlLocation="widgets.wsdl">
    <jaxb:bindings node="xsd:simpleType[@name='zipCode']">
        <jaxb:javaType name="com.widgetVendor.widgetTypes.zipCodeType"
                       parseMethod="com.widgetVendor.widgetTypes.support.parseZipCode"
                       printMethod="com.widgetVendor.widgetTypes.support.printZipCode" />
    </jaxb:bindings>
  </jaxb:bindings>
<jaxb:bindings>

要修改复杂类型定义的元素或属性 - javaType 可以被应用于复杂类型定义的独立部分，方法是将它作为 JAXB 属性自定义的一部分包含在内。javaType 元素被置于属性的 baseType 元素的子项。当使用 javaType 元素修改复杂类型定义的特定部分时，请不要使用 xmlType 属性。

例 38.9 “在复杂类型中自定义元素的绑定文件” 显示修改复杂类型的元素的绑定文件。

例 38.9. 在复杂类型中自定义元素的绑定文件

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="2.0">
  <jaxb:bindings schemaLocation="enumMap.xsd">
    <jaxb:bindings node="xsd:ComplexType[@name='widgetOrderInfo']">
      <jaxb:bindings node="xsd:element[@name='cost']">
        <jaxb:property>
          <jaxb:baseType>
            <jaxb:javaType name="com.widgetVendor.widgetTypes.costType"
                            parseMethod="parseCost"
                            printMethod="printCost" >
          </jaxb:baseType>
        </jaxb:property>
      </jaxb:bindings>
    </jaxb:bindings>
  </jaxb:bindings>
<jaxb:bindings>

有关使用 baseType 元素的更多信息，请参阅第 38.6 节 “指定元素或属性的 Base Type”。

指定转换器

Apache CXF 无法将 XML Schema 原语类型转换为随机 Java 类。当您使用 javaType 元素自定义 XML Schema 原语类型的映射时，代码生成器会创建一个适配器类，用于汇总自定义 XML Schema 原语类型。例 38.10 “JAXB Adapter Class” 中显示了一个适配器类示例。

例 38.10. JAXB Adapter Class

public class Adapter1 extends XmlAdapter<String, javaType>
{
  public javaType unmarshal(String value)
  {
    return(parseMethod(value));
  }

  public String marshal(javaType value)
  {
    return(printMethod(value));
  }
}

parseMethod 和 printMethod 被对应的 parseMethod 属性和 printMethod 属性的值替代。值必须识别有效的 Java 方法。您可以通过以下两种方式之一指定方法的名称：

完全限定的 Java 方法名称，格式为 packagename.ClassName.methodName
以 methodName的形式的简单方法名称
当您只提供简单方法名称时，代码生成器假定方法存在于 javaType 元素的 name 属性指定的类中。

重要

代码生成器 不会生成 解析或打印方法。您负责提供它们。有关开发解析和打印方法的详情请参考 “实现转换器”一节。

如果没有提供 parseMethod 属性的值，代码生成器假定 name 属性指定的 Java 类具有 buildor，其第一个参数是 Java String 对象。生成的适配器的 unmarshal （） 方法使用假定的构造器使用 XML 数据填充 Java 对象。

如果没有提供 printMethod 属性的值，代码生成器会假定 name 属性指定的 Java 类具有 toString （） 方法。生成的适配器的 marshal （） 方法使用 assumed toString （） 方法将 Java 对象转换为 XML 数据。

如果 javaType 元素的 name 属性指定 Java 原语类型，或者 Java 原语打包程序类型之一，则代码生成器使用默认转换器。有关默认转换器的更多信息，请参阅 “默认原语类型转换器”一节。

生成的内容

如 “指定转换器”一节所述，使用 javaType 自定义元素可为每个自定义 XML Schema 原语类型触发一个适配器类生成。适配器使用模式 适配器N 来按顺序命名。如果您指定了两种原语自定义，则代码生成器创建两个适配器类： Adapter1 和 Adapter2。

为 XML 模式构建生成的代码取决于其效果的 XML Schema 结构是全局定义的元素，或者被定义为复杂类型的一部分。

当 XML Schema 结构是一个全局定义元素时，从默认方法中为类型生成的对象工厂方法如下：

该方法通过 @XmlJavaTypeAdapter 注释进行解码。
该注解指示当处理这个元素的实例时要使用的运行时。适配器类指定为类对象。
默认类型由 javaType 元素的 name 属性指定的类替换。

例 38.11 “全球元素的自定义对象工厂方法” 显示例 38.7 “全球原语类型自定义” 中受自定义影响的元素的对象工厂方法。

例 38.11. 全球元素的自定义对象工厂方法

 @XmlElementDecl(namespace = "http://widgetVendor.com/types/widgetTypes", name = "shorty")
 @XmlJavaTypeAdapter(org.w3._2001.xmlschema.Adapter1.class)
 public JAXBElement<Integer> createShorty(Integer value) {
     return new JAXBElement<Integer>(_Shorty_QNAME, Integer.class, null, value);
 }

当 XML Schema 结构定义为复杂类型的一部分时，生成的 Java 属性将按如下所示修改：

属性使用 @XmlJavaTypeAdapter 注释进行解码。
该注解指示当处理这个元素的实例时要使用的运行时。适配器类指定为类对象。
该属性的 @XmlElement 包含 type 属性。
type 属性的值是代表所生成的对象默认基础类型的类对象。如果是 XML Schema 原语类型，则类为 String。
属性使用 @XmlSchemaType 注释进行解码。
该注释标识了构造的 XML Schema 原语类型。
默认类型由 javaType 元素的 name 属性指定的类替换。

例 38.12 “自定义复杂度类型” 显示例 38.7 “全球原语类型自定义” 中受自定义影响的元素的对象工厂方法。

例 38.12. 自定义复杂度类型

public class NumInventory {

    @XmlElement(required = true, type = String.class) @XmlJavaTypeAdapter(Adapter1.class) @XmlSchemaType(name = "short") protected Integer numLeft;
    @XmlElement(required = true)
    protected String size;

    public Integer getNumLeft() {
        return numLeft;
    }

    public void setNumLeft(Integer value) {
        this.numLeft = value;
    }

    public String getSize() {
        return size;
    }

    public void setSize(String value) {
        this.size = value;
    }

}

实现转换器

Apache CXF 运行时不知道如何将 XML 原语类型转换为 javaType 元素指定的 Java 类，除了它应该调用 parseMethod 属性和 printMethod 属性指定的方法。您需要提供运行时调用方法的实现。实施的方法必须能够处理 XML 原语类型的传统结构。

为简化数据转换方法的实施，Apache CXF 提供 javax.xml.bind.DatatypeConverter 类。此类提供了解析和打印所有 XML 原语类型的方法。解析方法使用 XML 数据的字符串表示，它们返回表 34.1 “XML Schema Primitive Type to Java Native Type Mapping” 中定义的默认类型实例。print 方法获取默认类型的实例，它们返回 XML 数据表示的字符串。

DatatypeConverter 类的 Java 文档可在 https://docs.oracle.com/javase/8/docs/api/javax/xml/bind/DatatypeConverter.html 中找到。

默认原语类型转换器

在 javaType 元素的 name 属性中指定 Java 原语类型 Wrapper 类中的 Java 原语类型或 Java 原语类型时，不需要为 parseMethod 属性或 printMethod 属性指定值。如果没有提供值，Apache CXF 运行时会替换默认转换器。

默认数据转换器使用 JAXB DatatypeConverter 类来解析 XML 数据。默认转换器也会提供必要的任何类型，以便进行转换。

38.3. 为简单类型生成 Java 类

概述

默认情况下，指定的简单类型不会产生生成的类型，除非有枚举。使用简单类型定义的元素映射到 Java 原语类型的属性。

如果需要将简单类型生成到 Java 类中，比如在使用类型替换时，实例会存在。

要指示代码生成器为所有全局定义的简单类型生成类，请将 全局Binding 自定义元素的 mapSimpleTypeDef 设置为 true。

添加自定义

要指示代码生成器为简单类型创建 Java 类，请添加 globalBinding 元素的 mapSimpleTypeDef 属性，并将其值设为 true。

例 38.13 “Check Alignment of PHsandgt;On-line Customization to Force Generation of Java Classes for SimpleTypes” 显示在线自定义，可强制代码生成器为命名简单类型生成 Java 类。

例 38.13. Check Alignment of PHsandgt;On-line Customization to Force Generation of Java Classes for SimpleTypes

<schema targetNamespace="http://widget.com/types/widgetTypes"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
        jaxb:version="2.0">
  <annotation>
    <appinfo>
      <jaxb:globalBindings mapSimpleTypeDef="true" />
    </appinfo>
  </annotation>
  ...
</schema>

例 38.14 “将文件绑定到强制生成 Constants” 显示外部绑定文件，用于自定义生成简单类型。

例 38.14. 将文件绑定到强制生成 Constants

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="2.0">
  <jaxb:bindings schemaLocation="types.xsd">
    <jaxb:globalBindings mapSimpleTypeDef="true" />
  <jaxb:bindings>
<jaxb:bindings>

重要

这个自定义 只会影响 全局范围 中定义的简单类型。

生成的类

为简单类型生成的类具有一个名为 value 的属性。value 属性是第 34.1 节 “原语类型” 中映射定义的 Java 类型。生成的类具有 getter 和 setter 值 属性。

例 38.16 “简单类型的自定义映射” 显示为例 38.15 “自定义映射的简单类型” 中定义的简单类型生成的 Java 类。

例 38.15. 自定义映射的简单类型

<simpleType name="simpleton">
  <restriction base="xsd:string">
    <maxLength value="10"/>
  </restriction>
</simpleType>

例 38.16. 简单类型的自定义映射

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "simpleton", propOrder = {"value"})
public class Simpleton {

    @XmlValue
    protected String value;

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

}

38.4. 自定义枚举映射

概述

如果您希望基于 xsd:string 以外的模式类型枚举，则必须指示代码生成器来映射它。您还可以控制生成的枚举常数的名称。

自定义使用 jaxb:typesafeEnumClass 元素以及一个或多个 jaxb:typesafeEnumMember 元素来完成。

可能还会有实例，代码生成器的默认设置无法为枚举的所有成员创建有效的 Java 标识符。您可以使用 全局Binding 自定义属性来自定义代码生成器的方式。

成员名称 customizer

如果代码生成器在生成枚举成员时遇到命名冲突，或者如果无法为枚举成员创建有效的 Java 标识符，则默认情况下代码生成器会生成一个警告，且不会为枚举生成 Java 枚举类型。

您可以通过添加 globalBinding 元素 的类型safeEnumMemberName 属性来更改此行为。表 38.2 “自定义枚举成员名称生成的值” 中描述了 typesafeEnumMemberName 属性的值。

表 38.2. 自定义枚举成员名称生成的值
值	描述
`skipGeneration`(default)	指定没有生成 `Java` 枚举类型并生成警告。
`generateName`	指定以 `VALUE_N` 模式生成的成员名称。n 一开始，并在枚举的每个成员中递增。
`generateError`	指定代码生成器在无法将枚举映射到 Java 枚举时 `会产生错误`。

例 38.17 “自定义以强制类型 Safe Member Names” 显示在线自定义，可强制代码生成器生成类型安全的成员名称。

例 38.17. 自定义以强制类型 Safe Member Names

<schema targetNamespace="http://widget.com/types/widgetTypes"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
        jaxb:version="2.0">
  <annotation>
    <appinfo>
      <jaxb:globalBindings typesafeEnumMemberName="generateName" />
    </appinfo>
  </annotation>
  ...
</schema>

类自定义器

jaxb:typesafeEnumClass 元素指定将 XML Schema 枚举性映射到 Java 枚举类型。它有两个属性，如表 38.3 “自定义生成的枚举类的属性” 所述。当指定 jaxb:typesafeEnumClass 元素时，它必须放在要修改的简单类型的 xsd:annotation 元素中。

表 38.3. 自定义生成的枚举类的属性
属性	描述
`name`	指定生成的 Java 枚举类型 `的名称`。这个值必须是有效的 Java 标识符。
`map`	指定枚举是否应映射到 Java 枚举 `类型`。默认值为 `true`。

成员自定义器

jaxb:typesafeEnumMember 元素指定 XML Schema enumeration facet 和 Java enum type constant 之间的映射。您必须在被自定义 枚举的每个枚举 方面，使用一个 jaxb:typesafeEnumMember 元素。

使用在线自定义时，可以通过以下两种方式之一使用此元素：

它可以放置在被修改的 enumeration facet 的 xsd:annotation 元素中。
它们都可以作为用于自定义枚举的 jaxb:typesafeEnumClass 元素的子项放置。

jaxb:typesafeEnumMember 元素具有所需的 name 属性。name 属性指定生成的 Java enum 类型常的名称。它的值必须是有效的 Java 标识符。

jaxb:typesafeEnumMember 元素也具有 value 属性。该值 用于将 枚举 facet 与正确的 jaxb:typesafeEnumMember 元素相关联。value 属性的值 必须与 枚举 值的其中一个值匹配。使用外部绑定规格来自定义类型生成时，或者将 jaxb:typesafeEnumMember 元素分组为 jaxb:typesafeEnumClass 元素时，需要此属性。

例子

例 38.18 “枚举类型自定义” 显示在线自定义中使用的枚举类型，并且具有单独自定义的枚举成员。

例 38.18. 枚举类型自定义

<schema targetNamespace="http://widget.com/types/widgetTypes"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
        jaxb:version="2.0">
  <simpleType name="widgetInteger">
    <annotation>
      <appinfo>
        <jaxb:typesafeEnumClass />
      </appinfo>
    </annotation>
    <restriction base="xsd:int">
      <enumeration value="1">
        <annotation>
          <appinfo>
            <jaxb:typesafeEnumMember name="one" />
          </appinfo>
        </annotation>
      </enumeration>
      <enumeration value="2">
        <annotation>
          <appinfo>
            <jaxb:typesafeEnumMember name="two" />
          </appinfo>
        </annotation>
      </enumeration>
      <enumeration value="3">
        <annotation>
          <appinfo>
            <jaxb:typesafeEnumMember name="three" />
          </appinfo>
        </annotation>
      </enumeration>
      <enumeration value="4">
        <annotation>
          <appinfo>
            <jaxb:typesafeEnumMember name="four" />
          </appinfo>
        </annotation>
      </enumeration>
    </restriction>
  </simpleType>
<schema>

例 38.19 “使用组合映射对枚举类型进行在线自定义” 显示一个枚举类型，它使用在线自定义功能，并在课堂自定义中合并成员的自定义。

例 38.19. 使用组合映射对枚举类型进行在线自定义

<schema targetNamespace="http://widget.com/types/widgetTypes"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
        jaxb:version="2.0">
  <simpleType name="widgetInteger">
    <annotation>
      <appinfo>
        <jaxb:typesafeEnumClass>
            <jaxb:typesafeEnumMember value="1" name="one" />
            <jaxb:typesafeEnumMember value="2" name="two" />
            <jaxb:typesafeEnumMember value="3" name="three" />
            <jaxb:typesafeEnumMember value="4" name="four" />
        </jaxb:typesafeEnumClass>
      </appinfo>
    </annotation>
    <restriction base="xsd:int">
      <enumeration value="1" />
      <enumeration value="2" />
      <enumeration value="3" />
      <enumeration value="4" >
    </restriction>
  </simpleType>
<schema>

例 38.20 “用于自定义枚举的绑定文件” 显示自定义枚举类型的外部绑定文件。

例 38.20. 用于自定义枚举的绑定文件

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="2.0">
  <jaxb:bindings schemaLocation="enumMap.xsd">
    <jaxb:bindings node="xsd:simpleType[@name='widgetInteger']">
        <jaxb:typesafeEnumClass>
            <jaxb:typesafeEnumMember value="1" name="one" />
            <jaxb:typesafeEnumMember value="2" name="two" />
            <jaxb:typesafeEnumMember value="3" name="three" />
            <jaxb:typesafeEnumMember value="4" name="four" />
        </jaxb:typesafeEnumClass>
    </jaxb:bindings>
  </jaxb:bindings>
<jaxb:bindings>

38.5. 自定义修复的值属性映射

概述

默认情况下，代码生成器映射属性定义为将固定值定义为正常属性。在使用架构验证时，Apache CXF 可以强制执行 schema 定义（请参阅第 24.3.4.7 节 “模式验证类型值”）。但是，使用 schema 验证会增加消息处理时间。

将带有固定值的属性映射到 Java 的另一种方法是将它们映射到 Java 常量。您可以使用 全局Binding 自定义元素指示代码生成器将固定值属性映射到 Java 常量。您还可以使用 property 元素自定义在更本地化级别上固定值属性到 Java 常量的映射。

全球自定义

您可以通过添加 globalBinding 元素的 fixedAttributeAsConstantProperty 属性来更改此行为。将此属性设置为 true 会指示代码生成器将使用 固定 属性定义的任何属性映射到 Java 常量。

例 38.21 “在线自定义以强制生成 Constants” 显示在线自定义，可强制代码生成器为带有固定值的属性生成常量。

例 38.21. 在线自定义以强制生成 Constants

<schema targetNamespace="http://widget.com/types/widgetTypes"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
        jaxb:version="2.0">
  <annotation>
    <appinfo>
      <jaxb:globalBindings fixedAttributeAsConstantProperty="true" />
    </appinfo>
  </annotation>
  ...
</schema>

例 38.22 “将文件绑定到强制生成 Constants” 显示用来自定义固定属性生成的外部绑定文件。

例 38.22. 将文件绑定到强制生成 Constants

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="2.0">
  <jaxb:bindings schemaLocation="types.xsd">
    <jaxb:globalBindings fixedAttributeAsConstantProperty="true" />
  <jaxb:bindings>
<jaxb:bindings>

本地映射

您可以使用属性元素的 fixedAttributeAsConstantProperty 属性 来自定义每个attribute 的属性映射。将此属性设置为 true 会指示代码生成器将使用 固定 属性定义的任何属性映射到 Java 常量。

例 38.23 “在线自定义以强制生成 Constants” 显示在线自定义，可强制代码生成器为具有固定值的单个属性生成常量。

例 38.23. 在线自定义以强制生成 Constants

<schema targetNamespace="http://widget.com/types/widgetTypes"
        xmlns="http://www.w3.org/2001/XMLSchema"
        xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
        xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
        jaxb:version="2.0">
  <complexType name="widgetAttr">
    <sequence>
      ...
    </sequence>
    <attribute name="fixer" type="xsd:int" fixed="7">
      <annotation> <appinfo> <jaxb:property fixedAttributeAsConstantProperty="true" /> </appinfo> </annotation>
     </attribute>
  </complexType>
  ...
</schema>

例 38.24 “将文件绑定到强制生成 Constants” 显示用来自定义固定属性生成的外部绑定文件。

例 38.24. 将文件绑定到强制生成 Constants

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="2.0">
  <jaxb:bindings schemaLocation="types.xsd">
    <jaxb:bindings node="xsd:complexType[@name='widgetAttr']">
      <jaxb:bindings node="xsd:attribute[@name='fixer']">
            <jaxb:property fixedAttributeAsConstantProperty="true" />
        </jaxb:bindings>
    </jaxb:bindings>
  </jaxb:bindings>
<jaxb:bindings>

Java 映射

在默认映射中，所有属性都通过 getter 和 setter 方法映射到标准的 Java 属性。当此自定义应用到 使用固定 属性定义的属性时，属性映射到 Java 常量，如例 38.25 “将修复的值属性映射到 Java Constant” 所示。

例 38.25. 将修复的值属性映射到 Java Constant

@XmlAttribute
public final static type NAME = value;

Type 由使用第 34.1 节 “原语类型” 中描述的映射将属性的基本类型映射到 Java 类型来确定。

NAME 通过将 属性 元素的 name 属性的值转换为所有大写字母来确定。

值由 属性 元素 的固定 属性的值决定。

例如，例 38.23 “在线自定义以强制生成 Constants” 中定义的属性映射为例 38.26 “修复了映射到 Java Constant 的 Value Attribute” 所示。

例 38.26. 修复了映射到 Java Constant 的 Value Attribute

@XmlRootElement(name = "widgetAttr")
public class WidgetAttr {

    ...

  @XmlAttribute
  public final static int FIXER = 7;

  ...

}

38.6. 指定元素或属性的 Base Type

概述

有时您需要自定义为元素生成的对象的类，或者针对定义为 XML Schema 复杂类型的一部分定义的属性。例如，您可能希望使用更为常规化的对象类，以便进行简单替换。

其中一种实现方式是使用 JAXB 基础类型自定义。它允许开发人员以防范的方式指定生成的对象类，以代表元素或属性。基础类型自定义允许您指定 XML Schema 结构和生成的 Java 对象之间的备用映射。这个备用映射可以是一个简单的分类，也可以是默认基础类的一般性。它还可以是 XML Schema 原语类型到 Java 类的映射。

自定义使用

要将 JAXB 基础类型属性应用到 XML Schema 结构，请使用 JAXB baseType 自定义元素。baseType 自定义元素是 JAXB 属性 元素的子项，所以它必须正确嵌套。

根据您要自定义 XML Schema 构造到 Java 对象的映射，您要添加 baseType 自定义元素 的名称 属性或 javaType 子元素。name 属性用于将生成的对象的 default 类映射到同一类层次结构中的另一个类。当您将 XML Schema 原语类型映射到 Java 类时，使用 javaType 元素。

重要

您不能在同一 baseType 自定义元素中使用 name 属性和 javaType 子元素。

特殊大小或常规默认映射

baseType 自定义元素的 name 属性用于将生成的对象的类重新定义为同一 Java 类层次结构中的类。属性指定 XML Schema 结构映射到的 Java 类的完全限定名称。指定的 Java 类 必须是 超级类或 Java 类的子类，这些代码生成器通常会为 XML Schema 结构生成。对于映射到 Java 原语类型的 XML 方案，打包程序类用作自定义用途的默认基础类。

例如，定义为 xsd:int 的元素使用 java.lang.Integer 作为其默认基础类。name 属性的值可以指定任何一类 Integer，如 Number 或 Object。

对于简单类型替换，最常见的自定义是将原语类型映射到对象对象。

例 38.27 “基本类型的在线自定义” 显示在线自定义，它将复杂类型中的一个元素映射到 Java 对象对象。

例 38.27. 基本类型的在线自定义

<complexType name="widgetOrderInfo">
  <all>
    <element name="amount" type="xsd:int" />
     <element name="shippingAdress" type="Address">
      <annotation> <appinfo> <jaxb:property> <jaxb:baseType name="java.lang.Object" /> </jaxb:property> </appinfo> </annotation>
    </element>
    <element name="type" type="xsd:string"/>
  </all>
</complexType>

例 38.28 “外部绑定文件自定义基本类型” 显示例 38.27 “基本类型的在线自定义” 中显示的自定义外部绑定文件。

例 38.28. 外部绑定文件自定义基本类型

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               jaxb:version="2.0">
  <jaxb:bindings schemaLocation="enumMap.xsd">
    <jaxb:bindings node="xsd:ComplexType[@name='widgetOrderInfo']">
      <jaxb:bindings node="xsd:element[@name='shippingAddress']">
        <jaxb:property>
          <jaxb:baseType name="java.lang.Object" />
        </jaxb:property>
      </jaxb:bindings>
    </jaxb:bindings>
  </jaxb:bindings>
<jaxb:bindings>

生成的 Java 对象的 @XmlElement 注释包含 type 属性。type 属性的值是代表所生成的对象默认基础类型的类对象。如果是 XML Schema 原语类型，类是对应 Java 原语类型的打包程序类。

例 38.29 “带有修改的基本类的 Java 类” 显示根据例 38.28 “外部绑定文件自定义基本类型” 中的 schema 定义生成的类。

例 38.29. 带有修改的基本类的 Java 类

public class WidgetOrderInfo {

    protected int amount;
    @XmlElement(required = true)
    protected String type;
    @XmlElement(required = true, type = Address.class) protected Object shippingAddress;

    ...
    public Object getShippingAddress() {
        return shippingAddress;
    }

    public void setShippingAddress(Object value) {
        this.shippingAddress = value;
    }

}

使用 javaType 的使用

javaType 元素可用于自定义使用 XML Schema 原语类型定义的元素和属性如何映射到 Java 对象。使用 javaType 元素提供更大的灵活性，而不仅仅是使用 baseType 元素的 name 属性。javaType 元素允许您将原语类型映射到任何对象的类。

有关使用 javaType 元素的详细描述，请参阅第 38.2 节 “指定 XML Schema 原语的 Java 类”。

第 39 章使用 A `JAXBContext` 对象

摘要

JAXBContext 对象允许 Apache CXF 的运行时在 XML 元素和 Java 对象之间转换数据。应用程序开发人员需要实例化 JAXBContext 对象，它们要在消息处理程序中使用 JAXB 对象，并在实施使用原始 XML 消息的消费者时。

概述

JAXBContext 对象是运行时使用的低级别对象。它允许运行时在 XML 元素和对应的 Java 表示法之间转换。应用程序开发人员通常不需要与 JAXBContext 对象一起使用。XML 数据的 marshaling 和 unmarling 通常由 JAX-WS 应用的传输和绑定层处理。

但是，当应用程序需要直接操作 XML 消息内容时，会出现实例。在两个实例中的两个中：

第 41.1 节 “在消费者中使用 XML”
第 43 章 编写处理程序

您需要使用两个可用的 JAXBContext.newInstance （） 方法之一实例化 JAXBContext 对象。

最佳实践

JAXBContext 对象是资源密集型，用于实例化。建议应用程序尽可能创建几个实例。执行此操作的一种方法是创建一个 JAXBContext 对象，它可以管理应用所使用的所有 JAXB 对象，并尽可能在应用的许多部分之间共享。

JAXBContext 对象是线程安全。

使用对象工厂获取 JAXBContext 对象

JAXBContext 类 提供新的Instance （） 方法，如例 39.1 “使用类获取 JAXB 上下文” 所示，取实施 JAXB 对象的类列表。

例 39.1. 使用类获取 JAXB 上下文

静态JAXBContextnewInstanceClass…classesToBeBoundJAXBException

返回的 JAXBObject 对象将能够为传递到方法的类实施的 JAXB 对象进行 marshal 和 unmarshal 数据。它还能够处理从传递给方法的任何类静态引用的任何类。

虽然您可以将应用所使用的每个 JAXB 类的名称传递给 newInstance （） 方法，但它效率不高。实现相同目标的更有效方法是将应用程序生成对象工厂或对象工厂。生成的 JAXBContext 对象将可以管理指定对象工厂可实例化的任何 JAXB 类。

使用软件包名称获取 JAXBContext 对象

JAXBContext 类提供 一个新的Instance （） 方法，它在例 39.2 “使用类获取 JAXB 上下文” 中显示，它采用冒号(:)软件包名称列表。指定的软件包应包含从 XML Schema 派生的 JAXB 对象。

例 39.2. 使用类获取 JAXB 上下文

staticJAXBContextnewInstanceStringcontextPathJAXBException

返回的 JAXBContext 对象将能够为指定软件包中的类实施的所有 JAXB 对象进行 marshal 和 unmarshal 数据。

第 40 章开发异步应用程序

摘要

JAX-WS 提供异步访问服务的简单机制。SEI 可以指定其他方法，可用于异步访问服务。Apache CXF 代码生成器为您生成额外的方法。您只需添加业务逻辑。

40.1. 同步调用类型

除了通常的调用模式外，Apache CXF 还支持两种异步调用形式：

轮询方法 - 要使用轮询方法调用远程操作，您调用没有输出参数的方法，但返回 javax.xml.ws.Response 对象。可以轮询 Response 对象（从 javax.util.concurrency.Future 接口继承），以检查响应消息是否已到达。
回调方法 - 要使用回调方法调用远程操作，您可以调用一个方法，将引用回调对象( javax.xml.ws.AsyncHandler 类型)作为其参数之一。当响应消息到达客户端时，运行时在 AsyncHandler 对象上调用，并为其提供响应消息的内容。

40.2. 用于同步示例的 WSDL

例 40.1 “面向异步示例的 WSDL 合同” 显示用于异步示例的 WSDL 合同。该合同定义了单一界面 GreeterAsync，它包含单一操作 greetMeSometime。

例 40.1. 面向异步示例的 WSDL 合同

<?xml version="1.0" encoding="UTF-8"?><wsdl:definitions xmlns="http://schemas.xmlsoap.org/wsdl/"
                  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
                  xmlns:tns="http://apache.org/hello_world_async_soap_http"
                  xmlns:x1="http://apache.org/hello_world_async_soap_http/types"
                  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
                  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                  targetNamespace="http://apache.org/hello_world_async_soap_http"
                  name="HelloWorld">
  <wsdl:types>
    <schema targetNamespace="http://apache.org/hello_world_async_soap_http/types"
            xmlns="http://www.w3.org/2001/XMLSchema"
            xmlns:x1="http://apache.org/hello_world_async_soap_http/types"
            elementFormDefault="qualified">
      <element name="greetMeSometime">
        <complexType>
          <sequence>
            <element name="requestType" type="xsd:string"/>
          </sequence>
        </complexType>
      </element>
      <element name="greetMeSometimeResponse">
        <complexType>
          <sequence>
            <element name="responseType"
                     type="xsd:string"/>
          </sequence>
        </complexType>
      </element>
    </schema>
  </wsdl:types>

  <wsdl:message name="greetMeSometimeRequest">
    <wsdl:part name="in" element="x1:greetMeSometime"/>
  </wsdl:message>
  <wsdl:message name="greetMeSometimeResponse">
    <wsdl:part name="out"
               element="x1:greetMeSometimeResponse"/>
  </wsdl:message>

  <wsdl:portType name="GreeterAsync">
    <wsdl:operation name="greetMeSometime">
      <wsdl:input name="greetMeSometimeRequest"
                  message="tns:greetMeSometimeRequest"/>
      <wsdl:output name="greetMeSometimeResponse"
                   message="tns:greetMeSometimeResponse"/>
    </wsdl:operation>
  </wsdl:portType>

  <wsdl:binding name="GreeterAsync_SOAPBinding"
                type="tns:GreeterAsync">
    ...
  </wsdl:binding>

  <wsdl:service name="SOAPService">
    <wsdl:port name="SoapPort"
               binding="tns:GreeterAsync_SOAPBinding">
      <soap:address location="http://localhost:9000/SoapContext/SoapPort"/>
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>

40.3. 生成 Stub Code

概述

调用异步方式需要额外存根代码，以用于 SEI 中定义的专用异步方法。默认不生成此特殊存根代码。要在异步功能上切换并生成必要的存根代码，您必须使用 WSDL 2.0 规范中的映射自定义功能。

通过自定义，您可以修改 Maven 代码生成插件生成 stub 代码的方式。特别是，您可以修改 WSDL-to-Java 映射并切换某些功能。在这里，自定义用于切换异步调用功能。使用绑定声明指定自定义，您可以使用 jaxws:bindings 标签（其中 jaxws 前缀绑定到 http://java.sun.com/xml/ns/jaxws 命名空间）进行定义。有两种指定绑定声明的方法：

外部绑定声明: 当使用外部绑定声明时，在与 WSDL 合同独立的文件中定义 jaxws:bindings 元素。在生成 stub 代码时，您可以将绑定声明文件的位置指定为代码生成器。
嵌入式绑定声明: 使用嵌入式绑定声明时，您可以直接嵌入 WSDL 合同中的 jaxws:bindings 元素，将它视为 WSDL 扩展。在本例中，jaxws:bindings 中的设置仅应用到即时父元素。

使用外部绑定声明

例 40.2 “一个同步绑定拒绝的模板” 中显示了在异步调用时切换的绑定声明文件的模板。

例 40.2. 一个同步绑定拒绝的模板

<bindings xmlns:xsd="http://www.w3.org/2001/XMLSchema"
          xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
          wsdlLocation="AffectedWSDL"
          xmlns="http://java.sun.com/xml/ns/jaxws">
  <bindings node="AffectedNode">
    <enableAsyncMapping>true</enableAsyncMapping>
  </bindings>
</bindings>

其中 AffectedWSDL 指定受这个绑定声明影响的 WSDL 合同的 URL。AffectedNode 是一个 XPath 值，用于指定 WSDL 合同中哪些节点（或节点）会受到这个绑定声明的影响。如果您希望整个 WSDL 协议会受到影响，请将 AffectedNode 设置为 wsdl:definitions。将 jaxws:enableAsyncMapping 元素设置为 true 以启用异步调用功能。

例如，如果只想为 GreeterAsync 接口生成异步方法，您可以指定 <bindings node="wsdl:definitions/wsdl:portType[@name='GreeterAsync']">。

假设绑定声明存储在一个文件中，async_binding.xml 中，您将设置 POM，如例 40.3 “消费者代码生成” 所示。

例 40.3. 消费者代码生成

<plugin>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-codegen-plugin</artifactId>
  <version>${cxf.version}</version>
  <executions>
    <execution>
      <id>generate-sources</id>
      <phase>generate-sources</phase>
      <configuration>
        <sourceRoot>outputDir</sourceRoot>
        <wsdlOptions>
          <wsdlOption>
            <wsdl>hello_world.wsdl</wsdl>
            <extraargs>
              <extraarg>-client</extraarg>
              <extraarg>-b async_binding.xml</extraarg>
            </extraargs>
          </wsdlOption>
        </wsdlOptions>
      </configuration>
      <goals>
        <goal>wsdl2java</goal>
      </goals>
    </execution>
  </executions>
</plugin>

b 选项告诉代码生成器查找外部绑定文件。

有关代码生成器的更多信息，请参阅第 44.2 节 “cxf-codegen-plugin”。

使用嵌入的绑定声明

您还可以通过将 jaxws:bindings 元素及其关联 jaxws:enableAsynchMapping 子对象直接嵌入到 WSDL 定义服务的 WSDL 文档中。您还必须为 jaxws 前缀添加命名空间声明。

例 40.4 “带有嵌入式 Binding Declaration （同步映射）的 WSDL” 显示 WSDL 文件，其中包含用于激活操作的异步映射的嵌入式绑定声明。

例 40.4. 带有嵌入式 Binding Declaration （同步映射）的 WSDL

<wsdl:definitions xmlns="http://schemas.xmlsoap.org/wsdl/"
                  ...
                  xmlns:jaxws="http://java.sun.com/xml/ns/jaxws"
                  ...>
  ...
  <wsdl:portType name="GreeterAsync">
    <wsdl:operation name="greetMeSometime">
      <jaxws:bindings> <jaxws:enableAsyncMapping>true</jaxws:enableAsyncMapping> </jaxws:bindings>
      <wsdl:input name="greetMeSometimeRequest"
                  message="tns:greetMeSometimeRequest"/>
      <wsdl:output name="greetMeSometimeResponse"
                   message="tns:greetMeSometimeResponse"/>
    </wsdl:operation>
  </wsdl:portType>
  ...
</wsdl:definitions>

将绑定声明嵌入到 WSDL 文档中时，您可以通过更改您放置声明的位置来控制受声明影响的范围。当声明被放入 wsdl:definitions 元素的子部分时，代码生成器会为 WSDL 文档中定义的所有操作创建异步方法。如果它被置于 wsdl:portType 元素的子项，则代码生成器会为接口中定义的所有操作创建异步方法。如果它被置于 wsdl:operation 元素的子项，则代码生成器只为该操作创建异步方法。

在使用嵌入式声明时，不需要将任何特殊选项传递给代码生成器。代码生成器将识别它们并相应地操作。

生成的接口

以这种方式生成存根代码后，GreeterAsync SEI （在文件 GreeterAsync.java中）被定义，如例 40.5 “带有同步调用的方法的服务端点接口” 所示。

例 40.5. 带有同步调用的方法的服务端点接口

package org.apache.hello_world_async_soap_http;

import org.apache.hello_world_async_soap_http.types.GreetMeSometimeResponse;
...

public interface GreeterAsync
{
  public Future<?> greetMeSometimeAsync(
        java.lang.String requestType,
        AsyncHandler<GreetMeSometimeResponse> asyncHandler
    );

    public Response<GreetMeSometimeResponse> greetMeSometimeAsync(
        java.lang.String requestType
    );

    public java.lang.String greetMeSometime(
        java.lang.String requestType
    );
}

除了通常的同步方法 greetMeSometime （） 外，还会为 greetMeSometime 操作生成两种异步方法：

回调方法使用公共Future<?&gt;greetMeSomtimeAsyncjava.lang.StringrequestTypeAsyncHandler<GreetMeSomtimeResponse>asyncHandler
轮询方法公共Response<GreetMeSomeTimeResponse&gt;greetMeSometimeAsyncjava.lang.StringrequestType

40.4. 使用轮询方法实施同步客户端

概述

轮询方法比开发异步应用程序的两种方法更为简单。客户端调用名为 OperationNameAsync （） 的异步方法，它返回它轮询 响应的 Response<T > 对象。客户端在等待响应时会做什么取决于应用程序的要求。处理轮询有两种基本模式：

非阻塞轮询- 定期通过调用非阻塞 Response<T>.isDone （） 方法来查看结果是否已就绪。如果结果就绪，客户端会对其进行处理。如果没有，客户端将继续进行其他操作。
阻塞轮询- 您立即调用 Response<T>.get （），并阻止响应到达（可选指定超时）。

使用非阻塞模式

例 40.6 “非阻塞方法调用异步操作方法” 演示如何使用非阻塞轮询在例 40.1 “面向异步示例的 WSDL 合同” 中定义的 greetMeSometime 操作中进行异步调用。客户端调用异步操作，并定期检查结果是否返回。

例 40.6. 非阻塞方法调用异步操作方法

package demo.hw.client;

import java.io.File;
import java.util.concurrent.Future;

import javax.xml.namespace.QName;
import javax.xml.ws.Response;

import org.apache.hello_world_async_soap_http.*;

public final class Client {
  private static final QName SERVICE_NAME
    = new QName("http://apache.org/hello_world_async_soap_http",
                "SOAPService");

  private Client() {}

  public static void main(String args[]) throws Exception {

    // set up the proxy for the client

    Response<GreetMeSometimeResponse> greetMeSomeTimeResp =
      port.greetMeSometimeAsync(System.getProperty("user.name"));

      while (!greetMeSomeTimeResp.isDone()) {
      // client does some work
      }
      GreetMeSometimeResponse reply = greetMeSomeTimeResp.get();
      // process the response

      System.exit(0);
  }
}

例 40.6 “非阻塞方法调用异步操作方法” 中的代码执行以下操作：

调用代理上的 greetMeSometimeAsync （）。

方法调用会立即将 Response<GreetMeSometimeResponse& gt; 对象返回给客户端。Apache CXF 运行时处理从远程端点接收回复的详细信息，并填充 Response<GreetMeSometimeResponse> 对象。

注意

运行时将请求传输到远程端点的 greetMeSometime （） 方法，并透明处理调用的异步性质的详细信息。因此，端点(service 实现)不会担心客户端要等待响应的详细信息。

通过检查返回的 Response 对象的 isDone （） 来检查响应是否已到达。

如果响应未到达，客户端在再次检查前会继续工作。

当响应到达时，客户端使用 get （） 方法从 Response 对象检索它。

使用阻塞模式

在使用块轮询模式时，不会调用 Response 对象的 isDone （）。相反，在调用远程操作后，会立即调用 Response 对象的 get （） 方法。get （） 块，直到响应可用为止。

您还可以将超时限制传递给 get （） 方法。

例 40.7 “阻止异步操作调用方法” 显示使用阻塞轮询的客户端。

例 40.7. 阻止异步操作调用方法

package demo.hw.client;

import java.io.File;
import java.util.concurrent.Future;

import javax.xml.namespace.QName;
import javax.xml.ws.Response;

import org.apache.hello_world_async_soap_http.*;

public final class Client {
  private static final QName SERVICE_NAME
    = new QName("http://apache.org/hello_world_async_soap_http",
                "SOAPService");

  private Client() {}

  public static void main(String args[]) throws Exception {

    // set up the proxy for the client

    Response<GreetMeSometimeResponse> greetMeSomeTimeResp =
      port.greetMeSometimeAsync(System.getProperty("user.name"));
    GreetMeSometimeResponse reply = greetMeSomeTimeResp.get();
      // process the response
      System.exit(0);
  }
}

40.5. 使用回调方法实施同步客户端

概述

进行异步操作调用的替代方法是实施回调类。然后，您将调用异步远程方法，将回调对象用作参数。运行时返回对回调对象的响应。

要实现使用回调的应用程序，请执行以下操作：

创建实现 AsyncHandler 接口的回调类。
注意
您的回调对象可以执行应用程序所需的任何响应处理。
使用 operationNameAsync （） 进行远程调用，它将回调对象用作参数并返回 Future<?> 对象。
如果您的客户端需要访问响应数据，您可以轮询返回的 Future<?& gt; 对象的 isDone （） 方法来查看远程端点是否已发送响应。
如果回调对象执行所有响应处理，则不需要检查响应是否已到达。

实施回调

回调类必须实施 javax.xml.ws.AsyncHandler 接口。接口定义了一个方法： handleResponseResponse<T& gt; 重新使用 Apache CXF 运行时调用 handleResponse （） 方法来通知响应已到达的客户端。例 40.8 “The javax.xml.ws.AsyncHandler Interface” 显示您必须实现的 AsyncHandler 接口概述。

例 40.8. The javax.xml.ws.AsyncHandler Interface

public interface javax.xml.ws.AsyncHandler
{
  void handleResponse(Response<T> res)
}

例 40.9 “回调实现类” 为例 40.1 “面向异步示例的 WSDL 合同” 中定义的 greetMeSometime 操作显示回调类。

例 40.9. 回调实现类

package demo.hw.client;

import javax.xml.ws.AsyncHandler;
import javax.xml.ws.Response;

import org.apache.hello_world_async_soap_http.types.*;

public class GreeterAsyncHandler implements AsyncHandler<GreetMeSometimeResponse>
{
  private GreetMeSometimeResponse reply;

  public void handleResponse(Response<GreetMeSometimeResponse>
                             response)
  {
    try
    {
      reply = response.get();
    }
    catch (Exception ex)
    {
      ex.printStackTrace();
    }
  }

  public String getResponse()
  {
    return reply.getResponseType();
  }
}

例 40.9 “回调实现类” 中显示的回调实现如下：

定义成员变量 响应，其中包含从远程端点返回的响应。

实施 handleResponse （）。

这种实施仅提取响应并将其分配到成员变量 回复 中。

实施名为 getResponse （） 的添加方法。

此方法是一种便利方法，可以从 回复 中提取数据并返回数据。

实施使用者

例 40.10 “同步操作调用的回调方法” 显示使用回调方法对例 40.1 “面向异步示例的 WSDL 合同” 中定义的 GreetMeSometime 操作进行异步调用的客户端。

例 40.10. 同步操作调用的回调方法

package demo.hw.client;

import java.io.File;
import java.util.concurrent.Future;

import javax.xml.namespace.QName;
import javax.xml.ws.Response;

import org.apache.hello_world_async_soap_http.*;

public final class Client {
  ...

  public static void main(String args[]) throws Exception
  {
    ...
    // Callback approach
    GreeterAsyncHandler callback = new GreeterAsyncHandler();

    Future<?> response =
      port.greetMeSometimeAsync(System.getProperty("user.name"),
                                callback);
    while (!response.isDone())
    {
      // Do some work
    }
    resp = callback.getResponse();
    ...
    System.exit(0);
  }
}

例 40.10 “同步操作调用的回调方法” 中的代码执行以下操作：

实例化回调对象。

调用 greetMeSometimeAsync （），以获取代理上的回调对象。

方法调用会立即将 Future<? > 对象返回到客户端。Apache CXF 运行时处理从远程端点接收回复的详细信息，调用回调对象的 handleResponse （） 方法，并填充 Response< GreetMeSometimeResponse > 对象。

注意

运行时将请求传输到远程端点的 greetMeSometime （） 方法，并在不使用远程端点知识的情况下处理调用的异步性质的详细信息。因此，端点(service 实现)不需要担心客户端要等待响应的详细信息。

使用返回的 Future<? > 对象的 isDone （） 方法检查响应是否已从远程端点到达。

调用回调对象的 getResponse （） 方法来获取响应数据。

40.6. 捕获从远程服务返回的例外

概述

消费者发出异步请求，在请求同步请求时不会收到同样的异常。异步返回给使用者的任何例外都会在 ExecutionException 异常中嵌套。服务引发的实际异常存储在 ExecutionException 异常 原因 字段中。

捕获异常

远程服务生成的例外是因为将响应传递给消费者的业务逻辑的方法在本地发出。当使用者发出同步请求时，导致远程调用的方法会抛出异常。当消费者发出异步请求时，Response<T> 对象的 get （） 方法会抛出异常。消费者将不会发现在请求尝试检索响应消息之前遇到了错误。

与 JAX-WS 框架生成的方法不同，Response<T> 对象的 get （） 方法丢弃了用户建模的异常或通用 JAX-WS 例外。相反，它会抛出一个 java.util.concurrent.ExecutionException 异常。

获取例外详情

框架将远程服务返回的异常存储在 ExecutionException 异常的 cause 字段中。通过获取 cause 字段的值并检查所存储异常，可以提取远程异常的详细信息。存储的异常可以是任何用户定义的异常或通用 JAX-WS 例外。

示例

例 40.11 “使用轮询方法捕获异常” 显示使用轮询方法捕获异常的示例。

例 40.11. 使用轮询方法捕获异常

package demo.hw.client;

import java.io.File;
import java.util.concurrent.Future;

import javax.xml.namespace.QName;
import javax.xml.ws.Response;

import org.apache.hello_world_async_soap_http.*;

public final class Client
{
  private static final QName SERVICE_NAME
    = new QName("http://apache.org/hello_world_async_soap_http",
                "SOAPService");

  private Client() {}

  public static void main(String args[]) throws Exception
  {
    ...
    // port is a previously established proxy object.
    Response<GreetMeSometimeResponse> resp =
       port.greetMeSometimeAsync(System.getProperty("user.name"));

    while (!resp.isDone())
    {
      // client does some work
    }

    try
    {
      GreetMeSometimeResponse reply = greetMeSomeTimeResp.get();
      // process the response
    }
    catch (ExecutionException ee)
    {
       Throwable cause = ee.getCause();
       System.out.println("Exception "+cause.getClass().getName()+" thrown by the remote service.");
    }
  }
}

例 40.11 “使用轮询方法捕获异常” 中的代码执行以下操作：

在 try/catch 块中嵌套对 Response<T> 对象的 get （） 方法的调用。

捕获执行Exception 异常.

从异常中提取 原因 字段。

如果消费者使用回调方法，则用于捕获异常的代码将放置在提取服务响应的回调对象中。

第 41 章使用 Raw XML 消息

摘要

高级别 JAX-WS API，通过将数据编入 JAXB 对象，从而使开发人员使用原生 XML 消息影响。但是，在有些情况下，最好直接访问原始 XML 消息数据，这些数据在线上传递。JAX-WS API 提供了两个接口，它们提供对原始 XML 的访问： Dispatch 接口是客户端接口，Provider 接口是服务器端接口。

41.1. 在消费者中使用 XML

摘要

Dispatch 接口是一个低级 JAX-WS API，可让您直接使用原始消息。它接受并返回消息或有效负载，这是许多类型，包括 DOM 对象、SOAP 消息和 JAXB 对象。由于它是低级 API，所以 Dispatch 接口不会执行任何消息准备，因为该消息准备了更高级别的 JAX-WS API 执行。您必须确保正确构建消息或有效负载，传递给 Dispatch 对象，并对被调用的远程操作有意义。

41.1.1. 使用模式

概述

分配对象有两种 使用模式 ：

消息模式
消息 Payload 模式(Payload 模式)

您为 Dispatch 对象指定的使用模式决定了传递给用户级别的代码的详细信息量。

消息模式

在消息模式中，Dispatch 对象用于完整消息。完整消息中包含任何绑定特定标头和打包程序。例如，与需要 SOAP 消息的服务交互的用户必须提供完全指定的 SOAP 消息的 call （） 方法。调用（） 方法也返回完全指定的 SOAP 消息。消费者代码负责完成并读取 SOAP 消息的标头和 SOAP 消息的信封信息。

在使用 JAXB 对象时，消息模式不是理想的选择。

指定 Dispatch 对象使用消息模式在创建 Dispatch 对象时提供值 java.xml.ws.Service.Mode.MESSAGE。有关创建 Dispatch 对象的更多信息，请参阅 “创建 Dispatch 对象”一节。

有效负载模式

在 有效负载模式 中，也称为消息有效负载模式，Dispatch 对象仅适用于消息的有效负载。例如，在有效负载模式下工作的 Dispatch 对象只适用于 SOAP 消息的正文。绑定层处理任何绑定级别的打包程序和标头。当从 call （） 方法返回的结果时，绑定级别打包程序和标头已经分条，并且仅保留消息正文。

在使用不使用特殊打包程序的绑定时，如 Apache CXF XML 绑定、有效负载模式和消息模式提供相同的结果。

指定 Dispatch 对象使用有效负载模式，在创建 Dispatch 对象时提供 java.xml.ws.Service.Mode.PAYLOAD 的值。有关创建 Dispatch 对象的更多信息，请参阅 “创建 Dispatch 对象”一节。

41.1.2. 数据类型

概述

因为 Dispatch 对象是低级对象，所以无法使用与更高级别消费者 API 相同的 JAXB 生成的类型进行优化。将对象与以下对象类型的分配：

javax.xml.transform.Source
javax.xml.soap.SOAPMessage
javax.activation.DataSource
“使用 JAXB 对象”一节

使用 Source 对象

Dispatch 对象接受并返回来自 javax.xml.transform.Source 接口的对象。源对象受任何绑定支持，在消息模式或有效负载模式中支持。

源对象是包含 XML 文档的低级别对象。每个 Source 实施都提供了访问存储 XML 文档的方法，然后操作其内容。以下对象实现 Source 接口：

DOMSource: 将 XML 消息作为文档对象模型(DOM)树保存.XML 消息作为一组节点对象存储，它们通过 get Node （） 方法进行访问。可以使用 setNode （） 方法更新或添加到 DOM 树中。
SAXSource: 将 XML 消息保存为 XML (SAX)对象的简单 API。SAX 对象包含一个 InputSource 对象，该对象保存原始数据和解析原始数据的 XMLReader 对象。
StreamSource: 将 XML 消息作为数据流保存。数据流可以与任何其他数据流相同。

如果您创建 Dispatch 对象使其使用通用源对象，Apache CXF 会将消息返回为 SAXSource 对象。

可以使用端点 的源-preferred-format 属性更改此行为。有关配置 Apache CXF 运行时的信息，请参阅第 IV 部分 “配置 Web 服务端点”。

使用 SOAPMessage 对象

当以下条件满足时，分配对象可以使用 javax.xml.soap.SOAPMessage 对象：

Dispatch 对象使用 SOAP 绑定
Dispatch 对象使用消息模式

SOAPMessage 对象保存 SOAP 消息。它们包含一个 SOAPPart 对象和零个或更多 AttachmentPart 对象。SOAPPart 对象包含 SOAP 消息的特定部分，包括 SOAP envelope、任何 SOAP 标头和 SOAP 消息正文。AttachmentPart 对象包含作为附件传递的二进制数据。

使用 DataSource 对象

当以下条件满足时，分配对象可以使用实现 javax.activation.DataSource 接口的对象：

Dispatch 对象使用 HTTP 绑定
Dispatch 对象使用消息模式

Datasource 对象提供了一种机制，可用于处理来自各种来源的 MIME 类型数据，包括 URL、文件和字节阵列。

使用 JAXB 对象

虽然 Dispatch 对象是低级 API，但允许您处理原始消息，它们也允许您处理 JAXB 对象。要使用 JAXB 对象，必须传递一个 JAXBContext，以便可使用的 JAXBContext 和 unmarshal the JAXB 对象。创建 Dispatch 对象时会传递 JAXBContext。

您可以将任何 JAXBContext 对象理解为 调用（）方法的参数。您还可以将返回的消息转换为 JAXBContext 对象所理解的任何 JAXB 对象。

有关创建 JAXBContext 对象的详情，请参考第 39 章 使用 A JAXBContext 对象。

41.1.3. 使用 Dispatch 对象

流程

要使用 Dispatch 对象来调用远程服务，应遵循以下顺序：

创建 Dispatch 对象。
构建请求消息。
调用正确的 calls （） 方法。
解析响应消息。

创建 Dispatch 对象

要创建 Dispatch 对象，请执行以下操作：

创建一个 Service 对象来代表 wsdl:service 元素，用于定义 Dispatch 对象要进行调用的服务。请参阅第 25.2 节 “创建服务对象”。

使用 Service 对象的 createDispatch （） 方法创建 Dispatch 对象，如例 41.1 “createDispatch （） 方法” 所示。

例 41.1. createDispatch （） 方法

publicDispatch<T&gt;createDispatchQNameportNamejava.lang.Class<T&gt;typeService.ModemodeWebServiceException

注意

如果您使用 JAXB 对象了 createDispatch （） 的方法签名：publicDispatch<T&gt;createDispatchQNameportNamejavax.xml.bind.JAXBContextcontextService.ModemodeWebServiceException

表 41.1 “Parameters for createDispatch()” 描述 createDispatch （） 方法的参数。

表 41.1. Parameters for createDispatch()
参数	描述
`portName`	指定 `wsdl:port` 元素的 QName，它代表 Dispatch 对象进行调用的服务提供商。
`type`	指定 Dispatch 对象使用的对象的数据类型。请参阅第 41.1.2 节 “数据类型”。在使用 JAXB 对象时，此参数指定用于 marshal 和 unmarshal JAXB 对象的 `JAXBContext` 对象。
`模式`	指定 Dispatch 对象的使用模式。请参阅第 41.1.1 节 “使用模式”。

例 41.2 “创建 Dispatch 对象” 显示创建在有效负载模式中与 DOMSource 对象一同创建的 Dispatch 对象的代码。

例 41.2. 创建 Dispatch 对象

package com.fusesource.demo;

import javax.xml.namespace.QName;
import javax.xml.ws.Service;

public class Client
{
public static void main(String args[])
  {
    QName serviceName = new QName("http://org.apache.cxf", "stockQuoteReporter");
    Service s = Service.create(serviceName);

    QName portName = new QName("http://org.apache.cxf", "stockQuoteReporterPort");
    Dispatch<DOMSource> dispatch = s.createDispatch(portName,
                                                  DOMSource.class,
                                                  Service.Mode.PAYLOAD);
    ...

构建请求消息

在使用 Dispatch 对象时，必须从头开始构建请求。开发人员负责确保传递到 Dispatch 对象的消息与目标服务提供商可以处理的请求匹配。这需要准确了解服务提供商使用的信息以及需要的任何标头信息。

这些信息可以由 WSDL 文档或定义消息的 XML Schema 文档提供。虽然服务提供商大有不同，但要遵循以下几个指南：

请求的 root 元素基于与正在调用 的操作 对应的 wsdl:operation 元素的值。
警告
如果被调用的服务使用 doc/literal bare 消息，则请求的 root 元素基于 wsdl:part 元素的 name 属性的值。
请求的根元素是命名空间合格的。
如果被调用的服务使用 rpc/literal 消息，则请求中的顶层元素将不是命名空间合格的元素。
重要
顶级元素的子项可能是命名空间合格的。要保持某些情况，您必须检查其 schema 定义。
如果被调用的服务使用 rpc/literal 消息，则顶级元素都为空。
如果被调用的服务使用 doc/literal 消息，则消息的 schema 定义决定任何元素是否满足命名空间。

如需有关服务如何使用 XML 消息的更多信息，请参阅 WS-I 基本配置集。

同步调用

对于生成响应的用户进行同步调用，请使用例 41.3 “Dispatch.invoke （） 方法” 中显示的 Dispatch 对象的 call （） 方法。

例 41.3. Dispatch.invoke （） 方法

TinvokeTmsgWebServiceException

响应的类型和传递给 call （） 方法的请求都会被确定何时创建 Dispatch 对象。例如，如果您使用 createDispatch (portName、SOAPMessage.class、Service.Mode.MESSAGE) 创建 Dispatch 对象，则响应和请求都是 SOAPMessage 对象。

注意

在使用 JAXB 对象时，响应和请求都可以是提供的 JAXBContext 对象的任何类型。另外，响应和请求可以是不同的 JAXB 对象。

例 41.4 “使用 Dispatch 对象进行同步调用” 显示使用 DOMSource 对象在远程服务上进行同步调用的代码。

例 41.4. 使用 Dispatch 对象进行同步调用

// Creating a DOMSource Object for the request
DocumentBuilder db = DocumentBuilderFactory.newDocumentBuilder();
Document requestDoc = db.newDocument();
Element root = requestDoc.createElementNS("http://org.apache.cxf/stockExample",
                                          "getStockPrice");
root.setNodeValue("DOW");
DOMSource request = new DOMSource(requestDoc);

// Dispatch disp created previously
DOMSource response = disp.invoke(request);

异步调用

分配对象也支持异步调用。与第 40 章 开发异步应用程序 中讨论的更高级别异步 API 一样，Dispatch 对象既可以使用轮询方法和回调方法。

使用轮询方法时，calls Async （） 方法返回 Response<t& gt; 对象，该对象可以被轮询以查看响应是否已到达。例 41.5 “Dispatch.invokeAsync （） 方法进行轮询” 显示用于使用轮询方法进行异步调用的方法的签名。

例 41.5. Dispatch.invokeAsync （） 方法进行轮询

response <T&gt;invokeAsyncTmsgWebServiceException

有关使用轮询方法进行异步调用的详情，请参考第 40.4 节 “使用轮询方法实施同步客户端”。

使用回调方法时，calls Async （） 方法采用 AsyncHandler 实施，该实施可在返回时处理响应。例 41.6 “使用回调的 Dispatch.invokeAsync （） 方法” 显示用于利用回调方法进行异步调用的方法的签名。

例 41.6. 使用回调的 Dispatch.invokeAsync （） 方法

future<?> 调用AsyncTmsgAsyncHandler<T&gt;handlerWebServiceException

有关使用回调方法进行异步调用的详情，请参考第 40.5 节 “使用回调方法实施同步客户端”。

注意

与同步 调用（） 方法一样，当您创建 Dispatch 对象时，响应的类型和请求的类型决定。

单向调用

当请求没有生成响应时，使用 Dispatch 对象的 calls OneWay （）进行远程调用。例 41.7 “Dispatch.invokeOneWay （） 方法” 显示此方法的签名。

例 41.7. Dispatch.invokeOneWay （） 方法

invokeOneWayTmsgWebServiceException

用于在创建 Dispatch 对象时确定用于对请求打包的对象类型。例如，如果使用 createDispatch (portName, DOMSource.class, Service.Mode.PAYLOAD) 创建 Dispatch 对象，则请求会打包成 DOMSource 对象。

注意

在使用 JAXB 对象时，响应和请求可以是提供的 JAXBContext 对象的任何类型。

例 41.8 “使用 Dispatch 对象进行一次性调用” 显示使用 JAXB 对象在远程服务上进行单向调用的代码。

例 41.8. 使用 Dispatch 对象进行一次性调用

// Creating a JAXBContext and an Unmarshaller for the request
JAXBContext jbc = JAXBContext.newInstance("org.apache.cxf.StockExample");
Unmarshaller u = jbc.createUnmarshaller();

// Read the request from disk
File rf = new File("request.xml");
GetStockPrice request = (GetStockPrice)u.unmarshal(rf);

// Dispatch disp created previously
disp.invokeOneWay(request);

41.2. 在服务提供商中使用 XML

摘要

Provider 接口是一个低级 JAX-WS API，它允许您实施一个服务供应商，作为原始 XML 直接处理消息。消息不会打包成 JAXB 对象，然后传递到实现 Provider 接口的对象。

41.2.1. 消息传递模式

概述

实施 Provider 接口的对象有两种 消息传递模式 ：

消息模式
有效负载模式

您指定的消息传递模式决定了传递到您的实施的消息传递详情级别。

消息模式

在使用 消息模式 时，提供程序实施可用于完成消息。完整消息中包含任何绑定特定标头和打包程序。例如，使用 SOAP 绑定的供应商实现会接收请求作为完全指定的 SOAP 消息。所有从实施返回的响应都必须是完全指定的 SOAP 消息。

要指定 Provider 实现使用消息模式，方法是提供值 java.xml.ws.Service.Mode.MESSAGE 作为 javax.xml.ws.ServiceMode 注解的值，如例 41.9 “指定供应商实施使用消息模式” 所示。

例 41.9. 指定供应商实施使用消息模式

@WebServiceProvider
@ServiceMode(value=Service.Mode.MESSAGE)
public class stockQuoteProvider implements Provider<SOAPMessage>
{
  ...
}

有效负载模式

在 有效负载模式中，提供程序实施仅用于消息有效负载。例如，在有效负载模式下工作的供应商实施只适用于 SOAP 消息的正文。绑定层处理任何绑定级别的打包程序和标头。

在使用不使用特殊打包程序的绑定时，如 Apache CXF XML 绑定、有效负载模式和消息模式提供相同的结果。

要指定 Provider 实现使用有效负载模式，方法是提供值 java.xml.ws.Service.Mode.PAYLOAD 作为 javax.xml.ws.ServiceMode 注解的值，如例 41.10 “指定 Provider Implementation Uses Payload Mode” 所示。

例 41.10. 指定 Provider Implementation Uses Payload Mode

@WebServiceProvider
@ServiceMode(value=Service.Mode.PAYLOAD)
public class stockQuoteProvider implements Provider<DOMSource>
{
  ...
}

如果没有为 @ServiceMode 注释提供值，则 Provider 实现使用 payload 模式。

41.2.2. 数据类型

概述

由于它们是低级对象，因此提供商实施无法使用与更高级别的消费者 API 相同的 JAXB 生成的类型。供应商实现用于以下类型的对象：

javax.xml.transform.Source
javax.xml.soap.SOAPMessage
javax.activation.DataSource

使用 Source 对象

提供程序实施可以接受并返回来自 javax.xml.transform.Source 接口的对象。源对象是包含 XML 文档的低级别对象。每个 Source 实施都提供了访问存储 XML 文档和操作其内容的方法。以下对象实现 Source 接口：

DOMSource: 将 XML 消息作为文档对象模型(DOM)树保存.XML 消息作为一组节点对象存储，它们通过 get Node （） 方法进行访问。可以使用 setNode （） 方法更新或添加到 DOM 树中。
SAXSource: 将 XML 消息保存为 XML (SAX)对象的简单 API。SAX 对象包含一个 InputSource 对象，该对象保存原始数据和解析原始数据的 XMLReader 对象。
StreamSource: 将 XML 消息作为数据流保存。数据流可以与任何其他数据流相同。

如果创建 Provider 对象使其使用通用源对象，Apache CXF 会将消息返回为 SAXSource 对象。

可以使用端点 的源-preferred-format 属性更改此行为。有关配置 Apache CXF 运行时的信息，请参阅第 IV 部分 “配置 Web 服务端点”。

重要

在使用 Source 对象时，开发人员将负责确保所有所需的特定绑定程序都添加到消息中。例如，当与希望 SOAP 消息的服务交互时，开发人员必须确保将所需的 SOAP envelope 添加到传出请求中，并且 SOAP envelope 的内容正确。

使用 SOAPMessage 对象

当以下条件满足时，提供程序实施可以使用 javax.xml.soap.SOAPMessage 对象：

Provider 实现使用 SOAP 绑定
Provider 实现使用消息模式

使用 DataSource 对象

当以下条件满足时，提供程序实施可以使用实现 javax.activation.DataSource 接口的对象：

实现使用 HTTP 绑定
实现使用消息模式

Datasource 对象提供了一种机制，可用于处理来自各种来源的 MIME 类型数据，包括 URL、文件和字节阵列。

41.2.3. 实施供应商对象

概述

提供者界面相对容易实施。它只具有一种方法，调用（） 必须被实施。另外，它有三个简单的要求：

实施必须含有 @WebServiceProvider 注释。
实施必须具有默认的公共构造器。
实施必须实施键入的提供者接口版本。
换句话说，您无法实施 Provider<T> 接口。您必须实现使用 concrete 数据类型的接口版本，如第 41.2.2 节 “数据类型” 中列出的。例如，您可以实施 Provider<SAXSource> 的实例。

实施 Provider 接口的复杂性是在处理请求消息并构建正确的响应的逻辑中。

使用消息

与基于较高级别的 SEI 服务实施不同，提供商实施将请求作为原始 XML 数据接收，并且必须作为原始 XML 数据发送响应。这要求开发人员对正在实施的服务所使用的消息有一定了解。这些详细信息通常可在描述服务的 WSDL 文档中找到。

WS-I 基本配置集提供有关服务使用的信息的指南，包括：

请求的 root 元素基于 wsdl:operation 元素的 name 属性的值，与调用的操作对应。
警告
如果服务使用 doc/literal bare 消息，则请求的 root 元素基于 wsdl:part 元素的 name 属性的值。
所有消息的根元素都是命名空间限定。
如果服务使用 rpc/literal 消息，则消息中的顶层元素不会被命名空间限定。
重要
顶级元素的子项可能是命名空间合格的，但在某些情况下您必须检查其架构定义。
如果服务使用 rpc/literal 消息，则顶级元素都为空。
如果服务使用 doc/literal 消息，则消息的 schema 定义决定任何元素是否满足命名空间。

@WebServiceProvider 注释

要将 JAX-WS 识别为服务实施，提供程序实施必须被 @WebServiceProvider 注释进行解码。

表 41.2 “@WebServiceProvider Properties” 描述可以为 @WebServiceProvider 注释设置的属性。

表 41.2. @WebServiceProvider Properties
属性	描述
`portName`	指定定义服务端点的 `wsdl:port` 元素的 `name` 属性的值。
`serviceName`	指定包含服务端点的 `wsdl:service` 元素的 `name` 属性的值。
`targetNamespace`	指定服务 WSDL 定义的 targetname 空间。
`wsdlLocation`	指定定义该服务的 WSDL 文档的 URI。

所有这些属性都是可选的，默认情况下为空。如果您为空，Apache CXF 将使用实施类中的信息创建值。

实施 call （）方法

Provider 接口只有一个方法 calls （），必须实施它。调用（） 方法接收打包为实施的 Provider 接口类型的对象类型的传入请求，并将响应消息返回成同一类型的对象。例如，实施 Provider<SOAPMessage> 接口接收请求作为 SOAPMessage 对象，并将响应作为 SOAPMessage 对象返回。

提供程序实施所用的消息传递模式决定了请求和响应消息中包含的特定信息的绑定量。使用消息模式的实现会接收所有绑定器和标头，以及请求。它们还必须将所有绑定程序和标头添加到响应消息。使用有效负载模式的实现仅接收请求的正文。使用有效负载模式返回的 XML 文档被放入请求消息的正文中。

例子

例 41.11 “provider<SOAPMessage> 实现” 显示一个供应商实施，用于消息模式的 SOAPMessage 对象。

例 41.11. provider<SOAPMessage> 实现

import javax.xml.ws.Provider;
import javax.xml.ws.Service;
import javax.xml.ws.ServiceMode;
import javax.xml.ws.WebServiceProvider;

@WebServiceProvider(portName="stockQuoteReporterPort"
                    serviceName="stockQuoteReporter")
@ServiceMode(value="Service.Mode.MESSAGE")
public class  stockQuoteReporterProvider implements Provider<SOAPMessage>
{
public stockQuoteReporterProvider()
  {
  }

public SOAPMessage invoke(SOAPMessage request)
  {
  SOAPBody requestBody = request.getSOAPBody();
  if(requestBody.getElementName.getLocalName.equals("getStockPrice"))
    {
    MessageFactory mf = MessageFactory.newInstance();
      SOAPFactory sf = SOAPFactory.newInstance();

    SOAPMessage response = mf.createMessage();
      SOAPBody respBody = response.getSOAPBody();
      Name bodyName = sf.createName("getStockPriceResponse");
      respBody.addBodyElement(bodyName);
      SOAPElement respContent = respBody.addChildElement("price");
      respContent.setValue("123.00");
      response.saveChanges();
    return response;
    }
    ...
  }
}

例 41.11 “provider<SOAPMessage> 实现” 中的代码执行以下操作：

指定以下类实施实施实施服务（其 wsdl:service 元素名为 stockQuoteReporter ）的 Provider 对象，其 wsdl:port 元素名为 stockQuoteReporterPort。

指定此提供程序实施使用消息模式。

提供所需的默认公共构造器。

提供 调用（）方法的 实现，它采用 SOAPMessage 对象并返回 SOAPMessage 对象。

从传入 SOAP 消息的正文中提取请求消息。

检查请求消息的根元素，以确定如何处理请求。

创建构建响应所需的工厂。

为响应构建 SOAP 消息。

将响应返回为 SOAPMessage 对象。

例 41.12 “provider<DOMSource> 实施” 显示在有效负载模式中使用 DOMSource 对象进行提供程序实施的示例。

例 41.12. provider<DOMSource> 实施

import javax.xml.ws.Provider;
import javax.xml.ws.Service;
import javax.xml.ws.ServiceMode;
import javax.xml.ws.WebServiceProvider;

@WebServiceProvider(portName="stockQuoteReporterPort" serviceName="stockQuoteReporter")
@ServiceMode(value="Service.Mode.PAYLOAD")
public class  stockQuoteReporterProvider implements Provider<DOMSource>
public stockQuoteReporterProvider()
  {
  }

public DOMSource invoke(DOMSource request)
  {
    DOMSource response = new DOMSource();
    ...
    return response;
  }
}

例 41.12 “provider<DOMSource> 实施” 中的代码执行以下操作：

指定该类实施了实施服务（其 wsdl:service 元素名为 stockQuoteReporter ）的 Provider 对象，其 wsdl:port 元素名为 stockQuoteReporterPort。

指定此提供程序实施使用有效负载模式。

提供所需的默认公共构造器。

提供 调用（） 方法的实施，该方法采用 DOMSource 对象并返回 DOMSource 对象。

第 42 章使用上下文

摘要

JAX-WS 使用上下文将元数据与消息传递链一起传递。此元数据取决于范围，可以被实施级别的代码访问。它也可用于在实施级别低于消息的 JAX-WS 处理程序。

42.1. 了解上下文

概述

在很多实例中，需要将消息的信息传递给应用的其他部分。Apache CXF 使用上下文机制执行此操作。上下文映射包含与传出或传入消息相关的属性。该上下文中存储的属性通常是有关消息的元数据，以及用于传递消息的底层传输。例如，传输消息（如 HTTP 响应代码或 JMS 相关性 ID）所用的传输特定标头保存在 JAX-WS 上下文中。

这些上下文在 JAX-WS 应用程序的所有级别上提供。但是，它们以细微的方式有所不同，具体取决于您在访问上下文的消息处理堆栈中的位置。JAX-WS 处理程序实施可直接访问上下文，并可访问其中设置的所有属性。服务实施访问权限由注入注入，并且只能访问 APPLICATION 范围内设置的属性。使用者实施只能访问 APPLICATION 范围内设置的属性。

图 42.1 “消息上下文和消息处理路径” 显示上下文属性如何通过 Apache CXF 传递。随着消息通过消息传递链，其相关的消息上下文随其一起传递。

图 42.1. 消息上下文和消息处理路径

属性如何存储在上下文中

消息上下文是 javax.xml.ws.handler.MessageContext 接口的所有实现。MessageContext 接口扩展了 java.util.Map<String 键，Object value> 接口。将信息映射为键值对。

在消息上下文中，属性存储为名称/值对。属性的键是用于标识属性的字符串。属性的值可以是存储在任何 Java 对象中的任何值。当从消息上下文返回该值时，应用程序必须知道要相应地预期和广播的类型。例如，如果属性的值存储在 UserInfo 对象中，它仍然从消息上下文返回，作为必须回回到 UserInfo 对象的对象对象。

消息上下文中的属性也具有范围。范围决定了在消息处理链中可以访问属性的位置。

属性值

消息上下文中的属性有作用域。属性可以位于以下范围之一：

应用: 属性称为 APPLICATION，可用于 JAX-WS 处理程序实施、消费者实施代码和服务提供商实施代码。如果处理程序需要将属性传递给服务提供商实施，它会将属性的作用域设置为 APPLICATION。从使用者实施或服务提供商实施上下文设置的所有属性都会作为 APPLICATION 自动限定。
HANDLER: 属性称为 HANDLER 仅适用于 JAX-WS 处理程序。默认情况下，处理程序实施存储在消息上下文中的属性被限定为 HANDLER。

您可以使用消息上下文的 setScope （） 方法来更改属性的范围。例 42.1 “The MessageContext.setScope() Method” 显示方法的签名。

例 42.1. The MessageContext.setScope() Method

setScopeStringkeyMessageContext.Scopescopejava.lang.IllegalArgumentException

第一个参数指定属性的密钥。第二个参数指定属性的新范围。范围可以是：

MessageContext.Scope.APPLICATION
MessageContext.Scope.HANDLER

处理程序中的上下文概述

实施 JAX-WS Handler 接口的类可以直接访问消息的上下文信息。消息的上下文信息将传递到 Handler 实施的 handleMessage （）、handleFault （） 和 close （） 方法。

处理程序实施能够访问消息上下文中存储的所有属性，无论其范围如何。另外，逻辑处理程序使用专用的消息上下文，称为 LogicalMessageContext。LogicalMessageContext 对象具有访问消息正文内容的方法。

服务实现中的上下文概述

服务实施可作为来自消息上下文 的应用 访问属性。服务提供商的实施对象通过 WebServiceContext 对象访问消息上下文。

更多信息请参阅第 42.2 节 “在服务实现中使用上下文”。

用户实施中的上下文概述

消费者实施可以间接访问消息上下文的内容。使用者实施有两个不同的消息上下文：

请求上下文 - 保存用于传出请求的属性副本
响应上下文 - 包含来自传入响应的属性副本

分配层会传输消费者实施的消息上下文和处理程序实施所使用的消息上下文之间的属性。

从消费者实施传递请求到分配层时，请求上下文的内容将复制到由分配层使用的消息上下文中。从服务返回响应时，分配层会处理消息，并将适当的属性设置为其消息上下文。在分配层处理响应后，它会将所有属性范围作为 APPLICATION 复制到消费者实施的响应上下文。

更多信息请参阅第 42.3 节 “在消费者实现中使用上下文”。

42.2. 在服务实现中使用上下文

概述

使用 WebServiceContext 接口的服务实施提供了上下文信息。从 WebServiceContext 对象，您可以获取一个 MessageContext 对象，该对象使用应用程序范围内当前请求的上下文属性填充。您可以操作属性的值，它们通过响应链来回送。

注意

MessageContext 接口从 java.util.Map 接口继承。其内容可以使用 Map 接口的方法来操作。

获取上下文

要在服务实现中获取消息上下文，请执行以下操作：

声明类型为 WebServiceContext 的变量。
使用 javax.annotation.Resource 注解声明变量，以指示上下文信息注入变量中。
使用 get MessageContext （） 方法从 WebServiceContext 对象获取 MessageContext 对象。
重要
getMessageContext （） 只能在通过 @WebMethod 注释进行解码的方法中使用。

例 42.2 “在服务实现中获取上下文对象” 显示获取上下文对象的代码。

例 42.2. 在服务实现中获取上下文对象

import javax.xml.ws.*;
import javax.xml.ws.handler.*;
import javax.annotation.*;

@WebServiceProvider
public class WidgetServiceImpl
{
  @Resource
  WebServiceContext wsc;

  @WebMethod
  public String getColor(String itemNum)
  {
    MessageContext context = wsc.getMessageContext();
  }

  ...
}

从上下文读取属性

获取用于实现的 MessageContext 对象后，您可以使用例 42.3 “The MessageContext.get() Method” 中显示的 get （） 方法访问存储的属性。

例 42.3. The MessageContext.get() Method

vgetObjectkey

注意

这个 get （） 从 Map 接口继承。

key 参数是代表您要从上下文检索的属性的字符串。get （） 返回必须广播到属性的正确类型的对象。表 42.1 “服务实施上下文中可用的属性” 列出服务实施上下文中可用的很多属性。

重要

更改从上下文返回的对象值也会更改上下文中属性的值。

例 42.4 “从服务的消息上下文获取属性” 显示获取代表调用操作的 WSDL 操作 元素的名称的代码。

例 42.4. 从服务的消息上下文获取属性

import javax.xml.ws.handler.MessageContext;
import org.apache.cxf.message.Message;

  ...
  // MessageContext context retrieved in a previous example
  QName wsdl_operation = (QName)context.get(Message.WSDL_OPERATION);

在上下文中设置属性

获取用于实现的 MessageContext 对象后，您可以使用例 42.5 “The MessageContext.put() Method” 中显示的 put （） 方法设置属性并更改现有属性。

例 42.5. The MessageContext.put() Method

v将K键VvalueClassCastExceptionIllegalArgumentExceptionNullPointerException

如果在消息上下文中已存在要设置的属性，put （） 方法将现有的值替换为新值，并返回旧值。如果消息上下文中不存在属性，则 put （） 方法设置属性并返回 null。

例 42.6 “在服务的消息上下文中设置 Property” 显示用于为 HTTP 请求设置响应代码的代码。

例 42.6. 在服务的消息上下文中设置 Property

import javax.xml.ws.handler.MessageContext;
import org.apache.cxf.message.Message;

  ...
  // MessageContext context retrieved in a previous example
  context.put(Message.RESPONSE_CODE, new Integer(404));

支持的上下文

表 42.1 “服务实施上下文中可用的属性” 列出可通过服务实施对象中的上下文访问的属性。

表 42.1. 服务实施上下文中可用的属性
属性名称	描述
`org.apache.cxf.message.Message`
PROTOCOL_HEADERS^[a]	指定特定于传输的标头信息。该值保存为 `java.util.Map<String, List<String>`。
RESPONSE_CODE	指定返回到使用者的响应代码。该值保存为 `Integer` 对象。
ENDPOINT_ADDRESS	指定服务提供程序的地址。该值保存为 `String`。
HTTP_REQUEST_METHOD	指定通过请求发送的 HTTP 动词。该值保存为 `String`。
PATH_INFO	指定请求的资源的路径。该值保存为 `String`。该路径是主机名之后的 URI 部分，在任何查询字符串之前。例如，如果端点的 URI 是 http://cxf.apache.org/demo/widgets，则路径为 `/demo/widgets`。
QUERY_STRING	指定查询（若有）附加到用于调用请求的 URI。该值保存为 `String`。查询在 URI 的末尾出现在 `?` 后面。例如，如果向 http://cxf.apache.org/demo/widgets?color 发出了查询的请求是 `颜色`。
MTOM_ENABLED	指定服务供应商是否可以将 MTOM 用于 SOAP 附加。该值保存为 `布尔值`。
SCHEMA_VALIDATION_ENABLED	指定服务提供商是否针对 schema 验证消息。该值保存为 `布尔值`。
FAULT_STACKTRACE_ENABLED	指定运行时是否提供堆栈追踪以及出错信息。该值保存为 `布尔值`。
CONTENT_TYPE	指定消息的 MIME 类型。该值保存为 `String`。
BASE_PATH	指定请求的资源的路径。该值保存为 `java.net.URL`。该路径是主机名之后的 URI 部分，在任何查询字符串之前。例如，如果端点的 URL 是 http://cxf.apache.org/demo/widgets 基础路径为 `/demo/widgets`。
编码	指定消息的编码。该值保存为 `String`。
FIXED_PARAMETER_ORDER	指定参数是否必须以特定顺序显示。该值保存为 `布尔值`。
MAINTAIN_SESSION	指定消费者是否希望为将来的请求维护当前会话。该值保存为 `布尔值`。
WSDL_DESCRIPTION	指定定义所实施服务的 WSDL 文档。该值保存为 `org.xml.sax.InputSource` 对象。
WSDL_SERVICE	指定定义正在实施服务的 `wsdl:service` 元素的合格名称。该值保存为 `QName`。
WSDL_PORT	指定定义用于访问服务的端点的 `wsdl:port` 元素的限定名称。该值保存为 `QName`。
WSDL_INTERFACE	指定定义正在实施服务的 `wsdl:portType` 元素的限定名称。该值保存为 `QName`。
WSDL_OPERATION	指定 `wsdl:operation` 元素的合格名称，对应于使用者调用的操作。该值保存为 `QName`。
`javax.xml.ws.handler.MessageContext`
MESSAGE_OUTBOUND_PROPERTY	指定消息是否出站。该值保存为 `布尔值`。`true` 指定消息是出站。
INBOUND_MESSAGE_ATTACHMENTS	包含请求消息中包含的任何附件。该值保存为 `java.util.Map<String, DataHandler>`。映射的键值是标头的 MIME Content-ID。
OUTBOUND_MESSAGE_ATTACHMENTS	包含响应消息的任何附件。该值保存为 `java.util.Map<String, DataHandler>`。映射的键值是标头的 MIME Content-ID。
WSDL_DESCRIPTION	指定定义所实施服务的 WSDL 文档。该值保存为 `org.xml.sax.InputSource` 对象。
WSDL_SERVICE	指定定义正在实施服务的 `wsdl:service` 元素的合格名称。该值保存为 `QName`。
WSDL_PORT	指定定义用于访问服务的端点的 `wsdl:port` 元素的限定名称。该值保存为 `QName`。
WSDL_INTERFACE	指定定义正在实施服务的 `wsdl:portType` 元素的限定名称。该值保存为 `QName`。
WSDL_OPERATION	指定 `wsdl:operation` 元素的合格名称，对应于使用者调用的操作。该值保存为 `QName`。
HTTP_RESPONSE_CODE	指定返回到使用者的响应代码。该值保存为 `Integer` 对象。
HTTP_REQUEST_HEADERS	指定请求的 HTTP 标头。该值保存为 `java.util.Map<String, List<String>`。
HTTP_RESPONSE_HEADERS	指定响应的 HTTP 标头。该值保存为 `java.util.Map<String, List<String>`。
HTTP_REQUEST_METHOD	指定通过请求发送的 HTTP 动词。该值保存为 `String`。
SERVLET_REQUEST	包含 servlet 的请求对象。该值保存为 `javax.servlet.http.HttpServletRequest`。
SERVLET_RESPONSE	包含 servlet 的响应对象。该值保存为 `javax.servlet.http.HttpResponse`。
SERVLET_CONTEXT	包含 servlet 的上下文对象。该值保存为 `javax.servlet.ServletContext`。
PATH_INFO	指定请求的资源的路径。该值保存为 `String`。该路径是主机名之后的 URI 部分，在任何查询字符串之前。例如，如果端点的 URL 是 http://cxf.apache.org/demo/widgets 路径为 `/demo/widgets`。
QUERY_STRING	指定查询（若有）附加到用于调用请求的 URI。该值保存为 `String`。查询在 URI 的末尾出现在 `?` 后面。例如，如果向 http://cxf.apache.org/demo/widgets?color 发出查询字符串的请求为 `颜色`。
REFERENCE_PARAMETERS	指定 WS-Addressing 参考参数。这包括其 `wsa:IsReference` eter 属性设为 `true` 的所有 SOAP 标头。该值保存为 `java.util.List`。
`org.apache.cxf.transport.jms.JMSConstants`
JMS_SERVER_HEADERS	包含 JMS 消息标头。更多信息请参阅第 42.4 节 “使用 JMS 消息属性”。
^[a] 使用 HTTP 此属性时，与标准 JAX-WS 定义的属性相同。

42.3. 在消费者实现中使用上下文

概述

消费者实施可以通过 BindingProvider 接口访问上下文信息。BindingProvider 实例在两个独立上下文中保存上下文信息：

请求上下文 请求上下文 允许您设置影响出站消息的属性。请求上下文属性应用到特定的端口实例，一旦设置，属性将影响端口上进行的每个后续操作调用，直到明确清除了属性等时间。例如，您可以使用请求上下文属性来设置连接超时，或者初始化在标头中发送的数据。
响应上下文 响应上下文 允许您读取对从当前线程发出的最后一个操作调用的响应设置的属性值。响应上下文属性会在每个操作调用后重置。例如，您可以访问响应上下文属性来读取从最后入站消息接收的标头信息。

重要

只有放置在消息上下文的应用范围内的信息才可以被消费者实施访问。

获取上下文

使用 javax.xml.ws.BindingProvider 接口获取上下文。BindingProvider 接口有两种方法来获取上下文：

getRequestContext() getRequestContext （） 方法（如例 42.7 “getRequestContext （） 方法” 所示）将请求上下文返回为 Map 对象。返回的 map 对象可以直接操作上下文的内容。
例 42.7. getRequestContext （） 方法
Map<String, Object>getRequestContext
getResponseContext() getResponseContext （） （如例 42.8 “getResponseContext （） 方法” 所示）将响应上下文返回为 Map 对象。返回的 Map 对象的内容反映了响应上下文内容（来自当前线程中提出的远程服务最近一次成功请求）的状态。
例 42.8. getResponseContext （） 方法
map<String, Object&gt;getResponseContext

由于代理对象实施 BindingProvider 接口，因此可通过多播代理对象来获取 BindingProvider 对象。从 BindingProvider 对象获取的上下文仅对用于创建它的代理对象上调用的操作才有效。

例 42.9 “获取消费者的 Request 上下文” 显示为代理获取请求上下文的代码。

例 42.9. 获取消费者的 Request 上下文

// Proxy widgetProxy obtained previously
BindingProvider bp = (BindingProvider)widgetProxy;
Map<String, Object> requestContext = bp.getRequestContext();

从上下文读取属性

消费者上下文存储在 java.util.Map<String, Object> 对象中。映射具有包含任意对象的 String 对象和值的键。使用 java.util.Map.get （） 访问响应上下文属性映射中的条目。

要检索特定上下文属性，请 context PropertyName，使用例 42.10 “阅读 Response Context Property” 中显示的代码。

例 42.10. 阅读 Response Context Property

// Invoke an operation.
port.SomeOperation();

// Read response context property.
java.util.Map<String, Object> responseContext =
  ((javax.xml.ws.BindingProvider)port).getResponseContext();
PropertyType propValue = (PropertyType) responseContext.get(ContextPropertyName);

在上下文中设置属性

使用者上下文是存储在 java.util.Map<String、Object > 对象中的哈希上下文。映射具有任意对象的 String 对象和值的键。要在上下文中设置属性，请使用 java.util.Map.put （） 方法。

虽然您可以在请求上下文和响应上下文中设置属性，但只有对请求上下文进行的更改对消息处理产生任何影响。当每个远程调用在当前线程上完成时，会重置响应上下文中的属性。

例 42.11 “设置 Request Context Property” 中显示的代码通过设置 BindingProvider.ENDPOINT_ADDRESS_PROPERTY 的值来更改目标服务提供商的地址。

例 42.11. 设置 Request Context Property

// Set request context property.
java.util.Map<String, Object> requestContext =
     ((javax.xml.ws.BindingProvider)port).getRequestContext();
requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "http://localhost:8080/widgets");

// Invoke an operation.
port.SomeOperation();

重要

在请求上下文中设置了一个属性后，其值将用于所有后续远程调用。您可以更改值，然后将使用 changed 值。

支持的上下文

Apache CXF 在消费者实现中支持以下上下文属性：

表 42.2. 使用者上下文属性
属性名称	描述
`javax.xml.ws.BindingProvider`
ENDPOINT_ADDRESS_PROPERTY	指定目标服务的地址。该值保存为 `String`。
USERNAME_PROPERTY^[a]	指定用于 HTTP 基本身份验证的用户名。该值保存为 `String`。
PASSWORD_PROPERTY^[b]	指定用于 HTTP 基本身份验证的密码。该值保存为 `String`。
SESSION_MAINTAIN_PROPERTY^[c]	指定客户端是否希望维护会话信息。该值保存为 `布尔值` 对象。
`org.apache.cxf.ws.addressing.JAXWSAConstants`
CLIENT_ADDRESSING_PROPERTIES	指定使用者用来联系所需服务提供商的 WS-Addressing 信息。该值保存为 `org.apache.cxf.ws.addressing.AddressingProperties`。
`org.apache.cxf.transports.jms.context.JMSConstants`
JMS_CLIENT_REQUEST_HEADERS	包含消息的 JMS 标头。更多信息请参阅第 42.4 节 “使用 JMS 消息属性”。
^[a] 此属性会被 HTTP 安全设置中定义的用户名覆盖。 ^[b] 此属性会被 HTTP 安全设置中定义的密码覆盖。 ^[c] Apache CXF 忽略此属性。

42.4. 使用 JMS 消息属性

摘要

Apache CXF JMS 传输具有一个上下文机制，可用于检查 JMS 消息的属性。上下文机制也可用于设置 JMS 消息的属性。

42.4.1. 检查 JMS 消息标头

摘要

使用者和服务使用不同的上下文机制来访问 JMS 消息标头属性。但是，这两种机制都将标头属性作为 org.apache.cxf.transports.jms.context.JMSMessageHeadersType 对象返回。

在服务中获取 JMS 消息标头

要从 WebServiceContext 对象获取 JMS 消息标头属性，请执行以下操作：

获取 “获取上下文”一节中描述的上下文。
使用消息上下文的 get （） 方法和参数 org.apache.cxf.transports.jms.JMSConstants.JMS_SERVER_HEADERS 获取消息标题。

例 42.12 “在服务实现中获取 JMS 消息标头” 显示从服务的消息上下文获取 JMS 消息标头的代码：

例 42.12. 在服务实现中获取 JMS 消息标头

import org.apache.cxf.transport.jms.JMSConstants;
import org.apache.cxf.transports.jms.context.JMSMessageHeadersType;

@WebService(serviceName = "HelloWorldService",
                           portName = "HelloWorldPort",
                           endpointInterface = "org.apache.cxf.hello_world_jms.HelloWorldPortType",
                           targetNamespace = "http://cxf.apache.org/hello_world_jms")
  public class GreeterImplTwoWayJMS implements HelloWorldPortType
  {
    @Resource
    protected WebServiceContext wsContext;
    ...

    @WebMethod
    public String greetMe(String me)
    {
      MessageContext mc = wsContext.getMessageContext();
      JMSMessageHeadersType headers = (JMSMessageHeadersType) mc.get(JMSConstants.JMS_SERVER_HEADERS);
       ...
     }
      ...
}

在消费者中获取 JMS 消息标头属性

从 JMS 传输成功检索了消息后，您可以使用消费者的响应上下文检查 JMS 标头属性。另外，您可以设置或检查客户端在超时前等待响应的时间，如 “客户端接收超时”一节所述。从消费者的响应上下文获取 JMS 消息标头，请执行以下操作：

获取响应上下文，如 “获取上下文”一节所述。
使用上下文的 get （） 方法和 org.apache.cxf.transports.jms.JMSConstants.JMS_CLIENT_RESPONSE_HEADERS 获取 JMS 消息标头属性。

例 42.13 “从 Consumer Response 标头获取 JMS 标头” 显示从消费者的响应上下文获取 JMS 消息标头属性的代码。

例 42.13. 从 Consumer Response 标头获取 JMS 标头

import org.apache.cxf.transports.jms.context.*;
// Proxy greeter initialized previously
BindingProvider  bp = (BindingProvider)greeter;
Map<String, Object> responseContext = bp.getResponseContext();
JMSMessageHeadersType responseHdr = (JMSMessageHeadersType)
                           responseContext.get(JMSConstants.JMS_CLIENT_RESPONSE_HEADERS);
...
}

例 42.13 “从 Consumer Response 标头获取 JMS 标头” 中的代码执行以下操作：

将代理广播到 BindingProvider。

获取响应上下文。

从响应上下文检索 JMS 消息标头。

42.4.2. 检查消息标头属性

标准 JMS 标头属性

表 42.3 “JMS 标头属性” 列出 JMS 标头中您可以检查的标准属性。

表 42.3. JMS 标头属性
属性名称	属性类型	getter Method
关联 ID	`字符串`	`getJMSCorralationID()`
交付模式	`int`	`getJMSDeliveryMode()`
消息过期	`long`	`getJMSExpiration()`
消息 ID	`字符串`	`getJMSMessageID()`
优先级	`int`	`getJMSPriority()`
redelivered	`布尔值`	`getJMSRedlivered()`
时间时间戳	`long`	`getJMSTimeStamp()`
类型	`字符串`	`getJMSType()`
生存时间	`long`	`getTimeToLive()`

可选标题属性

另外，您可以使用 JMSMessageHeadersType.getProperty （） 检查 JMS 标头中存储的任何可选属性。可选属性返回为 org.apache.cxf.transports.jms.context.JMSPropertyType 的列表。可选属性存储为名称/值对。

示例

例 42.14 “读取 JMS 标头属性” 显示使用响应上下文检查一些 JMS 属性的代码。

例 42.14. 读取 JMS 标头属性

// JMSMessageHeadersType messageHdr retrieved previously
System.out.println("Correlation ID: "+messageHdr.getJMSCorrelationID());
System.out.println("Message Priority: "+messageHdr.getJMSPriority());
System.out.println("Redelivered: "+messageHdr.getRedelivered());

JMSPropertyType prop = null;
List<JMSPropertyType> optProps = messageHdr.getProperty();
Iterator<JMSPropertyType> iter = optProps.iterator();
while (iter.hasNext())
{
  prop = iter.next();
   System.out.println("Property name: "+prop.getName());
   System.out.println("Property value: "+prop.getValue());
}

例 42.14 “读取 JMS 标头属性” 中的代码执行以下操作：

显示消息的关联 ID 的值。

打印消息优先级属性的值。

打印消息的 redelivered 属性的值。

获取消息的可选标头属性列表。

获取 迭代 属性列表。

迭代可选属性列表并打印其名称和值。

42.4.3. 设置 JMS 属性

摘要

使用使用者端点中的请求上下文，您可以设置多个 JMS 消息标头属性和消费者端点的超时值。这些属性可用于单一调用。每次调用服务代理时都必须重置它们。

请注意，您无法在服务中设置标头属性。

JMS 标头属性

表 42.4 “table JMS 标头属性” 列出 JMS 标头中使用消费者端点的请求上下文设置的属性。

表 42.4. table JMS 标头属性
属性名称	属性类型	设置方法
关联 ID	`字符串`	`setJMSCorralationID()`
交付模式	`int`	`setJMSDeliveryMode()`
优先级	`int`	`setJMSPriority()`
生存时间	`long`	`setTimeToLive()`

设置这些属性请执行以下操作：

创建 org.apache.cxf.transports.jms.context.JMSMessageHeadersType 对象。
使用表 42.4 “table JMS 标头属性” 中描述的适当设置方法填充您要设置的值。
通过将 org.apache.cxf.transports.jms.JMSConstants.JMS_CLIENT_REQUEST_HEADERS 调用请求上下文，并将新的 JMSMessageHeadersType 对象用作第二个参数，将值设置为请求上下文。

可选 JMS 标头属性

您还可以将可选属性设置为 JMS 标头。可选的 JMS 标头属性存储在用于设置其他 JMS 标头属性的 JMSMessageHeadersType 对象中。它们存储为包含 org.apache.cxf.transports.jms.context.JMSPropertyType 对象的 List 对象。要在 JMS 标头中添加可选属性，请执行以下操作：

创建 JMSPropertyType 对象。
使用 setName （） 设置属性的 name 字段。
使用 setValue （） 设置属性的 value 字段。
使用 JMSMessageHeadersType.getProperty （）.add (JMSPropertyType)，将属性添加到 JMS 消息标头中。
重复这个过程，直到所有属性都添加到邮件标头中。

客户端接收超时

除了 JMS 标头属性外，您还可以设置消费者端点在超时前等待响应的时间。您可以通过使用 org.apache.cxf.transports.jms.JMSConstants.JMS_CLIENT_RECEIVE_TIMEOUT 调用请求上下文的 put （） 方法以毫秒为单位来设置值。

示例

例 42.15 “使用 Request 上下文设置 JMS 属性” 显示使用请求上下文设置某些 JMS 属性的代码。

例 42.15. 使用 Request 上下文设置 JMS 属性

import org.apache.cxf.transports.jms.context.*;
 // Proxy greeter initialized previously
InvocationHandler handler = Proxy.getInvocationHandler(greeter);

BindingProvider bp= null;
if (handler instanceof BindingProvider)
{
  bp = (BindingProvider)handler;
  Map<String, Object> requestContext = bp.getRequestContext();

  JMSMessageHeadersType requestHdr = new JMSMessageHeadersType();
  requestHdr.setJMSCorrelationID("WithBob");
  requestHdr.setJMSExpiration(3600000L);


  JMSPropertyType prop = new JMSPropertyType;
  prop.setName("MyProperty");
  prop.setValue("Bluebird");
  requestHdr.getProperty().add(prop);

  requestContext.put(JMSConstants.CLIENT_REQUEST_HEADERS, requestHdr);

  requestContext.put(JMSConstants.CLIENT_RECEIVE_TIMEOUT, new Long(1000));
}

例 42.15 “使用 Request 上下文设置 JMS 属性” 中的代码执行以下操作：

获取用于其 JMS 属性更改的代理的 InvocationHandler。

检查 InvocationHandler 是否为 BindingProvider。

将返回的 InvocationHandler 对象转换为 BindingProvider 对象，以检索请求上下文。

获取请求上下文。

创建一个 JMSMessageHeadersType 对象来保存新的消息标头值。

设置正确 ID。

将 Expiration 属性设为 60 分钟。

创建新的 JMSPropertyType 对象。

设置可选属性的值。

将可选属性添加到消息标头中。

将 JMS 消息标头值设置为请求上下文。

将客户端接收超时属性设置为 1 秒。

第 43 章编写处理程序

摘要

JAX-WS 提供了一个灵活的插件框架，用于向应用程序添加消息处理模块。这些模块称为处理程序，它们独立于应用程序级代码，可以提供低级别的消息处理功能。

43.1. 处理程序：简介

概述

当服务代理在服务上调用操作时，操作的参数将传递到 Apache CXF，其中将其内置于消息并置于线路上。服务收到消息后，Apache CXF 从线上读取消息，重新创建消息，然后将操作参数传递给负责实施操作的应用代码。当应用程序代码完成此请求时，回复消息在其计划上与请求的服务代理类似的事件链。这显示在图 43.1 “消息交换路径” 中。

图 43.1. 消息交换路径

JAX-WS 定义了用于操作应用程序级别代码和网络之间的消息数据的机制。例如，您可能希望通过开放网络传递的消息数据使用专有加密机制加密。您可以编写加密并解密数据的 JAX-WS 处理程序。然后，您可以将处理程序插入到所有客户端和服务器的消息处理链中。

如图 43.2 “带有处理程序的消息交换路径” 所示，处理程序放置在一个链中，它遍历应用程序级代码和将消息传送到网络的传输代码。

图 43.2. 带有处理程序的消息交换路径

处理程序类型

JAX-WS 规范定义了两种基本处理程序类型：

逻辑处理程序逻辑处理程序可以处理消息有效负载，以及消息上下文中存储的属性。例如，如果应用使用纯 XML 消息，则逻辑处理程序有权访问整个消息。如果应用程序使用 SOAP 消息，则逻辑处理程序有权访问 SOAP 正文的内容。它们不能访问 SOAP 标头或任何附件，除非它们被置于邮件上下文中。
逻辑处理程序接近于处理程序链上的应用程序代码。这意味着，当消息从应用程序代码传递给传输时，会首先执行这些消息。从网络收到消息并返回到应用代码时，将最后一次执行逻辑处理程序。
协议处理程序协议处理程序可以处理从网络接收的所有消息，以及消息上下文中存储的属性。例如，如果应用程序使用 SOAP 消息，协议处理程序可以访问 SOAP 正文、SOAP 标头和任何附件。
协议处理程序接近处理程序链上的传输。这意味着，当从网络收到消息时，会首先执行它们。当消息从应用程序代码发送到网络时，协议处理程序会最后一次执行。
注意
Apache CXF 支持的唯一协议处理器特定于 SOAP。

处理程序的实现

两种处理程序类型之间的区别非常微，它们共享了一个通用基本接口。由于它们常用的父项，逻辑处理程序和协议处理程序共享必须实施的多个方法，包括：

handleMessage() handleMessage （） 方法是任何处理器中的中央方法。它是负责处理普通消息的方法。
handleFault() handleFault （） 是负责处理错误消息的方法。
close() 当消息到达链的末尾时，会在处理程序链中调用 close （）。它用于清理消息处理过程中消耗的所有资源。

逻辑处理器的实现和协议处理器的实现之间的区别如下：

实施的特定接口
所有处理程序实施从 Handler 接口派生的接口。逻辑处理程序实施逻辑处理程序接口。协议处理程序实施 Handler 接口协议特定的扩展。例如，SOAP 处理程序实施 SOAPHandler 接口。
处理程序可用信息量
协议处理程序可以访问消息的内容以及与消息内容打包的所有协议特定信息。逻辑处理程序只能访问消息的内容。逻辑处理程序没有了解协议详情。

将处理程序添加到应用程序

要在应用程序中添加处理器，您必须执行以下操作：

确定处理程序是否在服务提供商、消费者或两者上使用。
确定哪个类型的处理程序是最适合该作业的处理器。
实施正确的接口。
要实现逻辑处理器，请查看第 43.2 节 “实施逻辑处理程序”。
要实现协议处理器，请查看第 43.4 节 “实施协议处理程序”。
将您的端点配置为使用处理程序。请参阅第 43.10 节 “配置端点以使用处理程序”。

43.2. 实施逻辑处理程序

概述

逻辑处理程序实施 javax.xml.ws.handler.LogicalHandler 接口。LogicalHandler 接口显示在例 43.1 “LogicalHandler Synopsis” 中，将 LogicalMessageContext 对象传递给 handleMessage （） 方法和 handleFault （） 方法。上下文对象提供对 消息正文 的访问，以及设置为消息交换上下文的任何属性。

例 43.1. LogicalHandler Synopsis

public interface LogicalHandler extends Handler
{
  boolean handleMessage(LogicalMessageContext context);
  boolean handleFault(LogicalMessageContext context);
  void close(LogicalMessageContext context);
}

流程

要实现实现的逻辑手动操作，请执行以下操作：

实施处理程序所需的任何第 43.6 节 “初始化处理程序” 逻辑。
实施第 43.3 节 “在逻辑处理程序中处理消息” 逻辑。
实施第 43.7 节 “处理容错消息” 逻辑。
在结束时为第 43.8 节 “关闭处理程序” 实施处理程序的逻辑。
在销毁前，为第 43.9 节 “发布处理程序” 处理程序的资源实施任何逻辑。

43.3. 在逻辑处理程序中处理消息

概述

普通消息处理由 handleMessage （） 方法处理。

handleMessage （） 方法收到 LogicalMessageContext 对象，它提供对消息正文的访问和消息上下文中存储的任何属性。

根据消息处理方式，handleMessage （） 方法返回 true 或 false。它还可能会抛出异常。

获取消息数据

传递到逻辑消息处理程序的 LogicalMessageContext 对象允许使用上下文的 getMessage （） 方法访问消息正文。getMessage （） 方法（如例 43.2 “在逻辑处理程序中获得消息 Payload 的方法” ）将消息有效负载返回为 LogicalMessage 对象。

例 43.2. 在逻辑处理程序中获得消息 Payload 的方法

LogicalMessagegetMessage

具有 LogicalMessage 对象后，就可以使用它来操作消息正文。LogicalMessage 接口显示在例 43.3 “逻辑消息冻结” 中，具有用于实际消息正文的 getters 和 setters。

例 43.3. 逻辑消息冻结

LogicalMessageSourcegetPayloadObjectgetPayloadJAXBContext上下文setPayloadObjectpayloadJAXBContext上下文setPayloadSourcepayload

重要

消息有效负载的内容由使用中的绑定类型决定。SOAP 绑定只允许访问消息的 SOAP 正文。XML 绑定允许访问整个邮件正文。

将消息正文用作 XML 对象

其中一个对 getters 和 setter of the logical message of the message payload 一起用于 javax.xml.transform.dom.DOMSource 对象。

没有参数的 getPayload （） 方法将消息有效负载返回为 DOMSource 对象。返回的对象是实际消息有效负载。对返回对象所做的任何更改都会立即更改消息正文。

您可以使用采用单一 Source 对象的 setPayload （） 方法将消息的正文替换为 DOMSource 对象。

将消息正文用作 JAXB 对象

其他对 getters 和 setters 允许您将消息有效负载用作 JAXB 对象。它们使用 JAXBContext 对象将消息有效负载转换为 JAXB 对象。

要使用 JAXB 对象，请执行以下操作：

获取一个可在消息正文中管理数据类型的 JAXBContext 对象。
有关创建 JAXBContext 对象的详情，请参考第 39 章 使用 A JAXBContext 对象。
获取消息正文，如例 43.4 “获取消息正文作为 JAXB 对象” 所示。
例 43.4. 获取消息正文作为 JAXB 对象
```
JAXBContext jaxbc = JAXBContext(myObjectFactory.class);
Object body = message.getPayload(jaxbc);
```
将返回的对象转换为正确的类型。
根据需要操作消息正文。
将更新的消息正文重新置于上下文中，如例 43.5 “使用 JAXB 对象更新消息正文” 所示。
例 43.5. 使用 JAXB 对象更新消息正文
```
message.setPayload(body, jaxbc);
```

使用上下文属性

传递到逻辑处理程序的逻辑消息上下文是应用消息上下文的实例，并可访问其中存储的所有属性。处理程序可以访问 APPLICATION 范围和 HANDLER 范围中的属性。

与应用的消息上下文一样，逻辑消息上下文是 Java map 的子类。若要访问上下文中存储的属性，您可以使用 get （） 方法和从 Map 接口继承的 put （） 方法。

默认情况下，您在逻辑处理程序内在消息上下文中设置的任何属性都会被分配为 HANDLER 范围。如果您希望应用程序代码能够访问所需的属性，您需要使用上下文的 setScope （） 方法显式将属性的范围设置为 APPLICATION。

有关在消息上下文中使用属性的更多信息，请参阅第 42.1 节 “了解上下文”。

确定消息的方向

知道消息通过处理程序链的方向通常非常重要。例如，您要从传入请求检索安全令牌，并将安全令牌附加到传出响应。

消息的方向存储在消息上下文的出站消息属性中。您可以使用 MessageContext.MESSAGE_OUTBOUND_PROPERTY 键从消息上下文检索出站消息属性，如例 43.6 “从 SOAP 消息上下文获取消息的方向” 所示。

例 43.6. 从 SOAP 消息上下文获取消息的方向

Boolean outbound;
outbound = (Boolean)smc.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);

该属性存储为 布尔值 对象。您可以使用对象的 booleanValue （） 方法来确定属性的值。如果属性设为 true，则消息是出站。如果属性设为 false，则消息为入站。

确定返回值

handleMessage （） 方法完成其消息处理对消息处理方式具有直接影响。它可以通过以下操作之一完成：

返回 true-Returning true 信号到消息处理应继续的 Apache CXF 运行时。下一个处理程序（若有）已调用了其 handleMessage （）。
将 false-Returning false 信号返回到普通消息处理必须停止的 Apache CXF 运行时。运行时的执行方式取决于用于 当前消息 的消息交换模式。
对于请求响应的消息会交换以下情况：
1. 消息处理的方向将被逆向。
  例如，如果某个请求由服务提供商处理，消息将停止提升到服务的实施对象。相反，它会被发回给该绑定，以返回源自请求的使用者。
2. 在新的处理方向中驻留在处理程序链的任何消息处理程序都会以它们驻留在链中的顺序调用其 handleMessage （） 方法。
3. 当消息到达处理程序链的末尾时，它将被分配。
  对于单向消息交换以下情况：
4. 消息处理将停止。
5. 所有之前调用的消息处理程序都具有其 close （） 方法调用。
6. 邮件被发送。
引发协议Exception 异常异常或此异常的子类，以信号开始消息处理的 Apache CXF 运行时。运行时的执行方式取决于用于 当前消息 的消息交换模式。
对于请求响应的消息会交换以下情况：
1. 如果处理程序尚未创建错误消息，则运行时会将消息嵌套在容错消息中。
2. 消息处理的方向将被逆向。
  例如，如果某个请求由服务提供商处理，消息将停止提升到服务的实施对象。相反，它会被发回给该绑定，以返回源自请求的使用者。
3. 在新的处理方向中驻留在处理程序链的任何消息处理程序都会以它们驻留在链中的顺序调用其 handleFault （） 方法。
4. 当故障消息到达处理程序链的末尾时，它将被分配。
  对于单向消息交换以下情况：
5. 如果处理程序尚未创建错误消息，则运行时会将消息嵌套在容错消息中。
6. 消息处理将停止。
7. 所有之前调用的消息处理程序都具有其 close （） 方法调用。
8. 将发送错误信息。
抛出任何其他运行时异常 - 除 ProtocolException 以外的运行时异常会信号消息处理是停止的 Apache CXF 运行时。所有之前调用的消息处理程序都有调用 close （） 方法，并且发送异常。如果消息是请求响应的消息交换的一部分，则发送异常，使其返回到源自请求的消费者。

示例

例 43.7 “逻辑消息处理程序消息处理” 为服务消费者使用的逻辑消息处理程序显示 handleMessage （） 消息的实现。在向服务提供商发送请求前，它会处理请求。

例 43.7. 逻辑消息处理程序消息处理

public class SmallNumberHandler implements LogicalHandler<LogicalMessageContext>
{
    public final boolean handleMessage(LogicalMessageContext messageContext)
    {
        try
        {
            boolean outbound = (Boolean)messageContext.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);

            if (outbound)
            {
                LogicalMessage msg = messageContext.getMessage();

                JAXBContext jaxbContext = JAXBContext.newInstance(ObjectFactory.class);
                Object payload = msg.getPayload(jaxbContext);
                if (payload instanceof JAXBElement)
                {
                    payload = ((JAXBElement)payload).getValue();
                }

                if (payload instanceof AddNumbers)
                {
                    AddNumbers req = (AddNumbers)payload;

                    int a = req.getArg0();
                    int b = req.getArg1();
                    int answer = a + b;

                    if (answer < 20)
                    {
                      AddNumbersResponse resp = new AddNumbersResponse();
                      resp.setReturn(answer);
                      msg.setPayload(new ObjectFactory().createAddNumbersResponse(resp),
                                                      jaxbContext);

                      return false;
                    }
                }
                else
                {
                   throw new WebServiceException("Bad Request");
                }
            }
            return true;
        }
        catch (JAXBException ex)
        {
            throw new ProtocolException(ex);
        }
    }
...
}

例 43.7 “逻辑消息处理程序消息处理” 中的代码执行以下操作：

检查消息是否为出站请求。

如果消息是出站请求，处理程序执行其他消息处理。

从消息上下文获取消息有效负载的 LogicalMessage 表示。

获取实际消息有效负载作为 JAXB 对象。

检查以确保请求是正确的类型。

如果是，处理程序将继续处理消息。

检查 sum 的值。

如果小于 20 的阈值，则构建响应并将其返回到客户端。

构建响应。

返回 false 以停止消息处理，并将响应返回给客户端。

如果消息不是正确的类型，则抛出运行时异常。

这个例外返回给客户端。

如果消息是入站响应，则返回 true，或者 sum 不满足阈值。

消息处理通常会继续。

如果遇到 JAXB marshalling 错误，则引发 ProtocolException。

异常在由当前处理程序和客户端之间的处理程序的 handleFault （） 方法处理后返回给客户端。

43.4. 实施协议处理程序

概述

协议处理程序特定于使用中的协议。Apache CXF 提供由 JAX-WS 指定的 SOAP 协议处理器。SOAP 协议处理程序实施 javax.xml.ws.handler.soap.SOAPHandler 接口。

SOAPHandler 接口（如例 43.8 “SOAPHandler Synopsis” 所示）使用 SOAP 特定消息上下文，作为 SOAPMessage 对象提供消息的访问。它还可让您访问 SOAP 标头。

例 43.8. SOAPHandler Synopsis

public interface SOAPHandler extends Handler
{
  boolean handleMessage(SOAPMessageContext context);
  boolean handleFault(SOAPMessageContext context);
  void close(SOAPMessageContext context);
  Set<QName> getHeaders()
}

除了使用 SOAP 特定的消息上下文外，SOAP 协议处理程序还要求您实施名为 getHeaders （） 的额外方法。这个额外的方法返回标头的 QNames，处理程序可以处理。

流程

要实现逻辑手，请执行以下操作：

实施处理程序所需的任何第 43.6 节 “初始化处理程序” 逻辑。
实施第 43.5 节 “在 SOAP 处理程序中处理消息” 逻辑。
实施第 43.7 节 “处理容错消息” 逻辑。
实施 getHeaders （） 方法。
在结束时为第 43.8 节 “关闭处理程序” 实施处理程序的逻辑。
在销毁前，为第 43.9 节 “发布处理程序” 处理程序的资源实施任何逻辑。

实现 getHeaders （）方法

getHeaders （） 在例 43.9 “The SOAPHander.getHeaders() Method” 中显示的，方法会通知 Apache CXF 运行时，SOAP 用来处理处理程序。它会返回每个 SOAP 的 outer 元素的 QNames，处理程序理解。

例 43.9. The SOAPHander.getHeaders() Method

Set<QName>getHeaders

对于很多情况，只需返回 null 即可。但是，如果应用程序使用任何 SOAP 标头的 mustUnderstand 属性，那么务必要指定应用程序 SOAP 处理程序所理解的标头。运行时会检查一组 SOAP 标头，所有注册的处理程序都知道所有已注册的处理程序对标头列表（且 mustUnderstand 属性设置为 true ）的理解。如果任何标记的标头没有包括在所理解的标头列表中，则运行时会拒绝该消息并抛出一个 SOAP 必须理解异常。

43.5. 在 SOAP 处理程序中处理消息

概述

普通消息处理由 handleMessage （） 方法处理。

handleMessage （） 方法收到 SOAPMessageContext 对象，它以 SOAPMessage 对象和与该消息关联的 SOAP 标头来提供对消息的访问。此外，上下文还提供对消息上下文中存储的任何属性的访问。

根据消息处理方式，handleMessage （） 方法返回 true 或 false。它还可能会抛出异常。

使用消息正文

您可以使用 SOAP 消息上下文的 getMessage （） 方法来获取 SOAP 消息消息。它将消息返回为实时 SOAPMessage 对象。处理程序中消息的任何更改都会自动反映到存储位置的消息中。

如果要将现有消息替换为新消息，您可以使用上下文的 setMessage （） 方法。setMessage （） 方法采用 SOAPMessage 对象。

获取 SOAP 标头

您可以使用 SOAPMessage 对象的 getHeader （） 方法访问 SOAP 消息的标头。这会将 SOAP 标头返回为 SOAPHeader 对象，您将需要检查来查找您要处理的标头元素。

SOAP 消息上下文提供 getHeaders （） 方法，如例 43.10 “The SOAPMessageContext.getHeaders() Method” 所示，这将返回一个包含指定 SOAP 标头的 JAXB 对象的数组。

例 43.10. The SOAPMessageContext.getHeaders() Method

Ojbect[]getHeadersQName标头JAXBContext上下文布尔值allRoles

您可以使用其元素的 QName 指定标头。您可以通过将 allRoles 参数设置为 false 来进一步限制返回的标头。这指示运行时只返回适用于活跃 SOAP 角色的 SOAP 标头。

如果没有找到标头，方法会返回一个空数组。

有关实例化 JAXBContext 对象的更多信息，请参阅第 39 章 使用 A JAXBContext 对象。

使用上下文属性

传递到逻辑处理程序的 SOAP 消息上下文是应用程序消息上下文的实例，可以访问其中存储的所有属性。处理程序可以访问 APPLICATION 范围和 Handler 范围中的属性。

与应用程序的消息上下文一样，SOAP 消息上下文是 Java map 的子类。若要访问上下文中存储的属性，您可以使用 get （） 方法和从 Map 接口继承的 put （） 方法。

默认情况下，您在逻辑处理程序内部设置的上下文中将分配 HANDLER 范围。如果您希望应用程序代码能够访问所需的属性，您需要使用上下文的 setScope （） 方法显式将属性的范围设置为 APPLICATION。

有关在消息上下文中使用属性的更多信息，请参阅第 42.1 节 “了解上下文”。

确定消息的方向

知道消息通过处理程序链的方向通常非常重要。例如，您要将标头添加到传出消息，并从传入消息中剥离标头。

消息的方向存储在消息上下文的出站消息属性中。您可以使用 MessageContext.MESSAGE_OUTBOUND_PROPERTY 键从消息上下文检索出站消息属性，如例 43.11 “从 SOAP 消息上下文获取消息的方向” 所示。

例 43.11. 从 SOAP 消息上下文获取消息的方向

Boolean outbound;
outbound = (Boolean)smc.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);

确定返回值

handleMessage （） 方法完成其消息处理对消息处理方式具有直接影响。它可以通过以下操作之一完成：

返回 true-Returning true 信号到消息处理应继续的 Apache CXF 运行时。下一个处理程序（若有）已调用了其 handleMessage （）。
将 false-Returning false 信号返回到普通消息处理可停止的 Apache CXF 运行时。运行时的执行方式取决于用于 当前消息 的消息交换模式。
对于请求响应的消息会交换以下情况：
1. 消息处理的方向将被逆向。
  例如，如果请求由服务提供商处理，消息将停止提升到服务的实施对象。相反，它将退回到该绑定，以返回源自请求的使用者。
2. 在新的处理方向中驻留在处理程序链的任何消息处理程序都会以它们驻留在链中的顺序调用其 handleMessage （） 方法。
3. 当消息到达处理程序链的末尾时，它将被分配。
  对于单向消息交换以下情况：
4. 消息处理将停止。
5. 所有之前调用的消息处理程序都具有其 close （） 方法调用。
6. 邮件被发送。
引发 ProtocolException 异常异常或此异常的子类，以指出消息处理是启动的 Apache CXF 运行时。运行时的执行方式取决于用于 当前消息 的消息交换模式。
对于请求响应的消息会交换以下情况：
1. 如果处理程序尚未创建错误消息，则运行时会将消息嵌套在容错消息中。
2. 消息处理的方向将被逆向。
  例如，如果请求由服务提供商处理，消息将停止提升到服务的实施对象。它将发回给该绑定，以返回源自请求的使用者。
3. 在新的处理方向中驻留在处理程序链的任何消息处理程序都会以它们驻留在链中的顺序调用其 handleFault （） 方法。
4. 当故障消息到达处理程序链的末尾时，它将被分配。
  对于单向消息交换以下情况：
5. 如果处理程序尚未创建错误消息，则运行时会将消息嵌套在容错消息中。
6. 消息处理将停止。
7. 所有之前调用的消息处理程序都具有其 close （） 方法调用。
8. 将发送错误信息。
抛出任何其他运行时异常 - 除 ProtocolException 以外的运行时异常会信号消息处理是停止的 Apache CXF 运行时。所有之前调用的消息处理程序都有调用 close （） 方法，并且发送异常。如果消息是请求响应消息交换的一部分，则发送异常，使其返回到源自此请求的消费者。

示例

例 43.12 “在 SOAP 处理程序中处理消息” 显示 handleMessage （） 实现，它将打印 SOAP 消息到屏幕。

例 43.12. 在 SOAP 处理程序中处理消息

public boolean handleMessage(SOAPMessageContext smc)
{
  PrintStream out;

  Boolean outbound = (Boolean)smc.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);

  if (outbound.booleanValue())
  {
    out.println("\nOutbound message:");
  }
  else
  {
    out.println("\nInbound message:");
  }

  SOAPMessage message = smc.getMessage();

  message.writeTo(out);
  out.println();

  return true;
}

例 43.12 “在 SOAP 处理程序中处理消息” 中的代码执行以下操作：

从消息上下文检索出站属性。

测试消息方向并输出正确的消息。

从上下文检索 SOAP 消息。

将信息打印到控制台。

43.6. 初始化处理程序

概述

当运行时创建处理程序实例时，它会创建手手需要处理消息的所有资源。虽然您可以将所有用于执行此操作的逻辑放在处理程序的构造器中，但可能不是最合适的位置。处理程序框架在实例化处理程序时执行多个可选步骤。您可以添加资源注入和其他将在可选步骤中执行的初始化逻辑。

您不必为处理程序提供任何初始化方法。

初始化顺序

Apache CXF 运行时使用以下方法初始化处理程序：

处理程序的构造器称为.
注入任何由 @Resource 注释指定的资源。
存在 @PostConstruct 注释的方法（如果存在）。
注意
使用 @PostConstruct 注释识别的方法必须具有 void return type 且没有参数。
处理程序被置于 Ready 状态。

43.7. 处理容错消息

概述

当消息处理期间引发 ProtocolException 异常时，处理程序使用 handleFault （） 方法处理错误消息。

handleFault （） 方法根据处理程序的类型接收 LogicalMessageContext 对象或 SOAPMessageContext 对象。接收的上下文为处理程序的实施提供了消息有效负载的实现。

handleFault （） 方法返回 true 或 false，具体取决于消息处理方式。它还可能会抛出异常。

获取消息有效负载

handleFault （） 方法接收的上下文对象与 handleMessage （） 方法收到的上下文对象类似。您可以使用上下文的 getMessage （） 方法以同样的方式访问消息有效负载。唯一的区别是上下文中包含的有效负载。

有关使用 LogicalMessageContext 的更多信息，请参阅第 43.3 节 “在逻辑处理程序中处理消息”。

有关使用 SOAPMessageContext 的更多信息，请参阅第 43.5 节 “在 SOAP 处理程序中处理消息”。

确定返回值

handleFault （） 方法的完成其消息处理对消息处理方式具有直接影响。它通过执行以下操作之一完成：

return true: 返回容错处理应继续正常使用的真正信号。将调用链中下一个处理程序的 handleFault （） 方法。
返回 false: 返回错误处理停止的假信号。调用在处理当前消息的处理程序的 close （） 方法会被调用，并且发送错误消息。
抛出异常: 引发异常会停止容错消息处理。调用在处理当前消息的处理程序的 close （） 方法会被调用，并且发送异常。

示例

例 43.13 “在消息处理程序中处理故障” 显示 handleFault （） 的实现，它将消息正文打印到屏幕。

例 43.13. 在消息处理程序中处理故障

public final boolean handleFault(LogicalMessageContext messageContext)
{
  System.out.println("handleFault() called with message:");

  LogicalMessage msg=messageContext.getMessage();
  System.out.println(msg.getPayload());

  return true;
}

43.8. 关闭处理程序

当处理程序链完成消息时，运行时会调用每个已执行的处理程序的 close （） 方法。这是清理处理程序在消息处理过程中使用的任何资源或将任何属性重置为默认状态的适当位置。

如果资源需要在单一消息交换之外保留，您不应在处理器的 close （） 方法中进行清理。

43.9. 发布处理程序

概述

当处理器被绑定关闭的服务或服务代理时，运行时会释放处理程序。在调用处理程序的 destructor 之前，运行时将调用可选的发行方法。此可选发行版本方法可用于释放由处理程序使用的任何资源，或执行在处理程序的销毁器中不适用的其他操作。

您不必为处理程序提供任何清理方法。

发行版本顺序

在处理程序被释放时会出现以下情况：

该处理程序完成处理任何活动消息。
运行时通过 @PreDestroy 注释调用方法 decorated。
此方法应清理由处理程序使用的任何资源。
处理程序的 destructor 称为.

43.10. 配置端点以使用处理程序

43.10.1. 程序配置

43.10.1.1. 将处理程序链添加到消费者

概述

向使用者添加处理程序链涉及明确构建处理程序链。然后，直接在服务代理的 Binding 对象中设置处理器链。

重要

使用 Spring 配置配置的任何处理器链都会覆盖配置了 programmaticaly 的处理程序链。

流程

在您可以执行以下操作的使用者中添加处理器链：

创建 List<Handler& gt; 对象来保存处理程序链。
创建将添加到该链的每个处理程序的实例。
按照运行时需要调用的顺序将每个实例化的处理程序对象添加到列表中。
从服务代理获取 Binding 对象。
Apache CXF 提供名为 org.apache.cxf.jaxws.binding.DefaultBindingImpl 的 Binding 接口的实施。
使用 Binding 对象的 setHandlerChain （） 方法，设置代理上的处理程序链。

示例

例 43.14 “将处理程序链添加到消费者” 显示将处理程序链添加到消费者的代码。

例 43.14. 将处理程序链添加到消费者

import javax.xml.ws.BindingProvider;
import javax.xml.ws.handler.Handler;
import java.util.ArrayList;
import java.util.List;

import org.apache.cxf.jaxws.binding.DefaultBindingImpl;
...
SmallNumberHandler sh = new SmallNumberHandler();
List<Handler> handlerChain = new ArrayList<Handler>();
handlerChain.add(sh);

DefaultBindingImpl binding = ((BindingProvider)proxy).getBinding();
binding.getBinding().setHandlerChain(handlerChain);

例 43.14 “将处理程序链添加到消费者” 中的代码执行以下操作：

实例化处理程序。

创建用于存放链的列表对象。

将处理程序添加到链。

从代理获取 Binding 对象作为 DefaultBindingImpl 对象。

将处理程序链分配给代理的绑定。

43.10.1.2. 在服务提供商中添加处理程序链

概述

您可以通过调整 SEI 或实施类及 @HandlerChain 注释来向服务提供商添加处理程序链。该注释指向一个 meta-data 文件，该文件定义供服务提供商使用的处理程序链。

流程

在您进行以下的服务提供商中添加处理器链：

使用 @HandlerChain 注释声明提供程序的实施类。
创建定义处理程序链的处理程序配置文件。

@HandlerChain 注释

javax.jws.HandlerChain 注解 decorates 服务提供商的实施类。它指示运行时加载由其 file 属性指定的处理程序链配置文件。

该注解的 file 属性支持通过两种方法来识别要加载的处理程序配置文件：

a URL
相对路径名称

例 43.15 “加载处理程序链的服务实施” 显示一个服务提供商实施，它将使用名为 handlers.xml 的文件中定义的处理程序链。handlers.xml 必须位于运行服务提供商的目录中。

例 43.15. 加载处理程序链的服务实施

import javax.jws.HandlerChain;
import javax.jws.WebService;
...

@WebService(name = "AddNumbers",
            targetNamespace = "http://apache.org/handlers",
            portName = "AddNumbersPort",
            endpointInterface = "org.apache.handlers.AddNumbers",
            serviceName = "AddNumbersService")
@HandlerChain(file = "handlers.xml")
public class AddNumbersImpl implements AddNumbers
{
...
}

处理器配置文件

处理程序配置文件使用 XML grammar 定义处理程序链，该链附带 JSR 109 (Java EE 版本 1.2 的 Web 服务)。这个 grammar 在 http://java.sun.com/xml/ns/javaee 中定义。

处理程序配置文件的 root 元素是 handler-chains 元素。handler-chains 元素具有一个或多个 handler-chain 元素。

handler-chain 元素定义处理程序链。表 43.1 “用于定义 Server-Side Handler 链的元素” 描述 handler-chain 元素的子项。

表 43.1. 用于定义 Server-Side Handler 链的元素
element	描述
`handler`	包含描述处理程序的元素。
`service-name-pattern`	指定 WSDL `服务` 元素的 QName，定义处理程序链绑定的服务。在定义 QName 时，您可以使用 `*` 作为通配符。
`port-name-pattern`	指定 WSDL `端口` 元素的 QName，定义处理程序链绑定的端点。在定义 QName 时，您可以使用 `*` 作为通配符。
`protocol-binding`	指定使用 handler 链的消息绑定。该绑定被指定为 URI，或使用以下别名之一： `#\#SOAP11_HTTP`,`\##SOAP11_HTTP_M ,` `\##SOAP12_HTTP`、`\##SOAP12_HTTP_M` 或 `\#\#XML_HTTP`。有关消息绑定 URI 的更多信息，请参阅第 23 章 Apache CXF Binding ID。

handler-chain 元素只需要将单个 handler 元素作为子项。但是，它可以根据需要支持任意数量的 处理程序 元素来定义完整的处理程序链。链中的处理程序按照处理程序链定义中指定的顺序执行。

重要

执行最终顺序将通过将指定处理程序排序为逻辑处理程序和协议处理程序来确定。在分组中，将使用配置中指定的顺序。

协议绑定 等其他子项用于限制定义的处理程序链的范围。例如，如果您使用 service-name-pattern 元素，处理程序链将只附加到服务提供程序，而 WSDL 端口 元素是指定的 WSDL 服务 元素的子供应商。您只能使用这些限制的子项在 handler 元素中。

handler 元素在处理程序链中定义各个处理程序。其 handler-class 子元素指定实施该处理程序的类完全限定名称。handler 元素也可以具有可选 handler-name 元素，它指定处理程序的唯一名称。

例 43.16 “处理器配置文件” 显示定义单一处理程序链的处理程序配置文件。该链由两个处理程序组成。

例 43.16. 处理器配置文件

<handler-chains xmlns="http://java.sun.com/xml/ns/javaee"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xsi:schemaLocation="http://java.sun.com/xml/ns/javaee">
  <handler-chain>
    <handler>
      <handler-name>LoggingHandler</handler-name>
      <handler-class>demo.handlers.common.LoggingHandler</handler-class>
    </handler>
    <handler>
      <handler-name>AddHeaderHandler</handler-name>
      <handler-class>demo.handlers.common.AddHeaderHandler</handler-class>
    </handler>
  </handler-chain>
</handler-chains>

43.10.2. Spring 配置

概述

将端点配置为使用处理程序链的最简单方法是在端点配置中定义链。这可以通过将 jaxwxs:handlers 子添加到配置端点的元素来实现。

重要

通过配置文件添加的处理程序链优先于编程配置的处理程序链。

流程

要配置端点来加载处理器链，您可以进行以下操作：

如果端点还没有配置元素，请添加它。
有关配置 Apache CXF 端点的更多信息，请参阅第 17 章 配置 JAX-WS 端点。
添加 jaxws:handlers 子元素到端点的配置元素。
对于链中的每个处理程序，添加一个 bean 元素，指定实施该处理程序的类。
如果您的处理器实施在多个位置中使用，您可以使用 ref 元素引用 bean 元素。

handlers 元素

jaxws:handlers 元素在端点配置中定义处理程序链。它可以显示为所有 JAX-WS 端点配置元素的子项。以下是：

jaxws:endpoint 配置一个服务提供程序。
jaxws:server 还配置服务提供商。
jaxws:client 配置服务使用者。

您可以通过以下两种方式之一将处理程序添加到处理程序链中：

添加定义实施类的 bean 元素
使用 ref 元素引用配置文件中其他位置的 named bean 元素

在配置中定义处理程序的顺序是它们的执行顺序。如果您混合了逻辑处理程序和协议处理程序，则可以修改顺序。运行时间会将它们排序为正确的顺序，同时保持配置中指定的基本顺序。

示例

例 43.17 “配置端点以在 Spring 中使用处理程序链” 显示加载处理程序链的服务提供商的配置。

例 43.17. 配置端点以在 Spring 中使用处理程序链

<beans ...
  xmlns:jaxws="http://cxf.apache.org/jaxws"
  ...
  schemaLocation="...
    http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
    ...">
  <jaxws:endpoint id="HandlerExample"
                  implementor="org.apache.cxf.example.DemoImpl"
                  address="http://localhost:8080/demo">
    <jaxws:handlers> <bean class="demo.handlers.common.LoggingHandler" /> <bean class="demo.handlers.common.AddHeaderHandler" /> </jaxws:handlers>
  </jaws:endpoint>
</beans>

第 44 章 Maven 工具参考

44.1. 插件设置

摘要

在使用 Apache CXF 插件之前，您必须首先在 POM 中添加正确的依赖项和存储库。

依赖项

您需要在项目的 POM 中添加以下依赖项：

JAX-WS frontend

<dependency>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-rt-frontend-jaxws</artifactId>
  <version>version</version>
</dependency>

HTTP 传输

<dependency>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-rt-transports-http</artifactId>
  <version>version</version>
</dependency>

Undertow 传输

<dependency>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-rt-transports-http-undertow</artifactId>
  <version>version</version>
</dependency>

44.2. cxf-codegen-plugin

摘要

从 WSDL 文档生成兼容 JAX-WS 的 Java 代码

概述

基本示例

以下 POM 提取显示如何将 Maven cxf-codegen-plugin 配置为处理 myService.wsdl WSDL 文件：

<plugin>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-codegen-plugin</artifactId>
  <version>3.3.6.fuse-780029-redhat-00001</version>
  <executions>
    <execution>
      <id>generate-sources</id>
      <phase>generate-sources</phase>
      <configuration>
        <sourceRoot>target/generated/src/main/java</sourceRoot>
        <wsdlOptions>
          <wsdlOption>
            <wsdl>src/main/resources/wsdl/myService.wsdl</wsdl>
          </wsdlOption>
        </wsdlOptions>
      </configuration>
      <goals>
        <goal>wsdl2java</goal>
      </goals>
    </execution>
  </executions>
</plugin>

基本配置设置

在前面的示例中，您可以自定义以下配置设置

configuration/sourceRoot: 指定存储生成的 Java 文件的目录。默认为 target/generated-sources/cxf。
configuration/wsdlOptions/wsdlOption/wsdl: 指定 WSDL 文件的位置。

描述

wsdl2java 任务采用 WSDL 文档，并从中生成完全注解的 Java 代码以实施服务。WSDL 文档必须具有有效的 portType 元素，但它不需要包含 绑定 元素 或服务 元素。使用可选参数来自定义生成的代码。

WSDL 选项

至少需要一个 wsdlOptions 元素来配置插件。需要 wsdlOptions 元素的 wsdl 子项，并指定要由插件处理的 WSDL 文档。除了 wsdl 元素外，wsdlOptions 元素还可取多个可自定义 WSDL 文档的子项。

插件配置中可以列出多个 wsdlOptions 元素。每个元素配置单一 WSDL 文档来处理。

默认选项

defaultOptions 元素是一个可选元素。它可用于设置在所有指定的 WSDL 文档中使用的选项。

重要

如果在 wsdlOptions 元素中重复某个选项，则 wsdlOptions 元素中的值会优先使用。

指定代码生成选项

要指定通用代码生成选项（与 Apache CXF wsdl2java 命令行工具支持的交换机相同），您可以添加 extraargs 元素作为 wsdlOption 元素的子项。例如，您可以添加 -impl 选项和 -verbose 选项，如下所示：

...
<configuration>
  <sourceRoot>target/generated/src/main/java</sourceRoot>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
      <!-- you can set the options of wsdl2java command by using the <extraargs> -->
      <extraargs>
        <extraarg>-impl</extraarg>
        <extraarg>-verbose</extraarg>
      </extraargs>
    </wsdlOption>
  </wsdlOptions>
</configuration>
...

如果交换机采用参数，您可以使用后续 额外参数 元素来指定这些参数。例如，要指定 jibx 数据绑定，您可以按照如下所示配置插件：

...
<configuration>
  <sourceRoot>target/generated/src/main/java</sourceRoot>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
      <extraargs>
        <extraarg>-databinding</extraarg>
        <extraarg>jibx</extraarg>
      </extraargs>
    </wsdlOption>
  </wsdlOptions>
</configuration>
...

指定绑定文件

要指定一个或多个 JAX-WS 绑定文件的位置，您可以将 bindingFiles 元素添加为 wsdlOption- 例如：

...
<configuration>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
      <bindingFiles>
        <bindingFile>${basedir}/src/main/resources/wsdl/async_binding.xml</bindingFile>
      </bindingFiles>
    </wsdlOption>
  </wsdlOptions>
</configuration>
...

为特定 WSDL 服务生成代码

要指定生成代码的 WSDL 服务的名称，您可以将 serviceName 元素添加为 wsdlOption 的子项（默认值为 WSDL 文档中的每个服务生成代码）：

...
<configuration>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
      <serviceName>MyWSDLService</serviceName>
    </wsdlOption>
  </wsdlOptions>
</configuration>
...

为多个 WSDL 文件生成代码

要为多个 WSDL 文件生成代码，只需为 WSDL 文件插入额外的 wsdlOption 元素。如果要指定适用于所有 WSDL 文件的一些常用选项，请将常用选项放在 defaultOptions 元素中，如下所示：

<configuration>
  <defaultOptions>
      <bindingFiles>
          <bindingFile>${basedir}/src/main/jaxb/bindings.xml</bindingFile>
      </bindingFiles>
      <noAddressBinding>true</noAddressBinding>
  </defaultOptions>
  <wsdlOptions>
      <wsdlOption>
          <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
          <serviceName>MyWSDLService</serviceName>
      </wsdlOption>
      <wsdlOption>
          <wsdl>${basedir}/src/main/resources/wsdl/myOtherService.wsdl</wsdl>
          <serviceName>MyOtherWSDLService</serviceName>
      </wsdlOption>
  </wsdlOptions>
</configuration>

也可以使用通配符匹配指定多个 WSDL 文件。在本例中，使用 wsdlRoot 元素指定 WSDL 文件的目录，然后使用 include 元素选择所需的 WSDL 文件，它支持使用 * 字符进行通配符。例如，若要从 src/main/resources/wsdl 根目录选择以 Service.wsdl 结尾的所有 WSDL 文件，您可以按照如下所示配置插件：

<configuration>
  <defaultOptions>
      <bindingFiles>
          <bindingFile>${basedir}/src/main/jaxb/bindings.xml</bindingFile>
      </bindingFiles>
      <noAddressBinding>true</noAddressBinding>
  </defaultOptions>
  <wsdlRoot>${basedir}/src/main/resources/wsdl</wsdlRoot>
  <includes>
      <include>*Service.wsdl</include>
  </includes>
</configuration>

从 Maven 存储库下载 WSDL

要直接从 Maven 存储库下载 WSDL 文件，请将 wsdlArtifact 元素添加为 wsdlOption 元素的子项，并指定 Maven 工件的协调，如下所示：

...
<configuration>
  <wsdlOptions>
    <wsdlOption>
      <wsdlArtifact>
        <groupId>org.apache.pizza</groupId>
        <artifactId>PizzaService</artifactId>
        <version>1.0.0</version>
      </wsdlArtifact>
    </wsdlOption>
  </wsdlOptions>
</configuration>
...

编码

（需要 JAXB 2.2） 若要指定用于生成的 Java 文件的字符编码(Charset)，添加 编码 元素作为 配置元素 的子项，如下所示：

...
<configuration>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
    </wsdlOption>
  </wsdlOptions>
  <encoding>UTF-8</encoding>
</configuration>
...

对独立进程进行分叉

您可以通过将 fork 元素添加为配置元素的子项，将 codegen 插件配置为代码生成的单独 JVM。fork 元素可设置为以下值之一：

once: 对一个新的 JVM 进行处理 codegen 插件配置中指定的所有 WSDL 文件。
always: 派生新的 JVM，以处理 codegen 插件配置中指定的每个 WSDL 文件。
false: （默认） 禁用分叉。

如果 codegen 插件配置为分叉一个单独的 JVM （即 fork 选项被设置为非false 值），您可以通过 additionalJvmArgs 元素为 fork JVM 指定额外的 JVM 参数。例如，以下片段将 codegen 插件配置为对单个 JVM 进行分叉，该插件仅限于从本地文件系统访问 XML 模式（仅通过设置 javax.xml.accessExternalSchema 系统属性）：

...
<configuration>
  <wsdlOptions>
    <wsdlOption>
      <wsdl>${basedir}/src/main/resources/wsdl/myService.wsdl</wsdl>
    </wsdlOption>
  </wsdlOptions>
  <fork>once</fork>
  <additionalJvmArgs>-Djavax.xml.accessExternalSchema=jar:file,file</additionalJvmArgs>
</configuration>
...

选项参考

下表中列出了用于管理代码生成过程的选项。

选项	解释
`-fe\|-frontend frontend`	指定代码生成器使用的前端。可能的值有 `jaxws`、`jaxws21` 和 `cxf`。`jaxws21` frontend 用于生成兼容 JAX-WS 2.1 的代码。`cxf` frontend （可以选择使用 `jaxws` frontend）为 Service 类提供额外的构造器。这个构造或方便您指定配置该服务的总线实例。默认为 `jaxws`。
`-db\|-databinding databinding`	指定代码生成器使用的数据绑定。可能的值有： `jaxb`、`xmlbeans`、`sdo` (`sdo-static` 和 `sdo-dynamic`)和 `jibx`。默认为 `jaxb`。
`-wv wsdlVersion`	指定工具预期的 WSDL 版本。默认值为 `1.1`。^[a]
`-p` wsdlNamespace=PackageName	指定用于生成的代码的零个或多个软件包名称。（可选）指定 WSDL 命名空间（用于软件包名称映射）。
`-b bindingName`	指定一个或多个 JAXWS 或 JAXB 绑定文件。每个绑定文件都使用单独的 `-b` 标志。
`-sn serviceName`	指定生成代码的 WSDL 服务的名称。默认值是为 WSDL 文档中的每个服务生成代码。
`-reserveClass classname`	与 `-autoNameResolution` 一起使用，定义在生成类时不使用 wsdl-to-java 的类名称。对于多个类，多次使用这个选项。
`-catalog catalogUrl`	指定用于解析导入的模式和 WSDL 文档的 XML 目录的 URL。
`-d output-directory`	指定生成代码文件的目录。
`-compile`	编译生成的 Java 文件。
`-classdir complile-class-dir`	指定要写入已编译的类文件的目录。
`-clientjar jar-file-name`	生成包含所有客户端类和 WSDL 的 JAR 文件。指定 `wsdlLocation` 在指定这个选项时无法正常工作。
`-client`	为客户端主线生成起点代码。
`-server`	为服务器主行生成起点代码。
`-impl`	为实现对象生成起点代码。
`-all`	生成所有起点代码：类型、服务代理、服务接口、服务器主行、客户端主线、实施对象和 Ant `build.xml` 文件。
`-ant`	生成 Ant `build.xml` 文件。
`-autoNameResolution`	自动解决命名冲突，而无需使用绑定自定义。
`-defaultValues`=DefaultValueProvider	指示工具为生成的客户端和生成的实施生成默认值。另外，您还可以提供用于生成默认值的类名称。默认情况下，使用 `RandomValueProvider` 类。
`-nexclude` schema-namespace=java-packagename	在生成代码时忽略指定的 WSDL 模式命名空间。这个选项可以多次指定。另外，可选指定由排除命名空间中描述的类型使用的 Java 软件包名称。
`-exsh` (`true`/`false`)	启用或禁用处理扩展 soap 标头消息绑定。默认为 false。
`-noTypes`	关闭生成类型。
`-dns` (true/false)	启用或禁用加载默认命名空间软件包名称映射。默认为 true。
`-dex` (true/false)	启用或禁用加载默认排除命名空间映射。默认为 true。
`-xjcargs`	指定在使用 JAXB 数据绑定时要直接传递给 XJC 的参数列表。要获得所有可能的 XJC 参数列表，请使用 `-xjc-X`。
`-noAddressBinding`	指示工具使用 Apache CXF 专有 WS-Addressing 类型，而不是兼容 JAX-WS 2.1 的映射。
`-validate [=all\|basic\|none]`	指示工具在尝试生成任何代码前验证 WSDL 文档。
`-keep`	指示工具不会覆盖任何现有的文件。
`-wsdlLocation wsdlLocation`	指定 `@WebService` 注释的 `wsdlLocation` 属性的值。
`-v`	显示工具的版本号。
`-verbose\|-V`	在代码生成过程中显示注释。
`-quiet`	在代码生成过程中阻止注释。
`-allowElementReferences[=true]`, `-aer[=true]`	如果为 `true`，在使用 wrapper 样式映射时，忽略 JAX-WS 2.2 规范中针对的规则 2.3.1.2 (v)不允许进行元素引用。默认为 `false`。
`-asyncMethods[=method1,method2,…]`	随后生成的 Java 类方法列表，以允许客户端异步调用；类似于 JAX-WS 绑定文件中的 `enableAsyncMapping`。
`-bareMethods[=method1,method2,…]`	随后生成的 Java 类方法列表具有打包程序风格（请参阅以下），类似于 JAX-WS 绑定文件中的 `enableWrapperStyle`。
`-mimeMethods[=method1,method2,…]`	随后生成的 Java 类方法列表以启用 mime:content 映射，类似于在 JAX-WS 绑定文件中 `启用MIMEContent`。
`-faultSerialVersionUID fault-serialVersionUID`	如何生成容错异常。可能的值有：NONE、`TIMESTAMP`、`FQCN` 或特定数字。默认为 `NONE`。
`- encoding编码`	指定生成 Java 代码时要使用的 Charset 编码。
`-exceptionSuper`	来自 `wsdl:fault` 元素生成的 fault Bean 的超级类（默认为 `java.lang.Exception`）。
`-seiSuper interfaceName`	为生成的 SEI 接口指定一个基本接口。例如，此选项可用于将 Java 7 `AutoCloseable` 接口添加为一个超级接口。
`-mark-generated`	将 @Generated 注释添加到生成的类。
^[a] 目前，Apache CXF 仅为代码生成器提供 WSDL 1.1 支持。

44.3. java2ws

摘要

从 Java 代码生成 WSDL 文档

synopsis

<plugin>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-java2ws-plugin</artifactId>
  <version>version</version>
  <executions>
    <execution>
      <id>process-classes</id>
      <phase>process-classes</phase>
      <configuration>
        <className>className</className>
        <option>...</option>
         ...
      </configuration>
      <goals>
        <goal>java2ws</goal>
      </goals>
    </execution>
  </executions>
</plugin>

描述

java2ws 任务采用服务端点实施(SEI)，并生成用于实施 Web 服务的支持文件。它可生成以下内容：

WSDL 文档
将服务部署为 POJO 所需的服务器代码
用于访问该服务的客户端代码
打包程序和故障 bean

所需的配置

该插件要求 className 配置元素存在。元素的值是要处理的 SEI 的完全限定名称。

可选配置

下表中列出的配置元素可用于微调 WSDL 生成。

element	描述
`frontend`	指定用于处理 SEI 的前端并生成支持类。`jaxws` 是默认值。也支持 `简单`。
`databinding`	指定用于处理 SEI 并生成支持类的数据绑定。使用 JAX-WS 前端时的默认设置是 `jaxb`。使用简单前端时的默认设置是 `aegis`。
`genWsdl`	指示工具在设置为 `true` 时生成 WSDL 文档。
`genWrapperbean`	当设置为 `true` 时，指示工具生成 wrapper bean 和 fault Bean。
`genClient`	指示工具在设置为 `true` 时生成客户端代码。
`genServer`	指示工具在设置为 `true` 时生成服务器代码。
`outputFile`	指定生成的 WSDL 文件的名称。
`classpath`	指定处理 SEI 时的 classpath 搜索。
`soap12`	指定在设置为 `true` 时生成的 WSDL 文档包含 SOAP 1.2 绑定。
`targetNamespace`	指定要在生成的 WSDL 文件中使用的目标命名空间。
`serviceName`	指定生成的 `service` 元素的 `name` 属性的值。

部分 VI. 开发 RESTful Web 服务

本指南介绍了如何使用 JAX-RS API 实施 Web 服务。

第 45 章 RESTful Web 服务简介

摘要

Representational State Transfer (REST)是一种软件架构风格，中心使用 HTTP 传输数据，仅使用四个基本的 HTTP 动词。它还使用任何额外打包程序，如 SOAP 信封并使用任何状态数据。

概述

表述性状态转移 (REST)是一种架构风格，首先由名为 Roy Fielding 的研究人员介绍。在 RESTful 系统中，服务器使用 URI 公开资源，客户端则使用四个 HTTP 动词访问这些资源。随着客户端收到它们处于状态的资源的表现形式。当用户访问新资源时，通常遵循链接、更改或转换其状态。为了工作，REST 假设资源能够使用普遍的标准 grammar 表示资源。

World Wide Web 是设计 REST 原则的系统的最普遍性例子。Web 浏览器充当访问 Web 服务器上托管的资源的客户端。资源使用 HTML 或 XML grammars 来表示，所有 Web 浏览器都可以使用。浏览器也可以轻松遵循新资源的链接。

RESTful 系统的优点在于，它们是高度可扩展且高度灵活性。由于资源是使用四种 HTTP 动词进行访问和操作，因此资源是使用 URI 公开的，并且资源会使用标准 grammars 表示，客户端不会受到服务器的更改的影响。另外，RESTful 系统还可以充分利用 HTTP 的扩展性功能，如缓存和代理。

基本 REST 原则

RESTful 架构遵循以下基本原则：

应用程序状态和功能划分到资源中。
资源可以使用标准 URI 进行寻址，这些 URI 可用作 hypermedia 链接。
所有资源都只使用四个 HTTP 动词。
- DELETE
- GET
- POST
- PUT
所有资源都提供了使用 HTTP 支持的 MIME 类型的信息。
该协议是无状态的。
响应是可缓存的。
协议是分层的。

Resources

资源是 REST 的中心。资源是使用 URI 寻址的信息源。在 Web 的早期阶段，资源是大量静态文档。在现代 Web 中，资源可以是任何信息来源。例如，如果 Web 服务可以使用 URI 访问资源，则可以是资源。

RESTful 端点交换它们地址的资源的表示法。表示是指包含资源提供数据的文档。例如，提供对客户记录的 Web 服务访问的方法是一个资源，在服务和消费者之间交换的客户记录的副本是资源。

REST 最佳实践

在设计 RESTful Web 服务时，请记住以下几点：

为您希望公开的每个资源提供不同的 URI。
例如，如果您正在构建一个处理驱动记录的系统，则每个记录都应该有一个唯一 URI。如果系统还提供有关停滞违规和加快精细的信息，每种类型的资源还应具有唯一的基础。例如，可以通过 /speedingfines/driverID和 parking violations 访问速度罚款/驱动程序ID，也可以通过 /parkingfines/driverID 访问。
在 URI 中使用 nouns。
使用 nouns 突出显示了资源是事物而不是操作的事实。URI，如 /ordering imply a action，而 /orders 则代表一个内容。
映射到 GET 的方法不应更改任何数据。
使用您的响应中的链接。
在响应中放入其他资源的链接可让客户端更轻松地跟踪数据链。例如，如果您的服务返回一组资源，则客户端更轻松地使用所提供的链接访问各个资源。如果没有包括链接，客户端需要有额外的逻辑才能将链跟到特定的节点。
使服务无状态化。
要求客户端或服务维护状态信息，强制两者之间的紧密耦合。紧张合作使升级和迁移更加困难。维护状态也可以使恢复从通信错误更困难。

设计 RESTful Web 服务

无论您用于实施 RESTful Web 服务的框架是什么，应遵循几个步骤：

定义服务将公开的资源。
通常，服务会公开一个或多个以树形组织的资源。例如，一个驱动记录服务可组织到三个资源：
- /license/driverID
- /license/driverID/speedingfines
- /license/driverID/parkingfines
定义您要能够对各个资源执行的操作。
例如，您可能要能够更新操作者的地址，或从驱动程序的记录中删除停滞票据。
将操作映射到适当的 HTTP 动词。

定义了服务后，您可以使用 Apache CXF 实施该服务。

使用 Apache CXF 实施 REST

Apache CXF 提供 RESTFul Web 服务(JAX-RS)的 Java API实施。JAX-RS 提供了一种使用注释将 POJO 映射到资源的一种标准化方法。

当从抽象服务定义移动到使用 JAX-RS 实施的 RESTful Web 服务时，您需要执行以下操作：

为资源创建一个代表该服务资源树的根资源类。
请参阅第 46.3 节 “根资源类”。
将服务的其他资源映射到子资源。
请参阅第 46.5 节 “使用子资源”。
创建方法，以实施各个资源所使用的每个 HTTP 动词。
请参阅第 46.4 节 “使用资源方法”。

注意

Apache CXF 将继续支持旧的 HTTP 绑定，将 Java 接口映射到 RESTful Web 服务。HTTP 绑定提供基本功能，并有一些限制。我们鼓励开发人员更新其应用以使用 JAX-RS。

数据绑定

默认情况下，Apache CXF 使用 Java 架构作为 XML 绑定(JAXB)对象，将资源及其表示映射到 Java 对象。提供 Java 对象和 XML 元素之间的明确定义的映射。

Apache CXF JAX-RS 实施也支持使用 JavaScript Object Notation (JSON)交换数据。JSON 是 Ajax 开发人员使用的常用数据格式。JSON 和 JAXB 之间的数据汇总由 Apache CXF 运行时处理。

第 46 章创建资源

摘要

在 RESTful Web 服务中，所有请求都由资源来处理。JAX-RS API 将资源实施为 Java 类。资源类是一个 Java 类，它标上一个或多个 JAX-RS 注释。使用 JAX-RS 实施的 RESTful Web 服务核心是根资源类。根资源类是指向服务公开的资源树的入口点。它可以处理所有请求，也可以提供对处理请求的子资源的访问权限。

46.1. 简介

概述

使用 JAX-RS API 实施的 RESTful Web 服务以 Java 类实施的资源形式提供响应。资源类 是一种类，使用 JAX-RS 注释来实施资源。对于大多数 RESTful Web 服务，需要访问一组资源。资源类的注释提供资源 URI 以及每个操作处理的 HTTP 动词等信息。

资源类型

JAX-RS API 允许您创建两种基本资源类型：

第 46.3 节 “根资源类” 是服务的资源树的入口点。它通过 @Path 注释来解码，以定义服务中资源的 base URI。
第 46.5 节 “使用子资源” 可通过 root 资源访问。它们通过利用 @Path 注释进行解码的方法来实施。子资源的 @Path 注释定义了相对于根资源的基本 URI 的 URI。

示例

例 46.1 “简单资源类” 显示简单的资源类。

例 46.1. 简单资源类

package demo.jaxrs.server;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;

@Path("/customerservice")
public class CustomerService
{
  public CustomerService()
  {
  }

  @GET
  public Customer getCustomer(@QueryParam("id") String id)
  {
    ...
  }

  ...
}

两项组成一个资源类例 46.1 “简单资源类” 中定义的类：

@Path 注释指定资源的 base URI。

@GET 注释指定方法为资源实施 HTTP GET 方法。

46.2. 基本 JAX-RS 注解

概述

RESTful Web 服务实施需要的最基本信息有：

服务资源的 URI
类的方法如何映射到 HTTP 动词

JAX-RS 定义了一组提供这一基本信息的注解。所有资源类都必须包含这些注解之一。

设置路径

@Path 注释指定资源的 URI。该注解由 javax.ws.rs.Path 接口定义，它可用于推断一个资源类或资源方法。它取字符串值作为其仅有的参数。字符串是一个 URI 模板，用于指定已实施资源的位置。

URI 模板指定资源的相对位置。如例 46.2 “URI 模板语法” 所示，模板可以包含以下内容：

未处理的路径组件
由 { }括起的参数标识符
注意
参数标识符可以包含正则表达式，用于更改默认路径处理。

例 46.2. URI 模板语法

@Path("resourceName/{param1}/../{paramN}")

例如，URI 模板 小部件/{color}/{number} 映射到 widgets/blue/12。color 参数的值被分配给蓝色。number 参数的值被分配 12。

URI 模板如何映射到完整的 URI，它取决于 @Path 注释是减弱的。如果将其放置在根资源类中，则 URI 模板是树中所有资源的根 URI，并将其直接附加到从中发布服务的 URI。如果注解分离一个子资源，它相对于 root 资源 URI。

指定 HTTP 动词

JAX-RS 使用五个注释来指定将用于方法的 HTTP 动词：

javax.ws.rs.DELETE 指定该方法映射到 DELETE。
javax.ws.rs.GET 指定该方法映射到 GET。
javax.ws.rs.POST 指定方法映射到 POST。
javax.ws.rs.PUT 指定方法映射到 PUT。
javax.ws.rs.HEAD 指定该方法映射到 HEAD。

当您将方法映射到 HTTP 动词时，您必须确保映射有意义。例如，如果您映射旨在提交采购订单的方法，您可以将其映射到 PUT 或 POST。将它映射到 GET 或 DELETE 会导致无法预计的行为。

46.3. 根资源类

概述

根资源类是进入 JAX-RS 实施 RESTful Web 服务的入口点。它被解码为 @Path，用于指定服务实施的资源的根 URI。其方法可以在资源上直接实施操作，或提供对子资源的访问权限。

要求

为了使类是根资源类，它必须满足以下条件：

该类必须使用 @Path 注释来解码。
指定路径是服务实施的所有资源的根 URI。如果根资源类指定其路径是 widgets，其中一个方法实施了 GET 动词，则 小部件 上的 GET 会调用此方法。如果子资源指定其 URI 为 {id}，则子资源的完整 URI 模板为 小部件/{id}，它将处理对 URI 的请求，如 widgets/12 和 小部件/42。
类必须具有公共构造器才能调用运行时。
运行时必须能够为所有构造器的参数提供值。构造器的参数可以包含使用 JAX-RS 参数注释进行解码的参数。有关参数注解的更多信息，请参阅第 47 章 将信息传递到资源类和方法。
至少一种类方法必须使用 HTTP 动词注释或 @Path 注释来解码。

示例

例 46.3 “根资源类” 显示一个根资源类，提供对子资源的访问权限。

例 46.3. 根资源类

package demo.jaxrs.server;

import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;

@Path("/customerservice/")
public class CustomerService
{
  public CustomerService()
  {
    ...
  }

  @GET
  public Customer getCustomer(@QueryParam("id") String id)
  {
    ...
  }

  @DELETE
  public Response deleteCustomer(@QueryParam("id") String id)
  {
    ...
  }

  @PUT
  public Response updateCustomer(Customer customer)
  {
    ...
  }

  @POST
  public Response addCustomer(Customer customer)
  {
    ...
  }

  @Path("/orders/{orderId}/")
  public Order getOrder(@PathParam("orderId") String orderId)
  {
    ...
  }

}

例 46.3 “根资源类” 中的类满足根资源类的所有要求。

该类使用 @Path 注释进行解码。服务公开的资源的 root URI 是 customerservice。

类具有公共构造器。在这种情况下，不使用参数构造器来实现简单性。

类实施资源的四个 HTTP 动词每一个。

类还通过 getOrder （） 方法访问子资源。使用 @Path 注释指定的子资源的 URI 是 customerservice/order/id。子资源由 Order 类实现。

有关实施子资源的更多信息，请参阅第 46.5 节 “使用子资源”。

46.4. 使用资源方法

概述

资源方法使用 JAX-RS 注释标注。它们具有一个 HTTP 方法注释，指定方法进程的请求类型。JAX-RS 在资源方法上放置了多个限制。

常规限制

所有资源方法都必须满足以下条件：

它必须是公共的。
它必须使用 “指定 HTTP 动词”一节中描述的 HTTP 方法注解之一进行解码。
它不能有一个以上的实体参数，如 “参数”一节所述。

参数

资源方法参数采用两种形式：

实体参数- 不注解参数。它们的值从请求实体正文映射。实体参数可以是应用程序拥有实体供应商的任何类型的类型。通常，它们是 JAXB 对象。
重要
资源方法 只能有一个 实体参数。
有关实体供应商的更多信息，请参阅第 51 章 实体支持。
注解的参数-Annotated 参数使用 JAX-RS 注释中的一个，用于指定参数的值如何从请求映射。通常，参数的值从请求 URI 的部分映射。
有关使用 JAX-RS 注释将请求数据映射到方法参数的更多信息，请参阅第 47 章 将信息传递到资源类和方法。

例 46.4 “带有有效参数列表的资源方法” 显示具有有效参数列表的资源方法。

例 46.4. 带有有效参数列表的资源方法

@POST
@Path("disaster/monster/giant/{id}")
public void addDaikaiju(Kaiju kaiju,
                        @PathParam("id") String id)
{
  ...
}

例 46.5 “带有无效参数列表的资源方法” 显示具有无效参数列表的资源方法。它有两个没有注解的参数。

例 46.5. 带有无效参数列表的资源方法

@POST
@Path("disaster/monster/giant/")
public void addDaikaiju(Kaiju kaiju,
                        String id)
{
  ...
}

返回值

资源方法可以返回以下之一：

void
任何应用程序具有实体供应商的 Java 类
有关实体供应商的更多信息，请参阅第 51 章 实体支持。
响应 对象
有关 Response 对象的详情请参考第 48.3 节 “微调应用程序响应”。
一个 GenericEntity<T> 对象
有关 GenericEntity<T&gt; 对象的更多信息，请参阅第 48.4 节 “返回包含通用类型信息的实体”。

所有资源方法都会将 HTTP 状态代码返回到请求者。当方法的返回类型为 void 或返回的值为 null 时，资源方法会将 HTTP 状态代码设置为 204。当资源方法返回 null 以外的任何值时，它会将 HTTP 状态代码设置为 200。

46.5. 使用子资源

概述

服务可能需要由多个资源处理。例如，在订购处理服务的最佳实践表明每个客户都作为唯一资源进行处理。每个顺序也会作为唯一资源进行处理。

使用 JAX-RS API，您要将客户资源和顺序资源 实施为子资源。子资源是可通过根资源类访问的资源。它们通过将 @Path 注释添加到资源类的方法来定义。子资源可以通过以下两种方式之一实现：

子资源方法 - 间接为子资源实施 HTTP 动词，并使用 “指定 HTTP 动词”一节中描述的一个注解之一进行解码。
子资源 locator- 指向实施子资源的类。

指定子资源

子资源通过利用 @Path 注释方式指定。子资源的 URI 构造如下：

将 sub-resource 的 @Path 注释的值附加到子资源的 @Path 注释的值。
父资源的 @Path 注释可能位于资源类中的方法，该类返回包含子资源的类对象。
重复上一步，直到达到 root 资源。
assembled URI 附加到部署该服务的基础 URI 中。

例如，例 46.6 “订购子资源” 中显示的子资源的 URI 可以是 baseURI/customerservice/order/12。

例 46.6. 订购子资源

...
@Path("/customerservice/")
public class CustomerService
{
  ...
  @Path("/orders/{orderId}/")
  @GET
  public Order getOrder(@PathParam("orderId") String orderId)
  {
    ...
  }
}

子资源方法

子资源方法使用 @Path 注释和其中一个 HTTP 动词标注进行解码。子资源方法直接负责使用指定的 HTTP 动词处理资源上发出的请求。

例 46.7 “子资源方法” 显示具有三个子资源方法的资源类：

getOrder （） 处理其 URI 匹配 /customerservice/orders/{orderId}/ 的资源的 HTTP GET 请求。
updateOrder （） 处理 URI 匹配 /customerservice/orders/{orderId}/ 的资源的 HTTP PUT 请求。
newOrder （） 处理 /customerservice/orders/ 上资源的 HTTP POST 请求。

例 46.7. 子资源方法

...
@Path("/customerservice/")
public class CustomerService
{
  ...
  @Path("/orders/{orderId}/")
  @GET
  public Order getOrder(@PathParam("orderId") String orderId)
  {
    ...
  }

  @Path("/orders/{orderId}/")
  @PUT
  public Order updateOrder(@PathParam("orderId") String orderId,
                           Order order)
  {
    ...
  }

  @Path("/orders/")
  @POST
  public Order newOrder(Order order)
  {
    ...
  }
}

注意

具有相同 URI 模板的子资源方法等同于由子资源 locator 返回的资源类。

子资源 locators

子资源 locators 不与其中一个 HTTP 动词注解中分离，且不会直接处理子资源上的请求。相反，子资源 locator 会返回一个可处理请求的资源类的实例。

除了没有 HTTP 动词注解外，子资源 locators 还不能有任何实体参数。子资源 locator 方法使用所有参数都必须使用第 47 章 将信息传递到资源类和方法 中描述的一个注解。

如例 46.8 “子资源 locator 返回特定类” 所示，子资源定位为可重复使用的类，而不是将所有方法放在一个超级类中。processOrder （） 方法是一个子资源 locator。对与 URI 模板 /orders/{orderId}/ /orders/{orderId}/ 匹配的 URI 发出请求时，它会返回一个 Order 类的实例。Order 类使用 HTTP 动词注解进行解码的方法。PUT 请求由 updateOrder （） 方法处理。

例 46.8. 子资源 locator 返回特定类

...
@Path("/customerservice/")
public class CustomerService
{
  ...
  @Path("/orders/{orderId}/")
  public Order processOrder(@PathParam("orderId") String orderId)
  {
    ...
  }

  ...
}

public class Order
{
  ...
  @GET
  public Order getOrder(@PathParam("orderId") String orderId)
  {
    ...
  }

  @PUT
  public Order updateOrder(@PathParam("orderId") String orderId,
                           Order order)
  {
    ...
  }

}

子资源 locators 在运行时处理，以便支持多形器。子资源 locator 的返回值可以是通用 对象、抽象类或类层次结构的顶部。例如，如果您的服务需要处理 PayPal 订单和信用卡订单，则来自例 46.8 “子资源 locator 返回特定类” 的 processOrder （） 方法的签名可能会保持不变。您只需要实施两个类，即 ppOrder 和 ccOder 来扩展 Order 类。processOrder （） 的实现将根据所需的逻辑实例化子资源的实现。

46.6. 资源选择方法

概述

给定 URI 可以映射到一个或多个资源方法。例如，URI customerservice/12/ma 可以匹配 templates @Path ("customerservice/{id}") 或 @Path ("customerservice/{id}/{state}/{state}")。JAX-RS 指定与请求匹配的资源方法的详细算法。该算法将规范化 URI、HTTP 动词和请求的介质类型与资源类上的注释进行比较。

基本选择算法

JAX-RS 选择算法分为三个阶段：

确定根资源类。
请求 URI 与以 @Path 注释分隔的所有类匹配。确定了 @Path 注释与请求 URI 匹配的类。
如果资源类的 @Path 注释的值与整个请求 URI 匹配，则类的方法将用作第三个阶段的输入。
确定对象将处理请求。
如果请求 URI 大于所选类的 @Path 注释的值，则使用资源方法的 @Path 注释的值来查找可处理请求的子资源。
如果一个或多个子资源方法与请求 URI 匹配，则这些方法用作第三个阶段的输入。
如果请求 URI 的唯一匹配是子资源定位器，则由子资源定位器所创建的对象的资源方法与请求 URI 匹配。这个阶段会被重复，直到子资源方法与请求 URI 匹配。
选择处理请求的资源方法。
HTTP 动词注解与请求的 HTTP 动词匹配的资源方法。此外，所选的资源方法必须接受请求实体正文的媒体类型，并且能够生成符合请求中指定的介质类型的响应。

从多个资源类中选择

选择算法的前两个阶段决定了将处理请求的资源。在某些情况下，该资源由资源类实施。在其他情况下，它由使用同一 URI 模板的一个或多个子资源来实施。当有多个与请求 URI 匹配的资源时，资源类优先于子资源。

如果在资源类和子资源排序后，如果多个资源仍然与请求 URI 匹配，则会使用以下条件来选择单个资源：

优先选择其 URI 模板中带有最多字面字符的资源。
字面上的字符是不是模板变量一部分的字符。例如，/widgets/{id}/{color} 具有十个字面字符，/widgets/1/{color} 具有 eleven literal 字符。因此，请求 URI /widgets/1/red 将与 /widgets/1/{color} 作为其 URI 模板的资源匹配。
注意
尾部斜杠（）计数为一个字面字符。因此，/joefred/ 将比 /joefred 优先选择。
首选使用 URI 模板中的大部分变量的资源。
请求 URI /widgets/30/green 可以匹配 /widgets/{id}/{color} 和 /widgets/{amount}/。但是，带有 URI 模板 /widgets/{id}/{color} 的资源会被选择，因为它有两个变量。
使用包含正则表达式的大部分变量选择该资源。
请求 URI /widgets/30/green 可以匹配 /widgets/{number}/{color} 和 /widgets/{idgets/{id:.}/{color}*。但是，带有 URI 模板 */widgets/{id:.}/{color} 的资源将被选择，因为它有一个包含正则表达式的变量。

从多个资源方法中选择

在很多情况下，选择与请求 URI 匹配的资源会导致单个资源方法处理请求。该方法通过与请求中指定的 HTTP 动词和资源方法的 HTTP 动词进行匹配来确定。除了具有适当的 HTTP 动词注解外，所选的方法还必须能够处理请求中包含的请求实体，并且能够生成正确的请求元数据中指定的响应类型。

注意

资源方法可以处理的请求实体的类型通过 @Consumes 注释来指定。可以通过 @Produces 注释来指定资源方法生成的响应类型。

当选择资源会产生多个可以处理以下条件的方法时，会使用以下条件来选择处理请求的资源方法：

资源方法优先于子资源。
对于子资源定位器，首选子资源方法。
优先使用 @Consumes 注释和 @Produces 注释中最具体值的方法。
例如，具有注释 @Consumes ("text/xml") 的方法优先于具有注释 @Consumes ("text/*") 的方法。这两种方法都优先于没有 @Consumes 注释或注释 @Consumes ("\*/*") 的方法。
首选方法最接近请求正文实体的内容类型。
注意
请求正文实体的内容类型在 HTTP Content-Type 属性中指定。
首选最符合内容类型的方法作为回答。
注意
作为响应接受的内容类型在 HTTP Accept 属性中指定。

自定义选择过程

在某些情况下，开发人员已报告了选择多个资源类的方式受到限制性。例如，如果给定资源类匹配，并且此类没有匹配资源方法，则算法将停止执行。它永远不会检查剩余的匹配资源类。

Apache CXF 提供 org.apache.cxf.jaxrs.ext.ResourceComparator 接口，可用于自定义运行时如何处理多个匹配资源类。ResourceComparator 接口（如例 46.9 “用于自定义资源选择的接口” 所示）需要实施的方法。个比较了两个资源类，另一个资源则比较了两个资源方法。

例 46.9. 用于自定义资源选择的接口

package org.apache.cxf.jaxrs.ext;

import org.apache.cxf.jaxrs.model.ClassResourceInfo;
import org.apache.cxf.jaxrs.model.OperationResourceInfo;
import org.apache.cxf.message.Message;

public interface ResourceComparator
{
  int compare(ClassResourceInfo cri1,
              ClassResourceInfo cri2,
              Message message);

  int compare(OperationResourceInfo oper1,
              OperationResourceInfo oper2,
              Message message);
}

自定义实现在两个资源间进行选择，如下所示：

如果第一个参数 比第二个参数更好匹配，则返回 1
如果第二个参数比第一个参数更匹配，则返回 -1

如果返回 0， 则运行时将继续执行默认选择算法

您可以通过在服务的 jaxrs:server 元素中添加 resourceComparator 子来注册自定义资源Comparator 实现。

第 47 章将信息传递到资源类和方法

摘要

JAX-RS 指定很多注释，允许开发人员控制传递给资源的信息的位置。该注解符合 URI 中的通用 HTTP 概念，如列表参数。标准 API 允许注释在方法参数、bean 属性和资源类字段上使用。Apache CXF 提供了一个扩展，允许将一系列参数注入到 bean 中。

47.1. 注入数据的基础知识

概述

使用 HTTP 请求消息中的数据初始化的参数、字段和 Bean 属性具有在运行时注入到其中的值。注入的特定数据由第 47.2 节 “使用 JAX-RS API” 中描述的一组注解指定。

在注入数据时，JAX-RS 规范会对以下几个限制：它还对可以注入数据的对象类型有一些限制。

注入数据时

当请求因为请求实例化时，请求数据会被注入到对象中。这意味着，只有与资源直接对应的对象才能使用注入注解。如第 46 章 创建资源 中所述，这些对象将由 @Path 注释或从子资源 locator 方法返回的对象进行解码。

支持的数据类型

数据可以注入的特定数据类型取决于用来指定注入的数据源的注解。但是，所有注入注解至少支持以下数据类型：

原语，如 int、char 或 long
具有接受单个 String 参数的构造器的对象
具有静态 valueOf （） 方法的对象，它接受单个 String 参数
list<T>、Set<T> 或 SortedSet< T > 对象，其中 TK 满足列表中的其他条件

注意

如果注入注解对支持的数据类型有不同的要求，在讨论注解中会突出显示不同之处。

47.2. 使用 JAX-RS API

47.2.1. JAX-RS 注解类型

标准 JAX-RS API 指定可用于将值注入字段、bean 属性和方法参数的标注。注解可以被分成三种不同的类型：

第 47.2.2 节 “从请求 URI 注入数据”
第 47.2.3 节 “从 HTTP 邮件标头中注入数据”
第 47.2.4 节 “从 HTML 表单注入数据”

47.2.2. 从请求 URI 注入数据

概述

设计 RESTful Web 服务的最佳实践之一是每个资源都应该具有唯一 URI。开发人员可以使用这个原则为底层资源实施提供良好的信息。当为资源设计 URI 模板时，开发人员可以构建模板，使其包含可注入到资源实施中的参数信息。开发人员还可以利用查询和矩阵参数将信息传送到资源实现中。

从 URI 的路径获取数据

获取资源信息的最常见机制之一是通过为资源创建 URI 模板时使用的变量。这可以通过 javax.ws.rs.PathParam 注解来实现。@PathParam 注释具有一个参数，用于标识要注入数据的 URI 模板变量。

在例 47.1 “从 URI 模板变量注入数据” 中，@PathParam 注释指定 URI 模板变量 颜色 的值被注入到 itemColor 字段中。

例 47.1. 从 URI 模板变量注入数据

import javax.ws.rs.Path;
import javax.ws.rs.PathParam
...

@Path("/boxes/{shape}/{color}")
class Box
{
  ...

  @PathParam("color")
  String itemColor;

  ...
}

@PathParam 注释支持的数据类型与 “支持的数据类型”一节中描述的数据类型不同。@PathParam 注释注入数据的实体必须是以下类型之一：

PathSegment
该值将是路径中匹配部分的最后一个片段。
List<PathSegment>
该值将是与指定模板参数匹配的路径片段对应的 PathSegment 对象列表。
原语，如 int、char 或 long
具有接受单个 String 参数的构造器的对象
具有静态 valueOf （） 方法的对象，它接受单个 String 参数

使用查询参数

在 Web 上传递信息的常见方法是使用 URI 中的 查询参数。查询参数会出现在 URI 的末尾，并由问号(?)分隔至 URI 的资源位置部分。它们由一个或多个名称值对组成，其中 name 和值由等号(=)分隔。当指定多个查询参数时，对通过分号(;)或符号( 和 )相互分离。例 47.2 “带有查询字符串的 URI” 显示带有查询参数的 URI 的语法。

例 47.2. 带有查询字符串的 URI

http://fusesource.org?name=value;name2=value2;...

注意

您可以使用 分号或 符号分隔查询参数，但不能同时使用这两者。

javax.ws.rs.QueryParam 注解提取查询参数的值并将其注入 JAX-RS 资源。该注释采用单个参数，用于标识提取值并注入到指定字段、bean 属性或参数中的查询参数。@QueryParam 注释支持 “支持的数据类型”一节中描述的类型。

例 47.3 “使用查询参数中的数据的资源方法” 显示一个资源方法，用于将查询参数 id 的值注入到方法的 id 参数中。

例 47.3. 使用查询参数中的数据的资源方法

import javax.ws.rs.QueryParam;
import javax.ws.rs.PathParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
...

@Path("/monstersforhire/")
public class MonsterService
{
  ...
  @POST
  @Path("/{type}")
  public void updateMonster(@PathParam("type") String type,
                            @QueryParam("id") String id)
  {
    ...
  }
  ...
}

要处理 HTTP POST 到 /monstersforhire/daikaiju?id=jonas the updateMonster （） 方法 的类型 被设置为 daikaiju，并将 id 设置为 jonas。

使用列表参数

URI 列表参数（如 URI 查询参数）是 name/value 对，可以提供选择资源的额外信息。与查询参数不同，列表参数可在 URI 中的任何位置显示，它们使用分号(;)从 URI 的分层路径段中分离。/mostersforhire/daikaiju;id=jonas 有一个名为 id 和 /monstersforhi/japan; type =daikaiju/flying;wingspan=40 的两个列表，称为 name 和 wingspan。

注意

当计算资源 URI 时，不会评估列表参数。因此，用来处理请求 URI /monstersforhire/japan;type=daikaiju/flying;wingspan=40 是 /monstersforhire/japan/flying 的资源的 URI /monstersforre/japan/flying。

matrix 参数的值注入使用 javax.ws.rs.MatrixParam 注解的字段、参数或 bean 属性。该注释采用单个参数，用于标识提取值并注入到指定字段、bean 属性或参数中的 list 参数的名称。@MatrixParam 注释支持 “支持的数据类型”一节中描述的类型。

例 47.4 “使用列表参数中的数据的资源方法” 显示一个资源方法，用于将列表参数 类型和 id 的值注入到方法的参数中。

例 47.4. 使用列表参数中的数据的资源方法

import javax.ws.rs.MatrixParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
...

@Path("/monstersforhire/")
public class MonsterService
{
  ...
  @POST
  public void updateMonster(@MatrixParam("type") String type,
                            @MatrixParam("id") String id)
  {
    ...
  }
  ...
}

要处理 HTTP POST 到 /monstersforhire;type=daikaiju;id=whale the updateMonster （） 方法的 类型设置为 daikaiju，并将 id 设置为 whale。

注意

JAX-RS 同时评估 URI 中的所有列表参数，因此它无法对 URI 中的列表参数位置实施限制。例如 /monstersforhire/japan;type=daikaiju/flying;wingspan=40 , /monstersforhire/japan/flying;type=daikaiju;wingspan=40, 和 /monstersforhire/japan; type=daikaiju;wingspan=40/flying 均被视为使用 JAX-RS API 实施的 RESTful Web 服务。

禁用 URI decoding

默认情况下，所有请求 URI 都会被解码。因此 URI /monster/night%20stalker 和 URI /monster/night stalker 等效。自动 URI 解码使得将 ASCII 字符设置之外的字符作为参数轻松发送。

如果您不想自动解码 URI，您可以使用 javax.ws.rs.Encoded 注解来取消激活 URI decoding。该注解可用于在以下级别取消激活 URI decoding：

使用 @Encoded 注释对类进行类进行分类，可停用课堂上所有参数、字段和 bean 属性的 URI 解码。
方法级别的使用 @Encoded 注释的方法取消激活了类的所有参数的 URI 解码。
参数/字段使用 @Encoded 注释定义参数或字段将停用 URI 解码类的所有参数。

例 47.5 “禁用 URI decoding” 显示 getMonster （） 方法不使用 URI decoding 的资源。addMonster （） 方法仅禁用 type 参数的 URI decoding。

例 47.5. 禁用 URI decoding

@Path("/monstersforhire/")
public class MonsterService
{
  ...

  @GET
  @Encoded
  @Path("/{type}")
  public Monster getMonster(@PathParam("type") String type,
                            @QueryParam("id") String id)
  {
    ...
  }

  @PUT
  @Path("/{id}")
  public void addMonster(@Encoded @PathParam("type") String type,
                         @QueryParam("id") String id)
  {
    ...
  }
  ...
}

错误处理

如果在尝试使用某一 URI 注入注解 WebApplicationException 异常时，会发生错误来注入数据。WebApplicationException 异常的状态设置为 404。

47.2.3. 从 HTTP 邮件标头中注入数据

概述

在普通中使用请求消息中的 HTTP 标头会传递有关消息的一般信息，如何传输中处理它，以及预期响应的详细信息。虽然通常会识别和使用几个标准标头，但 HTTP 规范允许将任何名称/值对用作 HTTP 标头。JAX-RS API 提供了将 HTTP 标头信息注入资源实施的简单机制。

最常用的 HTTP 标头之一是 Cookie。Cookie 允许 HTTP 客户端和服务器在多个请求/响应序列之间共享静态信息。JAX-RS API 提供注释，将数据直接从 Cookie 注入资源实施。

从 HTTP 标头注入信息

javax.ws.rs.HeaderParam 注解用于将 HTTP 标头字段中的数据注入参数、字段或 bean 属性。它有一个参数，用于指定从中提取值并注入到资源实施中的 HTTP 标头字段的名称。关联的参数、字段或 bean 属性必须符合 “支持的数据类型”一节中描述的数据类型。

注入 If-Modified-Since 标头显示将 HTTP If-Modified-Since 标头注入类 最旧的 字段的代码。

注入 If-Modified-Since 标头

import javax.ws.rs.HeaderParam;
...
class RecordKeeper
{
  ...
  @HeaderParam("If-Modified-Since")
  String oldestDate;
  ...
}

从 Cookie 注入信息

Cookie 是特殊的 HTTP 标头类型。它们由一个或多个在第一个请求上传递给资源实施的名称/值对组成。在第一个请求后，cookie 会在提供程序和消费者之间返回并传给每条消息。只有消费者来生成请求，因此可以更改 Cookie。Cookie 通常用于跨多个请求/响应序列、存储用户设置和其他可保留的数据进行维护。

javax.ws.rs.CookieParam 注解从 Cookie 的字段中提取值并将其注入资源实施。它取一个参数，用于指定要从中提取值的 cookie 的字段名称。除了 “支持的数据类型”一节中列出的数据类型外，带有 @CookieParam 的实体也可以是一个 Cookie 对象。

例 47.6 “注入 Cookie” 显示将 句柄 Cookie 值注入 CB 类中的字段的代码。

例 47.6. 注入 Cookie

import javax.ws.rs.CookieParam;
...
class CB
{
  ...
  @CookieParam("handle")
  String handle;
  ...
}

错误处理

如果在尝试使用 HTTP 消息注入注解 WebApplicationException 异常被嵌套原始异常时，会发生错误。WebApplicationException 异常的状态设置为 400。

47.2.4. 从 HTML 表单注入数据

概述

HTML 表单是一种从用户获取信息的简单方法，也易于创建。表单数据可用于 HTTP GET 请求和 HTTP POST 请求：

GET: 当表单数据作为 HTTP GET 请求的一部分发送时，数据会作为一组查询参数附加到 URI 中。“使用查询参数”一节中讨论从查询参数注入数据。
POST: 当表单数据作为 HTTP POST 请求的一部分发送时，数据将放置在 HTTP 消息正文中。表格数据可使用支持表单数据的常规实体参数进行处理。它还可以通过使用 @FormParam 注释来提取数据并将部分注入资源方法参数来实现。

使用 @FormParam 注释来注入表单数据

javax.ws.rs.FormParam 注解从表单 data 中提取字段值，并将值注入到资源方法参数中。该注释采用单一参数，用于指定它提取值的字段键。关联的参数必须符合 “支持的数据类型”一节中描述的数据类型。

重要

JAX-RS API Javadoc指出 @FormParam 注释可以放在字段、方法和参数上。但是，@FormParam 注释仅在放置资源方法参数时有意义。

示例

将表单数据注入资源方法参数显示将表单数据注入参数的资源方法。该方法假定客户端的格式包含三个字段：标题、标签 和 body- 包含字符串数据。

将表单数据注入资源方法参数

import javax.ws.rs.FormParam;
import javax.ws.rs.POST;

...
@POST
public boolean updatePost(@FormParam("title") String title,
                          @FormParam("tags") String tags,
                          @FormParam("body") String post)
{
  ...
}

47.2.5. 指定要注入的默认值

概述

为了提供更可靠的服务实施，您可能需要确保将任何可选参数设置为默认值。因为输入长 URI 字符串非常容易出错，所以对于从查询参数和列表参数获取的值特别有用。您可能还想为从 Cookie 中提取的参数设置默认值，因为请求系统可能没有适当的信息来构建带有所有值的 cookie。

javax.ws.rs.DefaultValue 注解可与以下注入注解结合使用：

@PathParam
@QueryParam
@MatrixParam
@FormParam
@HeaderParam
@CookieParam

当请求中不存在与注入注解对应的数据时，@DefaultValue 注释指定要使用的默认值。

语法

设置参数默认值的语法显示使用 @DefaultValue 注释的语法。

设置参数默认值的语法

import javax.ws.rs.DefaultValue;
  ...
  void resourceMethod(@MatrixParam("matrix")
                      @DefaultValue("value)
                      int someValue, ... )
  ...

该注解必须在参数、bean 或 field 之前出现，它将生效。相对于附带的注入注解的 @DefaultValue 注释的位置无关紧要。

@DefaultValue 注释采用单参数。如果无法根据注入注解提取正确的数据，则此参数是注入到字段的值。该值可以是任何 String 值。该值应该与关联字段的类型兼容。例如，如果关联字段类型为 int，则默认值 blue 除外。

处理列表和集合

如果注解的参数的类型，bean 或 field 为 List、Set 或 SortedSet，则生成的集合将包含一个从提供的默认值映射的条目。

示例

设置默认值演示了使用 @DefaultValue 为字段指定值的默认值的两个示例。

设置默认值

import javax.ws.rs.DefaultValue;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;
import javax.ws.rs.GET;
import javax.ws.rs.Path;

@Path("/monster")
public class MonsterService
{

  @Get
  public Monster getMonster(@QueryParam("id") @DefaultValue("42") int id,
                            @QueryParam("type") @DefaultValue("bogeyman") String type)
  {
    ...
  }

  ...
}

当 GET 请求发送到 baseURI/monster 时，会调用设置默认值中的 getMonster （） 方法。该方法需要两个查询参数，即 id 和 type，并附加到 URI。因此，使用 URI baseURI/monster?id=1&type=fomóiri 的 GET 请求会用其中一个 ID 返回 Fomóiri。

由于 @DefaultValue 注释放在这两个参数上，因此如果省略了查询参数，getMonster （） 方法可以发挥作用。发送到 baseURI/monster 的 GET 请求等同于使用 URI baseURI/monster?id=42&type=bogeyman 的 GET 请求。

47.2.6. 将参数注入 Java Bean

概述

在通过 REST 发布 HTML 表单时，服务器端的常用模式是创建一个 Java bean 来封装以形式接收的所有数据（还可能来自其他参数和 HTML 标头的数据）。通常，创建此 Java bean 属于两步过程：资源方法通过注入（例如，通过将 @FormParam 注释添加到其方法参数）接收表单值，而资源方法则调用 bean 的构造器，并以表单数据传递。

使用 JAX-RS 2.0 @BeanParam 注释，可以在一个步骤中实施此模式。表格数据可以直接注入到 bean 类的字段中，而 bean 本身由 JAX-RS 运行时自动创建。这是示例最为容易解释。

注入目标

@BeanParam 注释可以附加到资源方法参数、资源字段或 bean 属性。但是，参数目标是唯一可用于所有资源类生命周期的目标类型。另一种目标类型仅限于每个请求的生命周期。表 47.1 “@BeanParam Injection Targets” 中总结了这种情况。

表 47.1. @BeanParam Injection Targets
目标	资源代理生命周期
`参数`	All
`字段`	per-request （默认）
`METHOD` （字母属性）	per-request （默认）

without BeanParam 注解示例

以下示例演示了如何使用传统方法以 Java bean 格式获取表单数据（不使用 @BeanParam）：

// Java
import javax.ws.rs.POST;
import javax.ws.rs.FormParam;
import javax.ws.rs.core.Response;
...
@POST
public Response orderTable(@FormParam("orderId")  String orderId,
                           @FormParam("color")    String color,
                           @FormParam("quantity") String quantity,
                           @FormParam("price")    String price)
{
    ...
    TableOrder bean = new TableOrder(orderId, color, quantity, price);
    ...
    return Response.ok().build();
}

在本例中，orderTable 方法可以处理一个表单，用于订购来自单一站点的表数量。发布完订购后，表单值将注入到 orderTable 方法的参数中，orderTable 方法明确使用注入的表格数据创建 TableOrder 类的实例。

带有 BeanParam 注解的示例

可以重构前面的示例，以利用 @BeanParam 注释。使用 @BeanParam 方法时，表单参数可以直接注入到 bean 类 表表 的字段。实际上，您可以使用 bean 类中的任何标准 JAX-RS 参数注释：包括 @PathParam、@QueryParam、@FormParam、@MatrixParam、@CookieParam 和 @HeaderParam。可以按如下所示重构处理表单的代码：

// Java
import javax.ws.rs.POST;
import javax.ws.rs.FormParam;
import javax.ws.rs.core.Response;
...
public class TableOrder {
    @FormParam("orderId")
    private String orderId;

    @FormParam("color")
    private String color;

    @FormParam("quantity")
    private String quantity;

    @FormParam("price")
    private String price;

    // Define public getter/setter methods
    // (Not shown)
    ...
}
...
@POST
public Response orderTable(@BeanParam TableOrder orderBean)
{
    ...
    // Do whatever you like with the 'orderBean' bean
    ...
    return Response.ok().build();
}

现在，表单注解已添加到 bean 类 TableOrder 中，您可以使用单个 @BeanParam 注释替换资源方法签名中的所有 @FormParam 注解，如下所示。现在，当表单被发布到可 订购 的资源方法时，JAX-RS 运行时会自动创建 TableOrder 实例、orderBean 并在 bean 类上注入参数注解指定的所有数据。

47.3. 参数 Converters

概述

使用参数转换器，可以将参数( String 类型)注入 任何类型的 字段、bean 属性或资源方法参数。通过实施并绑定合适的参数转换器，您可以扩展 JAX-RS 运行时，使它能够将参数 String 值转换为目标类型。

自动转换

参数作为 String 的实例接收，因此您始终可以直接将它们注入到字段、bean 属性和 String 类型的方法参数中。另外，JAX-RS 运行时会自动将参数字符串转换为以下类型：

原语类型.
具有接受单个 String 参数的构造器类型。
具有名为 valueOf 或 fromString 的静态方法类型，该类型包含一个 String 参数，后者返回类型为的实例。
如果 T 是 2 或 3 中描述的类型之一，则 list <T >、Set< T > 或 SortedSet <T>。

参数转换器

要将参数注入自动转换中未涵盖的类型，您可以为该类型定义自定义 参数转换器。参数转换器是一个 JAX-RS 扩展，可用于定义从 String 转换为自定义类型，并在反向方向中定义从自定义类型转换为 String。

factory pattern

JAX-RS 参数转换器机制使用工厂模式。因此，您必须根据需要注册一个参数转换器（类型为 javax.ws.rs.ext.ParamConverterProvider），它会创建一个参数转换器（类型为 javax.ws.rs.ext.ParamConverter）。

ParamConverter 接口

javax.ws.rs.ext.ParamConverter 接口定义如下：

// Java
package javax.ws.rs.ext;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.ws.rs.DefaultValue;

public interface ParamConverter<T> {

    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public static @interface Lazy {}

    public T fromString(String value);

    public String toString(T value);
}

要实现自己的 ParamConverter 类，您必须实现这个接口，覆盖 fromString 方法（将参数字符串转换为您的目标类型）以及 toString 方法（将目标类型转换为字符串）。

ParamConverterProvider interface

javax.ws.rs.ext.ParamConverterProvider 接口定义如下：

// Java
package javax.ws.rs.ext;

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

public interface ParamConverterProvider {
    public <T> ParamConverter<T> getConverter(Class<T> rawType, Type genericType, Annotation annotations[]);
}

要实现自己的参数 ConverterProvider 类，您必须实施此接口，覆盖 getConverter 方法，这是创建参数 Converter 实例的一个工厂方法。

绑定参数转换器供应商

要将参数转换器提供程序 绑定到 JAX-RS 运行时（使它提供给您的应用），您必须使用 @Provider 注释标注您的实施类，如下所示：

// Java
...
import javax.ws.rs.ext.ParamConverterProvider;
import javax.ws.rs.ext.Provider;

@Provider
public class TargetTypeProvider implements ParamConverterProvider {
    ...
}

此注解可确保在部署的扫描阶段自动注册您的参数转换器提供程序。

示例

以下示例演示了如何实施 ParamConverterProvider 和 ParamConverter，它具有将参数字符串转换为 TargetType 类型的功能：

// Java
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

import javax.ws.rs.ext.ParamConverter;
import javax.ws.rs.ext.ParamConverterProvider;
import javax.ws.rs.ext.Provider;

@Provider
public class TargetTypeProvider implements ParamConverterProvider {

    @Override
    public <T> ParamConverter<T> getConverter(
        Class<T> rawType,
        Type genericType,
        Annotation[] annotations
    ) {
        if (rawType.getName().equals(TargetType.class.getName())) {
            return new ParamConverter<T>() {

                @Override
                public T fromString(String value) {
                    // Perform conversion of value
                    // ...
                    TargetType convertedValue = // ... ;
                    return convertedValue;
                }

                @Override
                public String toString(T value) {
                    if (value == null) { return null; }
                    // Assuming that TargetType.toString is defined
                    return value.toString();
                }
            };
        }
        return null;
    }

}

使用参数转换器

现在，您为 TargetType 定义了参数转换程序，现在可以直接将参数注入到 TargetType 字段和参数中，例如：

// Java
import javax.ws.rs.FormParam;
import javax.ws.rs.POST;
...
@POST
public Response updatePost(@FormParam("target") TargetType target)
{
  ...
}

延迟默认转换

如果您为参数指定默认值（使用 @DefaultValue 注释），您可以选择默认值是否立即转换为目标类型（默认行为），或者仅应在需要时转换默认值（布局转换）。要选择 lazy 转换，请将 @ParamConverter.Lazy 注解添加到目标类型。例如：

// Java
import javax.ws.rs.FormParam;
import javax.ws.rs.POST;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.ext.ParamConverter.Lazy;
...
@POST
public Response updatePost(
    @FormParam("target")
    @DefaultValue("default val")
    @ParamConverter.Lazy
    TargetType target)
{
  ...
}

47.4. 使用 Apache CXF 扩展

概述

Apache CXF 为标准 JAX-WS 注入机制提供了一个扩展，供开发人员使用单个注释替换一系列注入注释。单个注解放置在包含使用注解提取数据的 bean 中。例如，如果某个资源方法预期一个请求 URI，它包括三个名为 id 的查询参数，键入，并且 大小，它可以使用一个 @QueryParam 注释，将所有参数注入到包含对应字段的 bean 中。

注意

考虑改为使用 @BeanParam 注释（自 JAX-RS 2.0 起可用）。标准化 @BeanParam 方法比专有的 Apache CXF 扩展更灵活，因此建议的替代方案。详情请查看第 47.2.6 节 “将参数注入 Java Bean”。

支持的注入注解

这个扩展不支持所有注入参数。它只支持以下内容：

@PathParam
@QueryParam
@MatrixParam
@FormParam

语法

要指示注解将使用串行注入进入 bean，您需要执行以下两个操作：

将注解的参数指定为空字符串。例如，@PathParam ("") 指定一系列 URI 模板变量被序列化为 bean。
确保注解的参数为 bean，其字段与注入的值匹配。

示例

例 47.7 “将查询参数注入 bean” 显示了将多个 Query 参数注入 bean 的示例。资源方法预期请求 URI 包括两个查询参数： type 和 id。其值注入 Monster bean 的对应字段。

例 47.7. 将查询参数注入 bean

import javax.ws.rs.QueryParam;
import javax.ws.rs.PathParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
...

@Path("/monstersforhire/")
public class MonsterService
{
  ...
  @POST
  public void updateMonster(@QueryParam("") Monster bean)
  {
    ...
  }
  ...
}

public class Monster
{
  String type;
  String id;

  ...
}

第 48 章将信息返回给消费者

摘要

RESTful 请求要求将至少 HTTP 响应代码返回到使用者。在很多情况下，可以通过返回普通 JAXB 对象或 通用Entity 对象来满足请求。当资源方法需要返回附加元数据以及响应实体时，JAX-RS 资源方法可以返回包含任何所需 HTTP 标头或其他元数据的 Response 对象。

48.1. 返回类型

返回到使用者的信息决定了资源方法返回的确切对象类型。这似乎显而易见，但 Java 返回对象和返回给 RESTful 使用者之间的映射并非一对一。至少，除了任何响应实体正文外，还要求返回有效的 HTTP 返回代码。将 Java 对象内所含的数据映射到响应实体的映射由消费者要接受的 MIME 类型生效。

为了解决映射 Java 对象到 RESTful 响应消息的问题，可以将资源方法返回四种 Java 结构类型：

第 48.2 节 “返回普通 Java 结构” 使用由 JAX-RS 运行时确定的 HTTP 返回代码返回基本信息。
第 48.2 节 “返回普通 Java 结构” 使用由 JAX-RS 运行时确定的 HTTP 返回代码返回复杂信息。
第 48.3 节 “微调应用程序响应” 通过以编程方式确定 HTTP 返回状态返回复杂信息。Response 对象也允许指定 HTTP 标头。
第 48.4 节 “返回包含通用类型信息的实体” 使用由 JAX-RS 运行时确定的 HTTP 返回代码返回复杂信息。GenericEnitity 对象提供了更多与数据序列化的运行时组件相关的信息。

48.2. 返回普通 Java 结构

概述

在许多情形中，资源类可以返回标准的 Java 类型、JAXB 对象或应用具有实体提供程序的任何对象。在这些情况下，运行时使用所返回对象的 Java 类确定 MIME 类型信息。运行时还会决定要发送到消费者的适当 HTTP 返回代码。

可返回的类型

资源方法可以返回 void 或提供实体写入器的任何 Java 类型。默认情况下，运行时有以下供应商：

Java 原语
Java 原语的数字表示
JAXB 对象

“原生支持的类型”一节列出默认支持的所有返回类型。“自定义写入器”一节介绍如何实施自定义实体写入器。

MIME 类型

运行时首先检查 @Produces 注释的资源方法和资源类型，来确定返回的实体的 MIME 类型。如果找到了一项，它将使用注解中指定的 MIME 类型。如果没有找到资源实施指定的资源，它依赖于实体供应商来确定正确的 MIME 类型。

默认情况下，运行时分配 MIME 类型，如下所示：

Java 原语及其数字表示会被分配一个 MIME 型应用程序 /octet-stream。
JAXB 对象被分配了 MIME 型 application/xml。

应用程序可通过实施自定义实体供应商（如 “自定义写入器”一节所述）来使用其他映射。

响应代码

当资源方法返回普通 Java 构造时，如果资源方法在没有引发异常的情况下，运行时会自动设置响应的状态代码。状态代码设置如下：

204（无内容）- 资源方法返回类型为 void
204（无内容）- 返回的实体的值是 null
200(OK)-- 返回实体的值 不为空

如果在资源方法完成返回状态代码前抛出异常，如第 50 章 处理例外 所述。

48.3. 微调应用程序响应

48.3.1. 构建响应的基础知识

概述

当资源方法返回普通 Java 结构时，RESTful 服务通常需要更精确地控制返回到消费者的响应。JAX-RS 响应 类允许资源方法对发送至使用者的返回状态具有一些控制，并在响应中指定 HTTP 消息标头和 cookies。

响应 对象嵌套代表返回到使用者实体的对象。响应 对象使用 ResponseBuilder 类作为工厂来实例化。

ResponseBuilder 类还有许多用于操作响应元数据的方法。例如，ResonseBuilder 类包含设置 HTTP 标头和缓存控制指令的方法。

响应和响应构建器之间的关系

响应 类具有受保护的构造器，因此无法直接实例化。它们是使用 Response 类括起的 ResponseBuilder 类创建的。response Builder 类是所有信息的拥有者，它将封装在从其创建的响应中。ResponseBuilder 类还具有负责在消息上设置 HTTP 标头属性的所有方法。

Response 类提供了一些方法来轻松设置正确的响应代码并嵌套实体。每个常见响应状态代码都有方法。与状态对应的方法（包括实体正文或所需元数据）包括允许直接设置信息到关联的响应构建器的版本。

response Builder 类的 build （） 方法返回一个响应对象，其包含在调用方法时存储在响应构建器中的信息。返回响应对象后，响应构建器将返回到干净的状态。

获取响应构建器

获取响应构建器有两种方法：

使用 Response 类的静态方法，如使用 Response 类获取响应构建器所示。
使用 Response 类获取响应构建器
```
import javax.ws.rs.core.Response;

Response r = Response.ok().build();
```
当通过这种方式获取响应构建器时，您无法在多个步骤中操作实例。您必须将所有操作字符串到一个方法调用中。
使用 Apache CXF 特定 ResponseBuilderImpl 类。通过本课程，您可以直接使用响应构建器。但是，需要手动设置所有响应构建器信息。
例 48.1 “使用 ResponseBuilderImpl 类获取响应构建器” 显示如何使用 ResponseBuilderImpl 类重写使用 Response 类获取响应构建器。
例 48.1. 使用 ResponseBuilderImpl 类获取响应构建器
```
import javax.ws.rs.core.Response;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.status(200);
Response r = builder.build();
```
注意
您也可以简单地将 ResponseBuilder 从 Response 类的方法返回给 ResponseBuilderImpl 对象。

48.3.2. 为常见用例创建响应

概述

Response 类提供了处理 RESTful 服务需要的更常见响应的快捷方式方法。这些方法处理使用提供的值或默认值设置正确的标头。它们也适当处理实体正文。

创建成功请求的响应

当请求成功处理时，需要发送响应来确认请求已达到。该响应可能包含实体。

成功完成响应时的最常见响应是 OK。确定 响应通常包含与请求对应的实体。Response 类具有超载的 ok （） 方法，可将响应状态设置为 200，并将提供的实体添加到括起的响应构建器中。ok （） 方法有五个版本。最常用的变体是：

response .ok （）- 创建状态为 200 和空实体正文的响应。
response .ok (java.lang.Object entity)- 创建 200 个状态的响应，将提供的对象存储在响应实体正文中，并通过内省对象来确定实体介质类型。

创建 200 响应的响应显示使用 OK 状态创建响应的示例。

创建 200 响应的响应

import javax.ws.rs.core.Response;
import demo.jaxrs.server.Customer;
...

Customer customer = new Customer("Jane", 12);

return Response.ok(customer).build();

对于请求者并不预期实体正文的情况，最好发送 204 No Content status 而不是 200 OK 状态。Response.noContent （） 方法将创建一个适当的响应对象。

创建具有 204 状态的响应显示创建具有 204 状态的响应的示例。

创建具有 204 状态的响应

import javax.ws.rs.core.Response;

return Response.noContent().build();

为重定向创建响应

Response 类提供了处理三个重定向响应状态的方法。

303 看到 Other

当请求的资源需要永久重定向到新资源以处理请求时，303 请参见 Other status。

Response 类 seeOther （） 方法创建具有 303 状态的响应，并将新资源 URI 放置到消息的 Location 字段中。seeOther （） 方法采用单一参数，将新 URI 指定为 java.net.URI 对象。

304 没有修改

304 Not Modified 状态可用于不同的任务，具体取决于请求的性质。它可用于表示请求的资源自以前的 GET 请求后没有更改。它还可用来表示修改资源的请求没有更改资源。

Response 类 notModified （） 方法创建了具有 304 状态的响应，并在 HTTP 消息上设置修改的日期属性。notModified （） 方法有三个版本：

notModified
notModifiedjavax.ws.rs.core.Entitytag
notModifiedjava.lang.Stringtag

307 临时重定向

当请求的资源需要向新资源定向到新资源时，307 Temporary Redirect 状态很有用，但希望使用者继续使用此资源来处理将来的请求。

Response 类 临时Redirect （） 方法创建具有 307 状态的响应，并将新资源 URI 放置到消息的 Location 字段中。temporaryRedirect （） 方法使用一个参数，该参数将新 URI 指定为 java.net.URI 对象。

创建具有 304 状态的响应显示创建具有 304 状态的响应的示例。

创建具有 304 状态的响应

import javax.ws.rs.core.Response;

return Response.notModified().build();

创建响应信号错误

Response 类提供了为两个基本处理错误创建响应的方法：

serverError-creates 状态为 500 Internal Server Error 的响应。
notAcceptablejava.util.List<javax.ws.rs.core.Variant>变体- 创建具有 406 Not Acceptable 状态的响应，以及包含可接受的资源类型列表的实体正文。

创建 500 状态的响应显示创建 500 状态的响应示例。

创建 500 状态的响应

import javax.ws.rs.core.Response;

return Response.serverError().build();

48.3.3. 处理更高级的响应

概述

响应 类方法提供了为常见情况创建响应的短期。当您需要解决更复杂的情形时，如指定缓存控制指令、添加自定义 HTTP 标头或发送不由 Response 类处理的状态，您需要使用 ResponseBuilder 类方法在使用 build （） 方法生成响应对象前填充响应。

如 “获取响应构建器”一节中所述，您可以使用 Apache CXF ResponseBuilderImpl 类创建可直接操作的响应构建器实例。

添加自定义标头

使用 ResponseBuilder 类的 header （） 方法将自定义标头添加到响应中。header （） 方法采用两个参数：

name-a 字符串指定标头的名称
value-a Java 对象，其中包含存储在标头中的数据

您可以通过重复调用 header （） 方法，在消息上设置多个标头。

在响应中添加标头显示将标头添加到响应的代码。

在响应中添加标头

import javax.ws.rs.core.Response;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.header("username", "joe");
Response r = builder.build();

添加 Cookie

使用 response Builder 类的 cookie （） 方法将自定义标头添加到响应中。Cookie （） 方法采用一个或多个 Cookie。每个 Cookie 存储在 javax.ws.rs.core.NewCookie 对象中。使用 NewCookie 类的 contructors 的最简单方法是取两个参数：

name-a 字符串指定 Cookie 的名称
value-a 字符串指定 Cookie 的值

您可以通过重复调用 cookie （） 方法来设置多个 Cookie。

将 Cookie 添加到响应中显示将 Cookie 添加到响应的代码。

将 Cookie 添加到响应中

import javax.ws.rs.core.Response;
import javax.ws.rs.core.NewCookie;

NewCookie cookie = new NewCookie("username", "joe");

Response r = Response.ok().cookie(cookie).build();

警告

使用 null 参数列表调用 cookie （） 方法，清除已与响应关联的任何 Cookie。

设置响应状态

如果要返回 响应 类帮助程序方法支持的状态以外的状态，您可以使用 ResponseBuilder 类的 status （） 方法来设置响应的状态代码。status （） 方法有两个变体。一个需要指定响应代码的 int。另外一个使用 Response.Status 对象来指定响应代码。

Response.Status 类是一个包括在 Response 类中的枚举。它具有大多数定义的 HTTP 响应代码条目。

在响应中添加标头显示将响应状态设置为 404 Not Found 的代码。

在响应中添加标头

import javax.ws.rs.core.Response;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.status(404);
Response r = builder.build();

设置缓存控制指令

通过 ResponseBuilder 类的 cacheControl （） 方法，您可以在响应上设置缓存控制标头。cacheControl （） 方法采用 javax.ws.rs.CacheControl 对象，该对象指定响应的缓存控制指令。

CacheControl 类具有与 HTTP 规范支持的所有缓存控制指令对应的方法。其中指令是简单的 on 或 off 值，则 setter 方法采用 布尔值。如果指令需要数字值，如 max-age 指令，则设置器会采用 int 值。

在响应中添加标头显示用于设置 no-store 缓存控制指令的代码。

在响应中添加标头

import javax.ws.rs.core.Response;
import javax.ws.rs.core.CacheControl;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

CacheControl cache = new CacheControl();
cache.setNoCache(true);

ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.cacheControl(cache);
Response r = builder.build();

48.4. 返回包含通用类型信息的实体

概述

对于返回对象的 MIME 类型或用于对响应进行序列化的实体供应商，应用程序需要更多地控制。JAX-RS javax.ws.rs.core.GenericEntity<T > 类通过提供指定代表实体的通用对象类型的机制来控制实体的序列化。

使用 GenericEntity<T> 对象

用于选择排序响应的实体提供程序的一个条件是对象的通用类型。对象的通用类型代表对象的 Java 类型。当返回常见 Java 类型或 JAXB 对象时，运行时可以使用 Java 反映来确定通用类型。但是，当返回 JAX-RS response 对象时，运行时无法确定嵌套的实体的通用类型，对象的实际 Java 类用作 Java 类型。

为确保实体供应商提供正确的通用类型信息，在将 实体添加到返回的 Response 对象之前，可以将该实体嵌套在通用 类型信息中。

资源方法也可以直接返回 GenericEntity<T> 对象。实际上，这种方法很少被使用。通过反映未封装的实体以及存储在通用 实体的通用类型信息，通用 类型信息通常相同。

创建通用<T> 对象

创建 通用Entity<T&gt; 对象的方法有两种：

使用被嵌套的实体，创建 GenericEntity<T > 类的子类。使用子类创建通用保护<T> 对象显示如何创建包含类型为 List<String& gt; 的 GenericEntity<T & gt; 对象，其通用类型在运行时可用。
使用子类创建通用保护<T> 对象
```
import javax.ws.rs.core.GenericEntity;

List<String> list = new ArrayList<String>();
...
GenericEntity<List<String>> entity =
  new GenericEntity<List<String>>(list) {};
Response response = Response.ok(entity).build();
```
用于创建 GenericEntity<T> 对象的 子类通常是匿名的。

直接创建一个实例，方法是向实体提供通用类型信息。例 48.2 “直接实例化通用<T> 对象” 演示了如何创建包含 AtomicInteger 实体的响应。

例 48.2. 直接实例化通用<T> 对象

import javax.ws.rs.core.GenericEntity;

AtomicInteger result = new AtomicInteger(12);
GenericEntity<AtomicInteger> entity =
  new GenericEntity<AtomicInteger>(result,
                                      result.getClass().getGenericSuperclass());
Response response = Response.ok(entity).build();

48.5. 异步响应

48.5.1. 服务器上的异步处理

概述

在服务器端异步处理调用的目的是，可以更有效地利用线程，并最终避免客户端连接尝试所拒绝的情况，因为所有服务器的请求线程都会被阻断。异步处理调用时，该请求线程几乎会立即释放。

注意

请注意，即使在服务器端启用了异步处理，客户端 仍会被阻止，直到它从服务器收到响应。如果您想在客户端中看到异步行为，则必须实施客户端异步处理。请参阅第 49.6 节 “客户端上的异步处理”。

异步处理的基本模型

图 48.1 “同步处理的线程模型” 显示了服务器端异步处理的基本模型概述。

图 48.1. 同步处理的线程模型

在提纲中，请求在异步模型中处理如下：

在请求线程内调用异步资源方法（并接收对 AsyncResponse 对象的引用），稍后需要发回响应。
资源方法将暂停的请求封装在可运行对象中，其中包含处理请求所需的所有信息和处理逻辑。
资源方法将 Runnable 对象推送到 executor 线程池的块队列中。
资源方法现在可以返回，从而释放请求线程。
当 Runnable 对象到达队列的顶部时，它由 executor 线程池中的一个线程处理。然后，使用封装的 AsyncResponse 对象将响应发回到客户端。

使用 Java executor 实现线程池

java.util.concurrent API 是一个功能强大的 API，可让您非常轻松地创建完整的线程池实施。在 Java 并发 API 的术语中，线程池被称为 executor。它只需要单行代码来创建完整的工作线程池，包括工作线程和源源的块队列。

例如，要创建类似图 48.1 “同步处理的线程模型” 可执行文件的 Executor Thread 池的完整工作池，请创建一个 java.util.concurrent.Executor 实例，如下所示：

Executor executor = new ThreadPoolExecutor(
    5,                                    // Core pool size
    5,                                    // Maximum pool size
    0,                                    // Keep-alive time
    TimeUnit.SECONDS,                     // Time unit
    new ArrayBlockingQueue<Runnable>(10)  // Blocking queue
);

此构造器创建具有五个线程的新线程池，由单个块队列来容纳最多 10 个可运行的对象。若要将任务提交到线程池，请调用 executor.execute 方法，传入对可 Runnable 对象的引用（封装异步任务）。

定义异步资源方法

要定义异步的资源类型，请使用 @Suspended 注释注入类型为 javax.ws.rs.container.AsyncResponse 的参数，并确保方法返回 void。例如：

// Java
...
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.container.AsyncResponse;
import javax.ws.rs.container.Suspended;

@Path("/bookstore")
public class BookContinuationStore {
    ...
    @GET
    @Path("{id}")
    public void handleRequestInPool(@PathParam("id") String id,
                                    @Suspended AsyncResponse response) {
        ...
    }
    ...
}

请注意，资源方法必须返回 void，因为注入的 AsyncResponse 对象将在以后返回响应。

AsyncResponse 类

javax.ws.rs.container.AsyncResponse 类在传入客户端连接中提供抽象句柄。当 AsyncResponse 对象注入资源方法时，底层 TCP 客户端连接最初处于暂停状态。稍后，当您准备好返回响应时，您可以通过在 AsyncResponse 实例中调用 恢复 来重新激活底层 TCP 客户端连接并返回响应。或者，如果您需要中止调用，可以在 AsyncResponse 实例上调用 取消。

将暂停请求封装为可运行

在图 48.1 “同步处理的线程模型” 中显示的异步处理场景中，您可以将暂停的请求推送到队列，稍后可在其中被专用线程池处理。但是，为了使这种方法能够工作，您需要以某种方式封装对象中暂停的请求。暂停的请求对象需要封装以下事项：

来自传入请求的参数（若有）。
AsyncResponse 对象，它在传入客户端连接上提供一个句柄，以及发回响应的方法。
调用的逻辑。

封装这些内容的便捷方法是定义一个可运行的类来代表暂停请求，其中 Runnable .run （） 方法封装了调用的逻辑。执行此操作的最最好方法是将 Runnable 作为本地类实施，如下例所示。

异步处理示例

要实施异步处理场景，资源方法的实现必须将可运行的对象（代表暂停的请求）传递给 executor 线程池。在 Java 7 和 8 中，您可以利用一些 novel 语法将 Runnable 类定义为本地类，如下例所示：

// Java
package org.apache.cxf.systest.jaxrs;

import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;

import javax.ws.rs.GET;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.container.AsyncResponse;
import javax.ws.rs.container.CompletionCallback;
import javax.ws.rs.container.ConnectionCallback;
import javax.ws.rs.container.Suspended;
import javax.ws.rs.container.TimeoutHandler;

import org.apache.cxf.phase.PhaseInterceptorChain;

@Path("/bookstore")
public class BookContinuationStore {

    private Map<String, String> books = new HashMap<String, String>();
    private Executor executor = new ThreadPoolExecutor(5, 5, 0, TimeUnit.SECONDS,
                                        new ArrayBlockingQueue<Runnable>(10));

    public BookContinuationStore() {
        init();
    }
    ...
    @GET
    @Path("{id}")
    public void handleRequestInPool(final @PathParam("id") String id,
                                    final @Suspended AsyncResponse response) {
        executor.execute(new Runnable() {
            public void run() {
                // Retrieve the book data for 'id'
                // which is presumed to be a very slow, blocking operation
                // ...
                bookdata = ...
                // Re-activate the client connection with 'resume'
                // and send the 'bookdata' object as the response
                response.resume(bookdata);
            }
        });
    }
    ...
}

注意资源方法参数、id 和 响应 如何直接传递到可运行本地类的定义。这个特殊语法可让您直接在 Runnable.run （） 方法中使用资源方法参数，而无需在本地类中定义对应的字段。

重要

要使这种特殊语法发挥作用，必须声明资源方法参数作为 最终性 （这意味着在方法实施中必须不更改它们）。

48.5.2. 超时和超时处理程序

概述

异步处理模型还支持在 REST 调用时实现超时。默认情况下，超时会导致将 HTTP 错误响应发送到客户端。但是，您还可以选择注册超时处理器回调，它可让您自定义对超时事件的响应。

设置没有处理程序的超时示例

要定义简单的调用超时，但不指定 timeout 处理程序，在 AsyncResponse 对象中调用 setTimeout 方法，如下例所示：

// Java
// Java
...
import java.util.concurrent.TimeUnit;
...
import javax.ws.rs.GET;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.container.AsyncResponse;
import javax.ws.rs.container.Suspended;
import javax.ws.rs.container.TimeoutHandler;

@Path("/bookstore")
public class BookContinuationStore {
    ...
    @GET
    @Path("/books/defaulttimeout")
    public void getBookDescriptionWithTimeout(@Suspended AsyncResponse async) {
        async.setTimeout(2000, TimeUnit.MILLISECONDS);
        // Optionally, send request to executor queue for processing
        // ...
    }
    ...
}

请注意，您可以使用 java.util.concurrent.TimeUnit 类中的任何单元来指定超时值。前面的示例没有显示将请求发送到 executor 线程池的代码。如果您只想测试超时行为，可以在资源方法正文中包含对 async.SetTimeout 的调用，每次调用时会触发超时。

AsyncResponse.NO_TIMEOUT 值代表无限超时。

默认超时

默认情况下，如果触发调用超时，JAX-RS 运行时会引发 ServiceUnavailableException 异常，并发送 HTTP 错误响应，其状态为 503。

TimeoutHandler 接口

如果要自定义超时行为，您必须通过实施 TimeoutHandler 接口来定义超时处理程序：

// Java
package javax.ws.rs.container;

public interface TimeoutHandler {
    public void handleTimeout(AsyncResponse asyncResponse);
}

当您覆盖实现类中的 handleTimeout 方法时，您可以选择以下方法来处理超时：

通过调用 asyncResponse.cancel 方法取消响应。
通过用响应值调用 asyncResponse.resume 方法来发送响应。
通过调用 asyncResponse.setTimeout 方法来扩展等待的时间。（例如，要等待 10 秒，您可以调用 asyncResponse.setTimeout (10, TimeUnit.SECONDS)）。

使用处理程序设置超时示例

要使用超时处理程序定义调用超时，请在 AsyncResponse 对象中调用 setTimeout Handler 方法和 setTimeoutHandler 方法，如下例所示：

// Java
...
import javax.ws.rs.GET;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.container.AsyncResponse;
import javax.ws.rs.container.Suspended;
import javax.ws.rs.container.TimeoutHandler;

@Path("/bookstore")
public class BookContinuationStore {
    ...
    @GET
    @Path("/books/cancel")
    public void getBookDescriptionWithCancel(@PathParam("id") String id,
                                             @Suspended AsyncResponse async) {
        async.setTimeout(2000, TimeUnit.MILLISECONDS);
        async.setTimeoutHandler(new CancelTimeoutHandlerImpl());
        // Optionally, send request to executor queue for processing
        // ...
    }
    ...
}

在本例中注册一个 CancelTimeoutHandlerImpl timeout 处理程序实例，以处理调用超时。

使用超时处理程序取消响应

CancelTimeoutHandlerImpl timeout 处理程序定义如下：

// Java
...
import javax.ws.rs.container.AsyncResponse;
...
import javax.ws.rs.container.TimeoutHandler;

@Path("/bookstore")
public class BookContinuationStore {
    ...
    private class CancelTimeoutHandlerImpl implements TimeoutHandler {

        @Override
        public void handleTimeout(AsyncResponse asyncResponse) {
            asyncResponse.cancel();
        }

    }
    ...
}

在 AsyncResponse 对象上调用 取消 的效果是为客户端发送 HTTP 503 (服务不可用)错误响应。您可以选择为 cancel 方法指定参数( int 或 java.util.Date 值)，该值将用于在响应消息中设置 Retry-After: HTTP 标头。但是，客户端通常忽略 Retry-After: 标头。

在可运行的实例中处理取消响应

如果您将暂停请求封装为可运行的实例，它会在 executor 线程池中排队处理，您可能会发现线程池围绕处理请求时已取消 AsyncResponse 已取消。因此，您很难将一些代码添加到可运行的实例，使它能处理已取消的 AsyncResponse 对象。例如：

// Java
...
@Path("/bookstore")
public class BookContinuationStore {
    ...
    private void sendRequestToThreadPool(final String id, final AsyncResponse response) {

        executor.execute(new Runnable() {
            public void run() {
                if ( !response.isCancelled() ) {
                    // Process the suspended request ...
                    // ...
                }
            }
        });

    }
    ...
}

48.5.3. 处理丢弃连接

概述

可以添加回调来处理客户端连接丢失的情况。

ConnectionCallback 接口

要为丢弃的连接添加回调，您必须实施 javax.ws.rs.container.ConnectionCallback 接口，该接口定义如下：

// Java
package javax.ws.rs.container;

public interface ConnectionCallback {
    public void onDisconnect(AsyncResponse disconnected);
}

注册连接回调

在实施了连接回调后，必须通过调用其中一个寄存器方法，将其注册到 当前的 AsyncResponse 对象。例如，注册类型为 MyConnectionCallback 的连接回调：

asyncResponse.register(new MyConnectionCallback());

连接回调的典型场景

通常，实施连接回调的主要原因是释放与丢弃客户端连接关联的资源（您可以使用 AsyncResponse 实例作为密钥来识别需要释放的资源）。

48.5.4. 注册回调

概述

您可以选择将回调添加到 AsyncResponse 实例，以便在调用完成时获得通知。当可以调用这个回调时，可以调用以下两种替代点：

请求处理完成后，响应已发回到客户端，或者
请求处理完成后，会将未映射的 Throwable 传播到托管 I/O 容器。

CompletionCallback 接口

要添加完成回调，您必须实施 javax.ws.rs.container.CompletionCallback 接口，该接口定义如下：

// Java
package javax.ws.rs.container;

public interface CompletionCallback {
    public void onComplete(Throwable throwable);
}

通常，可调参数为 null。但是，如果请求处理导致未映射异常，则会 抛出 包含未映射异常实例。

注册完成回调

实施完成回调后，必须通过调用其中一个寄存器方法，将其注册到 当前的 AsyncResponse 对象。例如，注册类型为 MyCompletionCallback 的完成回调：

asyncResponse.register(new MyCompletionCallback());

第 49 章 JAX-RS 2.0 客户端 API

摘要

JAX-RS 2.0 定义功能齐全的客户端 API，可用于进行 REST 调用或任何 HTTP 客户端调用。这包括一个流畅的 API （以简化构建请求）、用于解析消息的框架（基于称为 实体提供程序的类型），以及客户端一侧异步调用的支持。

49.1. JAX-RS 2.0 客户端 API 简介

概述

JAX-RS 2.0 为 JAX-RS 客户端定义流畅的 API，它允许您通过步骤构建 HTTP 请求步骤，然后使用适当的 HTTP 动词(GET、POST、PUT 或 DELETE)调用请求。

注意

还可以在 Blueprint XML 或 Spring XML 中定义 JAX-RS 客户端（使用 jaxrs:client 元素）。有关这个方法的详情，请参考第 18.2 节 “配置 JAX-RS 客户端端点”。

依赖项

要在应用程序中使用 JAX-RS 2.0 客户端 API，您必须将以下 Maven 依赖项添加到项目的 pom.xml 文件中：

<dependency>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-rt-rs-client</artifactId>
  <version>3.3.6.fuse-780029-redhat-00001</version>
</dependency>

如果您计划使用异步调用功能（请参阅第 49.6 节 “客户端上的异步处理”），您还需要以下 Maven 依赖项：

<dependency>
  <groupId>org.apache.cxf</groupId>
  <artifactId>cxf-rt-transports-http-hc</artifactId>
  <version>3.3.6.fuse-780029-redhat-00001</version>
</dependency>

客户端 API 软件包

JAX-RS 2.0 客户端接口和类位于以下 Java 软件包中：

javax.ws.rs.client

在开发 JAX-RS 2.0 Java 客户端时，您通常还需要从核心软件包访问类：

javax.ws.rs.core

简单客户端请求的示例

以下代码片段显示一个简单的示例，其中 JAX-RS 2.0 客户端 API 用于对 http://example.org/bookstore JAX-RS 服务进行调用，并通过 GET HTTP 方法调用：

// Java
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Client;
import javax.ws.rs.core.Response;
...
Client client = ClientBuilder.newClient();
Response res = client.target("http://example.org/bookstore/books/123")
    .request("application/xml").get();

fluent API

JAX-RS 2.0 客户端 API 设计为一个 流畅的 API （有时称为域特定语言）。在流畅的 API 中，在单个声明中调用 Java 方法链，使得 Java 方法看起来像是简单语言中的命令。在 JAX-RS 2.0 中，fluent API 用于构建和调用 REST 请求。

进行 REST 调用的步骤

使用 JAX-RS 2.0 客户端 API，在一系列步骤中构建和调用客户端，如下所示：

bootstrap 客户端。
配置目标。
构建和进行调用。
解析响应。

bootstrap 客户端

第一步是通过创建 javax.ws.rs.client.Client 对象来引导客户端。此 客户端 实例是一个相对重量级对象，它代表了支持 JAX-RS 客户端所需的技术堆栈（可能包括拦截器和其他 CXF 功能）。理想情况下，您应重新使用客户端对象，而不是创建新的客户端对象。

要创建新 Client 对象，请在 ClientBuilder 类上调用静态方法，如下所示：

// Java
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Client;
...
Client client = ClientBuilder.newClient();
...

配置目标

通过配置目标，您可以有效地定义用于 REST 调用的 URI。以下示例演示了如何定义基础 URI、基础，然后使用路径 (String)方法向基本 URI 添加额外的路径 片段：

// Java
import javax.ws.rs.client.WebTarget;
...
WebTarget base = client.target("http://example.org/bookstore/");
WebTarget books = base.path("books").path("{id}");
...

构建和进行调用

这实际上已推出两个步骤：首先，您要构建 HTTP 请求（包括标头、接受媒体类型等）；另一方面，您调用相关的 HTTP 方法（可选提供请求消息正文（如果需要）。

例如，要创建和调用接受 application/xml 介质类型的请求：

// Java
import javax.ws.rs.core.Response;
...
Response resp = books.resolveTemplate("id", "123").request("application/xml").get();

解析响应

最后，您需要解析上一步中获取的 respose, resp。通常，响应以 javax.ws.rs.core.Response 对象的形式返回，该对象封装 HTTP 标头，以及其他 HTTP 元数据和 HTTP 消息正文（若有）。

如果要以 String 格式访问返回的 HTTP 消息，可以通过使用 String.class 参数调用 readEntity 方法来轻松完成此操作，如下所示：

// Java
...
String msg = resp.readEntity(String.class);

您可以通过将 String.class 指定为 readEntity 的参数，将响应消息正文作为 String 进行访问。对于更常规转换或转换邮件正文的转换，您可以提供 一个实体供应商 来执行转换。如需了解更多详细信息，请参阅第 49.4 节 “解析请求和响应”。

49.2. 构建客户端目标

概述

在创建初始 客户端 实例后，下一步是构建请求 URI。WebTarget 构建器类可让您配置 URI 的所有方面，包括 URI 路径和查询参数。

WebTarget 构建器类

javax.ws.rs.client.WebTarget 构建器类提供 fluent API 的一部分，使您可以为请求构建 REST URI。

创建客户端目标

若要创建 WebTarget 实例，可在 javax.ws.rs.client.Client 实例中调用其中一个 目标 方法。例如：

// Java
import javax.ws.rs.client.WebTarget;
...
WebTarget base = client.target("http://example.org/bookstore/");

基本路径和路径片段

您可以使用 目标 方法指定整个路径；或者，您可以指定基本路径，然后使用 target 方法和路径方法的组合添加 路径 片段。将基本路径与路径段相结合的优点是，您可以轻松地重新使用基本路径 WebTarget 对象进行多种调用，略有不同目标。例如：

// Java
import javax.ws.rs.client.WebTarget;
...
WebTarget base = client.target("http://example.org/bookstore/");
WebTarget headers     = base.path("bookheaders");
// Now make some invocations on the 'headers' target...
...
WebTarget collections = base.path("collections");
// Now make some invocations on the 'collections' target...
...

URI 模板参数

目标路径的语法也支持 URI 模板参数。也就是说，可以使用模板参数( {param} )初始化路径片段，之后会解析到指定值。例如：

// Java
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Response;
...
WebTarget base = client.target("http://example.org/bookstore/");
WebTarget books = base.path("books").path("{id}");
...
Response resp = books.resolveTemplate("id", "123").request("application/xml").get();

其中，resolveTemplate 方法将路径片段 {id} 替换为值 123。

定义查询参数

查询参数可以附加到 URI 路径，其中查询参数的开始标有单个 ? 字符。这个机制可让您使用语法设置一系列名称/值对： ?name1=value1&name2=value2&…

WebTarget 实例可让您使用 queryParam 方法定义查询参数，如下所示：

// Java
WebTarget target = client.target("http://example.org/bookstore/")
                         .queryParam("userId","Agamemnon")
                         .queryParam("lang","gr");

定义列表参数

列表参数类似于查询参数，但并不像广泛支持，使用不同的语法。要在 WebTarget 实例上定义列表参数，请调用 list Param (String, Object) 方法。

49.3. 构建 Client Invocation

概述

构建目标 URI 后，使用 WebTarget 构建器类，下一步是配置请求的其他方面，如 HTTP 标头、cookies 等，使用 Invocation.Builder 类。构建调用的最后一步是调用适当的 HTTP 动词(GET、POST、PUT 或 DELETE)，并提供消息正文（如果需要）。

invocation.Builder 类

javax.ws.rs.client.Invocation.Builder 构建器类提供 fluent API 的一部分，使您能够构建 HTTP 消息的内容并调用 HTTP 方法。

创建调用构建器

若要创建 Invocation.Builder 实例，可在 javax.ws.rs.client.client.WebTarget 实例中调用其中一个 请求 方法。例如：

// Java
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.client.Invocation.Builder;
...
WebTarget books = client.target("http://example.org/bookstore/books/123");
Invocation.Builder invbuilder = books.request();

定义 HTTP 标头

您可以使用标头方法在请求消息中添加 HTTP 标头，如下所示：

Invocation.Builder invheader = invbuilder.header("From", "fionn@example.org");

定义 Cookie

您可以使用 Cookie 方法在请求消息中添加 Cookie，如下所示：

Invocation.Builder invcookie = invbuilder.cookie("myrestclient", "123xyz");

定义属性

您可以使用属性方法在这个请求上下文中设置属性，如下所示：

Invocation.Builder invproperty = invbuilder.property("Name", "Value");

定义可接受的媒体类型、语言或编码

您可以定义接受的介质类型、语言或编码，如下所示：

Invocation.Builder invmedia = invbuilder.accept("application/xml")
                                        .acceptLanguage("en-US")
                                        .acceptEncoding("gzip");

调用 HTTP 方法

构建 REST 调用的过程通过调用 HTTP 方法（执行 HTTP 调用）终止。可以调用以下方法（继承 javax.ws.rs.client.SyncInvoker 基础类）：

get
post
delete
put
head
trace
options

如果您想要调用的特定 HTTP 动词不在此列表中，您可以使用通用方法来调用任何 HTTP 方法。

输入的响应

所有 HTTP 调用方法都附带一个未键入的变体和类型变体（采用额外参数）。如果您使用默认的 get （） 方法调用请求（不使用任何参数），则从调用返回 javax.ws.rs.core.Response 对象。例如：

Response res = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml").get();

但是，也可以使用 get (Class<T>) 方法要求以特定类型形式返回响应。例如，要调用请求并要求将响应作为 BookInfo 对象返回：

BookInfo res = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml").get(BookInfo.class);

但是，为了解决这个问题，您必须使用 客户端 实例注册合适的 实体提供程序，该供应商可以将响应格式 application/xml 映射到请求的类型。有关实体供应商的详情，请参考第 49.4 节 “解析请求和响应”。

在创建后指定传出消息

对于在请求中包含消息正文的 HTTP 方法（如 POST 或 PUT），您必须将消息正文指定为方法的第一个参数。消息正文必须指定为 javax.ws.rs.client.Entity 对象，其中 Entity 封装了消息内容及其关联的媒体类型。例如，要调用 POST 方法，其中消息内容作为 String 类型提供：

import javax.ws.rs.client.Entity;
...
Response res = client.target("http://example.org/bookstore/registerbook")
                     .request("application/xml")
                     .put(Entity.entity("Red Hat Install Guide", "text/plain"));

如有必要，实体.entity （） 构造器方法会自动将提供的消息实例映射到指定介质类型（使用注册的实体提供程序）。始终可以将消息正文指定为简单的 String 类型。

延迟调用

您可以选择创建 javax.ws.rs.client.client.Invocation 对象，而不是立即调用 HTTP 请求（例如，可以通过调用 get （） 方法）。Invocation 对象封装待处理的调用的所有详情，包括 HTTP 方法。

以下方法可用于构建 Invocation 对象：

buildGet
buildPost
buildDelete
buildPut
build

例如，要创建 GET Invocation 对象并稍后调用它，您可以使用类似如下的代码：

import javax.ws.rs.client.Invocation;
import javax.ws.rs.core.Response;
...
Invocation getBookInfo = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml").buildGet();
...
// Later on, in some other part of the application:
Response = getBookInfo.invoke();

异步调用

JAX-RS 2.0 客户端 API 支持客户端一侧异步调用。要进行异步调用，只需在以下 request （） 链中调用 async （） 方法。例如：

Future<Response> res = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml")
                     .async()
                     .get();

当您进行异步调用时，返回的值是 java.util.concurrent.Future 对象。有关异步调用的详情，请参阅第 49.6 节 “客户端上的异步处理”。

49.4. 解析请求和响应

概述

进行 HTTP 调用的基本方面是客户端必须能够解析传出请求消息和传入的响应。在 JAX-RS 2.0 中，密钥概念是 实体 类，它代表了使用介质类型标记的原始消息。为了解析原始消息，您可以注册多个 实体供应商，该提供程序具有将介质类型转换为和的能力。

换句话说，在 JAX-RS 2.0 上下文中，实体 是原始消息的表示，实体提供程序是提供解析原始消息（基于介质类型）能力的插件。

实体

实体 是一种通过元数据（媒体类型、语言和编码）增强的消息正文。实体 实例以原始格式保存消息，并与特定介质类型相关联。要将 实体对象的内容转换为您需要实体供应商 的 Java 对象，它可以将给定介质类型映射到所需的 Java 类型。

变体

javax.ws.rs.core.Variant 对象封装与 实体关联的元数据，如下所示：

媒体类型，
语言，
编码.

实际上，您可以将 实体 视为由 HTTP 消息内容组成的，由各种元数据提供增强。

实体供应商

实体提供程序是一种类，提供介质类型和 Java 类型之间的映射功能。您可以有效地将实体供应商视为一种类，能够解析特定介质类型（也可能是多种媒体类型）的消息。实体供应商有两个不同的变体：

MessageBodyReader: 提供从介质类型映射到 Java 类型的功能。
MessageBodyWriter: 提供从 Java 类型映射到介质类型的功能。

标准实体供应商

以下 Java 和介质类型组合的实体供应商作为标准提供：

byte[]: 所有介质类型( */* )。
java.lang.String: 所有介质类型( */* )。
java.io.InputStream: 所有介质类型( */* )。
java.io.Reader: 所有介质类型( */* )。
java.io.File: 所有介质类型( */* )。
javax.activation.DataSource: 所有介质类型( */* )。
javax.xml.transform.Source: XML 类型(text/xml、application/xml 和 media type of the application/*+xml)。
javax.xml.bind.JAXBElement 和 application-supplied JAXB 类: XML 类型(text/xml、application/xml 和 media type of the application/*+xml)。
MultivaluedMap<String,String>: 表单内容(application/x-www-form-urlencoded)。
StreamingOutput: 所有介质类型(*/*), 仅 MessageBodyWriter。
java.lang.Boolean, java.lang.Character, java.lang.Number: 只适用于 文本/说明。通过 boxing/unboxing 转换支持对应的原语类型.

响应对象

默认返回类型是 javax.ws.rs.core.Response 类型，它代表未输入的响应。Response 对象提供对完整 HTTP 响应的访问，包括消息正文、HTTP 状态、HTTP 标头、媒体类型等等。

访问响应状态

您可以通过 getStatus 方法访问响应状态（这将返回 HTTP 状态代码）：

int status = resp.getStatus();

或者，虽然 getStatusInfo 方法还提供描述字符串：

String statusReason = resp.getStatusInfo().getReasonPhrase();

访问返回的标头

您可以使用以下任一方法访问 HTTP 标头：

MultivaluedMap<String,Object>
getHeaders()

MultivaluedMap<String,String>
getStringHeaders()

String
getHeaderString(String name)

例如，如果您知道 响应 有 日期 标头，您可以按照以下方法访问它：

String dateAsString = resp.getHeaderString("Date");

访问返回的 Cookie

您可以使用 getCookies 方法访问 响应 上设置的任何新 Cookie，如下所示：

import javax.ws.rs.core.NewCookie;
...
java.util.Map<String,NewCookie> cookieMap = resp.getCookies();
java.util.Collection<NewCookie> cookieCollection = cookieMap.values();

访问返回的消息内容

您可以通过在 Response 对象上调用其中一个 readEntity 方法来访问返回的消息内容。readEntity 方法自动调用可用的实体提供程序，将消息转换为请求的类型（指定为 readEntity的第一个参数）。例如，要将消息内容作为 String 类型来访问：

String messageBody = resp.readEntity(String.class);

集合返回值

如果您需要以 Java 通用类型（例如 List 或 Collection 类型）访问返回的消息，您可以使用 javax.ws.rs.core.GenericType<T > construct 指定请求消息类型。例如：

import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Client;
import javax.ws.rs.core.GenericType;
import java.util.List;
...
GenericType<List<String>> stringListType = new GenericType<List<String>>() {};

Client client = ClientBuilder.newClient();
List<String> bookNames = client.target("http://example.org/bookstore/booknames")
                     .request("text/plain")
                     .get(stringListType);

49.5. 配置客户端端点

概述

可以通过注册和配置功能和提供程序来增加基础 javax.ws.rs.client.Client 对象的功能。

示例

以下示例显示了将客户端配置为具有日志记录功能、自定义实体供应商，并将 prettyLogging 属性设为 true ：

// Java
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Client;
import org.apache.cxf.feature.LoggingFeature;
...
Client client = ClientBuilder.newClient();
client.register(LoggingFeature.class)
      .register(MyCustomEntityProvider.class)
      .property("LoggingFeature.prettyLogging","true");

可配置 API 用于注册对象

Client 类支持将 Configurable API 用于注册对象，它提供了 寄存器 方法的多个变体。在大多数情况下，您将注册一个类或对象实例，如下例所示：

client.register(LoggingFeature.class)
client.register(new LoggingFeature())

有关 注册 变体的详情，请参阅配置文档中的 参考文档。

您可以在客户端上配置什么？

您可以配置客户端端点的以下方面：

功能
供应商
Properties
过滤器
拦截器

功能

javax.ws.rs.core.Feature 实际上是一个插件，该插件向 JAX-RS 客户端添加额外的功能。通常，一个功能会安装一个或多个拦截器，以提供所需功能。

供应商

提供程序是一种特定的客户端插件，可提供映射功能。JAX-RS 2.0 规范定义了以下类型的供应商：

实体供应商: 实体供应商提供 在特定介质类型 Java 类型之间映射的功能。如需了解更多详细信息，请参阅第 49.4 节 “解析请求和响应”。
映射供应商例外: 一个 例外映射供应商 将检查的运行时异常映射到 Response 实例。
上下文供应商: 在服务器端使用上下文提供程序，为资源类别和其他服务提供商提供上下文。

过滤器

JAX-RS 2.0 过滤器是一个插件，可让您在消息处理管道的不同点(extension点)内访问 URI、标头和各种上下文数据。详情请查看第 61 章 JAX-RS 2.0 Filters 和 Interceptors。

拦截器

JAX-RS 2.0 拦截器是一个插件，它可让您访问请求或响应的消息正文。详情请查看第 61 章 JAX-RS 2.0 Filters 和 Interceptors。

Properties

通过在客户端上设置一个或多个属性，您可以自定义注册功能或注册提供程序的配置。

其他可配置类型

不可能，不仅配置 javax.ws.rs.client.Client （和 javax.ws.rs.client.client.ClientBuilder）对象，还是一个 WebTarget 对象。当您更改 WebTarget 对象的配置时，底层客户端配置会被深入复制，以提供新的 WebTarget 配置。因此，可以在不更改原始 Client 对象的配置的情况下更改 WebTarget 对象的配置。

49.6. 客户端上的异步处理

概述

JAX-RS 2.0 支持在客户端之间异步处理调用。支持两种不同的异步处理方式：可以使用 java.util.concurrent.Future<V&gt; 返回值；或者通过注册调用回调。

使用 Future<V> 返回值的异步调用

使用 Future<V > 方法异步处理，您可以异步调用客户端请求，如下所示：

// Java
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Client;
import java.util.concurrent.Future;
import javax.ws.rs.core.Response;
...
Client client = ClientBuilder.newClient();
Future<Response> futureResp = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml")
                     .async()
                     .get();
...
// At a later time, check (and wait) for the response:
Response resp = futureResp.get();

您可以使用类似方法进行键入的响应。例如，要获得类型为 BookInfo 的响应：

Client client = ClientBuilder.newClient();
Future<BookInfo> futureResp = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml")
                     .async()
                     .get(BookInfo.class);
...
// At a later time, check (and wait) for the response:
BookInfo resp = futureResp.get();

使用调用回调的异步调用

除了使用 Future<V> 对象访问返回值外，您可以定义调用回调（使用 javax.ws.rs.client.InvocationCallback<RESPONSE&gt; ），如下所示：

// Java
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Client;
import java.util.concurrent.Future;
import javax.ws.rs.core.Response;
import javax.ws.rs.client.InvocationCallback;
...
Client client = ClientBuilder.newClient();
Future<Response> futureResp = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml")
                     .async()
                     .get(
    new InvocationCallback<Response>() {
        @Override
        public void completed(final Response resp) {
            // Do something when invocation is complete
            ...
        }

        @Override
        public void failed(final Throwable throwable) {
            throwable.printStackTrace();
        }
    });
...

您可以使用类似方法进行键入的响应：

// Java
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Client;
import java.util.concurrent.Future;
import javax.ws.rs.core.Response;
import javax.ws.rs.client.InvocationCallback;
...
Client client = ClientBuilder.newClient();
Future<BookInfo> futureResp = client.target("http://example.org/bookstore/books/123")
                     .request("application/xml")
                     .async()
                     .get(
    new InvocationCallback<BookInfo>() {
        @Override
        public void completed(final BookInfo resp) {
            // Do something when invocation is complete
            ...
        }

        @Override
        public void failed(final Throwable throwable) {
            throwable.printStackTrace();
        }
    });
...

第 50 章处理例外

摘要

如果可能，资源方法捕获的异常应会导致将有用的错误返回到请求使用者。JAX-RS 资源方法可以抛出 WebApplicationException 异常。您还可以提供 ExceptionMapper<E> 实施，将例外映射到适当的响应。

50.1. JAX-RS Exception 类概述

概述

在 JAX-RS 1.x 中，唯一可用的异常类是 WebApplicationException。但是，由于 JAX-WS 2.0，已定义了多个额外的 JAX-RS 例外类。

JAX-RS 运行时级别例外

以下例外是因为 JAX-RS 运行时仅会抛出（也就是说，不得从应用程序级代码引发这些异常）：

ProcessingException: （仅限 JAX-RS 2.0） javax.ws.rs.ProcessingException 可在请求处理期间或在 JAX-RS 运行时中的响应处理期间抛出。例如，可能会因为过滤器链或拦截器链处理中的错误而抛出这个错误。
responseProcessingException: （仅限 JAX-RS 2.0） javax.ws.rs.client.Response ProcessingException 是处理Exception 的子类，可以在 客户端侧 JAX-RS 运行时发生错误时抛出。

JAX-RS 应用级别例外

在应用程序级别代码中要抛出（和捕获）以下例外：

WebApplicationException: javax.ws.rs.WebApplicationException 是一个通用应用级别 JAX-RS 异常，可以在服务器端的应用程序代码中抛出。此异常类型可以封装 HTTP 状态代码、错误消息和（可选）响应消息。详情请查看第 50.2 节 “使用 WebApplicationException 异常报告”。
ClientErrorException: （仅限 JAX-RS 2.0） javax.ws.rs.ClientErrorException 异常类从 WebApplicationException 继承，用于封装 HTTP 4xx 状态代码。
ServerErrorException: （仅限 JAX-RS 2.0） javax.ws.rs.ServerErrorException 异常类从 WebApplicationException 继承，用于封装 HTTP 5xx 状态代码。
RedirectionException: （仅限 JAX-RS 2.0） javax.ws.rs.RedirectionException 异常类从 WebApplicationException 继承，用于封装 HTTP 3xx 状态代码。

50.2. 使用 WebApplicationException 异常报告

            errors
indexterm:[WebApplicationException]

概述

JAX-RS API 引入了 WebApplicationException 运行时异常，为资源方法创建适合 RESTful 客户端使用的异常方法。WebApplicationException 异常可以包含 Response 对象，用于定义要返回到请求来源器的实体正文。它还提供了在不提供任何实体正文时指定 HTTP 状态代码的机制。

创建简单例外

创建 WebApplicationException 异常的最简单方法是使用 no 参数构造器或将原始异常嵌套在 WebApplicationException 异常的构造器。两个构造器都使用空响应创建 WebApplicationException。

当引发这些构造器创建的异常时，运行时会返回一个空实体正文和状态代码 500 Server Error 的响应。

设置返回到客户端的状态代码

当您要返回 500 之外的错误代码时，您可以使用允许指定状态的四个 WebApplicationException 构造器之一。例 50.1 “使用状态代码创建 WebApplicationException” 中显示的两个构造器将返回状态作为整数。

例 50.1. 使用状态代码创建 WebApplicationException

WebApplicationExceptionintstatusWebApplicationExceptionjava.lang.Throwablecauseint状态

例 50.2 “使用状态代码创建 WebApplicationException” 所示的另一个两个响应状态作为 Response.Status 实例。

例 50.2. 使用状态代码创建 WebApplicationException

WebApplicationExceptionjavax.ws.rs.core.Response.StatusstatusWebApplicationExceptionjava.lang.Throwablecausejavax.ws.rs.core.Response.Status状态

当引发这些构造器创建的异常时，运行时会返回一个空实体正文和指定状态代码的响应。

提供实体正文

如果您希望信息要随例外一起发送，您可以使用采用 Response 对象的 WebApplicationException 构造器之一。运行时使用 Response 对象来创建发送到客户端的响应。响应中存储的实体正文映射到消息的实体正文，响应的 status 字段映射到消息的 HTTP 状态。

例 50.3 “发送消息及异常信息” 显示将文本消息返回到包含异常原因的客户端，并将 HTTP 消息状态设置为 409 Conflict。

例 50.3. 发送消息及异常信息

import javax.ws.rs.core.Response;
import javax.ws.rs.WebApplicationException;
import org.apache.cxf.jaxrs.impl.ResponseBuilderImpl;

...
ResponseBuilderImpl builder = new ResponseBuilderImpl();
builder.status(Response.Status.CONFLICT);
builder.entity("The requested resource is conflicted.");
Response response = builder.build();
throw WebApplicationException(response);

扩展通用异常

可以扩展 WebApplicationException 异常。这可让您创建自定义例外并消除一些样板代码。

例 50.4 “扩展 WebApplicationException” 显示创建新例外，它创建了与例 50.3 “发送消息及异常信息” 中的代码类似的响应。

例 50.4. 扩展 WebApplicationException

public class ConflicteddException extends WebApplicationException
{
  public ConflictedException(String message)
  {
    ResponseBuilderImpl builder = new ResponseBuilderImpl();
    builder.status(Response.Status.CONFLICT);
    builder.entity(message);
    super(builder.build());
     }
}

...
throw ConflictedException("The requested resource is conflicted.");

50.3. JAX-RS 2.0 Exception 类型

概述

JAX-RS 2.0 引入了很多特定的 HTTP 异常类型，您可以在应用程序代码中（以及现有 WebApplicationException 异常类型外）抛出（和捕获）。这些异常类型可用于嵌套标准 HTTP 状态代码，包括 HTTP 客户端错误(HTTP 4xx 状态代码)或 HTTP 服务器错误(HTTP 5xx 状态代码)。

异常层次结构

图 50.1 “JAX-RS 2.0 Application Exception Hierarchy” 显示 JAX-RS 2.0 中支持的应用级别例外的层次结构。

图 50.1. JAX-RS 2.0 Application Exception Hierarchy

WebApplicationException 类

javax.ws.rs.WebApplicationException 异常类（自 JAX-RS 1.x）位于 JAX-RS 2.0 异常层次结构的基础，在第 50.2 节 “使用 WebApplicationException 异常报告” 中详细介绍。

ClientErrorException 类

javax.ws.rs.ClientErrorException 异常类用于封装 HTTP 客户端错误(HTTP 4xx 状态代码)。在应用程序代码中，您可以抛出这个例外或其中一个子类。

ServerErrorException 类

javax.ws.rs.ServerErrorException 异常类用于封装 HTTP 服务器错误(HTTP 5xx 状态代码)。在应用程序代码中，您可以抛出这个例外或其中一个子类。

RedirectionException 类

javax.ws.rs.RedirectionException 异常类用于封装 HTTP 请求重定向(HTTP 3xx 状态代码)。此类的构造器使用 URI 参数，该参数指定重定向位置。重定向 URI 可通过 getLocation （） 方法访问。通常，HTTP 重定向在客户端上是透明的。

客户端子类

您可以在 JAX-RS 2.0 应用程序中引发以下 HTTP 客户端例外(HTTP 4xx 状态代码)：

BadRequestException

封装 400 Bad Request HTTP 错误状态。

ForbiddenException

封装 403 Forbidden HTTP 错误状态。

NotAcceptableException

封装 406 Not Acceptable HTTP 错误状态。

NotAllowedException

封装 405 Method Not Allowed HTTP 错误状态。

NotAuthorizedException

封装 401 Unauthorized HTTP 错误状态。在以下情况下可以引发这个例外：

客户端没有发送所需的凭证（在 HTTP 身份验证标头中 ）或
客户端显示凭据，但凭证无效。

NotFoundException

封装 404 Not Found HTTP 错误状态。

NotSupportedException

封装 415 Unsupported Media Type HTTP 错误状态。

服务器例外

您可以在 JAX-RS 2.0 应用程序中引发以下 HTTP 服务器例外(HTTP 5xx 状态代码)：

InternalServerErrorException: 封装 500 内部服务器错误 HTTP 错误状态。
ServiceUnavailableException: 封装 503 服务 Unavailable HTTP 错误状态。

50.4. 将 Exceptions 映射到响应

概述

在有些情况下，引发 WebApplicationException 异常是不现实或不可能的。例如，您可能不希望捕获所有可能的异常，然后为它们创建一个 WebApplicationException。您可能还希望使用自定义例外，以便更轻松地处理应用程序代码。

为了处理这些情况，您可以使用 JAX-RS API 来实施自定义异常提供程序，该提供程序会生成 Response 对象来发送到客户端。自定义异常供应商通过实施 ExceptionMapper<E> 接口来创建。当通过 Apache CXF 运行时注册时，都将在抛出异常时使用自定义提供程序。

如何选择异常映射程序

这两种情况下，使用异常映射程序：

当抛出异常或其中一个子类时，运行时将检查相应的例外映射程序。如果处理特定异常，则会选择异常映射程序。如果抛出了特定异常的异常映射程序，则会选择异常最接近的一块程序。
默认情况下，WebApplicationException 将被默认的 mapper WebApplicationExceptionper 来处理。即使注册了额外的自定义映射程序，这样可能会处理 WebApplicationException 异常（例如，自定义 RuntimeException mapper），也不会 使用自定义映射程序，并将改为使用 WebApplicationExceptionMapper。
不过，可以通过将 Message 对象上的 default.wae.mapper.least.specific 属性设为 true 来更改此行为。启用此选项后，默认的 WebApplicationExceptionMapper 被委派到最低优先级，这样便可与自定义异常映射程序来处理 WebApplicationException 异常。例如，如果启用了这个选项，可以通过注册自定义 RuntimeException mapper 来捕获 WebApplicationException 异常。请参阅 “为 WebApplicationException 注册异常映射程序”一节。

如果没有为异常找到异常映射程序，则异常会嵌套在 ServletException 异常中，并传递到容器运行时。然后，容器运行时将决定如何处理异常。

实施异常映射器

exception mappers 通过实施 javax.ws.rs.ext.ExceptionMapper<E> 接口来创建。如例 50.5 “例外映射程序接口” 所示，接口具有单一方法： toResponse （），它取原始异常作为参数并返回 Response 对象。

例 50.5. 例外映射程序接口

public interface ExceptionMapper<E extends java.lang.Throwable>
{
  public Response toResponse(E exception);
}

exception mapper 创建的 Response 对象由运行时处理，就像任何其他 响应 对象一样。生成的对使用者的响应将包含 Response 对象中封装的状态、标头和实体正文。

异常映射程序实施是由运行时视为供应商。因此，它们必须使用 @Provider 注释进行解码。

如果在异常映射程序构建 Response 对象时出现异常，运行时会将回复发送为 500 Server Error 状态。

例 50.6 “将例外映射到响应” 显示一个例外映射程序，它截获 Spring AccessDeniedException 异常，并生成具有 403 Forbidden 状态和空实体正文的响应。

例 50.6. 将例外映射到响应

import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;

import org.springframework.security.AccessDeniedException;

@Provider
public class SecurityExceptionMapper implements ExceptionMapper<AccessDeniedException>
{

  public Response toResponse(AccessDeniedException exception)
  {
    return Response.status(Response.Status.FORBIDDEN).build();
  }

}

运行时将捕获任何 AccessDeniedException 异常，并创建没有实体正文和 403 状态的 Response 对象。然后，运行时将按照常规响应处理 Response 对象。结果是使用者将接收 HTTP 响应，状态为 403。

注册异常映射程序

在 JAX-RS 应用可以使用例外映射程序之前，例外映射程序必须使用运行时注册。例外映射程序使用应用配置文件中的 jaxrs:providers 元素在运行时注册。

jaxrs:providers 元素是 jaxrs:server 元素的子项，包含 bean 元素的列表。每个 bean 元素都定义一个例外映射程序。

例 50.7 “使用运行时注册异常映射程序” 显示配置为使用自定义异常映射器 SecurityExceptionMapper 的 JAX-RS 服务器。

例 50.7. 使用运行时注册异常映射程序

<beans ...>
  <jaxrs:server id="customerService" address="/">
    ...
    <jaxrs:providers>
      <bean id="securityException" class="com.bar.providers.SecurityExceptionMapper"/>
    </jaxrs:providers>
  </jaxrs:server>
</beans>

为 WebApplicationException 注册异常映射程序

为 WebApplicationException 异常注册异常映射程序是一个特殊情形，因为此异常类型由默认的 WebApplicationExceptionMapper 自动处理。通常，即使注册希望处理 WebApplicationException 的自定义映射程序，它仍会由默认的 WebApplicationExceptionMapper 处理。要更改此默认行为，您需要将 default.wae.mapper.least.specific 属性设置为 true。

例如，以下 XML 代码演示了如何在 JAX-RS 端点上启用 default.wae.mapper.least.specific 属性：

<beans ...>
  <jaxrs:server id="customerService" address="/">
    ...
    <jaxrs:providers>
      <bean id="securityException" class="com.bar.providers.SecurityExceptionMapper"/>
    </jaxrs:providers>
    <jaxrs:properties>
      <entry key="default.wae.mapper.least.specific" value="true"/>
    </jaxrs:properties>
  </jaxrs:server>
</beans>

您还可以在拦截器设置 default.wae.mapper.least.specific 属性，如下例所示：

// Java
public void handleMessage(Message message)
{
    m.put("default.wae.mapper.least.specific", true);
    ...

第 51 章实体支持

摘要

Apache CXF 运行时支持 MIME 类型和 Java 对象之间的有限数量映射。开发人员可以通过实施自定义读取器和写入器来扩展映射。自定义读取器和写入器会在启动时通过运行时注册。

概述

该运行时依赖于 JAX-RS MessageBodyReader 和 MessageBodyWriter 实施在 HTTP 消息和其 Java 消息之间对数据进行序列化和反序列化。readers 和 writers 可以限制它们能够处理的 MIME 类型。

运行时为许多常见映射提供读取器和写入器。如果应用程序需要更多高级映射，开发人员可以提供 MessageBodyReader 接口和/或 MessageBodyWriter 接口的自定义实现。在应用程序启动时，自定义读取器和写入器会在运行时注册。

原生支持的类型

表 51.1 “原生支持的实体映射” 列出 Apache CXF 开箱即用提供的实体映射。

表 51.1. 原生支持的实体映射
Java 类型	MIME 类型
原语类型	`text/plain`
`java.lang.Number`	`text/plain`
`byte[]`	`/`
`java.lang.String`	`/`
`java.io.InputStream`	`/`
`java.io.Reader`	`/`
`java.io.File`	`/`
`javax.activation.DataSource`	`/`
`javax.xml.transform.Source`	`text/xml`,`application/xml`,`application/\*+xml`
`javax.xml.bind.JAXBElement`	`text/xml`,`application/xml`,`application/\*+xml`
JAXB 注释的对象	`text/xml`,`application/xml`,`application/\*+xml`
javax.ws.rs.core.MultivaluedMap<String, String>	`application/x-www-form-urlencoded` ^[a]
javax.ws.rs.core.StreamingOutput	`/` ^[b]
^[a] 此映射用于处理 HTML 表单数据。 ^[b] 这个映射只支持将数据返回到使用者。

自定义读取器

自定义实体读取器负责将传入的 HTTP 请求映射到服务实施可操作的 Java 类型中。它们实施 javax.ws.rs.ext.MessageBodyReader 接口。

例 51.1 “消息读取接口” 中显示的接口有两个需要实现的方法：

例 51.1. 消息读取接口

package javax.ws.rs.ext;

public interface MessageBodyReader<T>
{
  public boolean isReadable(java.lang.Class<?> type,
                            java.lang.reflect.Type genericType,
                            java.lang.annotation.Annotation[] annotations,
                            javax.ws.rs.core.MediaType mediaType);

  public T readFrom(java.lang.Class<T> type,
                    java.lang.reflect.Type genericType,
                    java.lang.annotation.Annotation[] annotations,
                    javax.ws.rs.core.MediaType mediaType,
                    javax.ws.rs.core.MultivaluedMap<String, String> httpHeaders,
                    java.io.InputStream entityStream)
  throws java.io.IOException, WebApplicationException;
}

isReadable()

isReadable （） 方法确定读者是否可以读取数据流并创建正确的实体表示法类型。如果读取器可以创建正确的实体类型，方法返回为 true。

表 51.2 “用于确定读者是否可以生成实体的参数” 描述 isReadable （） 方法的参数。

表 51.2. 用于确定读者是否可以生成实体的参数
参数	类型	描述
`type`	`class<T>`	指定用于存储实体的对象的实际 Java 类。
`genericType`	类型	指定用于存储实体的对象的 Java 类型。例如，如果消息正文被转换为 method 参数，则该值将是 `Method.getGenericParameterTypes （）` 方法返回的 method 参数的类型。
`annotations`	Annotation[]	指定为存储实体创建的对象声明中的注解列表。例如，如果消息正文转换为方法参数，这将是该参数上由 `Method.getParameterAnnotations （）` 方法返回的注解。
`mediaType`	`MediatType`	指定 HTTP 实体的 MIME 类型。

readFrom()

readFrom （） 方法读取 HTTP 实体，并将其覆盖到所需的 Java 对象中。如果读取成功，方法会返回包含该实体创建的 Java 对象。如果在读取输入流时出现错误，则方法应抛出 IOException 异常。如果发生错误需要 HTTP 错误响应，则应抛出带有 HTTP 响应的 WebApplicationException。

表 51.3 “用于读取实体的参数” 描述 readFrom （） 方法的参数。

表 51.3. 用于读取实体的参数
参数	类型	描述
`type`	`class<T>`	指定用于存储实体的对象的实际 Java 类。
`genericType`	类型	指定用于存储实体的对象的 Java 类型。例如，如果消息正文被转换为 method 参数，则该值将是 `Method.getGenericParameterTypes （）` 方法返回的 method 参数的类型。
`annotations`	Annotation[]	指定为存储实体创建的对象声明中的注解列表。例如，如果消息正文转换为方法参数，这将是该参数上由 `Method.getParameterAnnotations （）` 方法返回的注解。
`mediaType`	`MediatType`	指定 HTTP 实体的 MIME 类型。
`httpHeaders`	MultivaluedMap<String, String>	指定与实体关联的 HTTP 消息标头。
`entityStream`	`InputStream`	指定包含 HTTP 实体的输入流。

重要

这个方法不应关闭输入流。

在将 MessageBodyReader 实施用作实体读取器之前，必须使用 javax.ws.rs.ext.Provider 注解进行解码。@Provider 注释提醒提供的实施提供额外的功能。该实现还必须使用运行时注册，如 “注册读取器和写入器”一节所述。

默认情况下，自定义实体供应商处理所有 MIME 类型。您可以限制自定义实体读取器将使用 javax.ws.rs.Consumes 注释来处理的 MIME 类型。@Consumes 注释指定自定义实体提供程序读取的以逗号分隔的 MIME 类型列表。如果实体不是指定的 MIME 类型，则实体提供程序不会作为可能的读取器选择。

例 51.2 “XML 源实体读取” 显示读取使用的 XML 实体的实体，并将它们存储在 Source 对象中。

例 51.2. XML 源实体读取

import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

import javax.ws.rs.Consumes;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.MessageBodyReader;
import javax.ws.rs.ext.Provider;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamSource;

import org.w3c.dom.Document;
import org.apache.cxf.jaxrs.ext.xml.XMLSource;

@Provider
@Consumes({"application/xml", "application/*+xml", "text/xml", "text/html" })
public class SourceProvider implements MessageBodyReader<Object>
{
  public boolean isReadable(Class<?> type,
                            Type genericType,
                            Annotation[] annotations,
                            MediaType mt)
  {
    return Source.class.isAssignableFrom(type) || XMLSource.class.isAssignableFrom(type);
  }

  public Object readFrom(Class<Object> source,
                         Type genericType,
                         Annotation[] annotations,
                         MediaType mediaType,
                         MultivaluedMap<String, String> httpHeaders,
                         InputStream is)
  throws IOException
  {
    if (DOMSource.class.isAssignableFrom(source))
    {
      Document doc = null;
      DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
      DocumentBuilder builder;
      try
      {
        builder = factory.newDocumentBuilder();
        doc = builder.parse(is);
      }
      catch (Exception e)
      {
        IOException ioex = new IOException("Problem creating a Source object");
        ioex.setStackTrace(e.getStackTrace());
        throw ioex;
       }

       return new DOMSource(doc);
    }
    else if (StreamSource.class.isAssignableFrom(source) || Source.class.isAssignableFrom(source))
    {
      return new StreamSource(is);
    }
    else if (XMLSource.class.isAssignableFrom(source))
    {
      return new XMLSource(is);
    }

    throw new IOException("Unrecognized source");
  }
}

自定义写入器

自定义实体写入器负责将 Java 类型映射到 HTTP 实体。它们实施 javax.ws.rs.ext.MessageBodyWriter 接口。

例 51.3 “消息写入器接口” 中显示的接口有三种需要实现的方法：

例 51.3. 消息写入器接口

package javax.ws.rs.ext;

public interface MessageBodyWriter<T>
{
  public boolean isWriteable(java.lang.Class<?> type,
                             java.lang.reflect.Type genericType,
                             java.lang.annotation.Annotation[] annotations,
                             javax.ws.rs.core.MediaType mediaType);

  public long getSize(T t,
                      java.lang.Class<?> type,
                      java.lang.reflect.Type genericType,
                      java.lang.annotation.Annotation[] annotations,
                      javax.ws.rs.core.MediaType mediaType);

  public void writeTo(T t,
                      java.lang.Class<?> type,
                      java.lang.reflect.Type genericType,
                      java.lang.annotation.Annotation[] annotations,
                      javax.ws.rs.core.MediaType mediaType,
                      javax.ws.rs.core.MultivaluedMap<String, Object> httpHeaders,
                      java.io.OutputStream entityStream)
  throws java.io.IOException, WebApplicationException;
}

isWriteable()

isWriteable （） 方法决定实体写入器是否可以将 Java 类型映射到正确的实体类型。如果写入器可以执行映射，方法会返回 true。

表 51.4 “用于读取实体的参数” 描述 isWritable （） 方法的参数。

表 51.4. 用于读取实体的参数
参数	类型	描述
`type`	`class<T>`	指定正在写入的对象的 Java 类。
`genericType`	类型	指定要写入的 Java 类型，可通过反映资源方法返回类型或通过检查返回的实例来获取。`GenericEntity` 类第 48.4 节 “返回包含通用类型信息的实体” 提供了控制这个值的支持。
`annotations`	Annotation[]	指定返回实体的方法上的注释列表。
`mediaType`	`MediatType`	指定 HTTP 实体的 MIME 类型。

getSize()

getSize （） 方法在 writeTo （） 之前调用。它会返回所写入实体的长度（以字节为单位）。如果返回正值，则该值将写入到 HTTP 消息的 Content-Length 标头中。

表 51.5 “用于读取实体的参数” 描述 getSize （） 方法的参数。

表 51.5. 用于读取实体的参数
参数	类型	描述
`t`	generic	指定正在写入的实例。
`type`	`class<T>`	指定正在写入的对象的 Java 类。
`genericType`	类型	指定要写入的 Java 类型，可通过反映资源方法返回类型或通过检查返回的实例来获取。`GenericEntity` 类第 48.4 节 “返回包含通用类型信息的实体” 提供了控制这个值的支持。
`annotations`	Annotation[]	指定返回实体的方法上的注释列表。
`mediaType`	`MediatType`	指定 HTTP 实体的 MIME 类型。

writeTo()

writeTo （） 方法将 Java 对象转换为所需的实体类型，并将实体写入到输出流。如果在将实体写入输出流时出现错误，则方法应抛出 IOException 异常。如果发生错误需要 HTTP 错误响应，则应抛出带有 HTTP 响应的 WebApplicationException。

表 51.6 “用于读取实体的参数” 描述 writeTo （） 方法的参数。

表 51.6. 用于读取实体的参数
参数	类型	描述
`t`	generic	指定正在写入的实例。
`type`	`class<T>`	指定正在写入的对象的 Java 类。
`genericType`	类型	指定要写入的 Java 类型，可通过反映资源方法返回类型或通过检查返回的实例来获取。`GenericEntity` 类第 48.4 节 “返回包含通用类型信息的实体” 提供了控制这个值的支持。
`annotations`	Annotation[]	指定返回实体的方法上的注释列表。
`mediaType`	`MediatType`	指定 HTTP 实体的 MIME 类型。
`httpHeaders`	MultivaluedMap<String, Object>	指定与实体关联的 HTTP 响应标头。
`entityStream`	`OutputStream`	指定写入实体的输出流。

在将 MessageBodyWriter 实施用作实体写入器之前，必须使用 javax.ws.rs.ext.Provider 注解进行解码。@Provider 注释提醒提供的实施提供额外的功能。该实现还必须使用运行时注册，如 “注册读取器和写入器”一节所述。

默认情况下，自定义实体供应商处理所有 MIME 类型。您可以限制自定义实体写入器将使用 javax.ws.rs.Produces 注解来处理的 MIME 类型。@Produces 注释指定自定义实体提供程序生成的 MIME 类型的逗号分隔列表。如果实体不是指定的 MIME 类型，则实体提供程序将无法被选为可能的写入器。

例 51.4 “XML 源实体写入器” 显示取 Source 对象并生成 XML 实体的实体写入器。

例 51.4. XML 源实体写入器

import java.io.IOException;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

import javax.ws.rs.Produces;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.ext.MessageBodyWriter;
import javax.ws.rs.ext.Provider;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;

import org.w3c.dom.Document;

import org.apache.cxf.jaxrs.ext.xml.XMLSource;

@Provider
@Produces({"application/xml", "application/*+xml", "text/xml" })
public class SourceProvider implements MessageBodyWriter<Source>
{

  public boolean isWriteable(Class<?> type,
                             Type genericType,
                             Annotation[] annotations,
                             MediaType mt)
  {
    return Source.class.isAssignableFrom(type);
  }

  public void writeTo(Source source,
                      Class<?> clazz,
                      Type genericType,
                      Annotation[] annotations,
                      MediaType mediatype,
                      MultivaluedMap<String, Object> httpHeaders,
                      OutputStream os)
  throws IOException
  {
    StreamResult result = new StreamResult(os);
    TransformerFactory tf = TransformerFactory.newInstance();
    try
    {
      Transformer t = tf.newTransformer();
      t.transform(source, result);
    }
    catch (TransformerException te)
    {
      te.printStackTrace();
      throw new WebApplicationException(te);
    }
  }

  public long getSize(Source source,
                      Class<?> type,
                      Type genericType,
                      Annotation[] annotations,
                      MediaType mt)
  {
    return -1;
  }
}

注册读取器和写入器

在 JAX-RS 应用可以使用任何自定义实体提供程序之前，自定义提供程序必须通过运行时注册。使用应用配置文件中的 jaxrs:providers 元素或使用 JAXRSServerFactoryBean 类来注册提供程序。

jaxrs:providers 元素是 jaxrs:server 元素的子项，包含 bean 元素的列表。每个 bean 元素都定义一个实体提供程序。

例 51.5 “使用运行时注册实体供应商” 显示配置为使用一组自定义实体供应商的 JAX-RS 服务器。

例 51.5. 使用运行时注册实体供应商

<beans ...>
  <jaxrs:server id="customerService" address="/">
    ...
    <jaxrs:providers>
      <bean id="isProvider" class="com.bar.providers.InputStreamProvider"/>
      <bean id="longProvider" class="com.bar.providers.LongProvider"/>
    </jaxrs:providers>
  </jaxrs:server>
</beans>

JAXRSServerFactoryBean 类是一个 Apache CXF 扩展，提供对配置 API 的访问。它有一个 setProvider （） 方法，允许您将实例化的实体提供程序添加到应用程序中。例 51.6 “以编程方式注册实体供应商” 显示以编程方式注册实体提供程序的代码。

例 51.6. 以编程方式注册实体供应商

import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;
...
JAXRSServerFactoryBean sf = new JAXRSServerFactoryBean();
...
SourceProvider provider = new SourceProvider();
sf.setProvider(provider);
...

第 52 章获取和使用上下文信息

摘要

上下文信息包括关于资源 URI、HTTP 标头和其他未通过注入注解可用的其他详细信息的详细信息。Apache CXF 提供特殊类，可将所有可能的上下文信息放在一个对象中。

52.1. 上下文介绍

上下文注解

您可以使用 javax.ws.rs.core.Context 注解来指定该上下文信息被注入到字段或资源方法参数中。为其中一个上下文类型的字段或参数添加注解将指示运行时将适当的上下文信息注入注释字段或参数。

上下文类型

表 52.1 “上下文类型” 列出可注入的上下文信息以及支持它们的对象。

表 52.1. 上下文类型
对象	上下文信息
UriInfo	完整请求 URI
HttpHeaders	HTTP 消息标头
Request（请求）	可用于决定最佳表示变体的信息，或者确定是否设置了一组条件
SecurityContext	有关请求者的安全性的信息，包括使用中的身份验证方案（如果请求通道安全），以及用户原则

可以使用上下文信息

上下文信息可用于 JAX-RS 应用的以下部分：

资源类别
资源方法
实体供应商
例外映射程序

影响范围

使用 @Context 注释注入的所有上下文信息都特定于当前请求。在包括实体供应商和异常映射程序的所有情况下也是如此。

添加上下文

借助 JAX-RS 框架，开发人员可以扩展可通过上下文机制注入的信息类型。您可以通过实施 Context<T> 对象并将其注册到运行时来添加自定义上下文。

52.2. 使用完整请求 URI

摘要

请求 URI 包含大量信息。大部分信息可以使用方法参数来访问，如第 47.2.2 节 “从请求 URI 注入数据” 所述，但使用参数强制处理 URI 的具体限制。使用参数来访问 URI 片段，也不提供对完整请求 URI 的资源访问权限。

您可以通过将 URI 上下文注入资源来提供对完整请求 URI 的访问。URI 作为 UriInfo 对象提供。UriInfo 接口提供了以多种方式分离 URI 的功能。它还可以将 URI 提供为 UriBuilder 对象，允许您构建 URI 以返回到客户端。

:experimental:

52.2.1. 注入 URI 信息

概述

当为 UriInfo 对象进行解码的类字段或方法参数时，当前请求的 URI 上下文将注入到 UriInfo 对象中。

示例

将 URI 上下文注入类字段通过注入 URI 上下文，显示带有字段的类。

将 URI 上下文注入类字段

import javax.ws.rs.core.Context;
import javax.ws.rs.core.UriInfo;
import javax.ws.rs.Path;
...
@Path("/monstersforhire/")
public class MonsterService
{
  @Context
  UriInfo requestURI;
  ...
}

52.2.2. 使用 URI

概述

使用 URI 上下文的一个主要优点是，它提供对服务的基本 URI 以及所选资源的 URI 的路径片段。这些信息可用于很多目的，例如根据 URI 或计算 URI 返回作为响应的一部分的处理决策。例如，如果请求的基本 URI 包含 .com 扩展，该服务可能会决定使用美国金属，以及基本 URI 是否包含 .co.uk 扩展可能会决定我们 British Pounds。

UriInfo 接口提供了访问 URI 部分的方法：

基本 URI
资源路径
完整 URI

获取 Base URI

Base URI 是发布该服务的根 URI。它不包含在任何服务的 @Path 注释中指定的 URI 的任何部分。例如，如果实现例 47.5 “禁用 URI decoding” 中定义的资源的服务已发布到 http://fusesource.org，且在 http://fusesource.org/montersforhire/nightstalker?12 中发出了一个请求，基本 URI 为 http://fusesource.org。

表 52.2 “访问资源基本 URI 的方法” 描述返回基本 URI 的方法。

表 52.2. 访问资源基本 URI 的方法
方法	Desription
`URIgetBaseUri`	将服务的基本 URI 返回为 `URI` 对象。
`UriBuildergetBaseUriBuilder`	将基本 URI 返回为 `javax.ws.rs.core.UriBuilder` 对象。`UriBuilder` 类可用于为该服务实施的其他资源创建 URI。

获取路径

请求 URI 的路径 部分是用来选择当前资源的 URI 部分。它不包括基础 URI，但包含 URI 中包含的任何 URI 模板变量和列表参数。

路径的值取决于所选资源。例如，在获取资源路径中定义的资源路径将是：

rootPath — /monstersforhire/
getterPath — /mostersforhire/nightstalker
GET 请求在 /monstersforhire/nightstalker 上进行。
putterPath — /mostersforhire/911
PUT 请求在 /monstersforhire/911 上进行。

获取资源路径

@Path("/monstersforhire/")
public class MonsterService
{
  @Context
  UriInfo rootUri;

  ...

  @GET
  public List<Monster> getMonsters(@Context UriInfo getUri)
  {
    String rootPath = rootUri.getPath();
    ...
  }

  @GET
  @Path("/{type}")
  public Monster getMonster(@PathParam("type") String type,
                            @Context UriInfo getUri)
  {
    String getterPath = getUri.getPath();
    ...
  }

  @PUT
  @Path("/{id}")
  public void addMonster(@Encoded @PathParam("type") String type,
                         @Context UriInfo putUri)
  {
    String putterPath = putUri.getPath();
    ...
  }
  ...
}

表 52.3 “访问资源路径的方法” 描述返回资源路径的方法。

表 52.3. 访问资源路径的方法
方法	Desription
`StringgetPath`	将资源的路径返回为解码 URI。
`StringgetPathbooleandecode`	返回资源的路径。指定 `false` 可禁用 URI 解码。
`List<PathSegment>getPathSegments`	将解码的路径返回为 javax.ws.rs.core.PathSegment 对象列表。路径的每个部分（包括列表）都放在列表中的一个唯一条目中。例如，资源路径 box/round#tall 将导致一个含有三个条目的列表： `box`、`round` 和 `tall`。
`List<PathSegment>getPathSegmentsbooleandecode`	将路径返回为 javax.ws.rs.core.PathSegment 对象列表。路径的每个部分（包括列表）都放在列表中的一个唯一条目中。指定 `false` 可禁用 URI 解码。例如，资源路径 box#tall/round 将生成三个条目的列表： `box`、`tall`、和 `round`。

获取完整请求 URI

表 52.4 “访问完整请求 URI 的方法” 描述返回完整请求 URI 的方法。您可以选择返回请求 URI 或资源的绝对路径。区别在于，请求 URI 包含附加到 URI 的任何查询参数，且绝对路径不包含查询参数。

表 52.4. 访问完整请求 URI 的方法
方法	Desription
`URIgetRequestUri`	返回完整的请求 URI，包括查询参数和列表参数，作为 `java.net.URI` 对象。
`UriBuildergetRequestUriBuilder`	返回完整的请求 URI，包括查询参数和列表参数，作为 `javax.ws.rs.UriBuilder` 对象。`UriBuilder` 类可用于为该服务实施的其他资源创建 URI。
`URIgetAbsolutePath`	返回完整的请求 URI，包括列表参数，作为 `java.net.URI` 对象。绝对路径不包含查询参数。
`UriBuildergetAbsolutePathBuilder`	返回完整的请求 URI，包括列表参数，作为 `javax.ws.rs.UriBuilder` 对象。绝对路径不包含查询参数。

对于使用 URI http://fusesource.org/montersforhire/nightstalker?12 的请求，getRequestUri （） 方法将返回 http://fusesource.org/montersforhire/nightstalker?12。getAbsolutePath （） 方法返回 http://fusesource.org/montersforhire/nightstalker。

52.2.3. 获取 URI 模板变量的值

概述

如 “设置路径”一节所述，资源路径可以包含绑定到动态的值的变量片段。这些变量路径片段通常用作资源方法的参数，如 “从 URI 的路径获取数据”一节所述。但是，您还可以通过 URI 上下文访问它们。

获取路径参数的方法

UriInfo 接口提供了例 52.1 “从 URI 上下文返回路径参数的方法” 的两个方法，它返回路径参数列表。

例 52.1. 从 URI 上下文返回路径参数的方法

MultivaluedMap<java.lang.String, java.lang.String&gt;getPathParametersMultivaluedMap<java.lang.String, java.lang.String&gt;getPathParametersbooleandecode

不使用任何参数的 getPathParameters （） 方法自动解码路径参数。如果要禁用 URI decoding，请使用 getPathParameters (false)。

该值使用模板标识符作为键存储在映射中。例如，如果资源的 URI 模板是 /{color}/box/{note}，则返回的映射将有两个条目，且带有键 颜色 并记下。

示例

例 52.2 “从 URI 上下文提取路径参数” 显示使用 URI 上下文检索路径参数的代码。

例 52.2. 从 URI 上下文提取路径参数

import javax.ws.rs.Path;
import javax.ws.rs.Get;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.UriInfo;
import javax.ws.rs.core.MultivaluedMap;

@Path("/monstersforhire/")
public class MonsterService

  @GET
  @Path("/{type}/{size}")
  public Monster getMonster(@Context UriInfo uri)
  {
    MultivaluedMap paramMap = uri.getPathParameters();
    String type = paramMap.getFirst("type");
    String size = paramMap.getFirst("size");
  }
}

第 53 章注解继承

摘要

JAX-RS 注释可以通过子类和实施注释接口的类来继承。继承机制允许子类和实施类覆盖从其父级继承的注解。

概述

继承是 Java 中更强大的机制之一，因为它允许开发人员创建能够满足特定需求的通用对象。JAX-RS 通过允许将类映射到来自超级类的资源使用的注解来保留此电源。

JAX-RS 的注解继承也扩展为支持接口。实施类继承其实施接口中使用的 JAX-RS 注释。

JAX-RS 继承规则提供了覆盖继承注解的机制。但是，无法从超级类或接口继承的构造中完全删除 JAX-RS 注解。

继承规则

资源类从它实施的接口继承任何 JAX-RS 注释。资源类也会从扩展的任何超级类继承任何 JAX-RS 注解。从超级类继承的注解优先于从符号继承的注解。

在例 53.1 “注解继承” 中显示的代码示例中，Kaijin 类的 getMonster （） 方法继承了 Kaiju 接口的 @Path、@GET 和 @PathParam 注解。

例 53.1. 注解继承

public interface Kaiju
{
  @GET
  @Path("/{id}")
  public Monster getMonster(@PathParam("id") int id);
  ...
}

@Path("/kaijin")
public class Kaijin implements Kaiju
{
  public Monster getMonster(int id)
  {
    ...
  }
  ...
}

覆盖继承的注解

覆盖继承的注解就像提供新注解一样容易。如果子类或实施类为方法提供自己的 JAX-RS 注释，则忽略该方法的所有 JAX-RS 注释。

在例 53.2 “覆盖注解继承” 中显示的代码示例中，Kaijin 类的 getMonster （） 方法不会从 Kaiju 接口继承任何注解。实施类覆盖 @Produces 注释，它会导致从接口中的所有注解被忽略。

例 53.2. 覆盖注解继承

public interface Kaiju
{
  @GET
  @Path("/{id}")
  @Produces("text/xml");
  public Monster getMonster(@PathParam("id") int id);
  ...
}

@Path("/kaijin")
public class Kaijin implements Kaiju
{

  @GET
  @Path("/{id}")
  @Produces("application/octect-stream");
  public Monster getMonster(@PathParam("id") int id)
  {
    ...
  }
  ...
}

第 54 章使用 OpenAPI 支持扩展 JAX-RS 端点

摘要

CXF OpenApiFeature (org.apache.cxf.jaxrs.openapi.OpenApiFeature)允许您通过通过简单配置来扩展公布的 JAX-RS 服务端点来生成 OpenAPI 文档。

Spring Boot 和 Karaf 实现中均支持 OpenApiFeature。

54.1. OpenApiFeature 选项

您可以在 OpenApiFeature 中使用以下选项：

表 54.1. OpenApiFeature 操作
名称	描述	默认
`configLocation`	OpenAPI 配置位置	null
`contactEmail`	联系电子邮件+	null
`contactName`	联系人名称+	null
`contactUrl`	联系链接+	null
`customizer`	自定义器类实例	null
`description`	description+	null
`filterClass`	安全过滤器++	null
`ignoredRoutes`	扫描所有资源时排除特定路径（请参阅 `scanAllResources`）++	null
`license`	许可证+	null
`licenseUrl`	许可证 URL+	null
`prettyPrint`	生成 openapi.json 时，请看看 JSON 文档++	true
`propertiesLocation`	属性文件位置	`/swagger.properties`
`readAllResources`	读取所有操作，无 @Operation++	true
`resourceClasses`	必须扫描++ 的资源类列表。	null
`resourcePackages`	一个软件包名称列表，其中资源必须被扫描++	null
`runAsFilter`	作为过滤器运行该功能	false
`scan`	自动扫描所有 JAX-RS 资源	true
`scanKnownConfigLocations`	扫描已知的 OpenAPI 配置位置(classpath 或 filesystem)，即： openapi-configuration.yaml openapi-configuration.json openapi.yaml openapi.json	true
`scannerClass`	JAX-RS API 扫描程序类的名称，用于处理应用、资源软件包、资源类和类路径扫描，请参阅 Resource Scanning 部分	null
`securityDefinitions`	安全定义列表+	null
`supportSwaggerUi`	打开/关闭 SwaggerUI 支持	null (== true)
`swaggerUiConfig`	Swagger UI 配置	null
`swaggerUiMavenGroupAndArtifact`	用于 pinpoint SwaggerUI 的 Maven 工件	null
`swaggerUiVersion`	SwaggerUI 的版本	null
`termsOfServiceUrl`	服务 URL+ 条款.	null
`title`	标题+	null
`useContextBasedConfig`	如果设置，则会为每个 OpenApiContext 实例生成唯一的上下文 Id （请使用多服务器端点）。另外，您可能想要将 scan 属性设置为 false。	false
`version`	版本+	null

+ 选项在 OpenAPI 类中定义

++ 选项在 SwaggerConfiguration 类中定义

54.2. Karaf 实施

这部分论述了如何使用在 JAR 文件中定义 REST 服务并部署到 Karaf 容器上的 Fuse 的 OpenApiFeature。

54.2.1. Quickstart 示例

您可以从 Fuse Software Downloads 页面下载 Red Hat Fuse Quickstarts。

Quickstart zip 文件包含快速入门的 /cxf/rest/ 目录，它演示了如何使用 CXF 创建 RESTful (JAX-RS) Web 服务，以及如何启用 OpenAPI 并注解 JAX-RS 端点。

54.2.2. 启用 OpenAPI

启用 OpenAPI 涉及：

通过将 CXF 类(org.apache.cxf.jaxrs.openapi.OpenApiFeature)添加到 < jaxrs:server > 定义，修改定义 CXF 服务的 XML 文件。
例如，请参阅 55.4 示例 XML 文件示例。
在 REST 资源类中：
- 为服务所需的每个注解导入 OpenAPI 注解：
```
import io.swagger.annotations.*
```
  其中 * = Api,ApiOperation,ApiResponse, ApiResponse ,ApiResponses 等等。
  详情请参阅 https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X。
  例如，请参阅 55.5 示例资源类。
- 在 JAX-RS 注释的端点中添加 OpenAPI 注释(@PATH、@PUT、@POST、@GET、@Produces、@Consumes、@DELETE、@PathParam 等等)。

例如，请参阅 55.5 示例资源类。

55.4 示例 XML 文件示例

<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jaxrs="http://cxf.apache.org/blueprint/jaxrs"
    xmlns:cxf="http://cxf.apache.org/blueprint/core"
    xsi:schemaLocation="
      http://www.osgi.org/xmlns/blueprint/v1.0.0
https://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd
      http://cxf.apache.org/blueprint/jaxrs
http://cxf.apache.org/schemas/blueprint/jaxrs.xsd
      http://cxf.apache.org/blueprint/core
http://cxf.apache.org/schemas/blueprint/core.xsd">

    <jaxrs:server id="customerService" address="/crm">
        <jaxrs:serviceBeans>
            <ref component-id="customerSvc"/>
        </jaxrs:serviceBeans>
        <jaxrs:providers>
           <bean class="com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider"/>
        </jaxrs:providers>
        <jaxrs:features>
        <bean class="org.apache.cxf.jaxrs.openapi.OpenApiFeature">
          <property name="title" value="Fuse:CXF:Quickstarts - Customer Service" />
          <property name="description" value="Sample REST-based Customer Service" />
          <property name="version" value="${project.version}" />
        </bean>
        </jaxrs:features>
    </jaxrs:server>

    <cxf:bus>
        <cxf:features>
          <cxf:logging />
        </cxf:features>
        <cxf:properties>
            <entry key="skip.default.json.provider.registration" value="true" />
        </cxf:properties>
    </cxf:bus>

    <bean id="customerSvc" class="org.jboss.fuse.quickstarts.cxf.rest.CustomerService"/>

</blueprint>

55.5 示例资源类

.
.
.

import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.Response;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

.
.
.

@Path("/customerservice/")
@Api(value = "/customerservice", description = "Operations about customerservice")
public class CustomerService {

    private static final Logger LOG =
          LoggerFactory.getLogger(CustomerService.class);

    private MessageContext jaxrsContext;
    private long currentId                = 123;
    private Map<Long, Customer> customers = new HashMap<>();
    private Map<Long, Order> orders       = new HashMap<>();

    public CustomerService() {
        init();
    }


    @GET
    @Path("/customers/{id}/")
    @Produces("application/xml")
    @ApiOperation(value = "Find Customer by ID", notes = "More notes about this
        method", response = Customer.class)
    @ApiResponses(value = {
            @ApiResponse(code = 500, message = "Invalid ID supplied"),
            @ApiResponse(code = 204, message = "Customer not found")
            })
    public Customer getCustomer(@ApiParam(value = "ID of Customer to fetch",
        required = true) @PathParam("id") String id) {
        LOG.info("Invoking getCustomer, Customer id is: {}", id);
        long idNumber = Long.parseLong(id);
        return customers.get(idNumber);
    }


    @PUT
    @Path("/customers/")
    @Consumes({ "application/xml", "application/json" })
    @ApiOperation(value = "Update an existing Customer")
    @ApiResponses(value = {
            @ApiResponse(code = 500, message = "Invalid ID supplied"),
            @ApiResponse(code = 204, message = "Customer not found")
            })
    public Response updateCustomer(@ApiParam(value = "Customer object that needs
        to be updated", required = true) Customer customer) {
        LOG.info("Invoking updateCustomer, Customer name is: {}", customer.getName());
        Customer c = customers.get(customer.getId());
        Response r;
        if (c != null) {
            customers.put(customer.getId(), customer);
            r = Response.ok().build();
        } else {
            r = Response.notModified().build();
        }

        return r;
    }

    @POST
    @Path("/customers/")
    @Consumes({ "application/xml", "application/json" })
    @ApiOperation(value = "Add a new Customer")
    @ApiResponses(value = { @ApiResponse(code = 500, message = "Invalid ID
        supplied"), })
    public Response addCustomer(@ApiParam(value = "Customer object that needs to
        be updated", required = true) Customer customer) {
        LOG.info("Invoking addCustomer, Customer name is: {}", customer.getName());
        customer.setId(++currentId);

        customers.put(customer.getId(), customer);
        if (jaxrsContext.getHttpHeaders().getMediaType().getSubtype().equals("json"))
    {
            return Response.ok().type("application/json").entity(customer).build();
        } else {
            return Response.ok().type("application/xml").entity(customer).build();
        }
    }

    @DELETE
    @Path("/customers/{id}/")
    @ApiOperation(value = "Delete Customer")
    @ApiResponses(value = {
            @ApiResponse(code = 500, message = "Invalid ID supplied"),
            @ApiResponse(code = 204, message = "Customer not found")
            })
    public Response deleteCustomer(@ApiParam(value = "ID of Customer to delete",
        required = true) @PathParam("id") String id) {
        LOG.info("Invoking deleteCustomer, Customer id is: {}", id);
        long idNumber = Long.parseLong(id);
        Customer c = customers.get(idNumber);

        Response r;
        if (c != null) {
            r = Response.ok().build();
            customers.remove(idNumber);
        } else {
            r = Response.notModified().build();
        }

        return r;
    }

.
.
.

}

54.3. Spring Boot 实现

这部分论述了如何在 Spring Boot 中使用 Swagger2Feature。

请注意，对于 OpenAPI 3 实现，请使用 OpenApiFeature (org.apache.cxf.jaxrs.openapi.OpenApiFeature)。

54.3.1. Quickstart 示例

Quickstart 示例(https://github.com/fabric8-quickstarts/spring-boot-cxf-jaxrs)演示了如何在 Spring Boot 中使用 Apache CXF。Quickstart 使用 Spring Boot 配置一个应用程序，这些应用程序包括启用了 Swagger 的 CXF JAX-RS 端点。

54.3.2. 启用 Swagger

启用 Swagger 包括：

在 REST 应用程序中：
- 导入 Swagger2Feature:
```
import org.apache.cxf.jaxrs.swagger.Swagger2Feature;
```
- 在 CXF 端点中添加 Swagger2Feature:
```
endpoint.setFeatures(Arrays.asList(new Swagger2Feature()));
```
  例如，请参阅 55.1 示例 REST 应用程序。
在 Java 实施文件中，为服务所需的每个注解导入 Swagger API 注解：
```
import io.swagger.annotations.*
```
其中 * = Api,ApiOperation,ApiResponse, ApiResponse ,ApiResponses 等等。
详情请查看 https://github.com/swagger-api/swagger-core/wiki/Annotations。
例如，请参阅 55.2 示例 Java 实施文件。
在 Java 文件中，将 Swagger 注释添加到 JAX-RS 注释(@PATH、@PUT、@POST、@GET、@Produces、@Consumes、@DELETE、@PathParam 等等)。
例如，请参阅 55.3 示例 Java 文件。

55.1 示例 REST 应用程序

package io.fabric8.quickstarts.cxf.jaxrs;

import java.util.Arrays;

import org.apache.cxf.Bus;
import org.apache.cxf.endpoint.Server;
import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;
import org.apache.cxf.jaxrs.swagger.Swagger2Feature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class SampleRestApplication {

    @Autowired
    private Bus bus;

    public static void main(String[] args) {
        SpringApplication.run(SampleRestApplication.class, args);
    }

    @Bean
    public Server rsServer() {
        // setup CXF-RS
        JAXRSServerFactoryBean endpoint = new JAXRSServerFactoryBean();
        endpoint.setBus(bus);
        endpoint.setServiceBeans(Arrays.<Object>asList(new HelloServiceImpl()));
        endpoint.setAddress("/");
        endpoint.setFeatures(Arrays.asList(new Swagger2Feature()));
        return endpoint.create();
    }
}

55.2 示例 Java 实施文件

import io.swagger.annotations.Api;

@Api("/sayHello")
public class HelloServiceImpl implements HelloService {

    public String welcome() {
        return "Welcome to the CXF RS Spring Boot application, append /{name} to call the hello service";
    }

    public String sayHello(String a) {
        return "Hello " + a + ", Welcome to CXF RS Spring Boot World!!!";
    }

}

55.3 示例 Java 文件

package io.fabric8.quickstarts.cxf.jaxrs;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

import org.springframework.stereotype.Service;

@Path("/sayHello")
@Service
public interface HelloService {

    @GET
    @Path("")
    @Produces(MediaType.TEXT_PLAIN)
    String welcome();

    @GET
    @Path("/{a}")
    @Produces(MediaType.TEXT_PLAIN)
    String sayHello(@PathParam("a") String a);

}

54.4. 访问 OpenAPI 文档

当 OpenApiFeature 启用 OpenAPI 时，OpenApiFeature 包括了服务端点位置的 OpenAPI 文档，后跟 /openapi.json 或 /openapi.yaml。

例如，对于 http://host:port/context/services/ 上发布的 JAX-RS 端点，其中 上下文是 Web 应用上下文，/services 是一个 servlet URL，其 OpenAPI 文档位于 http://host:port/context/services/openapi.json 和 http://host:port/context/services/openapi.yaml。

如果 OpenApiFeature 处于活跃状态，CXF Services 页链接到 OpenAPI 文档。

在上例中，您将进入 http://host:port/context/services/services，然后按照返回 OpenAPI JSON 文档的链接操作。

如果需要使用 CORS 支持从另一主机上的 OpenAPI UI 访问定义，您可以从 cxf-rt-rs-security-cors 添加 CrossOriginResourceSharingFilter。

54.5. 通过反向代理访问 OpenAPI

如果要通过反向代理访问 OpenAPI JSON 文档或 OpenAPI UI，请设置以下选项：

将 CXFServlet use-x-forwarded-headers init 参数设置为 true。
- 在 Spring Boot 中，为参数名称添加前缀为 cxf.servlet.init ：
```
cxf.servlet.init.use-x-forwarded-headers=true
```
- 在 Karaf 中，将以下行添加到 installDir/etc/org.apache.cxf.osgi.cfg 配置文件：
```
cxf.servlet.init.use-x-forwarded-headers=true
```
  注：如果您还没有在 etc 目录中有一个 org.apache.cxf.osgi.cfg 文件，您可以创建一个。
如果您为 OpenApiFeature basePath 选项指定一个值，并且希望防止 OpenAPI 缓存 basePath 值，请将 OpenApiFeature usePathBasedConfig 选项设置为 TRUE ：
```
<bean class="org.apache.cxf.jaxrs.openapi.OpenApiFeature">
    <property name="usePathBasedConfig" value="TRUE" />
</bean>
```

部分 VII. 开发 Apache CXF Interceptors

本指南介绍了如何编写可在消息上执行前和后处理的 Apache CXF 拦截器。

第 55 章 Apache CXF 运行时中的拦截器

摘要

Apache CXF 运行时的大部分功能由拦截器实施。Apache CXF 运行时创建的每个端点都有三个用于处理消息的潜在拦截器链。这些链中的拦截器负责转换在线路间传输的原始数据与端点实施代码处理的 Java 对象之间的消息。拦截器被组织为阶段，以确保正确顺序进行处理。

概述

Apache CXF 处理消息的主要部分。当消费者对远程服务进行调用时，运行时需要将数据整理到服务可使用的消息中，并将其置于线路上。服务提供商必须传播消息，执行其业务逻辑，并将响应分到相应的消息格式。然后，消费者必须总结响应消息，将其与正确的请求相关联，并将它传递到消费者的应用代码。除了基本的 marshaling 和 unmarshaling 外，Apache CXF 运行时还可使用消息数据执行许多其他事务。例如，如果激活 WS-RM，运行时必须处理消息块和确认消息，然后再进行 marshaling 和 unmarshaling 消息。如果激活安全性，则运行时必须验证消息的凭据作为消息处理序列的一部分。

图 55.1 “Apache CXF 拦截器链” 显示服务提供商收到请求消息的基本路径。

图 55.1. Apache CXF 拦截器链

Apache CXF 中的消息处理

当 Apache CXF 开发的用户调用远程服务时，会启动以下消息处理序列：

Apache CXF 运行时会创建一个出站拦截器链，以处理请求。
如果调用启动双向消息交换，则运行时会创建入站拦截器链和故障处理拦截器链。
请求消息通过出站拦截器链按顺序传递。
链中的每个拦截器在消息上执行一些处理。例如，Apache CXF 提供的 SOAP 拦截器在 SOAP envelope 中打包信息。
如果出站链上的任何拦截器创建错误条件，则链的出现不一致，并将控制权返回到应用程序级代码。
通过在之前调用的拦截器在所有调用拦截器上调用错误处理方法，以此形成拦截器链。
请求被发送到适当的服务提供商。
收到响应后，它将按顺序通过入站拦截器链传输。
注意
如果响应是错误消息，它将被传递到错误处理拦截器链。
如果入站链上的任何拦截器都创建一个错误条件，则链将无用。
当消息到达入站拦截器链的末尾时，它将重新传递给应用代码。

当 Apache CXF 开发服务供应商从消费者收到请求时，会有一个类似的过程：

Apache CXF 运行时会创建一个入站拦截器链，以处理请求消息。
如果请求是双向消息交换的一部分，运行时还会创建出站拦截器链和故障处理拦截器链。
请求通过入站拦截器链按顺序传递。
如果入站链上的任何拦截器都创建一个错误条件，则该链将不一致，并将错误分配给消费者。
通过在之前调用的拦截器在所有调用拦截器上调用错误处理方法，以此形成拦截器链。
当请求到达入站拦截器链的末尾时，它将传递给服务实施。
当响应就绪后，它通过出站拦截器链按顺序传递。
注意
如果响应是异常，它将通过错误处理拦截器链进行传递。
如果出站链上的任何拦截器都创建一个错误条件，则链将不一致，并且会发送出错信息。
当请求到达出站链的末尾后，它将被分配给消费者。

拦截器

Apache CXF 运行时中的所有消息都通过 拦截器 完成。拦截器是 POJO，可在将消息数据传递给应用程序层之前访问消息数据。它们可以执行一系列操作，包括：转换信息、从消息中剥离标头或验证消息数据。例如，拦截器可以读取消息的安全标头，根据外部安全服务验证凭证，并决定消息处理是否可以继续。

拦截器可用的消息数据由以下几个因素决定：

拦截器链
拦截器的阶段
之前在链中进行的其他拦截器

阶段

拦截器组织为阶段。阶段是具有常见功能的拦截器的逻辑分组。每个阶段负责特定类型的消息处理。例如，处理被传递给应用程序层的 marshaled Java 对象的拦截器都会在同一阶段发生。

拦截器链

阶段聚合成 拦截器链。拦截器链列表是根据消息是入站还是出站的、排序的拦截器阶段列表。

使用 Apache CXF 创建的每个端点都有三个拦截器链：

用于入站消息的链
用于出站消息的链
错误消息的链

拦截器链主要根据端点使用的绑定和传输进行构建。在链中添加其他运行时功能，如安全或日志记录。开发人员也可以使用配置在链中添加自定义拦截器。

开发拦截器

无论其功能如何，开发拦截器始终遵循相同的基本步骤：

第 56 章 Interceptor API
Apache CXF 提供多个提取拦截器，以便更轻松地开发自定义拦截器。
第 57.2 节 “指定拦截器的阶段”
拦截器需要消息的某些部分可用，并要求数据处于特定格式。信息内容和数据格式部分由拦截器的阶段决定。
第 57.3 节 “在一个阶段约束拦截器放置”
通常，在阶段内拦截器的排序并不重要。但是，在某些情况下，务必要确保在同一阶段之前或之后执行拦截器。
第 58.2 节 “处理消息”
第 58.3 节 “错误后卸载”
如果在执行拦截器后的活跃拦截器链中发生错误，则会调用其故障处理逻辑。
第 59 章 配置端点以使用拦截器

第 56 章 Interceptor API

摘要

拦截器实施阶段拦截器接口，该接口扩展了 base Interceptor 接口。此界面定义了很多 Apache CXF 运行时用来控制拦截器执行的方法，且不适用于应用开发人员实施。为了简化拦截器开发，Apache CXF 提供了很多可以扩展的抽象拦截器实现。

接口

Apache CXF 中的所有拦截器都实现了例 56.1 “基本拦截器接口” 中显示的基本拦截器接口。

例 56.1. 基本拦截器接口

package org.apache.cxf.interceptor;

public interface Interceptor<T extends Message>
{

  void handleMessage(T message) throws Fault;

  void handleFault(T message);

}

Interceptor 接口定义了开发人员需要为自定义拦截器实施的两种方法：

handleMessage(): handleMessage （） 方法在拦截器中大部分工作。它在消息链中的每个拦截器调用，并接收正在处理的消息的内容。开发人员在此方法中实施拦截器的消息处理逻辑。有关实施 handleMessage （） 方法的详细信息，请参阅第 58.2 节 “处理消息”。
handleFault(): 当普通消息处理中断时，handleFault （） 方法在拦截器调用。运行时调用每个被调用的拦截器的 handleFault （） 方法，因为它无法插入拦截器链。有关实现 handleFault （） 方法的详情，请参考第 58.3 节 “错误后卸载”。

大多数拦截器不会直接实施 Interceptor 接口。相反，它们实现了例 56.2 “阶段拦截器接口” 中显示的 PhaseInterceptor 接口。PhaseInterceptor 接口添加了四种方法，允许截获参与拦截器链。

例 56.2. 阶段拦截器接口

package org.apache.cxf.phase;
...

public interface PhaseInterceptor<T extends Message> extends Interceptor<T>
{

    Set<String> getAfter();

    Set<String> getBefore();

    String getId();

    String getPhase();

}

抽象拦截器类

开发人员应扩展 AbstractPhaseInterceptor 类，而不是直接实施阶段拦截器接口。此抽象类为阶段拦截器接口的阶段管理方法提供了实现。AbstractPhaseInterceptor 类还提供 handleFault （） 方法的默认实现。

开发人员需要提供 handleMessage （） 方法的实施。它们也可以为 handleFault （） 方法提供不同的实施。开发人员提供的实施可以利用通用 org.apache.cxf.message.Message 接口提供的方法来操控消息数据。

对于处理 SOAP 消息的应用程序，Apache CXF 提供了一个 AbstractSoapInterceptor 类。扩展此类提供的 handleMessage （） 方法和 handleFault （） 方法可以作为 org.apache.cxf.binding.soap.SoapMessage 对象来访问消息数据。SoapMessage 对象有检索 SOAP 标头、SOAP envelope 和其他 SOAP 元数据来自消息的方法。

第 57 章确定 Interceptor is Invoked

摘要

拦截器被组织成阶段。拦截器运行的阶段决定了它可以访问的消息数据的哪些部分。拦截器可以确定它与同一阶段其他拦截器的关系的位置。拦截器的阶段及其在阶段的位置被设置为拦截器的构造逻辑的一部分。

57.1. 指定 Interceptor Location

在开发自定义拦截器时，首先要考虑的是在消息处理链中由拦截器所属内容。开发人员可以通过以下两种方式之一控制消息处理链中的位置：

指定拦截器的阶段
在阶段指定拦截器的约束

通常，指定拦截器的位置的代码会被放入拦截器的构造器中。这使得运行时可以实例化拦截器，并在拦截器链中正确放置，而无需在应用程序级别代码中的任何显式操作。

57.2. 指定拦截器的阶段

概述

拦截器被组织成阶段。拦截器的阶段决定在消息处理序列中的何时被调用。开发人员指定拦截器的阶段。使用框架提供的常量值来指定阶段。

阶段

阶段是拦截器的逻辑集合。如图 57.1 “拦截器阶段” 所示，阶段中的拦截器会按顺序调用。

图 57.1. 拦截器阶段

阶段以有序列表的形式链接，组成一个拦截器链，并在消息处理过程中提供定义的逻辑步骤。例如，入站拦截器的 RECEIVE 阶段中的一组拦截器使用从线路中提取的原始消息数据，处理传输级别详情。

但是，在任何阶段都无法执行什么操作。建议在阶段内拦截器遵循处于阶段激增的任务。

Apache CXF 定义的各个阶段的完整列表可在第 62 章 Apache CXF 消息处理阶段 中找到。

指定阶段

Apache CXF 提供 org.apache.cxf.Phase 类，以用于指定阶段。类是一系列恒定的。Apache CXF 定义的每个阶段都具有 阶段 类中的相应常量。例如，RECEIVE 阶段通过 value Phase.RECEIVE 指定。

设置阶段

拦截器的阶段在拦截器的构造器中设置。AbstractPhaseInterceptor 类定义了三个构造器用于实例化拦截器：

public AbstractPhaseInterceptor (String phase)- 将拦截器的阶段设置为指定阶段，并将拦截器的 id 设置为拦截器的类名称。
这种构造器将满足大多数用例的需求。
public AbstractPhaseInterceptor (String id, String phase)- 将拦截器的 id 设置为以第一个参数形式传递的字符串，以及拦截器的阶段到第二个字符串。
public AbstractPhaseInterceptor (String phase, boolean uniqueId)- 指定拦截器是否应使用唯一、系统生成的 id。如果 uniqueId 参数为 true，则拦截器的 id 将由系统计算。如果 uniqueId 参数设为 false，则拦截器的 id 被设置为拦截器的类名称。

设置自定义拦截器阶段的建议方法是，使用 super （） 方法将阶段传递给 AbstractPhaseInterceptor 结构器，如例 57.1 “设置拦截器的阶段” 所示。

例 57.1. 设置拦截器的阶段

import org.apache.cxf.message.Message;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;

public class StreamInterceptor extends AbstractPhaseInterceptor<Message>
 {

    public StreamInterceptor()
   {
     super(Phase.PRE_STREAM);
    }
}

例 57.1 “设置拦截器的阶段” 中显示的 StreamInterceptor 拦截器被放入 PRE_STREAM 阶段。

57.3. 在一个阶段约束拦截器放置

概述

将拦截器放入阶段可能无法为其放置提供足够的控制，以确保拦截器正常工作。例如，如果拦截器需要使用 SAAJ API 检查消息的 SOAP 标头，它需要在拦截器将消息转换为 SAAJ 对象后运行。有些情况下，一个拦截器消耗了另一个拦截器所需的消息的一部分。在这种情况下，开发人员可以提供在拦截器前必须执行的拦截器列表。开发人员也可以提供拦截器列表，必须在拦截器后执行。

重要

运行时只能在拦截器的阶段遵从这些列表。如果开发人员在拦截器列表中放置一个拦截器，则这个拦截器必须在当前阶段后执行，则运行时将忽略请求。

在前将添加到链

开发拦截器时会产生一个问题，即无法始终存在拦截器所需的数据。当链中一个拦截器消耗后续拦截器所需的消息数据时，会出现这种情况。开发人员可以通过修改拦截器来控制自定义拦截器使用的内容，并可能会修复问题。但是，这并非始终是不可能的，因为 Apache CXF 使用了多个拦截器，开发人员无法修改它们。

另一种解决方案是确保将自定义拦截器放置在任何使用自定义拦截器需要的消息数据之前。最简单的方法是将其放置在以前的阶段，但这并非总是可能。对于拦截器需要放置在一个或多个拦截器前，Apache CXF 的 AbstractPhaseInterceptor 类提供了两个 addBefore （） 方法。

如例 57.2 “在其他拦截器前添加拦截器的方法” 所示，使用一个拦截器 ID，另一个则使用拦截器 ID。您可以创建多个调用来继续在列表中添加拦截器。

例 57.2. 在其他拦截器前添加拦截器的方法

publicaddBeforeStringipublicaddBeforeCollection<String>i

如例 57.3 “指定在当前拦截器后必须运行的拦截器列表” 所示，开发人员在自定义拦截器的 constuctor 中调用 addBefore （） 方法。

例 57.3. 指定在当前拦截器后必须运行的拦截器列表

public class MyPhasedOutInterceptor extends AbstractPhaseInterceptor
{

    public MyPhasedOutInterceptor() {
        super(Phase.PRE_LOGICAL);
        addBefore(HolderOutInterceptor.class.getName());
    }

...

}

大多数拦截器都将其类名称用于拦截器 ID。

在创建后将添加到链

不存在该拦截器所需的数据的另一个原因是，数据尚未放置在消息对象中。例如，拦截器可能希望将消息数据用作 SOAP 消息，但如果在将消息转换为 SOAP 消息之前，它将无法正常工作。开发人员可以通过修改拦截器来控制自定义拦截器使用的内容，并可能会修复问题。但是，这并非始终是不可能的，因为 Apache CXF 使用了多个拦截器，开发人员无法修改它们。

另一种解决方案是确保在拦截器或拦截器后放置自定义拦截器，它会生成自定义拦截器需要的消息数据。最简单的方法是将其放置在后续的阶段，但并不总是可能。AbstractPhaseInterceptor 类提供了两个 addAfter （） 方法，以便在一个或多个拦截器后放置拦截器。

如例 57.4 “其他拦截器后添加拦截器的方法” 所示，一种方法采用单一拦截器 ID，另一个方法采用拦截器 ID 的集合。您可以创建多个调用来继续在列表中添加拦截器。

例 57.4. 其他拦截器后添加拦截器的方法

publicaddAfterStringipublicaddAfterCollection<String>i

如例 57.5 “指定在当前拦截器前必须运行的拦截器列表” 所示，开发人员在自定义拦截器的 constuctor 中调用 addAfter （） 方法。

例 57.5. 指定在当前拦截器前必须运行的拦截器列表

public class MyPhasedOutInterceptor extends AbstractPhaseInterceptor
{

    public MyPhasedOutInterceptor() {
        super(Phase.PRE_LOGICAL);
        addAfter(StartingOutInterceptor.class.getName());
    }

...

}

大多数拦截器都将其类名称用于拦截器 ID。

第 58 章实施拦截器处理日志

摘要

拦截器非常简单实现。其大部分处理逻辑在 handleMessage （） 方法中。此方法接收消息数据并根据需要操作。开发人员可能还希望添加一些特殊逻辑来处理故障处理情况。

58.1. 拦截器流

图 58.1 “通过拦截器的流” 显示通过拦截器的进程流。

图 58.1. 通过拦截器的流

在普通消息处理中，只有 handleMessage （） 方法被调用。handleMessage （） 方法是放置拦截器的消息处理逻辑的位置。

如果在拦截器的 handleMessage （） 方法中发生错误，或者拦截器链中的任何后续拦截器，则处理 Fault （） 方法被调用。handleFault （） 方法对发生错误时的拦截器在拦截器进行清理非常有用。它也可用于更改故障消息。

58.2. 处理消息

概述

在普通消息处理中，会调用拦截器的 handleMessage （） 方法。它以 Message 对象的形式接收该消息数据。除消息的实际内容外，Message 对象可以包含与消息或消息处理状态相关的很多属性。Message 对象的确切内容取决于链中当前拦截器前面的拦截器。

获取消息内容

Message 接口提供了有两种方法，可用于提取消息内容：

public<T> T getContentjava.lang.Class<T> 格式 getContent （） 方法在指定类的对象中返回消息内容。如果内容不能作为指定类的实例使用，则返回 null。可用内容类型的列表由拦截器链上的位置和拦截器链的方向决定。
publicCollection<Attachment&gt ;getAttachments （） 方法返回一个 Java Collection 对象，该对象包含与消息关联的任何二进制附件。该附件存储在 org.apache.cxf.message.Attachment 对象中。附加对象提供管理二进制数据的方法。
重要
附件处理拦截器才会执行后可用。

确定消息的方向

消息方向可以通过查询消息交换来确定。消息交换将入站消息和出站消息存储在单独的属性中。^[3]

与消息关联的消息交换使用消息的 getExchange （） 方法来检索。如例 58.1 “获取消息交换” 所示，getExchange （） 不使用任何参数，并将消息交换返回为 org.apache.cxf.message.Exchange 对象。

例 58.1. 获取消息交换

ExchangegetExchange

Exchange 对象有四种方法，显示在例 58.2 “从消息交换获取消息” 中，用于获取与交换关联的信息。每种方法都将消息返回为 org.apache.cxf.Message 对象，如果消息不存在，它将返回 null。

例 58.2. 从消息交换获取消息

MessagegetInMessageMessagegetInFaultMessagegetOutMessagegetOutFaultMessage

例 58.3 “检查消息链的方向” 显示用于确定当前消息是否出站代码。该方法获取消息交换，并检查当前消息是否与交换的出站消息相同。它还会根据交换出站错误消息检查当前的消息，以针对出站故障拦截器链上的错误消息。

例 58.3. 检查消息链的方向

public static boolean isOutbound()
{
   Exchange exchange = message.getExchange();
        return message != null
               && exchange != null
               && (message == exchange.getOutMessage()
                   || message == exchange.getOutFaultMessage());
}

示例

例 58.4 “消息处理方法示例” 显示处理 zip 压缩消息的拦截器代码。它将检查消息的方向，然后执行适当的操作。

例 58.4. 消息处理方法示例

import java.io.IOException;
import java.io.InputStream;
import java.util.zip.GZIPInputStream;

import org.apache.cxf.message.Message;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;

public class StreamInterceptor extends AbstractPhaseInterceptor<Message>
{

  ...

  public void handleMessage(Message message)
  {

        boolean isOutbound = false;
        isOutbound = message == message.getExchange().getOutMessage()
               || message == message.getExchange().getOutFaultMessage();

        if (!isOutbound)
        {
          try
          {
             InputStream is = message.getContent(InputStream.class);
             GZIPInputStream zipInput = new GZIPInputStream(is);
             message.setContent(InputStream.class, zipInput);
          }
          catch (IOException ioe)
          {
             ioe.printStackTrace();
           }
        }
         else
        {
         // zip the outbound message
        }
    }
  ...
}

^[3] 它还单独存储入站和出站故障。

58.3. 错误后卸载

概述

当执行拦截器链期间发生错误时，运行时会停止遍历拦截器链，并通过调用已执行的链中任何拦截器的 handleFault （） 方法取消对链进行解放。

handleFault （） 方法可用于清理正常消息处理期间被拦截器使用的任何资源。它还可用来回滚仅在消息处理成功完成时应该可以正常工作的任何操作。如果将错误消息传递到出站故障处理拦截器链，也可利用 handleFault （） 方法向故障消息添加信息。

获取消息有效负载

handleFault （） 方法收到与普通消息处理中使用的 handleMessage （） 方法相同的 Message 对象。“获取消息内容”一节中描述了从 Message 对象获取消息内容。

示例

例 58.5 “处理未发送拦截器链” 显示用于确保原始 XML 流在截屏链时重新放置到消息的代码。

例 58.5. 处理未发送拦截器链

@Override
public void handleFault(SoapMessage message)
{
  super.handleFault(message);
  XMLStreamWriter writer = (XMLStreamWriter)message.get(ORIGINAL_XML_WRITER);
  if (writer != null)
  {
    message.setContent(XMLStreamWriter.class, writer);
  }
}

第 59 章配置端点以使用拦截器

摘要

当端点中包含在消息交换中时，拦截器会添加到端点。端点的拦截器链由 Apache CXF 运行时中多个组件的拦截器链组成。拦截器在端点的配置或其中一个运行时组件的配置中指定。可以使用配置文件或拦截器 API 添加拦截器。

59.1. 确定何时附加拦截器

概述

有多个运行时对象托管拦截器链。包括：

端点对象
服务对象
代理对象
用于创建端点或代理的 factory 对象
绑定
中央 总线 对象

开发人员可以将自己的拦截器附加到这些对象。附加拦截器的最常见对象是总线和单个端点。选择正确的对象需要了解这些运行时对象如何组合组成端点。按照设计，每个 cxf 相关捆绑包都有自己的 cxf 总线。因此，如果在总线中配置了拦截器，且同一 Blueprint 上下文中的服务会被导入或创建到另一个捆绑包中，则拦截器不会被处理。您可以将拦截器直接配置到导入服务的 JAXWS 客户端或端点。

端点和代理

将拦截器附加到端点或代理是放置拦截器的最精细方式。任何直接连接到端点或代理的拦截器都仅影响特定的端点或代理。这是附加特定于某个服务的拦截器的好位置。例如，如果开发人员想要公开一个服务实例，可将单元从指标转换为阻碍，将拦截器直接附加到一个端点。

工厂

使用 Spring 配置将拦截器附加到用于创建端点的工厂，或者代理与将拦截器直接附加到端点或代理的效果相同。但是，当将拦截器附加到工厂时，以编程方式附加到工厂的拦截器会传播到工厂创建的每个端点或代理。

绑定

将拦截器附加到绑定可让开发人员指定一组应用于使用绑定的所有端点的拦截器。例如，如果开发人员想要强制所有使用 raw XML 绑定的端点包含特殊 ID 元素，他们可以将元素关联到 XML 绑定。

总线

附加拦截器的最常规位置是总线。当拦截器附加到总线时，拦截器会传播到该总线管理的所有端点。在创建一个共享类似拦截器集的多个端点的应用程序中，将拦截器附加到总线时很有用。

组合附件点

由于端点的最终拦截器链集是所列出对象所代表的拦截器链，因此多个列出的对象可以合并为一个端点的配置。例如，如果应用程序生成了多个端点，则所有需要检查验证令牌的拦截器都会被附加到应用程序的总线中。如果其中某一端点还需要将 Euros 转换为资金的拦截器，则转换拦截器会直接附加到特定的端点。

59.2. 使用配置添加拦截器

概述

将拦截器附加到端点的最简单方法是使用配置文件。要附加到端点的每个拦截器都使用标准 Spring bean 配置。然后，可以使用 Apache CXF 配置元素将拦截器的 bean 添加到正确的拦截器链中。

每个具有相关拦截器链的运行时组件都可使用专用的 Spring 元素进行配置。每个组件的元素都有一组标准的子项，用于指定其拦截器链。与组件关联的每个拦截器链都有一个子项。子项列出要在链中添加拦截器的 Bean。

配置元素

表 59.1 “拦截器配置元素” 描述将拦截器附加到运行时组件的四个配置元素。

表 59.1. 拦截器配置元素
element	描述
`inInterceptors`	包含配置拦截器列表，用于添加到端点的入站拦截器链。
`outInterceptors`	包含配置拦截器列表，以添加到端点的出站拦截器链。
`inFaultInterceptors`	包含配置拦截器列表，用于添加到端点的入站故障处理拦截器链。
`outFaultInterceptors`	包含配置拦截器列表，用于添加到端点的出站故障处理拦截器链。

所有拦截器配置元素都会取一个 列表 子元素。list 元素具有一个子项，每个拦截器都附加到链。可以使用 bean 元素直接配置拦截器或引用拦截器的 bean 元素来指定拦截器。

例子

例 59.1 “将拦截器附加到总线” 显示将拦截器附加到总线入站拦截器链的配置。

例 59.1. 将拦截器附加到总线

&lt;beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:cxf="http://cxf.apache.org/core"
       xmlns:http="http://cxf.apache.org/transports/http/configuration"
       xsi:schemaLocation="
       http://cxf.apache.org/core http://cxf.apache.org/schemas/core.xsd
       http://cxf.apache.org/transports/http/configuration http://cxf.apache.org/schemas/configuration/http-conf.xsd
       http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"&gt;
  ...
  &lt;bean id="GZIPStream" class="demo.stream.interceptor.StreamInterceptor"/&gt;

  &lt;cxf:bus&gt;
    *&lt;cxf:inInterceptors&gt;
      &lt;list&gt;
        &lt;ref bean="GZIPStream"/&gt;
      &lt;/list&gt;
    &lt;/cxf:inInterceptors&gt;*
  &lt;/cxf:bus&gt;
&lt;/beans&gt;

例 59.2 “将拦截器附加到 JAX-WS 服务供应商” 显示将拦截器附加到 JAX-WS 服务的出站拦截器的配置。

例 59.2. 将拦截器附加到 JAX-WS 服务供应商

&lt;beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:jaxws="http://cxf.apache.org/jaxws"
       xmlns:wsa="http://cxf.apache.org/ws/addressing"
       xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd"&gt;

  &lt;jaxws:endpoint ...&gt;
    *&lt;jaxws:outInterceptors&gt;
      &lt;list&gt;
        &lt;bean id="GZIPStream" class="demo.stream.interceptor.StreamInterceptor" /&gt;
      &lt;/list&gt;
    &lt;/jaxws:outInterceptors&gt;*
  &lt;/jaxws:endpoint&gt;
&lt;/beans&gt;

59.3. 以编程方式添加拦截器

59.3.1. 添加拦截器的方法

拦截器可以使用以下两种方式之一附加到端点：

InterceptorProvider API
Java 注解

通过 InterceptorProvider API，开发人员可以将拦截器附加到具有拦截器链的任何运行时组件，但它需要使用底层的 Apache CXF 类。Java 注解只能添加到服务接口或服务实施中，但它们允许开发人员保留在 JAX-WS API 或 JAX-RS API 中。

59.3.2. 使用拦截器供应商 API

概述

可以使用实现拦截器供应商接口 InterceptorProvider 接口的任何组件注册拦截器。

拦截器供应商接口

package org.apache.cxf.interceptor;

import java.util.List;

public interface InterceptorProvider
{
    List<Interceptor<? extends Message>> getInInterceptors();

    List<Interceptor<? extends Message>> getOutInterceptors();

    List<Interceptor<? extends Message>> getInFaultInterceptors();

    List<Interceptor<? extends Message>> getOutFaultInterceptors();
}

通过界面中的四种方法，您可以将每个端点的拦截器链作为 Java List 对象检索。使用 Java List 对象提供的方法，开发人员可以向任何链添加或删除拦截器。

流程

要使用 InterceptorProvider API，将拦截器附加到运行时组件的拦截器，您必须：

使用附加到拦截器的链获取运行时组件的访问权限。
开发人员必须使用 Apache CXF 特定的 API 从标准 Java 应用程序代码访问运行时组件。运行时组件可以通过将 JAX-WS 或 JAX-RS 工件转换为底层 Apache CXF 对象来访问。
创建拦截器的实例。
使用正确的 get 方法来检索所需的拦截器链。
使用 List 对象的 add （） 方法，将拦截器附加到拦截器链。
此步骤通常与检索拦截器链结合使用。

将拦截器附加到消费者

以编程方式将拦截器附加到消费者显示将拦截器附加到 JAX-WS 消费者入站拦截器链的代码。

以编程方式将拦截器附加到消费者

package com.fusesource.demo;

import java.io.File;
import java.net.URL;
import javax.xml.namespace.QName;
import javax.xml.ws.Service;

import org.apache.cxf.endpoint.Client;

public class Client
{
  public static void main(String args[])
  {
    QName serviceName = new QName("http://demo.eric.org", "stockQuoteReporter");
    Service s = Service.create(serviceName);

    QName portName = new QName("http://demo.eric.org", "stockQuoteReporterPort");
    s.addPort(portName, "http://schemas.xmlsoap.org/soap/", "http://localhost:9000/EricStockQuote");

    quoteReporter proxy = s.getPort(portName, quoteReporter.class);

    Client cxfClient = (Client) proxy;

    ValidateInterceptor validInterceptor = new ValidateInterceptor();
    cxfClient.getInInterceptor().add(validInterceptor);

    ...
  }
}

以编程方式将拦截器附加到消费者中的代码执行以下操作：

为使用者创建一个 JAX-WS Service 对象。

为提供消费者的目标地址的 Service 对象添加端口。

创建用于在服务提供商上调用方法的代理。

将代理广播到 org.apache.cxf.endpoint.Client 类型。

创建拦截器的实例。

将拦截器附加到入站拦截器链。

将拦截器附加到服务提供商

以编程方式将拦截器附加到服务提供商显示将拦截器附加到服务提供商的出站拦截器链的代码。

以编程方式将拦截器附加到服务提供商

package com.fusesource.demo;
import java.util.*;

import org.apache.cxf.endpoint.Server;
import org.apache.cxf.frontend.ServerFactoryBean;
import org.apache.cxf.frontend.EndpointImpl;

public class stockQuoteReporter implements quoteReporter
{
  ...
  public stockQuoteReporter()
  {
    ServerFactoryBean sfb = new ServerFactoryBean();
    Server server = sfb.create();
    EndpointImpl endpt = server.getEndpoint();

    AuthTokenInterceptor authInterceptor = new AuthTokenInterceptor();

    endpt.getOutInterceptor().add(authInterceptor);
  }
}

以编程方式将拦截器附加到服务提供商中的代码执行以下操作：

创建一个 ServerFactoryBean 对象，它将提供对底层的 Apache CXF 对象的访问。

获取 Apache CXF 用来代表端点的服务器对象。

获取服务提供商的 Apache CXF EndpointImpl 对象。

创建拦截器的实例。

将拦截器附加到端点；s 出站拦截器链。

将拦截器附加到总线

将拦截器附加到总线显示将拦截器附加到总线入站拦截器链的代码。

将拦截器附加到总线

import org.apache.cxf.BusFactory;
org.apache.cxf.Bus;

...

Bus bus = BusFactory.getDefaultBus();

WatchInterceptor watchInterceptor = new WatchInterceptor();

bus..getInInterceptor().add(watchInterceptor);

...

将拦截器附加到总线中的代码执行以下操作：

获取运行时实例的默认总线。

创建拦截器的实例。

将拦截器附加到入站拦截器链。

WatchInterceptor 将附加到运行时实例创建的所有端点的入站拦截器链。

59.3.3. 使用 Java 注解

概述

Apache CXF 提供四个 Java 注解，允许开发人员指定端点使用的拦截器链。与将拦截器附加到端点的不同，注解会附加到应用程序级别的工件中。所用的构件决定了注解的作用范围。

放置注解的位置

注解可放在以下工件中：

定义端点的服务端点接口(SEI)
如果注解放在一个 SEI 上，则所有实现接口和使用 SEI 创建代理的用户的服务提供商都将会受到影响。
服务实施类
如果注解放在实施类中，使用实施类的所有服务提供商都将会受到影响。

注解

该注解都位于 org.apache.cxf.interceptor 软件包中，并在表 59.2 “拦截器链注解” 中描述。

表 59.2. 拦截器链注解
注解	描述
`InInterceptors`	指定入站拦截器链的拦截器。
`OutInterceptors`	指定出站拦截器链的拦截器。
`InFaultInterceptors`	指定入站故障拦截器链的拦截器。
`OutFaultInterceptors`	指定出站故障拦截器链的拦截器。

列出拦截器

拦截器列表以完全限定类名称列表形式指定，使用在链注解中列出拦截器的语法中显示的语法。

在链注解中列出拦截器的语法

interceptors={"interceptor1", "interceptor2", ..., "interceptorN"}

示例

将拦截器附加到服务实现中显示将两个拦截器附加到使用 SayHiImpl 提供的逻辑的入站拦截器链的注解。

将拦截器附加到服务实现中

import org.apache.cxf.interceptor.InInterceptors;

@InInterceptors(interceptors={"com.sayhi.interceptors.FirstLast", "com.sayhi.interceptors.LogName"})
public class SayHiImpl implements SayHi
{
  ...
}

第 60 章在 Fly 上操作拦截器链

摘要

拦截器可以重新配置端点的拦截器链作为其消息处理逻辑的一部分。它可以添加新的拦截器，删除拦截器，删除拦截器，重新排列拦截器链，甚至挂起拦截器链。所有基于调用的操作都是特定于调用的，因此每次涉及消息交换端点时，都将使用原始链。

概述

只要创建消息交换，拦截器仅会实时链。每条消息都包含对负责处理的拦截器链的引用。开发人员可以使用此引用来更改消息的拦截器链。由于链进行每个交换，对消息拦截器链的任何更改都不会影响到其他消息交换。

链生命周期

拦截器链和链中的拦截器以每个调用为基础进行实例化。当调用端点来参与消息交换时，所需的拦截器链随其拦截器的实例一起实例化。当消息交换导致创建拦截器链完成时，链及其拦截器实例会被销毁。

这意味着您对拦截器链或拦截器的字段所做的任何更改都不会在消息交换之间保留。因此，如果拦截器在活跃链中放置另一个拦截器，则只会影响活跃链。任何未来消息交换都会从端点的配置决定的 pristine 状态创建。这也意味着开发人员无法在拦截器中设置更改未来消息处理的标志。

如果拦截器需要将信息传递给未来的实例，它可以在消息上下文中设置属性。该上下文在消息交换之间保留。

获取拦截器链

更改消息拦截器链的第一步是获取拦截器链。这可以通过在例 60.1 “获取拦截器链的方法” 中显示的 Message.getInterceptorChain （） 方法来完成。拦截器链作为 org.apache.cxf.interceptor.InterceptorChain 对象返回。

例 60.1. 获取拦截器链的方法

InterceptorChaingetInterceptorChain

添加拦截器

InterceptorChain 对象有两种方法，如例 60.2 “在拦截器链中添加拦截器的方法” 所示，用于将拦截器添加到拦截器链中。一个允许您添加单个拦截器，另一个则允许您添加多个拦截器。

例 60.2. 在拦截器链中添加拦截器的方法

添加Interceptor<? 扩展 Message>iaddCollection<Interceptor<? 扩展 Message>>i

例 60.3 “将拦截器添加到拦截器链 -fly-the-fly” 显示将单个拦截器添加到消息拦截器链的代码。

例 60.3. 将拦截器添加到拦截器链 -fly-the-fly

void handleMessage(Message message)
{
  ...
  AddledIntereptor addled = new AddledIntereptor();
  InterceptorChain chain = message.getInterceptorChain();
  chain.add(addled);
  ...
}

例 60.3 “将拦截器添加到拦截器链 -fly-the-fly” 中的代码执行以下操作：

实例化要添加到链中的拦截器副本。

重要

添加到链中的拦截器应该处于与当前拦截器相同的阶段，或者与当前拦截器相比的一个阶段。

获取当前消息的拦截器链。

向链中添加新拦截器。

删除拦截器

InterceptorChain 对象具有一个方法，显示在例 60.4 “从拦截器链中删除拦截器的方法” 中，用于从拦截器链中删除拦截器。

例 60.4. 从拦截器链中删除拦截器的方法

删除Interceptor<? 扩展 Message>i

例 60.5 “完全从拦截器链中删除拦截器” 显示从消息拦截器链中删除拦截器的代码。

例 60.5. 完全从拦截器链中删除拦截器

void handleMessage(Message message)
{
  ...
  Iterator<Interceptor<? extends Message>> iterator =
            message.getInterceptorChain().iterator();
  Interceptor<?> removeInterceptor =  null;
  for (; iterator.hasNext(); ) {
    Interceptor<?> interceptor = iterator.next();
    if (interceptor.getClass().getName().equals("InterceptorClassName")) {
      removeInterceptor = interceptor;
      break;
    }
  }

  if (removeInterceptor !=  null) {
    log.debug("Removing interceptor {}",removeInterceptor.getClass().getName());
    message.getInterceptorChain().remove(removeInterceptor);
  }
  ...
}

其中 InterceptorClassName 是您要从链中删除的拦截器的类名称。

第 61 章 JAX-RS 2.0 Filters 和 Interceptors

摘要

JAX-RS 2.0 定义标准 API 和语义，用于在 REST 调用处理管道中安装过滤器和拦截器。过滤器和拦截器通常用于提供日志、身份验证、授权、消息压缩、消息加密等等功能。

61.1. JAX-RS 过滤器和拦截器简介

概述

本节概述 JAX-RS 过滤器和拦截器的处理管道，突出显示可能安装过滤器链或拦截器链的扩展点。

过滤器

JAX-RS 2.0 过滤器 是一类插件，使开发人员能够访问通过 CXF 客户端或服务器的所有 JAX-RS 消息。过滤器适合处理与消息关联的元数据：HTTP 标头、查询参数、媒体类型和其他元数据。过滤器能够中止消息调用（例如，用于安全插件）。

如果您愿意，您可以在每个扩展点上安装多个过滤器，在这种情况下，在链中执行过滤器（但未定义执行顺序），除非为每个安装过滤器指定 优先级值。

拦截器

JAX-RS 2.0 拦截器 是一类插件，使开发人员能够访问消息正文，因为它正在读取或写入。拦截器围绕 MessageBodyReader.readFrom 方法调用（用于 reader interceptors）或 MessageBodyWriter.writeTo 方法调用（用于 writer interceptors）。

如果您愿意，您可以在每个扩展点安装多个拦截器，在这种情况下，拦截器在链中执行（未定义执行顺序，除非您为每个安装的拦截器指定 优先级值 ）。

服务器处理管道

图 61.1 “server-Side Filter 和 Interceptor Extension Points” 显示 JAX-RS 过滤器的处理管道概述，以及在服务器端安装的拦截器。

图 61.1. server-Side Filter 和 Interceptor Extension Points

服务器扩展点

在服务器处理管道中，您可以在以下任意扩展点中添加过滤器（或拦截器）：

PreMatchContainerRequest 过滤器
ContainerRequest 过滤器
ReadInterceptor
ContainerResponse 过滤器
WriteInterceptor

请注意，在资源匹配 发生前，PreMatchContainerRequest 扩展点会被访问，因此一些上下文元数据在此时不可用。

客户端处理管道

图 61.2 “Client-Side Filter 和 Interceptor Extension Points” 显示 JAX-RS 过滤器的处理管道概述，以及在客户端一侧安装的拦截器。

图 61.2. Client-Side Filter 和 Interceptor Extension Points

客户端扩展点

在客户端处理管道中，您可以在以下任意扩展点中添加过滤器（或拦截器）：

ClientRequest 过滤器
WriteInterceptor
ClientResponse 过滤器
ReadInterceptor

过滤和拦截器顺序

如果您在同一扩展点安装多个过滤器或拦截器，则过滤器的执行顺序取决于分配给它们的优先级（使用 Java 源中的 @Priority 注释）。优先级以整数值表示。通常，具有较高优先级的 过滤器接近服务器端的资源方法调用；而优先级 较小的 过滤器则更接近客户端调用。换句话说，过滤器和拦截器以优先级号降序执行；而筛选器和拦截器在 响应中 按照优先级编号降序执行。

过滤类

可以实施以下 Java 接口，以创建自定义 REST 消息过滤器：

拦截器类

可以实施以下 Java 接口，以创建自定义 REST 消息拦截器：

61.2. 容器请求过滤器

概述

本节介绍如何实施和注册 容器请求过滤器，该过滤器 用于截获服务器（容器）侧传入的请求消息。容器请求过滤器通常用于处理服务器端的标头，并可用于任何类型的通用请求处理（也就是说，独立于特定资源方法的处理）。

此外，容器请求过滤器是特殊案例之一，因为它可在两个不同的扩展点安装： PreMatchContainerRequest （在资源匹配步骤之前）和 ContainerRequest （在资源匹配步骤后安装）。

ContainerRequestFilter 接口

javax.ws.rs.container.ContainerRequestFilter 接口定义如下：

// Java
...
package javax.ws.rs.container;

import java.io.IOException;

public interface ContainerRequestFilter {
    public void filter(ContainerRequestContext requestContext) throws IOException;
}

通过实现 ContainerRequestFilter 接口，您可以在服务器端为以下任意扩展点创建一个过滤器：

PreMatchContainerRequest
ContainerRequest

ContainerRequestContext 接口

ContainerRequestFilter 的 过滤器 方法接收一个类型为 javax.ws.rs.container.ContainerRequestContext，它可用于访问传入请求消息及其相关元数据。ContainerRequestContext 接口定义如下：

// Java
...
package javax.ws.rs.container;

import java.io.InputStream;
import java.net.URI;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import javax.ws.rs.core.Cookie;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Request;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.SecurityContext;
import javax.ws.rs.core.UriInfo;


public interface ContainerRequestContext {

    public Object getProperty(String name);

    public Collection getPropertyNames();

    public void setProperty(String name, Object object);

    public void removeProperty(String name);

    public UriInfo getUriInfo();

    public void setRequestUri(URI requestUri);

    public void setRequestUri(URI baseUri, URI requestUri);

    public Request getRequest();

    public String getMethod();

    public void setMethod(String method);

    public MultivaluedMap getHeaders();

    public String getHeaderString(String name);

    public Date getDate();

    public Locale getLanguage();

    public int getLength();

    public MediaType getMediaType();

    public List getAcceptableMediaTypes();

    public List getAcceptableLanguages();

    public Map getCookies();

    public boolean hasEntity();

    public InputStream getEntityStream();

    public void setEntityStream(InputStream input);

    public SecurityContext getSecurityContext();

    public void setSecurityContext(SecurityContext context);

    public void abortWith(Response response);
}

PreMatchContainerRequest 过滤器的实现示例

要对 PreMatchContainerRequest 扩展点实施容器请求过滤器（即，在资源匹配之前执行过滤器），请定义实施 ContainerRequestFilter 接口的类，确保为类标上 @PreMatching 注释（以选择 PreMatchContainerRequest 扩展点）。

例如，以下代码显示了在 PreMatchContainerRequest 扩展点中安装的简单容器请求过滤器示例，其优先级为 20:

// Java
package org.jboss.fuse.example;

import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.container.PreMatching;
import javax.annotation.Priority;
import javax.ws.rs.ext.Provider;

@PreMatching
@Priority(value = 20)
@Provider
public class SamplePreMatchContainerRequestFilter implements
  ContainerRequestFilter {

  public SamplePreMatchContainerRequestFilter() {
    System.out.println("SamplePreMatchContainerRequestFilter starting up");
  }

  @Override
  public void filter(ContainerRequestContext requestContext) {
    System.out.println("SamplePreMatchContainerRequestFilter.filter() invoked");
  }
}

ContainerRequest 过滤器的实现示例

要对 ContainerRequest 扩展点实施容器请求过滤器（即，在资源匹配后执行过滤器），请定义一个实施 ContainerRequestFilter 接口的类，但不具有 @PreMatching 注释。

例如，以下代码显示了在 ContainerRequest 扩展点中安装的简单容器请求过滤器示例，其优先级为 30：

// Java
package org.jboss.fuse.example;

import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.ext.Provider;
import javax.annotation.Priority;

@Provider
@Priority(value = 30)
public class SampleContainerRequestFilter implements ContainerRequestFilter {

  public SampleContainerRequestFilter() {
    System.out.println("SampleContainerRequestFilter starting up");
  }

  @Override
  public void filter(ContainerRequestContext requestContext) {
    System.out.println("SampleContainerRequestFilter.filter() invoked");
  }
}

注入 ResourceInfo

在 ContainerRequest 扩展点（即，在资源匹配后），可以通过注入 ResourceInfo 类来访问匹配的资源类和资源方法。例如，以下代码演示了如何将 ResourceInfo 类注入 ContainerRequestFilter 类的一个字段：

// Java
package org.jboss.fuse.example;

import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.container.ResourceInfo;
import javax.ws.rs.ext.Provider;
import javax.annotation.Priority;
import javax.ws.rs.core.Context;

@Provider
@Priority(value = 30)
public class SampleContainerRequestFilter implements ContainerRequestFilter {

  @Context
  private ResourceInfo resinfo;

  public SampleContainerRequestFilter() {
    ...
  }

  @Override
  public void filter(ContainerRequestContext requestContext) {
    String resourceClass = resinfo.getResourceClass().getName();
    String methodName    = resinfo.getResourceMethod().getName();
    System.out.println("REST invocation bound to resource class: " + resourceClass);
    System.out.println("REST invocation bound to resource method: " + methodName);
  }
}

中止调用

通过创建适合容器请求过滤器的实施，可以在调用中中止服务器端调用。通常，这可用于在服务器端实施安全功能：例如，用于实施身份验证功能或授权功能。如果传入请求无法成功进行身份验证，您可能会在容器请求过滤器中中止调用。

例如，以下预匹配功能尝试从 URI 的查询参数中提取用户名和密码，并调用验证方法来检查用户名和密码凭证。如果身份验证失败，调用会在 ContainerRequestContext 对象中调用 abortWith 来中止，从而传递返回给客户端的错误响应。

// Java
package org.jboss.fuse.example;

import javax.annotation.Priority;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.container.PreMatching;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.ResponseBuilder;
import javax.ws.rs.core.Response.Status;
import javax.ws.rs.ext.Provider;

@PreMatching
@Priority(value = 20)
@Provider
public class SampleAuthenticationRequestFilter implements
  ContainerRequestFilter {

  public SampleAuthenticationRequestFilter() {
    System.out.println("SampleAuthenticationRequestFilter starting up");
  }

  @Override
  public void filter(ContainerRequestContext requestContext) {
    ResponseBuilder responseBuilder = null;
    Response response = null;

    String userName = requestContext.getUriInfo().getQueryParameters().getFirst("UserName");
    String password = requestContext.getUriInfo().getQueryParameters().getFirst("Password");
    if (authenticate(userName, password) == false) {
      responseBuilder = Response.serverError();
      response = responseBuilder.status(Status.BAD_REQUEST).build();
      requestContext.abortWith(response);
    }
  }

  public boolean authenticate(String userName, String password) {
    // Perform authentication of 'user'
    ...
  }
}

绑定服务器请求过滤器

要绑定一个服务器请求过滤器（即，将其安装到 Apache CXF 运行时），请执行以下步骤：

将 @Provider 注释添加到容器请求过滤器类，如以下代码片段所示：

// Java
package org.jboss.fuse.example;

import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerRequestFilter;
import javax.ws.rs.ext.Provider;
import javax.annotation.Priority;

@Provider
@Priority(value = 30)
public class SampleContainerRequestFilter implements ContainerRequestFilter {
  ...
}

当容器请求过滤器实现加载到 Apache CXF 运行时时，REST 实施会自动扫描加载的类，以搜索标有 @Provider 注释( 扫描阶段)的类。

在 XML 中定义 JAX-RS 服务器端点（例如，查看第 18.1 节 “配置 JAX-RS 服务器端点”）时，将服务器请求过滤器添加到 jaxrs:providers 元素中的提供程序列表中。

<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jaxrs="http://cxf.apache.org/blueprint/jaxrs"
    xmlns:cxf="http://cxf.apache.org/blueprint/core"
    ...
>
    ...
    <jaxrs:server id="customerService" address="/customers">
      ...
      <jaxrs:providers>
        <ref bean="filterProvider" />
      </jaxrs:providers>
      <bean id="filterProvider" class="org.jboss.fuse.example.SampleContainerRequestFilter"/>

    </jaxrs:server>

</blueprint>

注意

此步骤是 Apache CXF 非标准要求。严格根据 JAX-RS 标准进行说明，@Provider 注释应属于绑定该过滤器所需的所有内容。但是，在实践中，标准方法非常不灵活，如果大型项目中纳入了许多库，则可能会导致供应商冲突。

61.3. 容器响应过滤器

概述

本节介绍如何实施和注册 容器响应过滤器，该过滤器 用于截获服务器端的传出响应消息。容器响应过滤器可用于在响应消息中自动填充标头，一般可用于任何类型的通用响应处理。

ContainerResponseFilter 接口

javax.ws.rs.container.ContainerResponseFilter 接口定义如下：

// Java
...
package javax.ws.rs.container;

import java.io.IOException;

public interface ContainerResponseFilter {
    public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext)
            throws IOException;
}

通过实施 ContainerResponseFilter，您可以在服务器端为 ContainerResponse 扩展点创建一个过滤器，它会在调用 执行后 过滤响应消息。

注意

容器响应过滤器可让您同时访问请求消息（通过 请求Context 参数）和响应消息（通过 responseContext 消息），但这个阶段只能修改响应。

ContainerResponseContext 接口

ContainerResponseFilter 的 过滤器 方法接收了两个参数：参数 javax.ws.rs.container.ContainerRequestContext （请参阅 “ContainerRequestContext 接口”一节）；以及类型为 javax.ws.rs.container.ContainerResponseContext 的参数，它可用于访问传出响应消息及其相关元数据。

ContainerResponseContext 接口定义如下：

// Java
...
package javax.ws.rs.container;

import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.net.URI;
import java.util.Date;
import java.util.Locale;
import java.util.Map;
import java.util.Set;

import javax.ws.rs.core.EntityTag;
import javax.ws.rs.core.Link;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.NewCookie;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.MessageBodyWriter;

public interface ContainerResponseContext {

    public int getStatus();

    public void setStatus(int code);

    public Response.StatusType getStatusInfo();

    public void setStatusInfo(Response.StatusType statusInfo);

    public MultivaluedMap<String, Object> getHeaders();

    public abstract MultivaluedMap<String, String> getStringHeaders();

    public String getHeaderString(String name);

    public Set<String> getAllowedMethods();

    public Date getDate();

    public Locale getLanguage();

    public int getLength();

    public MediaType getMediaType();

    public Map<String, NewCookie> getCookies();

    public EntityTag getEntityTag();

    public Date getLastModified();

    public URI getLocation();

    public Set<Link> getLinks();

    boolean hasLink(String relation);

    public Link getLink(String relation);

    public Link.Builder getLinkBuilder(String relation);

    public boolean hasEntity();

    public Object getEntity();

    public Class<?> getEntityClass();

    public Type getEntityType();

    public void setEntity(final Object entity);

    public void setEntity(
            final Object entity,
            final Annotation[] annotations,
            final MediaType mediaType);

    public Annotation[] getEntityAnnotations();

    public OutputStream getEntityStream();

    public void setEntityStream(OutputStream outputStream);
}

实现示例

要为 ContainerResponse 扩展点实施容器响应过滤器（即，在服务器端执行调用后执行过滤器），请定义一个实现 ContainerResponseFilter 接口的类。

例如，以下代码显示了在 ContainerResponse 扩展点中安装的简单容器响应过滤器示例，其优先级为 10：

// Java
package org.jboss.fuse.example;

import javax.annotation.Priority;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerResponseContext;
import javax.ws.rs.container.ContainerResponseFilter;
import javax.ws.rs.ext.Provider;

@Provider
@Priority(value = 10)
public class SampleContainerResponseFilter implements ContainerResponseFilter {

  public SampleContainerResponseFilter() {
    System.out.println("SampleContainerResponseFilter starting up");
  }

  @Override
  public void filter(
      ContainerRequestContext requestContext,
      ContainerResponseContext responseContext
  )
  {
    // This filter replaces the response message body with a fixed string
    if (responseContext.hasEntity()) {
      responseContext.setEntity("New message body!");
    }
  }
}

绑定服务器响应过滤器

要绑定服务器响应过滤器（即，将其安装到 Apache CXF 运行时），请执行以下步骤：

将 @Provider 注释添加到容器响应过滤器类，如以下代码片段所示：

// Java
package org.jboss.fuse.example;

import javax.annotation.Priority;
import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerResponseContext;
import javax.ws.rs.container.ContainerResponseFilter;
import javax.ws.rs.ext.Provider;

@Provider
@Priority(value = 10)
public class SampleContainerResponseFilter implements ContainerResponseFilter {
  ...
}

当容器响应过滤器实现加载到 Apache CXF 运行时时，REST 实施会自动扫描加载的类，以搜索标有 @Provider 注释( 扫描阶段)的类。

在 XML 中定义 JAX-RS 服务器端点（例如，查看第 18.1 节 “配置 JAX-RS 服务器端点”）时，将服务器响应过滤器添加到 jaxrs:providers 元素中的提供程序列表。

<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jaxrs="http://cxf.apache.org/blueprint/jaxrs"
    xmlns:cxf="http://cxf.apache.org/blueprint/core"
    ...
>
    ...
    <jaxrs:server id="customerService" address="/customers">
      ...
      <jaxrs:providers>
        <ref bean="filterProvider" />
      </jaxrs:providers>
      <bean id="filterProvider" class="org.jboss.fuse.example.SampleContainerResponseFilter"/>

    </jaxrs:server>

</blueprint>

注意

61.4. Client Request Filter

概述

本节介绍如何实施和注册客户端请求 过滤器，该过滤器 用于截获客户端端的传出请求消息。客户端请求过滤器通常用于处理标头，并可用于任何类型的通用请求处理。

ClientRequestFilter 接口

javax.ws.rs.client.ClientRequestFilter 接口定义如下：

// Java
package javax.ws.rs.client;
...
import javax.ws.rs.client.ClientRequestFilter;
import javax.ws.rs.client.ClientRequestContext;
...
public interface ClientRequestFilter {
    void filter(ClientRequestContext requestContext) throws IOException;
}

通过实施 ClientRequestFilter，您可以为客户端侧的 ClientRequest 扩展点创建一个过滤器，它会在将消息发送到服务器前过滤请求消息。

ClientRequestContext interface

ClientRequestFilter 的 过滤器 方法接收一个类型为 javax.ws.rs.client.ClientRequestContext 的单个参数，可用于访问传出请求消息及其相关元数据。ClientRequestContext 接口定义如下：

// Java
...
package javax.ws.rs.client;

import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.net.URI;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import javax.ws.rs.core.Configuration;
import javax.ws.rs.core.Cookie;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.MessageBodyWriter;

public interface ClientRequestContext {

    public Object getProperty(String name);

    public Collection<String> getPropertyNames();

    public void setProperty(String name, Object object);

    public void removeProperty(String name);

    public URI getUri();

    public void setUri(URI uri);

    public String getMethod();

    public void setMethod(String method);

    public MultivaluedMap<String, Object> getHeaders();

    public abstract MultivaluedMap<String, String> getStringHeaders();

    public String getHeaderString(String name);

    public Date getDate();

    public Locale getLanguage();

    public MediaType getMediaType();

    public List<MediaType> getAcceptableMediaTypes();

    public List<Locale> getAcceptableLanguages();

    public Map<String, Cookie> getCookies();

    public boolean hasEntity();

    public Object getEntity();

    public Class<?> getEntityClass();

    public Type getEntityType();

    public void setEntity(final Object entity);

    public void setEntity(
            final Object entity,
            final Annotation[] annotations,
            final MediaType mediaType);

    public Annotation[] getEntityAnnotations();

    public OutputStream getEntityStream();

    public void setEntityStream(OutputStream outputStream);

    public Client getClient();

    public Configuration getConfiguration();

    public void abortWith(Response response);
}

实现示例

要对 ClientRequest 扩展点实施客户端请求过滤器（即，在发送请求消息前执行过滤器），请定义一个实现 ClientRequestFilter 接口的类。

例如，以下代码显示了在 ClientRequest 扩展点中安装的简单客户端请求过滤器示例，其优先级为 20：

// Java
package org.jboss.fuse.example;

import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.client.ClientRequestFilter;
import javax.annotation.Priority;

@Priority(value = 20)
public class SampleClientRequestFilter implements ClientRequestFilter {

  public SampleClientRequestFilter() {
    System.out.println("SampleClientRequestFilter starting up");
  }

  @Override
  public void filter(ClientRequestContext requestContext) {
    System.out.println("ClientRequestFilter.filter() invoked");
  }
}

中止调用

可以通过实施适当的客户端请求过滤器来中止客户端调用。例如，您可以实施客户端侧过滤器来检查请求是否正确格式化，如有必要，则中止请求。

以下测试代码始终中止请求，将 BAD_REQUEST HTTP 状态返回到客户端调用代码：

// Java
package org.jboss.fuse.example;

import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.client.ClientRequestFilter;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import javax.annotation.Priority;

@Priority(value = 10)
public class TestAbortClientRequestFilter implements ClientRequestFilter {

  public TestAbortClientRequestFilter() {
    System.out.println("TestAbortClientRequestFilter starting up");
  }

  @Override
  public void filter(ClientRequestContext requestContext) {
    // Test filter: aborts with BAD_REQUEST status
    requestContext.abortWith(Response.status(Status.BAD_REQUEST).build());
  }
}

注册客户端请求过滤器

使用 JAX-RS 2.0 客户端 API，您可以直接在 javax.ws.rs.client.client .Client 对象或 javax.ws.rs.client.client.client .client.WebTarget 对象上直接注册客户端请求过滤器。实际上，这意味着客户端请求过滤器可以选择性地应用到不同的范围，以便只有某些 URI 路径受到过滤器的影响。

例如，以下代码演示了如何注册 SampleClientRequestFilter 过滤器，使其应用于使用 client 对象进行的所有调用；以及如何注册 TestAbortClientRequestFilter 过滤器，使其仅应用于 rest/TestAbortClientRequest 的子路径。

// Java
...
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Response;
...
Client client = ClientBuilder.newClient();
client.register(new SampleClientRequestFilter());
WebTarget target = client
  .target("http://localhost:8001/rest/TestAbortClientRequest");
target.register(new TestAbortClientRequestFilter());

61.5. 客户端响应过滤器

概述

本节介绍如何实施和注册客户端 响应过滤器，该过滤器 用于截获客户端的传入响应消息。客户端响应过滤器可用于客户端端的任何通用响应处理。

ClientResponseFilter 接口

javax.ws.rs.client.ClientResponseFilter 接口定义如下：

// Java
package javax.ws.rs.client;
...
import java.io.IOException;

public interface ClientResponseFilter {
    void filter(ClientRequestContext requestContext, ClientResponseContext responseContext)
            throws IOException;
}

通过实施 ClientResponseFilter，您可以在客户端为 ClientResponse 扩展点创建一个过滤器，它会在从服务器收到响应消息后过滤响应消息。

ClientResponseContext 接口

ClientResponseFilter 的 过滤器 方法收到了两个参数：参数 javax.ws.rs.client.ClientRequestContext （请参阅 “ClientRequestContext interface”一节）；以及类型为 javax.ws.rs.client.ClientResponseContext 的参数，它可用于访问传出响应消息及其相关元数据。

ClientResponseContext 接口定义如下：

// Java
...
package javax.ws.rs.client;

import java.io.InputStream;
import java.net.URI;
import java.util.Date;
import java.util.Locale;
import java.util.Map;
import java.util.Set;

import javax.ws.rs.core.EntityTag;
import javax.ws.rs.core.Link;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.NewCookie;
import javax.ws.rs.core.Response;

public interface ClientResponseContext {

    public int getStatus();

    public void setStatus(int code);

    public Response.StatusType getStatusInfo();

    public void setStatusInfo(Response.StatusType statusInfo);

    public MultivaluedMap<String, String> getHeaders();

    public String getHeaderString(String name);

    public Set<String> getAllowedMethods();

    public Date getDate();

    public Locale getLanguage();

    public int getLength();

    public MediaType getMediaType();

    public Map<String, NewCookie> getCookies();

    public EntityTag getEntityTag();

    public Date getLastModified();

    public URI getLocation();

    public Set<Link> getLinks();

    boolean hasLink(String relation);

    public Link getLink(String relation);

    public Link.Builder getLinkBuilder(String relation);

    public boolean hasEntity();

    public InputStream getEntityStream();

    public void setEntityStream(InputStream input);
}

实现示例

要为 ClientResponse 扩展点实施客户端响应过滤器（即，在从服务器收到响应消息后执行过滤器），请定义一个实现 ClientResponseFilter 接口的类。

例如，以下代码显示了在 ClientResponse 扩展点中安装的简单客户端响应过滤器示例，其优先级为 20：

// Java
package org.jboss.fuse.example;

import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.client.ClientResponseContext;
import javax.ws.rs.client.ClientResponseFilter;
import javax.annotation.Priority;

@Priority(value = 20)
public class SampleClientResponseFilter implements ClientResponseFilter {

  public SampleClientResponseFilter() {
    System.out.println("SampleClientResponseFilter starting up");
  }

  @Override
  public void filter(
      ClientRequestContext requestContext,
      ClientResponseContext responseContext
  )
  {
    // Add an extra header on the response
    responseContext.getHeaders().putSingle("MyCustomHeader", "my custom data");
  }
}

注册客户端响应过滤器

通过使用 JAX-RS 2.0 客户端 API，您可以在 javax.ws.rs.client.Client 对象或 javax.ws.rs.client.client.client.client.client.client .client.client.Client 对象上直接注册客户端 响应过滤器。实际上，这意味着客户端请求过滤器可以选择性地应用到不同的范围，以便只有某些 URI 路径受到过滤器的影响。

例如，以下代码演示了如何注册 SampleClientResponseFilter 过滤器，使其应用于使用 client 对象进行的所有调用：

// Java
...
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Response;
...
Client client = ClientBuilder.newClient();
client.register(new SampleClientResponseFilter());

61.6. 实体 Reader Interceptor

概述

本节介绍如何实施和注册 实体 reader 拦截器，它可让您在客户端侧或服务器端读取消息正文时截获输入流。这通常适用于请求正文的通用转换，如加密和解密，或者压缩和解压缩。

ReaderInterceptor 接口

javax.ws.rs.ext.ReaderInterceptor 接口定义如下：

// Java
...
package javax.ws.rs.ext;

public interface ReaderInterceptor {
    public Object aroundReadFrom(ReaderInterceptorContext context)
            throws java.io.IOException, javax.ws.rs.WebApplicationException;
}

通过实施 ReaderInterceptor 接口，您可以截获消息正文(实体 对象)在服务器端或客户端一侧读取。您可以在以下任意上下文中使用实体读取器拦截：

服务器端- 如果作为服务器端拦截器绑定，则实体读取器在应用程序代码访问时截获请求消息正文（在匹配的资源中）。根据 REST 请求的语义，消息正文可能无法被匹配资源访问，在这种情况下，读取拦截器没有调用。
客户端侧-if 绑定到客户端侧拦截器，则实体读取器在客户端代码访问时截获响应消息正文。如果客户端代码没有明确访问响应消息（例如，通过调用 Response.getEntity 方法），则不会调用 reader 拦截器。

ReaderInterceptorContext 接口

ReaderInterceptor 的 aroundReadFrom 方法接收一个参数 javax.ws.rs.ext.ReaderInterceptorContext，它可用于访问消息正文(实体 对象)和元数据。

ReaderInterceptorContext 接口定义如下：

// Java
...
package javax.ws.rs.ext;

import java.io.IOException;
import java.io.InputStream;

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MultivaluedMap;

public interface ReaderInterceptorContext extends InterceptorContext {

    public Object proceed() throws IOException, WebApplicationException;

    public InputStream getInputStream();

    public void setInputStream(InputStream is);

    public MultivaluedMap<String, String> getHeaders();
}

InterceptorContext 接口

ReaderInterceptorContext 接口还支持从基础 InterceptorContext 接口继承的方法。

InterceptorContext 接口定义如下：

// Java
...
package javax.ws.rs.ext;

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Collection;

import javax.ws.rs.core.MediaType;

public interface InterceptorContext {

    public Object getProperty(String name);

    public Collection<String> getPropertyNames();

    public void setProperty(String name, Object object);

    public void removeProperty(String name);

    public Annotation[] getAnnotations();

    public void setAnnotations(Annotation[] annotations);

    Class<?> getType();

    public void setType(Class<?> type);

    Type getGenericType();

    public void setGenericType(Type genericType);

    public MediaType getMediaType();

    public void setMediaType(MediaType mediaType);
}

客户端中的实现示例

若要为客户端实施实体读取器拦截器，请定义一个实施 ReaderInterceptor 接口的类。

例如，以下代码显示了客户端侧的实体读取拦截器示例（优先级为 10），它将红帽在传入响应消息正文中替代 COMPANY_NAME 的所有实例：

// Java
package org.jboss.fuse.example;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.annotation.Priority;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.ext.ReaderInterceptor;
import javax.ws.rs.ext.ReaderInterceptorContext;

@Priority(value = 10)
public class SampleClientReaderInterceptor implements ReaderInterceptor {

  @Override
  public Object aroundReadFrom(ReaderInterceptorContext interceptorContext)
          throws IOException, WebApplicationException
  {
    InputStream inputStream = interceptorContext.getInputStream();
    byte[] bytes = new byte[inputStream.available()];
    inputStream.read(bytes);
    String responseContent = new String(bytes);
    responseContent = responseContent.replaceAll("COMPANY_NAME", "Red Hat");
    interceptorContext.setInputStream(new ByteArrayInputStream(responseContent.getBytes()));

    return interceptorContext.proceed();
  }
}

服务器端的实现示例

若要为服务器端实施实体读取器拦截器，请定义一个实施 ReaderInterceptor 接口的类，并通过 @Provider 注释对其进行标注。

例如，以下代码显示了服务器端的实体读取拦截器示例（优先级为 10），它将红帽在传入请求的消息正文中替代 COMPANY_NAME 的所有实例：

// Java
package org.jboss.fuse.example;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

import javax.annotation.Priority;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.ext.Provider;
import javax.ws.rs.ext.ReaderInterceptor;
import javax.ws.rs.ext.ReaderInterceptorContext;

@Priority(value = 10)
@Provider
public class SampleServerReaderInterceptor implements ReaderInterceptor {

  @Override
  public Object aroundReadFrom(ReaderInterceptorContext interceptorContext)
          throws IOException, WebApplicationException {
    InputStream inputStream = interceptorContext.getInputStream();
    byte[] bytes = new byte[inputStream.available()];
    inputStream.read(bytes);
    String requestContent = new String(bytes);
    requestContent = requestContent.replaceAll("COMPANY_NAME", "Red Hat");
    interceptorContext.setInputStream(new ByteArrayInputStream(requestContent.getBytes()));

    return interceptorContext.proceed();
  }
}

在客户端绑定 reader 拦截器

使用 JAX-RS 2.0 客户端 API，您可以在 javax.ws.rs.client. Client 对象或 javax.ws.rs.client.client.client .client.client 对象上直接注册实体读取器拦截器。这意味着读者拦截器可以选择性地应用到不同的范围，以便只有某些 URI 路径受到拦截器的影响。

例如，以下代码演示了如何注册 SampleClientReaderInterceptor 拦截器，使其应用于使用 client 对象进行的所有调用：

// Java
...
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Response;
...
Client client = ClientBuilder.newClient();
client.register(SampleClientReaderInterceptor.class);

有关使用 JAX-RS 2.0 客户端注册拦截器的详情，请参考第 49.5 节 “配置客户端端点”。

在服务器端绑定 reader 拦截器

要在服务器端绑定读取器拦截器（即，将其安装到 Apache CXF 运行时），请执行以下步骤：

将 @Provider 注释添加到 reader 拦截器类，如以下代码片段所示：

// Java
package org.jboss.fuse.example;
...
import javax.annotation.Priority;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.ext.Provider;
import javax.ws.rs.ext.ReaderInterceptor;
import javax.ws.rs.ext.ReaderInterceptorContext;

@Priority(value = 10)
@Provider
public class SampleServerReaderInterceptor implements ReaderInterceptor {
  ...
}

当 reader 拦截器实现加载到 Apache CXF 运行时，REST 实施会自动扫描载入的类，以搜索标有 @Provider 注解的类( 扫描阶段)。

在 XML 中定义 JAX-RS 服务器端点（例如，查看第 18.1 节 “配置 JAX-RS 服务器端点”）时，将 reader 拦截器添加到 jaxrs:providers 元素中的提供程序列表中。

<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jaxrs="http://cxf.apache.org/blueprint/jaxrs"
    xmlns:cxf="http://cxf.apache.org/blueprint/core"
    ...
>
    ...
    <jaxrs:server id="customerService" address="/customers">
      ...
      <jaxrs:providers>
        <ref bean="interceptorProvider" />
      </jaxrs:providers>
      <bean id="interceptorProvider" class="org.jboss.fuse.example.SampleServerReaderInterceptor"/>

    </jaxrs:server>

</blueprint>

注意

此步骤是 Apache CXF 非标准要求。严格根据 JAX-RS 标准进行说明，@Provider 注释应当是绑定拦截器所需的所有内容。但是，在实践中，标准方法非常不灵活，如果大型项目中纳入了许多库，则可能会导致供应商冲突。

61.7. 实体写入程序 Interceptor

概述

本节介绍如何实施和注册 实体写入器，这可让您在客户端侧或服务器端写入消息正文时截获输出流。这通常适用于请求正文的通用转换，如加密和解密，或者压缩和解压缩。

WriterInterceptor 接口

javax.ws.rs.ext.WriterInterceptor 接口定义如下：

// Java
...
package javax.ws.rs.ext;

public interface WriterInterceptor {
    void aroundWriteTo(WriterInterceptorContext context)
            throws java.io.IOException, javax.ws.rs.WebApplicationException;
}

通过实施 WriterInterceptor 接口，您可以截获消息正文(实体 对象)，因为它正在在服务器端或客户端进行写入。您可以在以下任意上下文中使用实体写入器：

服务器端- 如果作为服务器端拦截器绑定，则实体写入器会截获响应消息正文，然后被绑定并发回到客户端。
客户端侧- 如果作为客户端拦截器绑定，则实体写入器在请求消息正文之前截获请求消息正文，并将其发送到服务器。

WriterInterceptorContext interface

WriterInterceptor 的 aroundWriteTo 方法接收一个参数，类型为 javax.ws.rs.ext.WriterInterceptorContext，它可用于访问消息正文(实体 对象)和消息元数据。

WriterInterceptorContext 接口定义如下：

// Java
...
package javax.ws.rs.ext;

import java.io.IOException;
import java.io.OutputStream;

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MultivaluedMap;

public interface WriterInterceptorContext extends InterceptorContext {

    void proceed() throws IOException, WebApplicationException;

    Object getEntity();

    void setEntity(Object entity);

    OutputStream getOutputStream();

    public void setOutputStream(OutputStream os);

    MultivaluedMap<String, Object> getHeaders();
}

InterceptorContext 接口

WriterInterceptorContext 接口还支持从基础 InterceptorContext 接口继承的方法。有关 InterceptorContext 的定义，请参阅 “InterceptorContext 接口”一节。

客户端中的实现示例

要为客户端实现实体写入器，请定义实现 WriterInterceptor 接口的类。

例如，以下代码显示了客户端侧的实体写入器（优先级为 10）的实体写入器示例（优先级为 10），它会将额外文本行附加到传出请求的消息正文：

// Java
package org.jboss.fuse.example;

import java.io.IOException;
import java.io.OutputStream;

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.ext.WriterInterceptor;
import javax.ws.rs.ext.WriterInterceptorContext;
import javax.annotation.Priority;

@Priority(value = 10)
public class SampleClientWriterInterceptor implements WriterInterceptor {

  @Override
  public void aroundWriteTo(WriterInterceptorContext interceptorContext)
          throws IOException, WebApplicationException {
    OutputStream outputStream = interceptorContext.getOutputStream();
    String appendedContent = "\nInterceptors always get the last word in.";
    outputStream.write(appendedContent.getBytes());
    interceptorContext.setOutputStream(outputStream);

    interceptorContext.proceed();
  }
}

服务器端的实现示例

若要为服务器端实施实体写入器，请定义一个实施 WriterInterceptor 接口的类，并使用 @Provider 注释对其进行标注。

例如，以下代码显示了服务器端的实体写入器（优先级为 10），它会将额外文本行附加到传出请求的消息正文：

// Java
package org.jboss.fuse.example;

import java.io.IOException;
import java.io.OutputStream;

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.ext.Provider;
import javax.ws.rs.ext.WriterInterceptor;
import javax.ws.rs.ext.WriterInterceptorContext;
import javax.annotation.Priority;

@Priority(value = 10)
@Provider
public class SampleServerWriterInterceptor implements WriterInterceptor {

  @Override
  public void aroundWriteTo(WriterInterceptorContext interceptorContext)
          throws IOException, WebApplicationException {
    OutputStream outputStream = interceptorContext.getOutputStream();
    String appendedContent = "\nInterceptors always get the last word in.";
    outputStream.write(appendedContent.getBytes());
    interceptorContext.setOutputStream(outputStream);

    interceptorContext.proceed();
  }
}

在客户端上绑定 writer 拦截器

使用 JAX-RS 2.0 客户端 API，您可以在 javax.ws.rs.client. Client 对象或 javax.ws.rs.client.client.client. client.client 对象上直接注册实体写入器拦截器。这意味着写入器拦截器可以选择性地应用到不同的范围，以便只有某些 URI 路径受到拦截器的影响。

例如，以下代码演示了如何注册 SampleClientReaderInterceptor 拦截器，使其应用于使用 client 对象进行的所有调用：

// Java
...
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Response;
...
Client client = ClientBuilder.newClient();
client.register(SampleClientReaderInterceptor.class);

有关使用 JAX-RS 2.0 客户端注册拦截器的详情，请参考第 49.5 节 “配置客户端端点”。

在服务器端绑定写入器

要在服务器端绑定写入器拦截器（即，将其安装到 Apache CXF 运行时），请执行以下步骤：

将 @Provider 注释添加到 writer 拦截器类，如以下代码片段所示：

// Java
package org.jboss.fuse.example;
...
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.ext.Provider;
import javax.ws.rs.ext.WriterInterceptor;
import javax.ws.rs.ext.WriterInterceptorContext;
import javax.annotation.Priority;

@Priority(value = 10)
@Provider
public class SampleServerWriterInterceptor implements WriterInterceptor {
  ...
}

当写入器实施加载到 Apache CXF 运行时时，REST 实施会自动扫描载入的类，以搜索标有 @Provider 注解的类( 扫描阶段)。

在 XML 中定义 JAX-RS 服务器端点（例如，查看第 18.1 节 “配置 JAX-RS 服务器端点”）时，将 writer 拦截器添加到 jaxrs:providers 元素中的提供程序列表中。

<blueprint xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:jaxrs="http://cxf.apache.org/blueprint/jaxrs"
    xmlns:cxf="http://cxf.apache.org/blueprint/core"
    ...
>
    ...
    <jaxrs:server id="customerService" address="/customers">
      ...
      <jaxrs:providers>
        <ref bean="interceptorProvider" />
      </jaxrs:providers>
      <bean id="interceptorProvider" class="org.jboss.fuse.example.SampleServerWriterInterceptor"/>

    </jaxrs:server>

</blueprint>

注意

61.8. 动态绑定

概述

将容器过滤器和容器拦截器绑定到资源的标准方法是使用 @Provider 注释标注过滤器和拦截器。这样可确保绑定是全局：即，过滤器和拦截器绑定到服务器端的每个资源类和资源方法。

动态绑定是绑定服务器端的替代方法，可让您选取并选择要将拦截器和过滤器应用到哪些资源方法。要为过滤器和拦截器启用动态绑定，您必须实施自定义 DynamicFeature 接口，如下所述。

DynamicFeature 接口

DynamicFeature 接口在 javax.ws.rx.container 软件包中定义，如下所示：

// Java
package javax.ws.rs.container;

import javax.ws.rs.core.FeatureContext;
import javax.ws.rs.ext.ReaderInterceptor;
import javax.ws.rs.ext.WriterInterceptor;

public interface DynamicFeature {
    public void configure(ResourceInfo resourceInfo, FeatureContext context);
}

实施动态功能

您实现动态功能，如下所示：

按照前面所述，实施一个或多个容器过滤器或容器拦截器。但是，不要给他们标上 @Provider 注释（否则，会为他们全局绑定，使动态功能无效）。
通过实施 DynamicFeature 类，覆盖 配置 方法来创建您自己的动态功能。
在配置 方法中，您可以使用 resourceInfo 参数来发现哪些资源类以及哪个资源方法被调用。您可以使用这些信息来决定是否注册一些过滤器或拦截器。
如果您决定使用当前资源方法注册过滤器或拦截器，可以通过调用其中一个 context.register 方法来实现。
记得使用 @Provider 注释给您的动态功能类标注，以确保在部署的扫描阶段获取该类。

动态功能示例

以下示例演示了如何定义动态功能，为使用 @GET 标注的 MyResource 类（或子类）的任何方法注册 LoggingFilter 过滤器：

// Java
...
import javax.ws.rs.container.DynamicFeature;
import javax.ws.rs.container.ResourceInfo;
import javax.ws.rs.core.FeatureContext;
import javax.ws.rs.ext.Provider;

@Provider
public class DynamicLoggingFilterFeature implements DynamicFeature {
  @Override
  void configure(ResourceInfo resourceInfo, FeatureContext context) {
    if (MyResource.class.isAssignableFrom(resourceInfo.getResourceClass())
      && resourceInfo.getResourceMethod().isAnnotationPresent(GET.class)) {
      context.register(new LoggingFilter());
  }
}

动态绑定进程

JAX-RS 标准要求通过 DynamicFeature.configure 方法 为每一资源方法调用一次。这意味着，每个资源方法都可能安装有过滤器或拦截器，但动态功能最多可以决定每个情况下都会注册过滤器或拦截器。换句话说，动态功能支持的绑定的粒度是单个资源方法的级别。

FeatureContext 接口

FeatureContext 接口（允许您在配置方法中注册过滤器和拦截器）被定义为 Configurable <> 的子接口，如下所示：

// Java
package javax.ws.rs.core;

public interface FeatureContext extends Configurable<FeatureContext> {
}

Configurable& lt;> 接口定义了在单一资源方法上注册过滤器和拦截器的方法，如下所示：

// Java
...
package javax.ws.rs.core;

import java.util.Map;

public interface Configurable<C extends Configurable> {
    public Configuration getConfiguration();
    public C property(String name, Object value);
    public C register(Class<?> componentClass);
    public C register(Class<?> componentClass, int priority);
    public C register(Class<?> componentClass, Class<?>... contracts);
    public C register(Class<?> componentClass, Map<Class<?>, Integer> contracts);
    public C register(Object component);
    public C register(Object component, int priority);
    public C register(Object component, Class<?>... contracts);
    public C register(Object component, Map<Class<?>, Integer> contracts);
}

第 62 章 Apache CXF 消息处理阶段

入站阶段

表 62.1 “入站消息处理阶段” 列出入站拦截器链中的阶段。

表 62.1. 入站消息处理阶段
阶段	描述
RECEIVE	执行特定于传输的处理，如确定二进制附加的 MIME 边界。
PRE_STREAM	处理传输接收的原始数据流。
USER_STREAM
POST_STREAM
READ	确定请求是 SOAP 或 XML 消息，构建是否添加了适当的拦截器。在此阶段还处理 SOAP 消息标头。
PRE_PROTOCOL	执行协议级别处理。这包括处理 WS-* 标头并处理 SOAP 消息属性。
USER_PROTOCOL
POST_PROTOCOL
UNMARSHAL	将消息数据解压缩到由应用程序级代码使用的对象中。
PRE_LOGICAL	处理未过滤的消息数据。
USER_LOGICAL
POST_LOGICAL
PRE_INVOKE
调用	将消息传递给应用代码。在服务器端，服务实现将在此阶段调用。在客户端，响应被移回应用程序。
POST_INVOKE	调用出站拦截器链。

出站阶段

表 62.2 “入站消息处理阶段” 列出入站拦截器链中的阶段。

表 62.2. 入站消息处理阶段
阶段	描述
SETUP	执行链中后续阶段需要的设置。
PRE_LOGICAL	对从应用程序级别传递的未绑定数据执行处理。
USER_LOGICAL
POST_LOGICAL
PREPARE_SEND	打开连接，以在线上写入消息。
PRE_STREAM	执行必要的处理，以准备条目进入数据流中的消息。
PRE_PROTOCOL	开始处理协议特定信息。
写	写入协议消息。
PRE_MARSHAL	marshals 消息。
MARSHAL
POST_MARSHAL
USER_PROTOCOL	处理协议消息。
POST_PROTOCOL
USER_STREAM	处理字节级消息。
POST_STREAM
SEND	发送消息并关闭传输流。

重要

出站拦截器链具有一组镜像(mirror)的结束阶段，它们的名称会附加 _ENDING。结束阶段是使用拦截器，它们需要在数据使用线路写入前发生一些终端操作。

第 63 章 Apache CXF Provided Interceptors

63.1. Core Apache CXF Interceptors

入站

表 63.1 “内核入站拦截器” 列出添加至所有 Apache CXF 端点的核心入站拦截器。

表 63.1. 内核入站拦截器
类	阶段	描述
`ServiceInvokerInterceptor`	`调用`	在服务上调用正确的方法。

出站

默认情况下，Apache CXF 不会将任何内核拦截器添加到出站拦截器链。端点的出站拦截器链的内容取决于所使用的功能。

63.2. 前端

JAX-WS

表 63.2 “入站 JAX-WS 拦截器” 列出添加到 JAX-WS 端点的入站消息链的拦截器。

表 63.2. 入站 JAX-WS 拦截器
类	阶段	描述
`HolderInInterceptor`	`PRE_INVOKE`	在消息中为任何 out 或 in/out 参数创建拥有者对象。
`WrapperClassInInterceptor`	`POST_LOGICAL`	将嵌套的 doc/literal 消息的部分包装到相应的对象数组中。
`LogicalHandlerInInterceptor`	`PRE_PROTOCOL`	将消息处理传递给端点使用的 JAX-WS 逻辑处理程序。当 JAX-WS 处理程序完成后，该消息会传递到入站链上的下一个拦截器。
`SOAPHandlerInterceptor`	`PRE_PROTOCOL`	将消息处理传递给端点使用的 JAX-WS SOAP 处理程序。当 SOAP 处理程序通过消息完成时，信息会传递到链中的下一个拦截器。

表 63.3 “出站 JAX-WS 拦截器” 列出添加到 JAX-WS 端点的出站消息链的拦截器。

表 63.3. 出站 JAX-WS 拦截器
类	阶段	描述
`HolderOutInterceptor`	`PRE_LOGICAL`	从拥有者对象中删除任何 out 和 in/out 参数的值，并将值添加到消息的参数列表中。
`WebFaultOutInterceptor`	`PRE_PROTOCOL`	处理出站故障消息。
`WrapperClassOutInterceptor`	`PRE_LOGICAL`	确保在将 doc/literal 消息添加到消息之前，会正确换行 doc/literal 消息和 rpc/literal 消息。
`LogicalHandlerOutInterceptor`	`PRE_MARSHAL`	将消息处理传递给端点使用的 JAX-WS 逻辑处理程序。当 JAX-WS 处理程序完成后，该消息会传递到出站链上的下一拦截器。
`SOAPHandlerInterceptor`	`PRE_PROTOCOL`	将消息处理传递给端点使用的 JAX-WS SOAP 处理程序。当 SOAP 处理程序完成消息处理时，它将与链中的下一个拦截器一起传递。
`MessageSenderInterceptor`	`PREPARE_SEND`	调用回 Destination 对象，使它设置输出流、标头等，以准备传出传输。

JAX-RS

表 63.4 “入站 JAX-RS 拦截器” 列出添加到 JAX-RS 端点的入站消息链的拦截器。

表 63.4. 入站 JAX-RS 拦截器
类	阶段	描述
`JAXRSInInterceptor`	`PRE_STREAM`	选择根资源类，调用任何配置的 JAX-RS 请求过滤器，并确定在 root 资源上调用的方法。

重要

JAX-RS 端点的入站链跳过了 ServiceInvokerInInterceptor 拦截器。JAXRSInInterceptor 后面不会调用其他拦截器。

表 63.5 “出站 JAX-RS 拦截器” 列出添加到 JAX-RS 端点的出站消息链的拦截器。

表 63.5. 出站 JAX-RS 拦截器
类	阶段	描述
`JAXRSOutInterceptor`	`MARSHAL`	marshals 作为正确的传输格式的响应。

63.3. 消息绑定

SOAP

表 63.6 “入站 SOAP 拦截器” 在使用 SOAP Binding 时，列出添加到端点入站消息链的拦截器。

表 63.6. 入站 SOAP 拦截器
类	阶段	描述
`CheckFaultInterceptor`	`POST_PROTOCOL`	检查消息是否为失败消息。如果消息是容错消息，则正常处理会被中止，并且启动错误处理。
`MustUnderstandInterceptor`	`PRE_PROTOCOL`	进程必须理解标头。
`RPCInInterceptor`	`UNMARSHAL`	Unmarshals rpc/literal 消息。如果消息是 bare，则消息会传递到 `BareInInterceptor` 对象，以反序列化消息部分。
`ReadsHeadersInterceptor`	`READ`	解析 SOAP 标头，并将它们存储在消息对象中。
`SoapActionInInterceptor`	`READ`	解析 SOAP 操作标头，并尝试查找操作的唯一操作。
`SoapHeaderInterceptor`	`UNMARSHAL`	将映射到操作参数的 SOAP 标头绑定到适当的对象。
`AttachmentInInterceptor`	`RECEIVE`	解析 mime 边界的 mime 标头，找到 root 部分并重置输入流，并将其他部分存储在 `Attachment` 对象的集合中。
`DocLiteralInInterceptor`	`UNMARSHAL`	检查 SOAP 正文中第一个元素，以确定适当的操作，并调用数据中读取的数据绑定。
`StaxInInterceptor`	`POST_STREAM`	从消息中创建 `XMLStreamReader` 对象。
`URIMappingInterceptor`	`UNMARSHAL`	处理 HTTP GET 方法的处理。
`SwAInInterceptor`	`PRE_INVOKE`	为二进制 SOAP 附加创建所需的 MIME 处理程序，并将数据添加到参数列表中。

表 63.7 “出站 SOAP 拦截器” 在使用 SOAP Binding 时，列出添加到端点的出站消息链的拦截器。

表 63.7. 出站 SOAP 拦截器
类	阶段	描述
`RPCOutInterceptor`	`MARSHAL`	marshals rpc 风格消息用于传输。
`SoapHeaderOutFilterInterceptor`	`PRE_LOGICAL`	删除所有标记为入站的 SOAP 标头。
`SoapPreProtocolOutInterceptor`	`POST_LOGICAL`	设置 SOAP 版本和 SOAP 操作标头。
`AttachmentOutInterceptor`	`PRE_STREAM`	设置附件 marshalers 和处理任何可能位于消息中的附件所需的mime 内容。
`BareOutInterceptor`	`MARSHAL`	写入消息部分。
`StaxOutInterceptor`	`PRE_STREAM`	从消息创建 `XMLStreamWriter` 对象。
`WrappedOutInterceptor`	`MARSHAL`	嵌套出站消息参数。
`SoapOutInterceptor`	`写`	在消息中写入 `soap:envelope` 元素以及标头块的元素。另外，为剩余的拦截器写入一个空 `soap:body` 元素来填充。
`SwAOutInterceptor`	`PRE_LOGICAL`	删除任何要打包为 SOAP 附加的二进制数据，并存储它以便稍后处理。

XML

表 63.8 “入站 XML 拦截器” 使用 XML 绑定时，列出添加到端点入站消息链的拦截器。

表 63.8. 入站 XML 拦截器
类	阶段	描述
`AttachmentInInterceptor`	`RECEIVE`	解析 mime 边界的 mime 标头，找到 root 部分并重置输入流，然后将其他部分存储在 `Attachment` 对象的集合中。
`DocLiteralInInterceptor`	`UNMARSHAL`	检查消息正文中第一个元素，以确定适当的操作，然后调用数据中读取的数据绑定。
`StaxInInterceptor`	`POST_STREAM`	从消息中创建 `XMLStreamReader` 对象。
`URIMappingInterceptor`	`UNMARSHAL`	处理 HTTP GET 方法的处理。
`XMLMessageInInterceptor`	`UNMARSHAL`	解除 XML 消息。

表 63.9 “出站 XML 拦截器” 在使用 XML 绑定时，列出添加到端点的出站消息链的拦截器。

表 63.9. 出站 XML 拦截器
类	阶段	描述
`StaxOutInterceptor`	`PRE_STREAM`	从消息中创建 `XMLStreamWriter` 对象。
`WrappedOutInterceptor`	`MARSHAL`	嵌套出站消息参数。
`XMLMessageOutInterceptor`	`MARSHAL`	marshals 传输消息。

CORBA

表 63.10 “入站 CORBA 拦截器” 在使用 CORBA Binding 时，列出添加到端点入站消息链的拦截器。

表 63.10. 入站 CORBA 拦截器
类	阶段	描述
`CorbaStreamInInterceptor`	`PRE_STREAM`	对 CORBA 消息进行反序列化。
`BareInInterceptor`	`UNMARSHAL`	对消息部分进行反序列化。

表 63.11 “出站 CORBA 拦截器” 在使用 CORBA Binding 时，列出添加到端点的出站消息链的拦截器。

表 63.11. 出站 CORBA 拦截器
类	阶段	描述
`CorbaStreamOutInterceptor`	`PRE_STREAM`	序列化消息。
`BareOutInterceptor`	`MARSHAL`	写入消息部分。
`CorbaStreamOutEndingInterceptor`	`USER_STREAM`	为消息创建一个可流的对象，并将其存储在消息上下文中。

63.4. 其他功能

日志记录

表 63.12 “入站日志拦截器” 列出添加到端点入站消息链的拦截器来支持日志记录。

表 63.12. 入站日志拦截器
类	阶段	描述
`LoggingInInterceptor`	`RECEIVE`	将原始消息数据写入日志记录系统。

表 63.13 “出站日志拦截器” 列出添加到端点出站消息链的拦截器来支持日志记录。

表 63.13. 出站日志拦截器
类	阶段	描述
`LoggingOutInterceptor`	`PRE_STREAM`	将出站消息写入日志记录系统。

有关日志记录的更多信息，请参阅第 19 章 Apache CXF Logging。

WS-Addressing

表 63.14 “入站 WS-Addressing 拦截器” 在使用 WS-Addressing 时，列出添加到端点入站消息链的拦截器。

表 63.14. 入站 WS-Addressing 拦截器
类	阶段	描述
`MAPCodec`	`PRE_PROTOCOL`	解码消息寻址属性。

表 63.15 “出站 WS-寻址拦截器” 在使用 WS-Addressing 时，列出添加到端点的出站消息链的拦截器。

表 63.15. 出站 WS-寻址拦截器
类	阶段	描述
`MAPAggregator`	`PRE_LOGICAL`	聚合消息寻址属性。
`MAPCodec`	`PRE_PROTOCOL`	对消息寻址属性进行编码。

有关 WS-Addressing 的更多信息，请参阅第 20 章 部署 WS-Addressing。

WS-RM

重要

WS-RM 依赖于 WS-Addressing，因此所有 WS-Addressing 拦截器也会添加到拦截器链中。

表 63.16 “入站 WS-RM 拦截器” 在使用 WS-RM 时，列出添加到端点入站消息链的拦截器。

表 63.16. 入站 WS-RM 拦截器
类	阶段	描述
`RMInInterceptor`	`PRE_LOGICAL`	处理消息部分和确认消息的聚合。
`RMSoapInterceptor`	`PRE_PROTOCOL`	对来自消息的 WS-RM 属性进行编码并解码。

表 63.17 “出站 WS-RM 拦截器” 在使用 WS-RM 时，列出添加到端点的出站消息链的拦截器。

表 63.17. 出站 WS-RM 拦截器
类	阶段	描述
`RMOutInterceptor`	`PRE_LOGICAL`	处理消息的块和块的传输。还处理确认请求和重新发送请求的处理。
`RMSoapInterceptor`	`PRE_PROTOCOL`	对来自消息的 WS-RM 属性进行编码并解码。

有关 WS-RM 的更多信息，请参阅第 21 章 启用可靠的消息传递。

第 64 章拦截器供应商

概述

拦截器提供程序是 Apache CXF 运行时中附加了拦截器链的对象。它们都实施 org.apache.cxf.interceptor.InterceptorProvider 接口。开发人员可以将自己的拦截器附加到任何拦截器供应商。

供应商列表

以下对象是拦截器供应商：

AddressingPolicyInterceptorProvider
ClientFactoryBean
ClientImpl
ClientProxyFactoryBean
CorbaBinding
CXFBusImpl
org.apache.cxf.jaxws.EndpointImpl
org.apache.cxf.endpoint.EndpointImpl
ExtensionManagerBus
JAXRSClientFactoryBean
JAXRSServerFactoryBean
JAXRSServiceImpl
JaxWsClientEndpointImpl
JaxWsClientFactoryBean
JaxWsEndpointImpl
JaxWsProxyFactoryBean
JaxWsServerFactoryBean
JaxwsServiceBuilder
MTOMPolicyInterceptorProvider
NoOpPolicyInterceptorProvider
ObjectBinding
RMPolicyInterceptorProvider
ServerFactoryBean
ServiceImpl
SimpleServiceBuilder
SoapBinding
WrappedEndpoint
WrappedService
XMLBinding

部分 VIII. Apache CXF 功能

本指南介绍了如何启用 Apache CXF 的各种高级功能。

第 65 章 Bean Validation

摘要

Bean 验证是一种 Java 标准，您可以通过将 Java 注解添加到服务类或接口来定义运行时约束。Apache CXF 使用拦截器将此功能与 Web 服务方法调用集成。

65.1. 简介

概述

Bean Validation 1.1 (JSR-349)- 这是原始 Bean Validation 1.0 (JSR-303)标准的演进，您可以使用 Java 注释来声明运行时可以检查的约束。您可以使用注解来定义 Java 代码以下部分的约束：

Bean 类中的字段。
方法和构造器参数.
方法返回值。

注解类示例

以下示例显示了一个带有一些标准 bean 验证限制的 Java 类：

// Java
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Max;
import javax.validation.Valid;
...
public class Person {
    @NotNull private String firstName;
    @NotNull private String lastName;
    @Valid @NotNull private Person boss;

    public @NotNull String saveItem( @Valid @NotNull Person person, @Max( 23 ) BigDecimal age ) {
        // ...
    }
}

Bean 验证或架构验证？

在一些方面，bean 验证和模式验证过程非常相似。使用 XML 模式配置端点是在 Web 服务端点运行时验证消息的好方法。XML 模式可以检查许多与传入和传出消息上的 bean 验证相同的约束。然而，出于以下一个或多个原因，bean 验证有时是有用的替代选择：

Bean 验证可让您独立于 XML 模式定义约束（例如，如果 code-first 服务开发，这很有用）。
如果您的当前 XML 模式过拉x，您可以使用 bean 验证来定义严格的限制。
Bean 验证可让您定义自定义约束，这可能无法使用 XML 模式语言进行定义。

依赖项

Bean Validation 1.1 (JSR-349)标准仅定义 API，而非实施。因此，依赖项必须在两个部分中提供：

核心依赖项- 提供 bean 验证 1.1 API、Java 统一表达式语言 API 和实施。
Hibernate Validator 依赖项- 提供 bean 验证 1.1 的实现。

内核依赖项

要使用 bean 验证，您必须在项目的 Maven pom.xml 文件中添加以下核心依赖项：

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>
<dependency>
    <groupId>javax.el</groupId>
    <artifactId>javax.el-api</artifactId>
    <!-- use 3.0-b02 version for Java 6 -->
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <!-- use 3.0-b01 version for Java 6 -->
    <version>3.0.0</version>
</dependency>

注意

javax.el/javax.el-api 和 org.glassfish/javax.el 依赖项提供 Java 统一表达式语言的 API 和实施。此表达式语言由 bean 验证在内部使用，但对应用编程级别并不重要。

Hibernate Validator 依赖项

要使用 bean 验证的 Hibernate 验证功能，您必须在项目的 Maven pom.xml 文件中添加以下额外依赖项：

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.0.3.Final</version>
</dependency>

在 OSGi 环境中解析验证供应商

解决验证提供程序的默认机制需要扫描类路径以查找提供程序资源。但是，如果 OSGi (Apache Karaf)环境，这种机制无法正常工作，因为验证供应商（例如，Hibernate 验证器）打包在单独的捆绑包中，因此不会在您的应用程序类路径中自动可用。在 OSGi 的上下文中，Hibernate 验证器需要与您的应用程序捆绑包相连接，且 OSGi 需要一些帮助才能成功完成此操作。

在 OSGi 中明确配置验证供应商

在 OSGi 上下文中，您需要明确配置验证供应商，而不依赖于自动发现。例如，如果您使用通用验证功能（请参阅 “Bean 验证功能”一节）启用 Bean 验证功能，您必须使用验证供应商进行配置，如下所示：

<bean id="commonValidationFeature" class="org.apache.cxf.validation.BeanValidationFeature">
    <property name="provider" ref="beanValidationProvider"/>
</bean>

<bean id="beanValidationProvider" class="org.apache.cxf.validation.BeanValidationProvider">
    <constructor-arg ref="validationProviderResolver"/>
</bean>

<bean id="validationProviderResolver" class="org.example.HibernateValidationProviderResolver"/>

这里的 HibernateValidationProviderResolver 是一个自定义类，它嵌套 Hibernate 验证供应商。

HibernateValidationProviderResolver 类示例

以下代码示例演示了如何定义自定义 HibernateValidationProviderResolver，它解决了 Hibernate 验证器：

// Java
package org.example;

import static java.util.Collections.singletonList;
import org.hibernate.validator.HibernateValidator;
import javax.validation.ValidationProviderResolver;
import java.util.List;

/**
 * OSGi-friendly implementation of {@code javax.validation.ValidationProviderResolver} returning
 * {@code org.hibernate.validator.HibernateValidator} instance.
 *
 */
public class HibernateValidationProviderResolver implements ValidationProviderResolver {

    @Override
    public List getValidationProviders() {
        return singletonList(new HibernateValidator());
    }
}

当您在 Maven 构建系统中构建上述类（配置为使用 Maven bundle 插件）时，您的应用将在部署时连接到 Hibernate 验证捆绑包（假设您已将 Hibernate 验证捆绑包部署到 OSGi 容器中）。

65.2. 使用 Bean Validation 开发服务

65.2.1. 注解服务 Bean

概述

使用 bean 验证开发服务的第一步是将相关的验证注解应用到代表您的服务的 Java 类或接口。通过验证注释，您可以在每次调用服务时对方法参数、返回值和类字段应用约束，然后每次调用该服务时都会检查它们。

验证简单的输入参数

要验证服务方法的参数（其中参数是简单的 Java 类型），您可以应用来自 bean 验证 API (javax.validation.constraints 软件包)的任何约束注解。例如，以下代码示例测试两个参数是否表示 nullness (@NotNull 注释)，ID 字符串是否与 \\d+ 正则表达式(@Pattern 注释)匹配，以及 名称 字符串在范围 1 到 50 范围中的长度：

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
...
@POST
@Path("/books")
public Response addBook(
        @NotNull @Pattern(regexp = "\\d+") @FormParam("id") String id,
        @NotNull @Size(min = 1, max = 50) @FormParam("name") String name) {
    // do some work
    return Response.created().build();
}

验证复杂输入参数

要验证复杂的输入参数（对象实例），将 @Valid 注释应用到参数，如下例所示：

import javax.validation.Valid;
...
@POST
@Path("/books")
public Response addBook( @Valid Book book ) {
    // do some work
    return Response.created().build();
}

@Valid 注释本身不指定任何限制。使用 @Valid 标注 Book 参数时，您将有效地告知验证引擎在 Book 类的定义内查看（递归）查找验证限制。在本例中，Book 类使用 ID 和名称字段的验证限制定义，如下所示：

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
...
public class Book {
    @NotNull @Pattern(regexp = "\\d+") private String id;
    @NotNull @Size(min = 1, max = 50) private String name;

    // ...
}

验证返回值（非响应）

要将验证应用到常规方法返回值（非空间），请在方法签名前添加注解。例如，要测试 nullness (@NotNull 注释)的返回值，并以递归方式测试验证约束(@Valid 注释)，注解 getBook 方法，如下所示：

import javax.validation.constraints.NotNull;
import javax.validation.Valid;
...
@GET
@Path("/books/{bookId}")
@Override
@NotNull @Valid
public Book getBook(@PathParam("bookId") String id) {
    return new Book( id );
}

验证返回值(Response)

要将验证应用到返回 javax.ws.rs.core.Response 对象的方法，您可以在非空间中使用相同的注解。例如：

import javax.validation.constraints.NotNull;
import javax.validation.Valid;
import javax.ws.rs.core.Response;
...
@GET
@Path("/books/{bookId}")
@Valid @NotNull
public Response getBookResponse(@PathParam("bookId") String id) {
    return Response.ok( new Book( id ) ).build();
}

65.2.2. 标准注解

Bean 验证限制

表 65.1 “Bean 验证的标准注解” 显示 Bean Validation 规范中定义的标准注解，这些注解可用于定义字段和方法的返回值和参数（不在类级别上应用标准注解）。

表 65.1. Bean 验证的标准注解
注解	适用于	描述
`@AssertFalse`	`布尔值`，`布尔值`	检查被注释的元素是否为 `false`。
`@AssertTrue`	`布尔值`，`布尔值`	检查注解的元素是否为 `true`。
`@DecimalMax(value=, inclusive=)`	`BigDecimal`,`BigInteger`,`CharSequence`,`byte`,`short`,`int`, int,`long`, primitive type wrappers	当 `inclusive=false` 时，检查注解的值是否小于指定的最大值。否则，检查值是否小于或等于指定的最大值。`value` 参数指定 `BigDecimal` 字符串格式的最大值。
`@DecimalMin(value=, inclusive=)`	`BigDecimal`,`BigInteger`,`CharSequence`,`byte`,`short`,`int`, int,`long`, primitive type wrappers	当 `inclusive=false` 时，检查注解的值是否大于指定最小值。否则，检查值是否大于或等于指定最小值。`value` 参数指定 `BigDecimal` 字符串格式最小值。
`@Digits(integer=, fraction=)`	`BigDecimal`,`BigInteger`,`CharSequence`,`byte`,`short`,`int`, int,`long`, primitive type wrappers	检查注解的值是否最多有 `整数` 数和 `分数` 数。
`@Future`	`java.util.Date`, `java.util.Calendar`	检查注解的日期是否在未来。
`@Max(value=)`	`BigDecimal`,`BigInteger`,`CharSequence`,`byte`,`short`,`int`, int,`long`, primitive type wrappers	检查注解的值是否小于或等于指定的最大值。
`@Min(value=)`	`BigDecimal`,`BigInteger`,`CharSequence`,`byte`,`short`,`int`, int,`long`, primitive type wrappers	检查注解的值是否大于或等于指定最小值。
`@NotNull`	任何类型	检查注解的值是否 `不为空`。
`@Null`	任何类型	检查注解的值是否为 `null`。
`@Past`	`java.util.Date`, `java.util.Calendar`	检查注解的日期是否过去。
`@Pattern(regex=, flag=)`	`CharSequence`	检查被注释的字符串是否与给定标记匹配的正则表达式正则表达式匹配。
`@Size(min=, max=)`	`CharSequence`、`集合`、`映射` 和数组	检查被注解的集合、映射或数组的大小（包括）是否位于 `min` 和 `max` （含）之间。
`@Valid`	任何非primitive 类型	在注解对象中递归执行验证。如果对象是集合或数组，则会以递归方式验证元素。如果对象是一个映射，则值元素会递归验证。

65.2.3. 自定义注解

在 Hibernate 中定义自定义约束

可以使用 bean 验证 API 定义您自己的自定义约束注解。有关如何在 Hibernate 验证器实现中执行此操作的详情，请查看 Hibernate 验证参考指南中的创建自定义约束章节。

65.3. 配置 Bean 验证

65.3.1. JAX-WS 配置

概述

这部分论述了如何在 JAX-WS 服务端点中启用 bean 验证，该端点在 Blueprint XML 或 Spring XML 中定义。用于执行 bean 验证的拦截器在 JAX-WS 端点和 JAX-RS 1.1 端点(JAX-RS 2.0 端点)都很常见（但使用不同的拦截器类）。

命名空间

在本节所示的 XML 示例中，您必须记得将 jaxws 命名空间前缀映射到适当的命名空间，可以是 Blueprint 或 Spring，如下表中所示：

XML 语言	命名空间
蓝图（Blueprint）	`http://cxf.apache.org/blueprint/jaxws`
Spring	`http://cxf.apache.org/jaxws`

Bean 验证功能

在 JAX-WS 端点上启用 Bean 验证的最简单方式是将 bean 验证功能 添加到端点。Bean 验证功能由以下类实现：

org.apache.cxf.validation.BeanValidationFeature: 通过将此功能类的实例添加到 JAX-WS 端点（通过 Java API，或通过 XML 中的 jaxws: features 子元素），您可以在端点上启用 bean 验证。此功能安装两个拦截器：一个拦截器验证传入的消息数据；以及验证返回值的 Out 拦截器（其中，拦截器会使用默认配置参数创建）。

带有 bean 验证功能的 JAX-WS 配置示例

以下 XML 示例演示了如何在 JAX-WS 端点中启用 bean 验证功能，方法是在端点中添加 commonValidationFeature bean 作为 JAX-WS 功能：

<jaxws:endpoint xmlns:s="http://bookworld.com"
                serviceName="s:BookWorld"
                endpointName="s:BookWorldPort"
                implementor="#bookWorldValidation"
                address="/bwsoap">
    <jaxws:features>
        <ref bean="commonValidationFeature" />
    </jaxws:features>
</jaxws:endpoint>

<bean id="bookWorldValidation" class="org.apache.cxf.systest.jaxrs.validation.spring.BookWorldImpl"/>

<bean id="commonValidationFeature" class="org.apache.cxf.validation.BeanValidationFeature">
    <property name="provider" ref="beanValidationProvider"/>
</bean>

<bean id="beanValidationProvider" class="org.apache.cxf.validation.BeanValidationProvider">
    <constructor-arg ref="validationProviderResolver"/>
</bean>

<bean id="validationProviderResolver" class="org.example.HibernateValidationProviderResolver"/>

有关 HibernateValidationProviderResolver 类的示例实现，请参阅 “HibernateValidationProviderResolver 类示例”一节。只需要在 OSGi 环境(Apache Karaf)环境中配置 beanValidationProvider。

注意

根据具体情况，请记住将 jaxws 前缀映射到蓝图或 Spring 的相应 XML 命名空间。

Common bean 验证 1.1 拦截器

如果要对 bean 验证的配置具有更精细的控制，您可以单独安装拦截器，而不是使用 bean 验证功能。要代替 bean 验证功能，您可以配置以下拦截器之一或两者：

org.apache.cxf.validation.BeanValidationInInterceptor: 在 JAX-WS （或 JAX-RS 1.1）端点中安装时，根据验证限制验证资源方法参数。如果验证失败，则引发 javax.validation.ConstraintViolationException 异常。要安装此拦截器，请通过 XML 中的 jaxws:inInterceptors 子元素（或 XML 中的 jaxrs:inInterceptors 子元素）将其添加到端点。
org.apache.cxf.validation.BeanValidationOutInterceptor: 在 JAX-WS （或 JAX-RS 1.1）端点中安装时，根据验证限制验证响应值。如果验证失败，则引发 javax.validation.ConstraintViolationException 异常。要安装此拦截器，请通过 XML 中的 jaxws:outInterceptors 子元素（或 XML 中的 jaxrs:outInterceptors 子元素）将其添加到端点。

带有 bean 验证拦截器的 JAX-WS 配置示例

以下 XML 示例演示了如何在 JAX-WS 端点中启用 bean 验证功能，方法是明确将相关的 In 拦截器 bean 和 Out 拦截器 bean 添加到端点：

<jaxws:endpoint xmlns:s="http://bookworld.com"
                serviceName="s:BookWorld"
                endpointName="s:BookWorldPort"
                implementor="#bookWorldValidation"
                address="/bwsoap">
    <jaxws:inInterceptors>
        <ref bean="validationInInterceptor" />
    </jaxws:inInterceptors>

    <jaxws:outInterceptors>
        <ref bean="validationOutInterceptor" />
    </jaxws:outInterceptors>
</jaxws:endpoint>

<bean id="bookWorldValidation" class="org.apache.cxf.systest.jaxrs.validation.spring.BookWorldImpl"/>

<bean id="validationInInterceptor" class="org.apache.cxf.validation.BeanValidationInInterceptor">
    <property name="provider" ref="beanValidationProvider"/>
</bean>
<bean id="validationOutInterceptor" class="org.apache.cxf.validation.BeanValidationOutInterceptor">
    <property name="provider" ref="beanValidationProvider"/>
</bean>

<bean id="beanValidationProvider" class="org.apache.cxf.validation.BeanValidationProvider">
    <constructor-arg ref="validationProviderResolver"/>
</bean>

<bean id="validationProviderResolver" class="org.example.HibernateValidationProviderResolver"/>

配置 BeanValidationProvider

org.apache.cxf.validation.BeanValidationProvider 是一个简单打包程序类，用于包装 Bean 验证实施(验证供应商)。通过覆盖默认的 BeanValidationProvider 类，您可以自定义 bean 验证的实现。BeanValidationProvider bean 允许您覆盖以下一个或多个提供程序类：

javax.validation.ParameterNameProvider: 为方法和构造器参数提供名称。请注意，这个类是必需的，因为 Java 反映的 API 不提供 方法参数或构造器参数的名称。
javax.validation.spi.ValidationProvider<T>: 提供指定类型 T 的 Bean 验证实施。通过实施自己的 ValidationProvider 类，您可以为您自己的类定义自定义验证规则。这种机制有效允许您扩展 bean 验证框架。
javax.validation.ValidationProviderResolver: 实施用于发现 ValidationProvider 类的机制，并返回发现的类列表。默认解析器会在 classpath 中查找 META-INF/services/javax.validation.spi.ValidationProvider 文件，它应包含 ValidationProvider 类列表。
javax.validation.ValidatorFactory: 返回 javax.validation.Validator 实例的工厂。
org.apache.cxf.validation.ValidationConfiguration: CXF 打包程序类可让您覆盖验证供应商层中的更多类。

要自定义 BeanValidationProvider，请将自定义 BeanValidationProvider 实例传递到验证参与拦截器的构造器，并传递给验证传出拦截器的构造器。例如：

<bean id="validationProvider" class="org.apache.cxf.validation.BeanValidationProvider" />

<bean id="validationInInterceptor" class="org.apache.cxf.validation.BeanValidationInInterceptor">
    <property name="provider" ref="validationProvider" />
</bean>

<bean id="validationOutInterceptor" class="org.apache.cxf.validation.BeanValidationOutInterceptor">
    <property name="provider" ref="validationProvider" />
</bean>

65.3.2. JAX-RS 配置

概述

这部分论述了如何在 JAX-RS 服务端点中启用 bean 验证，该端点在 Blueprint XML 或 Spring XML 中定义。用于执行 bean 验证的拦截器在 JAX-WS 端点和 JAX-RS 1.1 端点(JAX-RS 2.0 端点)都很常见（但使用不同的拦截器类）。

命名空间

在本节所示的 XML 示例中，您必须记得将 jaxws 命名空间前缀映射到适当的命名空间，可以是 Blueprint 或 Spring，如下表中所示：

XML 语言	命名空间
蓝图（Blueprint）	`http://cxf.apache.org/blueprint/jaxws`
Spring	`http://cxf.apache.org/jaxws`

Bean 验证功能

在 JAX-RS 端点上启用 Bean 验证的最简单方式是将 bean 验证功能 添加到端点。Bean 验证功能由以下类实现：

org.apache.cxf.validation.BeanValidationFeature: 通过将此功能类的实例添加到 JAX-RS 端点（通过 Java API 或 XML 中的 jaxrs: features 子元素），您可以在端点上启用 bean 验证。此功能安装两个拦截器：一个拦截器验证传入的消息数据；以及验证返回值的 Out 拦截器（其中，拦截器会使用默认配置参数创建）。

验证异常映射程序

JAX-RS 端点还要求您配置 验证异常映射程序，它负责将验证异常映射到 HTTP 错误响应。以下类实施 JAX-RS 的验证异常映射：

org.apache.cxf.jaxrs.validation.ValidationExceptionMapper: 根据 JAX-RS 2.0 规范实施验证异常映射：任何输入参数验证违反情况都映射到 HTTP 状态代码 400 Bad Request ；以及任何返回值验证违反（或内部验证违反）都映射到 HTTP 状态代码 500 Internal Server Error。

JAX-RS 配置示例

以下 XML 示例演示了如何在 JAX-RS 端点中启用 bean 验证功能，方法是添加 commonValidationFeature bean 作为 JAX-RS 功能，通过将 exceptionMapper bean 添加为 JAX-RS 供应商：

<jaxrs:server address="/bwrest">
    <jaxrs:serviceBeans>
        <ref bean="bookWorldValidation"/>
    </jaxrs:serviceBeans>
    <jaxrs:providers>
        <ref bean="exceptionMapper"/>
    </jaxrs:providers>
    <jaxrs:features>
        <ref bean="commonValidationFeature" />
    </jaxrs:features>
</jaxrs:server>

<bean id="bookWorldValidation" class="org.apache.cxf.systest.jaxrs.validation.spring.BookWorldImpl"/>
<beanid="exceptionMapper"class="org.apache.cxf.jaxrs.validation.ValidationExceptionMapper"/>

<bean id="commonValidationFeature" class="org.apache.cxf.validation.BeanValidationFeature">
    <property name="provider" ref="beanValidationProvider"/>
</bean>

<bean id="beanValidationProvider" class="org.apache.cxf.validation.BeanValidationProvider">
    <constructor-arg ref="validationProviderResolver"/>
</bean>

<bean id="validationProviderResolver" class="org.example.HibernateValidationProviderResolver"/>

注意

根据具体情况，请记住将 jaxrs 前缀映射到蓝图或 Spring 的相应 XML 命名空间。

Common bean 验证 1.1 拦截器

您可以选择安装 bean 验证拦截器来获取对验证实施进行更精细的控制，而不是使用 bean 验证功能。JAX-RS 将与 JAX-WS 相同的拦截器用于此目的-请参阅 “Common bean 验证 1.1 拦截器”一节

带有 bean 验证拦截器的 JAX-RS 配置示例

以下 XML 示例演示了如何在 JAX-RS 端点中启用 bean 验证功能，方法是明确将相关的 In 拦截器 bean 和 Out 拦截器 bean 添加到服务器端点：

<jaxrs:server address="/">
    <jaxrs:inInterceptors>
        <ref bean="validationInInterceptor" />
    </jaxrs:inInterceptors>

    <jaxrs:outInterceptors>
        <ref bean="validationOutInterceptor" />
    </jaxrs:outInterceptors>

    <jaxrs:serviceBeans>
    ...
    </jaxrs:serviceBeans>

    <jaxrs:providers>
        <ref bean="exceptionMapper"/>
    </jaxrs:providers>
</jaxrs:server>

<bean id="exceptionMapper" class="org.apache.cxf.jaxrs.validation.ValidationExceptionMapper"/>

<bean id="validationInInterceptor" class="org.apache.cxf.validation.BeanValidationInInterceptor">
    <property name="provider" ref="beanValidationProvider" />
</bean>

<bean id="validationOutInterceptor" class="org.apache.cxf.validation.BeanValidationOutInterceptor">
    <property name="provider" ref="beanValidationProvider" />
</bean>

<bean id="beanValidationProvider" class="org.apache.cxf.validation.BeanValidationProvider">
    <constructor-arg ref="validationProviderResolver"/>
</bean>

<bean id="validationProviderResolver" class="org.example.HibernateValidationProviderResolver"/>

配置 BeanValidationProvider

您可以将自定义 BeanValidationProvider 实例注入验证拦截器，如 “配置 BeanValidationProvider”一节所述。

65.3.3. JAX-RS 2.0 配置

概述

与 JAX-RS 1.1 （使用 JAX-WS 共享常见验证拦截器）不同，JAX-RS 2.0 配置依赖于特定于 JAX-RS 2.0 的专用验证拦截器类。

Bean 验证功能

对于 JAX-RS 2.0，有一个专门的 bean 验证功能，它由以下类实施：

org.apache.cxf.validation.JAXRSBeanValidationFeature: 通过将此功能类的实例添加到 JAX-RS 端点（通过 Java API 或 XML 中的 jaxrs: features 子元素），您可以在 JAX-RS 2.0 服务器端点上启用 bean 验证。此功能安装两个拦截器：一个拦截器验证传入的消息数据；以及验证返回值的 Out 拦截器（其中，拦截器会使用默认配置参数创建）。

验证异常映射程序

JAX-RS 2.0 使用与 JAX-RS 1.x 相同的验证异常映射程序类：

org.apache.cxf.jaxrs.validation.ValidationExceptionMapper: 根据 JAX-RS 2.0 规范实施验证异常映射：任何输入参数验证违反情况都映射到 HTTP 状态代码 400 Bad Request ；以及任何返回值验证违反（或内部验证违反）都映射到 HTTP 状态代码 500 Internal Server Error。

Bean 验证调用器

如果您使用非默认生命周期策略（例如，使用 Spring 生命周期管理）配置 JAX-RS 服务，您还应注册 org.apache.cxf.jaxrs.validation.JAXRSBeanValidationInvoker 实例使用端点配置中的 jaxrs:invoker 元素，以确保正确调用了 bean 验证。

有关 JAX-RS 服务生命周期管理的更多详情，请参阅 “Spring XML 中的生命周期管理”一节。

带有 bean 验证功能的 JAX-RS 2.0 配置示例

以下 XML 示例演示了如何在 JAX-RS 2.0 端点中启用 bean 验证功能，方法是将 jaxrsValidationFeature bean 添加为 JAX-RS 功能，并通过将 exceptionMapper bean 添加为 JAX-RS 提供程序：

<jaxrs:server address="/">
    <jaxrs:serviceBeans>
    ...
    </jaxrs:serviceBeans>
    <jaxrs:providers>
        <ref bean="exceptionMapper"/>
    </jaxrs:providers>
    <jaxrs:features>
        <ref bean="jaxrsValidationFeature" />
    </jaxrs:features>
</jaxrs:server>

<bean id="exceptionMapper" class="org.apache.cxf.jaxrs.validation.ValidationExceptionMapper"/>
<bean id="jaxrsValidationFeature" class="org.apache.cxf.validation.JAXRSBeanValidationFeature">
    <property name="provider" ref="beanValidationProvider"/>
</bean>

<bean id="beanValidationProvider" class="org.apache.cxf.validation.BeanValidationProvider">
    <constructor-arg ref="validationProviderResolver"/>
</bean>

<bean id="validationProviderResolver" class="org.example.HibernateValidationProviderResolver"/>

注意

根据具体情况，请记住将 jaxrs 前缀映射到蓝图或 Spring 的相应 XML 命名空间。

Common bean 验证 1.1 拦截器

如果您想对 bean 验证的配置具有更精细的控制，您可以单独安装 JAX-RS 拦截器，而不使用 bean 验证功能。配置以下 JAX-RS 拦截器之一或两者：

org.apache.cxf.validation.JAXRSBeanValidationInInterceptor: 在 JAX-RS 2.0 服务器端点中安装时，根据验证限制验证资源方法参数。如果验证失败，则引发 javax.validation.ConstraintViolationException 异常。要安装此拦截器，请通过 XML 中的 jaxrs:inInterceptors 子元素将其添加到端点中。
org.apache.cxf.validation.JAXRSBeanValidationOutInterceptor: 在 JAX-RS 2.0 端点中安装时，根据验证限制验证响应值。如果验证失败，则引发 javax.validation.ConstraintViolationException 异常。要安装此拦截器，请通过 XML 中的 jaxrs:inInterceptors 子元素将其添加到端点中。

带有 bean 验证拦截器的 JAX-RS 2.0 配置示例

以下 XML 示例演示了如何在 JAX-RS 2.0 端点中启用 bean 验证功能，方法是明确将相关的 In 拦截器 bean 和 Out 拦截器 bean 添加到服务器端点：

<jaxrs:server address="/">
    <jaxrs:inInterceptors>
        <ref bean="validationInInterceptor" />
    </jaxrs:inInterceptors>

    <jaxrs:outInterceptors>
        <ref bean="validationOutInterceptor" />
    </jaxrs:outInterceptors>

    <jaxrs:serviceBeans>
    ...
    </jaxrs:serviceBeans>

    <jaxrs:providers>
        <ref bean="exceptionMapper"/>
    </jaxrs:providers>
</jaxrs:server>

<bean id="exceptionMapper" class="org.apache.cxf.jaxrs.validation.ValidationExceptionMapper"/>

<bean id="validationInInterceptor" class="org.apache.cxf.jaxrs.validation.JAXRSBeanValidationInInterceptor">
    <property name="provider" ref="beanValidationProvider" />
</bean>

<bean id="validationOutInterceptor" class="org.apache.cxf.jaxrs.validation.JAXRSBeanValidationOutInterceptor">
    <property name="provider" ref="beanValidationProvider" />
</bean>

<bean id="beanValidationProvider" class="org.apache.cxf.validation.BeanValidationProvider">
    <constructor-arg ref="validationProviderResolver"/>
</bean>

<bean id="validationProviderResolver" class="org.example.HibernateValidationProviderResolver"/>

配置 BeanValidationProvider

您可以将自定义 BeanValidationProvider 实例注入验证拦截器，如 “配置 BeanValidationProvider”一节所述。

配置 JAXRSParameterNameProvider

org.apache.cxf.jaxrs.validation.JAXRSParameterNameProvider 类是 javax.validation.ParameterNameProvider 接口的实现，可用于在 JAX-RS 2.0 端点的上下文中为方法和构造器参数提供名称。

法律通告

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Apache CXF 开发指南

使用 Apache CXF Web 服务开发应用程序

部分 I. 编写 WSDL 合同

第 1 章 WSDL 合同简介

1.1. WSDL 文档的结构

概述

逻辑部分

concrete 部分

1.2. WSDL 元素

1.3. 设计一个合同

第 2 章 定义逻辑数据单位

2.1. 逻辑数据单元简介

2.2. 将数据映射到逻辑数据单元

概述

用于定义服务单元的可用类型

XML Schema 作为类型系统

创建数据单元的注意事项

2.3. 在合同中添加数据单元

概述

流程

2.4. XML Schema 简单的类型

概述

输入简单类型

支持的 XSD 简单类型

2.5. 定义复杂数据类型

2.5.1. 定义数据结构

概述

复杂类型 varieties

定义结构的部分

定义属性

2.5.2. 定义数组

概述

复杂的类型数组

SOAP 阵列

2.5.3. 按扩展定义类型

2.5.4. 根据限制定义类型

概述

指定基本类型

定义限制

示例

2.5.5. 定义枚举类型

概述

在 XML Schema 中定义枚举

示例

2.6. 定义元素

第 3 章 定义服务使用的逻辑消息

概述

消息和参数列表

用于与旧系统集成的消息设计

SOAP 服务的消息设计

消息命名

Message parts

示例

第 4 章 定义逻辑接口

概述

Process

端口类型

操作

操作消息

返回值

示例

部分 II. Web 服务绑定

第 5 章 了解 WSDL 中的绑定

概述

端口类型和绑定

WSDL 元素

添加到合同

支持的绑定

第 6 章 使用 SOAP 1.1 消息

6.1. 添加 SOAP 1.1 绑定

使用 wsdl2soap

示例

6.2. 将 SOAP 标头添加到 SOAP 1.1 Binding 中

概述

语法

在正文和标头间分割消息

示例

第 7 章 使用 SOAP 1.2 消息

7.1. 在 WSDL 文档中添加 SOAP 1.2 绑定

使用 wsdl2soap

第 2 章定义逻辑数据单位

第 3 章定义服务使用的逻辑消息

第 4 章定义逻辑接口

第 5 章了解 WSDL 中的绑定

第 6 章使用 SOAP 1.1 消息

第 7 章使用 SOAP 1.2 消息

第 8 章使用带有附件的 SOAP 发送 Binary 数据

第 9 章使用 SOAP MTOM 发送二进制数据

第 10 章使用 XML 文档

第 11 章了解 WSDL 中的如何定义端点

第 12 章使用 HTTP