FasterXML / FasterXML/jackson-annotations

Property is not serialized when both @JsonProperty and @JsonIgnore are present

Open
#305 2 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Java
Stars
1.1k
Forks
342
Avg merge
8h 53m
Merged PRs (30d)
2

Description

I encountered a situation where a property annotated with both `@JsonProperty` and `@JsonIgnore` is not being serialized. In [Jackson wiki](https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations) said, that `@JsonProperty`:

> also indicates that property is to be included

Based on this, I assumed that `@JsonProperty` would override `@JsonIgnore`. However, in the following example, the property is omitted from the serialized JSON:

```java
public class Box {
@JsonProperty
@JsonIgnore
private int size;

public Box(int size) {
this.size = size;
}

public static void main(String[] args) throws JsonProcessingException {
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
Box box = new Box(10);

String json = objectMapper.writeValueAsString(box);
System.out.println(json);
}
}
```
Expected output:
```json
{"size":10}
```
But got:
```json
{}
```
**Jackson version**: `2.19.3`

I used a very simple example just to demonstrate the behavior, but the same issue also occurs with subclasses.

If this behavior is expected, it would be very helpful to have documentation describing the priority of different annotations, because it is currently unclear which annotation takes precedence over others.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.