Jax-rs JSON đầu ra khá

Question

trong Java khi tôi sử dụng các chú thích

@Produces("application/json") 

đầu ra không được formated thành dạng có thể đọc được của con người. Làm thế nào để tôi đạt được điều đó?

Answer 1

Tạo lớp này ở bất cứ đâu trong dự án của bạn. Nó sẽ được tải về triển khai. Lưu ý rằng .configure(SerializationConfig.Feature.INDENT_OUTPUT, true); sẽ định cấu hình trình ánh xạ để định dạng đầu ra.

Đối Jackson 2.0 và sau, thay thế hai .configure() dòng với những: .configure(DeserializationFeature.FAIL_ON_IGNORED_PROPERTIES, false) .configure(SerializationFeature.INDENT_OUTPUT, true);

Và thay đổi nhập khẩu cho phù hợp.

package com.secret; 

import javax.ws.rs.Produces; 
import javax.ws.rs.core.MediaType; 
import javax.ws.rs.ext.ContextResolver; 
import javax.ws.rs.ext.Provider; 
import org.codehaus.jackson.map.DeserializationConfig; 
import org.codehaus.jackson.map.ObjectMapper; 
import org.codehaus.jackson.map.SerializationConfig; 

/** 
* 
* @author secret 
*/ 
@Provider 
@Produces(MediaType.APPLICATION_JSON) 
public class JacksonContextResolver implements ContextResolver<ObjectMapper> { 
    private ObjectMapper objectMapper; 

    public JacksonContextResolver() throws Exception { 
     this.objectMapper = new ObjectMapper(); 
    this.objectMapper 
     .configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false) 
     .configure(SerializationConfig.Feature.INDENT_OUTPUT, true); 
    } 

    @Override 
    public ObjectMapper getContext(Class<?> objectType) { 
     return objectMapper; 
    } 
} 

Hãy nhớ rằng định dạng có tác động tiêu cực đến hiệu suất.

Answer 2

Chỉ dành cho bản ghi, nếu bạn muốn cho phép đầu ra đẹp chỉ cho một số tài nguyên bạn có thể sử dụng the @JacksonFeatures annotation trên phương pháp tài nguyên.

Dưới đây là ví dụ:

@Produces(MediaType.APPLICATION_JSON) 
@JacksonFeatures(serializationEnable = { SerializationFeature.INDENT_OUTPUT }) 
public Bean resource() { 
    return new Bean(); 
} 

Answer 3

Xây dựng về câu trả lời hữu ích DaTroop của, đây là một phiên bản khác mà cho phép lựa chọn giữa json tối ưu hóa và json định dạng dựa trên sự vắng mặt hay sự hiện diện của một tham số "đẹp":

package test; 


import javax.ws.rs.Produces; 
import javax.ws.rs.core.Context; 
import javax.ws.rs.core.MediaType; 
import javax.ws.rs.core.MultivaluedMap; 
import javax.ws.rs.core.UriInfo; 
import javax.ws.rs.ext.ContextResolver; 
import javax.ws.rs.ext.Provider; 

import org.codehaus.jackson.map.ObjectMapper; 
import org.codehaus.jackson.map.SerializationConfig; 

@Provider 
@Produces(MediaType.APPLICATION_JSON) 
public class JacksonContextResolver implements ContextResolver<ObjectMapper> { 

    private ObjectMapper prettyPrintObjectMapper; 
    private UriInfo uriInfoContext; 

    public JacksonContextResolver(@Context UriInfo uriInfoContext) throws Exception { 
     this.uriInfoContext = uriInfoContext; 

     this.prettyPrintObjectMapper = new ObjectMapper(); 
     this.prettyPrintObjectMapper.configure(SerializationConfig.Feature.INDENT_OUTPUT, true); 
    } 

    @Override 
    public ObjectMapper getContext(Class<?> objectType) { 

     try { 
      MultivaluedMap<String, String> queryParameters = uriInfoContext.getQueryParameters(); 
      if(queryParameters.containsKey("pretty")) { 
       return prettyPrintObjectMapper; 
      } 

     } catch(Exception e) { 
      // protect from invalid access to uriInfoContext.getQueryParameters() 
     } 

     return null; // use default mapper 
    } 
} 

Answer 4

Đây là cách bạn có thể thực hiện đúng điều kiện đầu ra khá đẹp/không xinh đẹp dựa trên sự hiện diện của "đẹp" trong chuỗi truy vấn.

Tạo một PrettyFilter mà thực hiện ContainerResponseFilter, mà sẽ được thực hiện trên mọi yêu cầu:

@Provider 
public class PrettyFilter implements ContainerResponseFilter { 

    @Override 
    public void filter(ContainerRequestContext reqCtx, ContainerResponseContext respCtx) throws IOException { 

     UriInfo uriInfo = reqCtx.getUriInfo(); 
     //log.info("prettyFilter: "+uriInfo.getPath()); 

     MultivaluedMap<String, String> queryParameters = uriInfo.getQueryParameters(); 
     if(queryParameters.containsKey("pretty")) { 
      ObjectWriterInjector.set(new IndentingModifier(true)); 
     } 

    } 

    public static class IndentingModifier extends ObjectWriterModifier { 

     private final boolean indent; 

     public IndentingModifier(boolean indent) { 
      this.indent = indent; 
     } 


     @Override 
     public ObjectWriter modify(EndpointConfigBase<?> endpointConfigBase, MultivaluedMap<String, Object> multivaluedMap, Object o, ObjectWriter objectWriter, JsonGenerator jsonGenerator) throws IOException { 
      if(indent) jsonGenerator.useDefaultPrettyPrinter(); 
      return objectWriter; 
     } 
    } 
} 

Và khá nhiều đó là nó!

Bạn sẽ cần phải đảm bảo rằng lớp này được Jersey sử dụng bằng quét gói tự động hoặc được đăng ký theo cách thủ công.

Đã dành vài giờ để cố gắng đạt được điều đó và thấy rằng chưa có ai xuất bản giải pháp đã sẵn sàng sử dụng trước đây.

Answer 5

Nếu bạn đang sử dụng Spring, sau đó bạn có thể thiết lập thuộc tính trên toàn cầu

spring.jackson.serialization.INDENT_OUTPUT=true 

Thông tin thêm tại https://docs.spring.io/spring-boot/docs/current/reference/html/howto-properties-and-configuration.html