#710: ProxyIdRefMarshaller.java

Architecture

Class Hierarchy

TreeMarshaller
  └── AbstractReferenceMarshaller       (adds object reference tracking)
       ├── ReferenceByXPathMarshaller   (#707 — XPath-based references)
       └── ReferenceByIdMarshaller      (ID/IDREF-based references)
            └── ProxyIdRefMarshaller    (this class — adds proxy stripping + CGLIB handling)

Fields

Constructors

Two constructor overloads:

1. Full constructor: Accepts HierarchicalStreamWriter, ConverterLookup, Mapper, and IDGenerator. Allows custom ID generation strategies.
2. Convenience constructor: Omits the IDGenerator parameter and defaults to SequenceGenerator(1) — produces sequential numeric IDs starting at 1.

convertAnother(Object item) — Core Algorithm

This is the overridden method where all proxy handling and reference tracking happens. It replaces XStream's default convertAnother() with proxy-aware logic:

1. CGLIB Enhancer stripping (lines ~56-59):

   Class<?> targetClass = item.getClass();
   while (Enhancer.isEnhanced(targetClass)) {
       targetClass = targetClass.getSuperclass();
   }

   Walks up the superclass chain stripping Spring CGLIB proxies (created by @Transactional, @Cacheable, etc.). Enhancer.isEnhanced() returns true for CGLIB-generated subclasses. This is done before converter lookup so the correct entity converter is selected.
2. Converter lookup (line ~61):

   Converter converter = converterLookup.lookupConverterForType(targetClass);

   Finds the appropriate XStream converter for the real (un-proxied) entity class.
3. Hibernate proxy unwrapping (line ~62):

   Object realItem = HibernateProxyHelper.get(item);

   Uses HibernateProxyHelper to unwrap Hibernate lazy-loading proxies. After this step, realItem is the actual entity instance with no proxy wrappers.
4. Immutable value type fast path (lines ~64-66):

   if (classMapper.isImmutableValueType(realItem.getClass())) {
       converter.marshal(item, writer, this);
   }

   Strings, integers, dates, enums, and other immutable types are marshalled directly without ID tracking. This avoids polluting the reference dictionary with values that can never form circular references.
5. Duplicate reference detection (lines ~67-70):

   Object idOfExistingReference = references.lookupId(realItem);
   if (idOfExistingReference != null) {
       writer.addAttribute("reference", idOfExistingReference.toString());
       return;
   }

   Checks the ObjectIdDictionary to see if realItem has already been serialized. If so, writes a reference attribute (e.g., reference="3") pointing to the earlier serialization by its generated ID. This is the mechanism that prevents infinite recursion in bidirectional associations — when XStream traverses back to a parent from a child, it finds the parent already in the dictionary and emits a reference instead of re-serializing.
6. First-time serialization (lines ~71-81):

   String newId = idGenerator.next(realItem);
   writer.addAttribute("id", newId);
   references.associateId(realItem, newId);
   converter.marshal(realItem, writer, this);

   Generates a new unique ID, stores it in the reference dictionary, writes it as an id attribute on the XML element, then delegates to the converter for full serialization. The item is now registered so future encounters will hit step 5.

ObjectIdDictionary

XStream's ObjectIdDictionary is an identity-based map (uses System.identityHashCode() and == comparison, not .equals()). This is critical because JPA entities often implement equals() based on database ID, which may be null for transient entities. Identity-based tracking ensures each object instance is tracked uniquely regardless of its equals() implementation.

Integration Points

• Created by: The ProxyIdRefMarshallingStrategy, which overrides createMarshallingContext() to instantiate this marshaller instead of the default ReferenceByIdMarshaller.
• Alternative to: HibernateProxyXPathMarshaller — this uses ID/IDREF attributes while the other uses XPath expressions. Both are valid approaches; the choice depends on which MarshallingStrategy is configured.
• Depends on: HibernateProxyHelper for Hibernate proxy unwrapping. Uses Spring Framework's Enhancer for CGLIB proxy detection (compile dependency on spring-core).

Design Decisions & Gotchas

• Spring CGLIB dependency: The import of org.springframework.cglib.proxy.Enhancer creates a hard dependency on Spring Framework, which is acceptable since ProjectForge is a Spring application. However, this class would not work outside a Spring context without modification.
• Immutable fast path: The classMapper.isImmutableValueType() check is an important optimization. Without it, every string literal, integer, and date in the entity graph would be assigned an ID and added to the reference dictionary, massively bloating memory usage and XML output.
• Debug logging: The SLF4J debug statement logs each marshalled object class. In production, this should be at TRACE level to avoid log spam during large entity graph exports.
• ID collision potential: SequenceGenerator(1) produces IDs within a single marshalling context. If two separate ProxyIdRefMarshaller instances serialize different object graphs within the same XML document (unlikely but theoretically possible with XStream's MarshallingContext nesting), IDs could collide. This is not a practical concern because each marshalling context uses its own marshaller instance.
• classMapper shadowing: Both this class and the superclass have a mapper field. The two-argument constructor sets this.classMapper but the three-argument constructor sets both. The code consistently uses this.classMapper for the locally stored reference, avoiding confusion with the inherited field.

Git History

868d6abb7 2025 -> 2026
63081666f Source file headers: 2024-> 2025.
b6092df09 Copyright 2023 -> 2024
ab45d51fa Copyright 2001-2022 -> 2001-2023.
5f7ef41b8 Copyright 2021 -> 2022
ceb63e8a1 Source code header: (C) 2001-2021.
7c79f1922 Copyright of source header -> 2020.
32f634b88 Optimize imports
000ca723d Remove pointless boolean expressions (business)
dd5ca38ac CopyRight of all java file-header updated or created.
a954d7f7d Changes from Java 9 branch
a5bbdca6a Change logger to slf4j
9ebb88522 Initial commit