为什么@JsonUnwrapped不适用于列表？ [英] Why doesn't @JsonUnwrapped work for Lists?

问题描述

我正在使用杰克逊2.1.0。鉴于：

  public static final class GetCompanies 
 {
 private final List< ; URI>企业; 
 
 / ** 
 *创建新的GetCompanies。 
 *< p /> 
 * @param公司可用公司列表
 * @throws NullPointerException如果公司为null 
 * / 
 @JsonCreator 
 public GetCompanies（@JsonUnwrapped @NotNull List< URI>公司）
 {
 Preconditions.checkNotNull（公司，公司）; 
 
 this.companies = ImmutableList.copyOf（公司）; 
} 
 
 / ** 
 * @return可用公司列表
 * / 
 @JsonUnwrapped 
 @SuppressWarnings（ReturnOfCollectionOrArrayField ）
 public List< URI> getCompanies（）
 {
返回公司; 
} 
} 
  

当输入列表包含时http://test.com/ ，Jackson生成：

  {公司：[ http://test.com/]} 
  

而不是：

  [http://test.com/] 
  

任何想法？

更新：参见 https://github.com/FasterXML/jackson-core/issues/41 进行相关讨论。

解决方案

在这种情况下，如果这样做，你最终会尝试产生以下内容：

  {http://test.com} 
  

这不是合法的JSON。 @JsonUnwrapped 实际上只是删除了一层包装。虽然它理论上可以用于数组中的数组的情况，但事实并非如此。
事实上我想知道添加此功能是否是一个错误：主要是因为它鼓励使用通常违反数据绑定的最佳实践（简单，一对一映射）。

但是可以使用的是 @JsonValue ：

< pre class =lang-java prettyprint-override> @JsonValue
private final List< URI>企业;


这意味着使用此属性的值而不是序列化包含它的对象。

并且创建者方法实际上可以正常工作，不需要 @JsonUnwrapped 或 @ JsonProperty 。

以下是更正后的代码：

  public static final class GetCompanies 
 {
 private final List< URI>企业; 
 
 / ** 
 *创建新的GetCompanies。 
 *< p /> 
 * @param公司可用公司列表
 * @throws NullPointerException如果公司为null 
 * / 
 @JsonCreator 
 public GetCompanies（@NotNull List< URI>公司）
 {
 Preconditions.checkNotNull（公司，公司）; 
 
 this.companies = ImmutableList.copyOf（公司）; 
} 
 
 / ** 
 * @return可用公司列表
 * / 
 @JsonValue 
 @SuppressWarnings（ReturnOfCollectionOrArrayField ）
 public List< URI> getCompanies（）
 {
返回公司; 
} 
} 
  

I am using Jackson 2.1.0. Given:

public static final class GetCompanies
{
    private final List<URI> companies;

    /**
     * Creates a new GetCompanies.
     * <p/>
     * @param companies the list of available companies
     * @throws NullPointerException if companies is null
     */
    @JsonCreator
    public GetCompanies(@JsonUnwrapped @NotNull List<URI> companies)
    {
        Preconditions.checkNotNull(companies, "companies");

        this.companies = ImmutableList.copyOf(companies);
    }

    /**
     * @return the list of available companies
     */
    @JsonUnwrapped
    @SuppressWarnings("ReturnOfCollectionOrArrayField")
    public List<URI> getCompanies()
    {
        return companies;
    }
}

When the input list contains http://test.com/, Jackson generates:

{"companies":["http://test.com/"]}

instead of:

["http://test.com/"]

Any ideas?

UPDATE: See https://github.com/FasterXML/jackson-core/issues/41 for a related discussion.

解决方案

In this case, if this was to work, you'd end up trying to produce following:

{ "http://test.com" }

which is not legal JSON. @JsonUnwrapped really just removes one layer of wrapping. And although it theoretically could be made to work for "arrays in arrays" case, it does not. And in fact I wonder if adding this feature was a mistake: mostly because it encourages use that is often against data-binding best practices (simplicity, one-to-one mapping).

But what would work instead is @JsonValue:

@JsonValue
private final List<URI> companies;

which means "use value of this property instead of serializing the object that contains it".

And the creator method would actually work as-is, no need for either @JsonUnwrapped or @JsonProperty.

Here is the corrected code:

public static final class GetCompanies
{
    private final List<URI> companies;

    /**
     * Creates a new GetCompanies.
     * <p/>
     * @param companies the list of available companies
     * @throws NullPointerException if companies is null
     */
    @JsonCreator
    public GetCompanies(@NotNull List<URI> companies)
    {
        Preconditions.checkNotNull(companies, "companies");

        this.companies = ImmutableList.copyOf(companies);
    }

    /**
     * @return the list of available companies
     */
    @JsonValue
    @SuppressWarnings("ReturnOfCollectionOrArrayField")
    public List<URI> getCompanies()
    {
        return companies;
    }
}

这篇关于为什么@JsonUnwrapped不适用于列表？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！