如何通过JAXB注解为UserDTO生成适配XSL的fo:root结构XML

问题根源 #

Apache FOP要求fo:root必须包含必填子元素：fo:layout-master-set（定义页面布局规则）和至少一个fo:page-sequence（承载页面内容）。你的UserDTO仅标注了@XmlRootElement(name="fo:root")，没有映射这些必填子节点，导致FOP验证时抛出ValidationException。

解决方案：构建完整的JAXB类结构 #

需要为UserDTO及相关子元素添加JAXB注解，严格匹配XSL-FO的fo:root层级结构，同时正确声明XSL-FO命名空间。

1. 统一声明XSL-FO命名空间

在包级别创建package-info.java，避免每个类重复写命名空间配置：

@XmlSchema(
    namespace = "http://www.w3.org/1999/XSL/Format",
    elementFormDefault = XmlNsForm.QUALIFIED
)
package com.your.package;

import javax.xml.bind.annotation.XmlNsForm;
import javax.xml.bind.annotation.XmlSchema;

2. 定义UserDTO类（对应fo:root）

import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import java.util.List;

@XmlRootElement(name = "root")
@XmlAccessorType(XmlAccessType.FIELD)
public class UserDTO {

    // 对应fo:layout-master-set，必填
    @XmlElement(name = "layout-master-set")
    private LayoutMasterSet layoutMasterSet;

    // 对应多个fo:page-sequence，至少需要一个
    @XmlElement(name = "page-sequence")
    private List<PageSequence> pageSequences;

    // 构造器、Getter/Setter 省略
}

3. 定义子元素类

LayoutMasterSet（对应fo:layout-master-set）

import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;

@XmlAccessorType(XmlAccessType.FIELD)
public class LayoutMasterSet {
    @XmlElement(name = "simple-page-master")
    private SimplePageMaster simplePageMaster;

    // Getter/Setter 省略
}

SimplePageMaster（对应fo:simple-page-master）

import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;

@XmlAccessorType(XmlAccessType.FIELD)
public class SimplePageMaster {
    @XmlAttribute(name = "master-name")
    private String masterName;

    @XmlAttribute(name = "page-width")
    private String pageWidth = "210mm";

    @XmlAttribute(name = "page-height")
    private String pageHeight = "297mm";

    @XmlElement(name = "region-body")
    private RegionBody regionBody;

    // Getter/Setter 省略
}

RegionBody（对应fo:region-body）

import javax.xml.bind.annotation.XmlAccessorType;

@XmlAccessorType(XmlAccessType.FIELD)
public class RegionBody {
    // 可添加margin等区域属性，按需扩展
    // Getter/Setter 省略
}

PageSequence（对应fo:page-sequence）

import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;

@XmlAccessorType(XmlAccessType.FIELD)
public class PageSequence {
    @XmlAttribute(name = "master-reference")
    private String masterReference;

    @XmlElement(name = "flow")
    private Flow flow;

    // Getter/Setter 省略
}

Flow & Block（对应fo:flow、fo:block）

import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import java.util.List;

@XmlAccessorType(XmlAccessType.FIELD)
public class Flow {
    @XmlAttribute(name = "flow-name")
    private String flowName = "xsl-region-body";

    @XmlElement(name = "block")
    private List<Block> blocks;

    // Getter/Setter 省略
}

@XmlAccessorType(XmlAccessType.FIELD)
public class Block {
    @XmlValue
    private String content;

    @XmlAttribute(name = "font-size")
    private String fontSize = "12pt";

    // Getter/Setter 省略
}

关键注意事项 #

• 命名空间必须正确：XSL-FO的标准命名空间是http://www.w3.org/1999/XSL/Format，elementFormDefault=QUALIFIED确保所有子元素自动带上该命名空间前缀，符合FOP的验证要求。
• 标签名严格匹配：JAXB的@XmlElement(name)要完全对应XSL-FO的标签名（比如layout-master-set，不能用驼峰命名）。
• 必填元素不能缺：fo:root必须包含layout-master-set和至少一个page-sequence，否则FOP会直接抛出验证异常。

测试生成XML #

通过JAXB Marshaller生成的XML会符合FOP要求的结构，示例输出：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root xmlns="http://www.w3.org/1999/XSL/Format">
    <layout-master-set>
        <simple-page-master master-name="A4" page-width="210mm" page-height="297mm">
            <region-body/>
        </simple-page-master>
    </layout-master-set>
    <page-sequence master-reference="A4">
        <flow flow-name="xsl-region-body">
            <block font-size="12pt">Welcome to Apache FOP!</block>
        </flow>
    </page-sequence>
</root>

内容的提问来源于stack exchange，提问作者Sanjay Naik