如何在不改变模型的情况下向Jersey/Moxy/jaxbxml添加结构链接

Question

我指的是HATEOAS/超媒体应用编程接口意义上的“结构链接”。更一般的问题是如何使用既依赖于被封送的实体，又依赖于环境（在本例中，至少是绝对URL）的数据来扩充生成的XML。

我正在使用与Moxy 2.5一起使用的泽西2.9作为JAXB提供程序。

根据该模型：

package testing;

import java.util.ArrayList;
import java.util.List;

public class Planet {

    private int id = 1;
    private String name = "test";
    private double radius = 3.0;
    private String href;

    private List<Moon> moons = new ArrayList<Moon>(0);

    public void addMoon(Moon moon) {
        moons.add(moon);
    }
}

...plus Moon class

我想得到这样的XML（以及等效的JSON）：

<planet href="http://mytestserver/rest/planets/test">
    <name>test</name>
    <radius>3.0</radius>
    <moons>
        <moon href="http://mytestserver/rest/moons/moon1">
            <name>moon1</name>
        </moon>
        <moon href="http://mytestserver/rest/moons/moon2">
            <name>moon2</name>
        </moon>
    </moons>
</planet>

模型没有“href”字段，也不能添加一个。理想情况下，我可以使用UriBuilder直接从资源类中抓取这些路径。

到目前为止，我已经提出了几种可能性。我能要求你考虑哪一个（如果有的话）有最多的腿，然后你怎么处理这个方法的缺点呢？

然后使用Jersey中现有的声明性链接机制，所有这些机制都依赖于模型中有一个字段来接收生成的链接。如果在构建过程中没有AspectJ和/或对字节码操纵等外来技术犹豫不决，那么这显然是行不通的。

例如，在MessageBodyWriter中：

ContextResolver<JAXBContext> resolver = providers.getContextResolver(JAXBContext.class, mediaType);
JAXBContext context = resolver.getContext(type);
Marshaller m = context.createMarshaller();
<--- here, marshall to e.g. a DOM then transform that
<--- then manipulate the JSON structures

我完全不知道如何做到这一点，因此缺少代码。可能还有其他方法可以钩住XML生成过程，但据我所知，Jersey或JAXB的事件处理程序或拦截器实际上都不允许您操作生成的XML/JSON。

例如：

XML binding:
<java-type name="Planet" xml-customizer="testing.HrefCustomizer">

Customizer:
public class HrefCustomizer implements DescriptorCustomizer {

    @Override
    public void customize(ClassDescriptor descriptor) throws Exception {
        XMLTransformationMapping xtm = new XMLTransformationMapping();
        xtm.addFieldTransformer("@href", new HrefWriter());

        descriptor.addMapping(xtm);

    }

}

Transformer:
public class HrefWriter implements FieldTransformer {

    @Override
    public Object buildFieldValue(Object instance, String fieldName,
            Session session) {
        return "href";  // constant value just for proof-of-concept
    }

    @Override
    public void initialize(AbstractTransformationMapping mapping) {
        // TODO Auto-generated method stub

    }

}

这种方法有两个问题：

1. 很难找到关于它的任何文档，我想知道它是否实际上是不受支持的用法

如果我们决定不能在实例化时为变压器提供任何有意义的上下文，定制程序将不会增加任何值，我们可以将上面的内容简化为以下内容：

    <java-type name="Planet">
        <xml-root-element/>            
        <java-attributes>
            <xml-transformation java-attribute="name">
                <xml-write-transformer transformer-class="testing.HrefWriter" xml-path="@href"/>
            </xml-transformation>
            <xml-element java-attribute="name"/>

有点奇怪的是，我们将变压器挂在另一个字段上（本例中为“名称”）。

或者，我完全找错人了。救命啊！！

Answer 1

• 使用AbulJ向模型类添加一个字段（在本例中称为href）
• 将泽西@InjectLink注释添加到该字段
• 然后，泽西将使用资源类定义的正确URL填充字段
• 使用外部映射文件指定href字段的封送处理。

您还可以通过相同的AspectJ类型间声明机制向href添加JAXB注释来指定href的封送。

这些是信息量最大的部分。看见http://lagod.id.au/blog/?p=494完整的例子。

package testing;

import org.glassfish.jersey.linking.InjectLink;
import org.glassfish.jersey.linking.Binding;

public aspect HrefInjector {

    private String Planet.href;
    declare @field : * Planet.href : @InjectLink(
                                        resource=Services.class, 
                                        style=InjectLink.Style.ABSOLUTE
                                    ) ;

    private String Moon.href;
    declare @field : * Moon.href : @InjectLink(
                                        resource=Services.class,
                                        method="moon",
                                        bindings={@Binding(
                                                name="moonid", value="${instance.name}"
                                                )},
                                        style=InjectLink.Style.ABSOLUTE
                                    ) ;

}

不含其他特定积垢的POJO。请参见Jersey Moxy JAXB-如何封送不带注释的XML。

package testing;

import java.util.ArrayList;
import java.util.List;

public class Planet {

    private int id = 1;
    private String name = "test";
    private double radius = 3.0;

    private List<Moon> moons = new ArrayList<Moon>(0);

    public void addMoon(Moon moon) {
        moons.add(moon);
    }
}


package testing;

public class Moon {

    private String name;

    // No-arg constructor is a requirement of JAXB
    public Moon() {
    }

    public Moon(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

}

这是一个标准的JAX-RS资源类。出于演示目的，我们只是返回新实例化的模型实例。

package testing;

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;

@Path("/services")
@Produces({MediaType.APPLICATION_XML,MediaType.APPLICATION_JSON})
public class Services {

    private Planet initPlanet() {
        Planet p = new Planet();
        p.addMoon(new Moon("moon1"));
        p.addMoon(new Moon("moon2"));
        return p;
    }

    @GET
    public Planet planet () {
        return initPlanet();
    }

    @GET @Path("/moons/{moonid}")
    public Moon moon (@PathParam("moonid") String name) {
        return new Moon(name);
    }

}

请注意，您可以为任何给定类型选择是否实际封送href字段。事实上，通过使用多个映射文件，您可以在某些表示中包含href字段，而不在其他表示中包含href字段。

<?xml version="1.0"?>
<xml-bindings
    xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm"
    package-name="testing"
    xml-mapping-metadata-complete="true"
    xml-accessor-type="NONE">
    <java-types>
        <java-type name="Planet">
            <xml-root-element/>
            <java-attributes>
                <xml-attribute java-attribute="href"/>
                <xml-element java-attribute="name"/>
                <xml-element java-attribute="radius"/>
                <xml-element java-attribute="moons" name="moon">
                    <xml-element-wrapper name="moons"/>
                </xml-element>    
            </java-attributes>
        </java-type>
        <java-type name="Moon">
            <xml-root-element/>
            <java-attributes>
                <xml-attribute java-attribute="href"/>
                <xml-element java-attribute="name"/>
            </java-attributes>
        </java-type>
    </java-types>
</xml-bindings>

Ta-dah！自动从JAX-RS资源类派生的结构链接，而无需更改模型源代码。因为我们使用Moxy，所以我们也可以免费获得JSON。

<planet href="http://localhost:8080/reststructlinks/rest/services">
    <name>test</name>
    <radius>3.0</radius>
    <moons>
        <moon href="http://localhost:8080/reststructlinks/rest/services/moons/moon1">
            <name>moon1</name>
        </moon>
        <moon href="http://localhost:8080/reststructlinks/rest/services/moons/moon2">
            <name>moon2</name>
        </moon>
    </moons>
</planet>