JAXB –新手的观点，第1部分

我知道你们很多人已经在想什么了，所以让我们摆脱它：“ JAXB？如XML？来吧，所有很棒的孩子都在使用JSON。”

关于XML与JSON的争论以及许多促成它的论据都已被很好地记录在案。我不会花很多时间在这里重新整理它们。我相信每种格式都有其用途，但是即使您处在“从未有过XML”阵营中，您仍然可能想继续阅读，因为我讨论的观察和技术应该同样适用于与Jackson进行JSON数据绑定（或类似工具）。

在第1部分中，我描述了一种简单的使用模式，该模式将JAXB的数据绑定功能与JPA配对。当然，两者之间的交互并不总是那么简单，因此在第2部分中，我将研究如何解决可能遇到的一些复杂问题。

问题

在我当前的项目中，我们正在构建一套Java应用程序，以管理制造过程中物料的转移。我们决定“从外而内”构建，以在任何给定的迭代之后促进面向用户的演示。因此，在第一个迭代中，我们使用硬编码的虚拟数据构建了一些屏幕。然后，在每次后续迭代中，我们都会在屏幕后面添加更多基础架构和逻辑。

为了使早期的演示更具交互性，我们决定为中央应用程序创建一个“测试控制台”。一个人在控制台上键入命令可以模拟系统“已实现网络”部分的行为。借助Antlr 4之类的工具可以简化命令解析，构建控制台的成本是适中的，并且我们认为使用控制台进行测试和诊断具有长期价值。

我们已经达到了需要由另一个应用程序的数据来驱动系统行为的地步。负责创建和维护此数据的“其他应用”尚未编写，并且不会使用一段时间，因此我们需要一种通过控制台加载示例数据的方法。

选件

本质上，我们的任务是构建（或利用）数据加载器。我们选择XML作为文件的可能格式，然后浏览我们的团队通常会熟悉的工具列表。

DBUnit具有数据加载功能（旨在设置可重复的测试条件）。它支持两种不同的XML模式（“平面”和“完整”），每种模式显然都是面向表的。它还提供了替换变量，因此我们可以构建模板文件并允许控制台输入设置最终值。

我对以这种方式使用单元测试工具有些保留，但是在团队的箭袋中，箭头可能是最合适的。不管是好是坏，我第一次尝试使用它都没有成功（结果是我看的是DBUnit API的错误部分），这使我想出了一些新的思路。

我们已经有一种方法（即Hibernate）将数据推送到我们的数据库中。因此，当我用“如何从XML文档创建实体实例”来表述问题时，JAXB显然是竞争者。我很高兴发现Java附带了JAXB实现，因此我开始尝试一下。

新人的观点

从未使用过JAXB，所以我开始进行一些研究。我发现的许多材料都涉及从XML模式生成Java类。这不足为奇-这是该工具可以完成的大部分工作-但就我而言，我想将数据绑定到现有的Hibernate映射域类。这导致可能会更加令人惊讶：我发现一些最全面的教程似乎并没有预料到这种用法。我认为这很好地说明了您对工具的初步假设可以影响您的想法和使用方式。

如果像几个在线资源一样，首先将JAXB与DOM进行比较，那么将编组操作的输出视为需要遍历和处理的文档树是很自然的，也许会将相关数据复制到并行的层次结构中。域对象。遍历和处理（至少在概念上）可能比使用DOM树要容易（但从概念上来说），但是要权衡，您必须保持两个类的层次结构直，这需要谨慎的命名约定。

毫无疑问，用例恰恰是必要的，但该工具不仅限于这种方法。如果您相反地比较JAXB和Hibernate（作为将数据从外部源加载到您的域对象中的一种方式），那么自然会问“为什么我不能同时使用一组域对象？” 您至少可以在某些时候稍加注意。

简单案例

