JAX-RS：从声明抽象返回类型的方法返回具体类实例

Question

我有一些使用JAX-RS和Jackson的REST服务。我的客户希望抽象类作为服务的返回类型，我不知道如何让JAX-RS客户端返回具体子类的实例。这是可能的XML和JSON表示？如果是这样，将欣赏样本和/或链接。

Answer 1

有几种方法可以实现这一点。最简单的方法是使用@JsonTypeInfo,as Garry mentioned。你所要做的就是用@JsonTypeInfo(use = Id.CLASS, include = As.PROPERTY)注释你的抽象基类，你应该很好走。

另一种方法是确保服务器端和客户端上的所有映射器都启用（可能为NON_FINAL）default typing，以便在未注释的类上对（类型）信息进行序列化。如果您对开箱即用的序列化功能不满意，可以通过提供自己的TypeResolverBuilder来加强这两种方式。这些方法的更详细的解释可以在in this article或Jackson's Polymorphic Type Handling wiki page找到。

尽管@JsonTypeInfo的方式很简单，但实际上获得CXF服务器/客户端可能是一件苦差事。所以这里有一个完整的例子：

import com.fasterxml.jackson.annotation.JsonTypeInfo; 
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider; 
import com.fasterxml.jackson.jaxrs.xml.JacksonJaxbXMLProvider; 
import org.apache.cxf.endpoint.Server; 
import org.apache.cxf.jaxrs.JAXRSServerFactoryBean; 
import org.apache.cxf.jaxrs.client.JAXRSClientFactoryBean; 

import javax.ws.rs.GET; 
import javax.ws.rs.Path; 
import javax.ws.rs.Produces; 
import java.util.Arrays; 
import java.util.Collections; 
import java.util.Random; 

import static javax.ws.rs.core.MediaType.APPLICATION_JSON; 
import static javax.ws.rs.core.MediaType.APPLICATION_XML; 

public class FullCxfJaxrsJacksonExample { 
    public static void main(String[] args) { 
     String serverAddress = "http://localhost:9000/"; 
     Server server = null; 

     try { 
      // make server that supports JSON and XML 
      JAXRSServerFactoryBean serverFactory = new JAXRSServerFactoryBean(); 
      serverFactory.setResourceClasses(ShapeServiceRandom.class); 
      serverFactory.setAddress(serverAddress); 
      serverFactory.setProviders(Arrays.asList(new JacksonJaxbJsonProvider(), new JacksonJaxbXMLProvider())); 
      server = serverFactory.create(); 

      // make and use a client 
      JAXRSClientFactoryBean clientFactory = new JAXRSClientFactoryBean(); 
      clientFactory.setAddress(serverAddress); 
      clientFactory.setServiceClass(ShapeService.class); 
      clientFactory.setProvider(new JacksonJaxbJsonProvider()); 
      clientFactory.setHeaders(Collections.singletonMap("Accept", "application/json")); 
      // for an XML client instead of a JSON client, use the following provider/headers instead: 
      //clientFactory.setProvider(new JacksonJaxbXMLProvider()); 
      //clientFactory.setHeaders(Collections.singletonMap("Accept", "application/xml")); 

      ShapeService shapeServiceClient = clientFactory.create(ShapeService.class); 
      for (int i = 0; i < 10; i++) { 
       System.out.format("created shape: %s\n", shapeServiceClient.create()); 
      } 

     } finally { 
      if (server != null) { 
       server.destroy(); 
      } 
     } 
     System.exit(0); 
    } 

    // Put JsonTypeInfo on the abstract base class so class info gets marshalled. 
    // You'll want CLASS instead of MINIMAL_CLASS if your base class and subclasses are in different packages. 
    @JsonTypeInfo(use = JsonTypeInfo.Id.MINIMAL_CLASS, include = JsonTypeInfo.As.PROPERTY) 
    public abstract static class Shape { 
    } 

    public static class Circle extends Shape { 
     public double radius; 

     @Override 
     public String toString() { 
      return "Circle{radius=" + radius + '}'; 
     } 
    } 

    public static class Polygon extends Shape { 
     public int numSides; 

     @Override 
     public String toString() { 
      return "Polygon{numSides=" + numSides + '}'; 
     } 
    } 

    // service definition with abstract return type 
    @Path("/shape") 
    public interface ShapeService { 
     @GET 
     @Path("/create") 
     @Produces({APPLICATION_JSON, APPLICATION_XML}) 
     Shape create(); 
    } 

    // service implementation that returns different concrete subclasses 
    public static class ShapeServiceRandom implements ShapeService { 
     Random random = new Random(); 

     public Shape create() { 
      int num = random.nextInt(8); 
      if (num > 3) { 
       Polygon polygon = new Polygon(); 
       polygon.numSides = num; 
       return polygon; 
      } else { 
       Circle circle = new Circle(); 
       circle.radius = num + 0.5; 
       return circle; 
      } 
     } 
    } 
} 

这个例子使用的是JDK 1.8.0_45成功进行了测试和下面的依赖关系：

<dependency> 
     <groupId>com.fasterxml.jackson.jaxrs</groupId> 
     <artifactId>jackson-jaxrs-json-provider</artifactId> 
     <version>2.5.4</version> 
    </dependency> 
    <dependency> 
     <groupId>com.fasterxml.jackson.jaxrs</groupId> 
     <artifactId>jackson-jaxrs-xml-provider</artifactId> 
     <version>2.5.4</version> 
    </dependency> 
    <dependency> 
     <groupId>org.apache.cxf</groupId> 
     <artifactId>cxf-rt-transports-http-jetty</artifactId> 
     <version>3.1.1</version> 
    </dependency> 
    <dependency> 
     <groupId>org.apache.cxf</groupId> 
     <artifactId>cxf-rt-rs-client</artifactId> 
     <version>3.1.1</version> 
    </dependency> 

Answer 2

你可以尝试添加JsonTypeInfo和JsonSubTypes注释

@JsonTypeInfo(use = Id.CLASS, 
       include = JsonTypeInfo.As.PROPERTY, 
       property = "type") 
@JsonSubTypes({ 
    @Type(value = MySubClass.class) 
    }) 
public abstract class MyAbsClass { 
.... 
} 
public class MySubClass extends MyAbsClass { 
.... 
} 

它应该增加的类型信息，以JSON输出。

Answer 3

如果您只想返回一个任意具体实例，那么在使用基于Jackson的提供程序时，这个“正常工作”。这是JSON的默认值DropWizard。可能发生的唯一问题是使用plain Jersey和基于JAXB的提供程序，这可能会限制序列化为抽象类型公开的API。

如果您还需要能够将客户端反序列化为具体类型，则需要使用@JsonTypeInfo。