Java JAXB自定义输出格式：能否复用现有转换能力实现简洁输出？

JAXB核心定位是XML的序列化/反序列化，本身没有直接提供自定义文本格式的可插拔模板功能，但可以通过扩展JAXB的现有机制实现类似需求，避免编写对象包装器重写toString()：

1. 利用JAXB Marshaller Listener实现自定义输出 #

通过Marshaller.Listener的生命周期回调，结合JAXB的内省API获取对象属性，实现自定义格式输出。这种方式无需修改原对象代码，可灵活插入输出逻辑：

JAXBContext jaxbContext = JAXBContext.newInstance(Organization.class);
Marshaller marshaller = jaxbContext.createMarshaller();

marshaller.setListener(new Marshaller.Listener() {
    @Override
    public void beforeMarshal(Object source) {
        if (source instanceof Organization org) {
            StringBuilder sb = new StringBuilder();
            sb.append("Org ").append(org.getId()).append(":").append(org.getLegalName()).append("\n");
            if (org.getAddresses() != null && org.getAddresses().getAddress() != null) {
                List<String> addressIds = org.getAddresses().getAddress();
                sb.append("- Addresses ").append(addressIds.size()).append(": ")
                  .append(String.join(",", addressIds));
            }
            System.out.println(sb.toString());
        }
    }
});

// 执行marshal触发回调（无需实际保存XML输出）
marshaller.marshal(organization, new StringWriter());

2. 使用XmlAdapter实现类型转换式输出 #

通过XmlAdapter将Organization对象转换为目标格式的字符串，实现可插拔的序列化逻辑。若需同时支持XML和自定义格式，可动态切换适配器：

// 自定义格式适配器
public class OrganizationFormatAdapter extends XmlAdapter<String, Organization> {
    @Override
    public String marshal(Organization org) throws Exception {
        StringBuilder sb = new StringBuilder();
        sb.append("Org ").append(org.getId()).append(":").append(org.getLegalName()).append("\n");
        if (org.getAddresses() != null && org.getAddresses().getAddress() != null) {
            List<String> addressIds = org.getAddresses().getAddress();
            sb.append("- Addresses ").append(addressIds.size()).append(": ")
              .append(String.join(",", addressIds));
        }
        return sb.toString();
    }

    @Override
    public Organization unmarshal(String v) throws Exception {
        // 无需反序列化时可返回null或抛出异常
        return null;
    }
}

// 在Organization类上绑定适配器
@XmlJavaTypeAdapter(OrganizationFormatAdapter.class)
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Organization")
public class Organization implements Serializable {
    // 原有属性定义...
}

// 输出自定义格式
JAXBContext jaxbContext = JAXBContext.newInstance(Organization.class);
Marshaller marshaller = jaxbContext.createMarshaller();
StringWriter writer = new StringWriter();
marshaller.marshal(organization, writer);
System.out.println(writer.toString());

3. 基于JAXB元数据+模板引擎实现可插拔模板 #

利用JAXB的元数据API获取类与属性的映射信息，结合模板引擎（如Freemarker、Velocity）实现完全可插拔的模板输出，模板可单独维护，无需修改Java代码：

// 获取JAXB元数据
JAXBContext jaxbContext = JAXBContext.newInstance(Organization.class);
ClassInfo orgClassInfo = jaxbContext.getRuntimeInfo().getClassInfo(Organization.class);

// 基于元数据提取对象属性值
Map<String, Object> data = new HashMap<>();
data.put("id", orgClassInfo.getProperty("id").getValue(organization));
data.put("name", orgClassInfo.getProperty("legalName").getValue(organization));
Addresses addresses = (Addresses) orgClassInfo.getProperty("addresses").getValue(organization);
if (addresses != null) {
    List<String> addressList = addresses.getAddress();
    data.put("addressCount", addressList.size());
    data.put("addressIds", String.join(",", addressList));
}

// 使用Freemarker模板渲染输出
Configuration cfg = new Configuration(Configuration.VERSION_2_3_32);
cfg.setClassForTemplateLoading(Organization.class, "/templates");
Template template = cfg.getTemplate("org-format.ftl");

StringWriter writer = new StringWriter();
template.process(data, writer);
System.out.println(writer.toString());

对应的Freemarker模板org-format.ftl内容：

Org ${id}:${name}
- Addresses ${addressCount}: ${addressIds}

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