在这些示例中，我将直接使用JAXB API。我们只需拨打几个简单的电话即可完成我们的任务，因此这相当简单。值得注意的是，Spring确实也提供JAXB集成，尤其是如果您在整个应用程序中都使用Spring，则它提供的配置方法可能是更可取的。

假设您有一个EMPLOYEE表。每个员工都有唯一的数字ID和名称。如果将注释用于ORM映射数据，则可能具有如下域类：

@Entity
@Table(name=”EMPLOYEE”)
public class Employee {@Id@Column(name=”EMPLOYEE_ID”)private Integer employeeId;@Column(name=”FIRST_NAME”)private String firstName;@Column(name=”LAST_NAME”)private String lastName;// … getters and setters …
};

现在，我们要让用户提供一个Employee.xml数据文件。假设我们没有需要遵循的特定XML模式，那么我们不妨看看JAXB对类的默认处理是什么。因此，我们将从最小的步骤开始，以将一个Employee实例“封送”到XML文档中。如果对结果文档的外观感到满意，我们将交换解组代码；如果没有，我们可以考虑自定义映射。

首先，我们需要配置一个JAXBContext实例以与我们的域类一起使用。

JAXBContext jaxb = JAXBContext.newInstance(Employee.class);

顺便说一句，我们可以传入包含类的包的名称，而不是将类对象传递给newInstance（），只要每个包都包含一个jaxb.index文件，该文件列出了要使用的类或ObjectFactory类，以及用于创建域类（和/或包装它们的JAXBElements）实例的方法。如果您需要大量不相关的域类的XML映射，则此方法可能更可取。

JAXBContext具有创建编组器（创建表示对象的XML文档）和解组器（实例化对象并从XML文档中的数据初始化它们）的方法。我们可以像这样检查Employee类的默认映射：

Employee employee = new Employee();employee.setEmployeeId(37);employee.setFirstName(“Dave”);employee.setLastName(“Lister”);Marshaller marshaller = jaxb.createMarshaller();marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
marshaller.marshal(employee, System.out);

（严格来说，setProperty（）调用不是必需的，但会使输出更易于理解。）如果尝试运行此代码，则会收到异常消息，告诉我们尚未识别出根元素。为了解决这个问题，我们将@XmlRootElement批注添加到Employee类中。

@XmlRootElement
@Entity
@Table(name=”EMPLOYEE”)
public class Employee {@Id@Column(name=”EMPLOYEE_ID”)private Integer employeeId;@Column(name=”FIRST_NAME”)private String firstName;@Column(name=”LAST_NAME”)private String lastName;// … getters and setters …
};

默认情况下，编组器将映射每个公共bean属性（getter / setter对）和每个公共字段。因此，如果我们的Employee类具有您期望的getter和setter，那么我们的输出应类似于以下内容：

<?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?>
<employee><employeeId>37</employeeId><firstName>Dave</firstName><lastName>Lister</lastName>
</employee>

请注意，下面的元素将采用任意顺序。（在我的测试中，这是按字母顺序排列的。）在这种情况下，效果很好，但是如果没有，我们可以使用@XmlType注释强制执行该顺序。默认情况下，解组器将以任何顺序获取元素。

JAXB很高兴不了解JPA批注，而Hibernate（或您可能使用的任何JPA提供程序）将不理会JAXB批注，因此，我们现在可以通过简单地要求JAXB从文件中解组数据来将XML文件中的数据加载到数据库中，将结果对象传递给JPA提供程序。解组代码如下所示：

JAXBContext jaxb = JAXBContext.newInstance(Employee.class);
Unmarshaller unmarshaller = jaxb.createUnmarshaller();
File xmlFile = /* … */;
Employee employee = unmarshaller.unmarshal(xmlFile);

默认情况下，如果从XML中省略了表示bean属性之一的元素，则不会设置该属性。因此，例如，如果我们的JPA映射包括自动生成employeeId，则<employee>元素仅需要包含<firstName>和<lastName>。