如何在JAX-RS上返回不带父标记的JSON?

时间:2019-04-25 12:56:01

标签: java json jax-rs liferay

我正在尝试为Liferay创建REST API模块,但是在尝试从我的Web服务生成JSON响应时遇到了问题。

我想生成一个像这样的简单JSON:

{
    "status": "ok",
    "message": "News not found for ID: 5"
}

但是,相反,这就是我得到的:

{
    "parentResponse": {
        "status": "ok",
        "message": "News not found for ID: 5"
    }
}

这是我的POJO课:

@XmlRootElement
public class ParentResponse {

    public String status, message;
    public Object item;

    public ParentResponse() {

    }

    public ParentResponse(String status, String message, Object item) {
        this.status = status;
        this.message = message;
        this.item = item;
    }   
}

我的返回json的Web服务:

// return a single news based on supplied ID
    @GET
    @Path("{id}")
    @Produces("application/json")
    public Response getNewsById(@PathParam("id") String id) {
        ResponseBuilder builder;
        try {
            News news = findById(new Long(id));
            if (news != null) {
                builder = Response.ok(news);
            } 
            else { // This is my POJO class returned as a JSON
                ParentResponse parentResponse = new ParentResponse("ok", "News not found for ID: " + id, null);

                builder = Response.status(Response.Status.NOT_FOUND).entity(parentResponse);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return builder.build();
    }

那么,如何获得不带根标签的JSON?我尝试在@XmlRootElement批注旁边添加(name =“”),但这无效。

2 个答案:

答案 0 :(得分:0)

我建议您使用jackson provider来编组/解组json输入/输出(就像我在对帖子的评论中所做的那样):

compile "com.fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider:2.9.0" 
compile "com.fasterxml.jackson.core:jackson-annotations:2.9.0"

您的模型应如下所示:

@JsonInclude(JsonInclude.Include.NON_EMPTY) 
public class ParentResponse { 

  @JsonProperty("message") 
  public String message; 

  @JsonProperty("status") 
  public String status; 

//... 

}

如果您使用Liferay 7,我还建议通过创建调用服务端点(Response getNewsById(@PathParam("id") String id))的服务来利用OSGi。当您的OSGi服务启动时,它应该设置杰克逊提供者并设置Web服务端点url ...以及通常用于初始化服务的其他任何内容。


@Component(immediate = false)
public class WonderfulOsgiService{

    private MyWebService myWebService;

    public Response getNews( String id) {
        return myWebService.getNewsById(id);
    }


    @Activate
    @Modified
    private void activate(Map<String, Object> config) {
        // Creates jackson provider for marshalling/unmarshalling json
        ObjectMapper myMapper = new ObjectMapper();
        myMapper.enable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE);
        JacksonJsonProvider provider = new JacksonJsonProvider(myMapper);
        provider.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
        List<Object> providers = new ArrayList<>();
        providers.add(provider);


        //web service endpoint address
        String address = "http://my-web-service-address.com/url/"
        //MyWebService is the class containing getNewsById(id)
        myWebService = JAXRSClientFactory.create(address, MyWebService.class, providers);   

    }

答案 1 :(得分:0)

如果将Liferay 7.1与CXF的Jettison支持一起使用,则可以通过将配置文件添加到/configs目录中来对其进行配置:

org.apache.aries.jax.rs.jaxb.json.cfg 内容:

drop.collection.wrapper.element=true
drop.root.element=true
serialize.as.array=true
support.unwrapped=true

从Liferay 7.2开始,Liferay随Jackson一起提供为默认的JAXB提供程序。

请注意,Liferay对OSGi JAX-RS Whiteboard的支持使您可以切换JSON提供程序,而不必更改应用程序的代码。您可以在https://github.com/apache/aries-jax-rs-whiteboard/tree/master/integrations

中找到不同的集成

或如何在Liferay中提供杰克逊支持(如果不是在7.2中,则包括在其中)及其相关性:https://github.com/liferay/liferay-portal/blob/7.2.x/modules/apps/portal-remote/portal-remote-jaxrs-whiteboard-jaxb-json/build.gradle

只需确保更换CXF抛弃式喷气飞机,这可能会对依赖于它的其他束产生副作用。