Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
9a42cca
feat(#1381): useInput=TRUE in JacksonInject now make deserialization …
giulong May 24, 2025
d714aeb
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Jun 5, 2025
d6bee5f
Change exception throws
cowtowncoder Jun 5, 2025
bc094d8
...
cowtowncoder Jun 5, 2025
a12a3d7
Add release notes; broke tests by changing annotation placements
cowtowncoder Jun 5, 2025
69c603e
test: minor refactor to apply coding conventions
giulong Jun 7, 2025
191292c
test(#1381): covering all cases for JacksonInject, whether we useInpu…
giulong Jun 15, 2025
5705aff
feat(#1381): JacksonInject.useInput works for constructor properties …
giulong Jun 15, 2025
bc9d37e
Merge branch '2.x' into feature/databind-1381-inject-only
giulong Jun 15, 2025
272c499
Merge branch 'FasterXML:2.x' into feature/databind-1381-inject-only
giulong Jun 20, 2025
5da46ac
test(#1381): minor code cleaning removing unused getters
giulong Jun 20, 2025
deb1741
feat(#1381): always adding properties annotated with JacksonInject to…
giulong Jun 20, 2025
bf34e81
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Jul 26, 2025
fac9b19
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Aug 8, 2025
13715a3
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Aug 22, 2025
03ba2cf
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Aug 22, 2025
8423113
Add back accidentally removed CREDITS line (merge)
cowtowncoder Aug 22, 2025
98abe58
...
cowtowncoder Aug 22, 2025
402e3cb
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Aug 22, 2025
bd2c4d7
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Aug 26, 2025
0c2f3f3
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Aug 26, 2025
202e5ec
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Aug 26, 2025
e30140b
Test cleanup for easier 3.0 merging
cowtowncoder Aug 26, 2025
2da95a7
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Aug 26, 2025
350f959
Minor renaming
cowtowncoder Aug 26, 2025
1e8578d
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Aug 27, 2025
32e84cb
Merge branch '2.x' into feature/databind-1381-inject-only
giulong Sep 3, 2025
5c58665
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Sep 6, 2025
5d32825
refactor(#1381): changing exception message in ValueInjector when no …
giulong Sep 6, 2025
285989f
chore(#1381): minor comment update
giulong Sep 6, 2025
eaf80fd
fix(#1381): avoid duplicate injection on constructor properties
giulong Sep 7, 2025
be8aea6
Merge branch '2.x' into feature/databind-1381-inject-only
cowtowncoder Sep 12, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions release-notes/CREDITS-2.x
Original file line number Diff line number Diff line change
Expand Up @@ -1957,6 +1957,8 @@ Eddú Meléndez Gonzales (@eddumelendez)
(2.19.2)

Giulio Longfils (@giulong)
* Contributed #1381: Add a way to specify "inject-only" with `@JacksonInject`
(2.20.0)
* Contributed fix for #2678: `@JacksonInject` added to property overrides value
from the JSON even if `useInput` is `OptBoolean.TRUE`
(2.20.0)
Expand Down
2 changes: 2 additions & 0 deletions release-notes/VERSION-2.x
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Project: jackson-databind

2.20.0 (28-Aug-2025)

#1381: Add a way to specify "inject-only" with `@JacksonInject`
(fix by Giulio L)
#2678: `@JacksonInject` added to property overrides value from the JSON
even if `useInput` is `OptBoolean.TRUE`
(reported by Plamen T)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -469,10 +469,12 @@ public final Object findInjectableValue(Object valueId,
throws JsonMappingException
{
if (_injectableValues == null) {
// `optional` comes from property annotation (if any); has precedence
// over global setting.
if (Boolean.TRUE.equals(optional)
|| (optional == null && !isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE))) {
// `useInput` and `optional` come from property annotation (if any);
// they have precedence over global setting.
if (Boolean.TRUE.equals(useInput)
|| Boolean.TRUE.equals(optional)
|| (useInput == null || optional == null)
Copy link
Member

@cowtowncoder cowtowncoder Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks odd; should second || actually be &&? Or maybe it's just odd grouping of clauses with parenthesis.

Should probably update comment to describe logic fully.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're returning empty() (we want to discard the injected value) in one of these cases:

  • either useInput or optional is true
  • either useInput or optional is null and FAIL_ON_UNKNOWN_INJECT_VALUE is disabled

maybe it's just odd grouping of clauses with parenthesis

Yup, due to formatting, I think the precedence in the last two lines is not immediately clear

if (Boolean.TRUE.equals(useInput)
        || Boolean.TRUE.equals(optional)
        || (useInput == null || optional == null)
        && !isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE)) {

I'm updating the comment

&& !isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE)) {
return JacksonInject.Value.empty();
}
throw missingInjectableValueException(String.format(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,11 @@ public Object getInjectableValueId() {
return (_injectableValue == null) ? null : _injectableValue.getId();
}

@Override // since 2.20
public JacksonInject.Value getInjectionDefinition() {
return _injectableValue;
}

@Override
public boolean isInjectionOnly() {
return (_injectableValue != null) && !_injectableValue.willUseInput(true);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import java.io.IOException;
import java.lang.annotation.Annotation;

import com.fasterxml.jackson.annotation.JacksonInject;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.deser.impl.FailingDeserializer;
Expand Down Expand Up @@ -468,6 +469,14 @@ public int getCreatorIndex() {
*/
public Object getInjectableValueId() { return null; }

/**
* Accessor for injection definition, if this bean property supports
* value injection.
*
* @since 2.20
*/
public JacksonInject.Value getInjectionDefinition() { return null; }

/**
* Accessor for checking whether this property is injectable, and if so,
* ONLY injectable (will not bind from input).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import java.io.IOException;
import java.util.BitSet;

import com.fasterxml.jackson.annotation.JacksonInject;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.deser.*;
Expand Down Expand Up @@ -89,6 +90,22 @@ public class PropertyValueBuffer
*/
protected PropertyValue _anyParamBuffered;

/**
* Bitflag used to track already injected parameters when number of parameters is
* less than 32 (fits in int).
*
* @since 2.21
*/
protected int _paramsInjected;

/**
* Bitflag used to track already injected parameters when number of parameters is
* 32 or higher.
*
* @since 2.21
*/
protected final BitSet _paramsInjectedBig;

/*
/**********************************************************
/* Life-cycle
Expand All @@ -108,8 +125,10 @@ public PropertyValueBuffer(JsonParser p, DeserializationContext ctxt, int paramC
_creatorParameters = new Object[paramCount];
if (paramCount < 32) {
_paramsSeenBig = null;
_paramsInjectedBig = null;
} else {
_paramsSeenBig = new BitSet();
_paramsInjectedBig = new BitSet();
}
// Only care about Creator-bound Any setters:
if ((anyParamSetter == null) || (anyParamSetter.getParameterIndex() < 0)) {
Expand Down Expand Up @@ -218,6 +237,7 @@ public Object[] getParameters(SettableBeanProperty[] props)
if (_anyParamSetter != null) {
_creatorParameters[_anyParamSetter.getParameterIndex()] = _createAndSetAnySetterValue();
}

if (_context.isEnabled(DeserializationFeature.FAIL_ON_NULL_CREATOR_PROPERTIES)) {
for (int ix = 0; ix < props.length; ++ix) {
if (_creatorParameters[ix] == null) {
Expand All @@ -228,6 +248,19 @@ public Object[] getParameters(SettableBeanProperty[] props)
}
}
}

if (_paramsInjectedBig == null) {
for (int ix = 0; ix < _creatorParameters.length; ++ix) {
if ((_paramsInjected & 1) == 0) {
_inject(props[ix]);
}
}
} else {
for (int ix = 0; (ix = _paramsInjectedBig.nextClearBit(ix)) < _creatorParameters.length; ++ix) {
_inject(props[ix]);
}
}

return _creatorParameters;
}

Expand Down Expand Up @@ -268,6 +301,7 @@ protected Object _findMissing(SettableBeanProperty prop) throws JsonMappingExcep
// First: do we have injectable value?
Object injectableValueId = prop.getInjectableValueId();
if (injectableValueId != null) {
_trackInjected(prop);
return _context.findInjectableValue(prop.getInjectableValueId(),
prop, null, null, null);
}
Expand Down Expand Up @@ -302,6 +336,32 @@ protected Object _findMissing(SettableBeanProperty prop) throws JsonMappingExcep
}
}

private void _inject(final SettableBeanProperty prop) throws JsonMappingException {
final JacksonInject.Value injection = prop.getInjectionDefinition();

if (injection != null) {
final Boolean useInput = injection.getUseInput();

if (!Boolean.TRUE.equals(useInput)) {
final Object value = _context.findInjectableValue(injection.getId(),
prop, prop.getMember(), injection.getOptional(), useInput);

if (value != JacksonInject.Value.empty()) {
_trackInjected(prop);
_creatorParameters[prop.getCreatorIndex()] = value;
}
}
}
}

private void _trackInjected(final SettableBeanProperty prop) {
if (_paramsInjectedBig == null) {
_paramsInjected |= 1 << prop.getCreatorIndex();
} else {
_paramsInjectedBig.set(prop.getCreatorIndex());
}
}

/*
/**********************************************************
/* Other methods
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,15 @@ public void inject(DeserializationContext context, Object beanInstance)
throws IOException
{
final Object value = findValue(context, beanInstance);
if (!JacksonInject.Value.empty().equals(value)) {

if (value == JacksonInject.Value.empty()) {
if (Boolean.FALSE.equals(_optional)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is slightly wrong as it won't match null; and as per @JacksonInject.optional Javadocs, default value, expressed as null here, is same as false.
So I think this should be:

if (!Boolean.TRUE.equals(_optional)) {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but I think it's more complicated than just flipping that condition, since now optional must work together with useInput. As an example, if I just apply your suggestion, this test fails:

@DisplayName("input YES, injectable NO, useInput TRUE => input")
void test4() throws Exception {
    assertEquals("input", plainMapper.readValue(input, InputTrue.class).getField());

In this case, I think that even if optional is null, useInput should take precedence: the user should not be forced to specify also optional = trueimho, since they're already saying "use the input whatever the injection is". Forcing users to also specify optional = true seems a bit redundant to me. What do you think?

On the other side, there are a couple test that are currently passing but should not, such as this (the @DisplayName is correct while the assertion is wrong):

@DisplayName("FAIL_ON_UNKNOWN_INJECT_VALUE NO, input YES, injectable NO, useInput DEFAULT|FALSE => exception")
    void test3() throws Exception {
        assertEquals("input", plainMapper.readValue(input, InputDefault.class).getField());

Here we have:

  • an input
  • no injection
  • both optional and useInput are null

So I think the user here should explicitly state that optional = true or expect an exception. Am I right?

If we agree on the behavior I can start fixing the current implementation.

throw context.missingInjectableValueException(
String.format("No injectable value with id '%s' found (for property '%s')",
_valueId, beanInstance),
_valueId, null, beanInstance);
}
} else if (!Boolean.TRUE.equals(_useInput)) {
_member.setValue(beanInstance, value);
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -675,8 +675,8 @@ private Object _createUsingDelegate(AnnotatedWithParams delegateCreator,
} else { // nope, injectable:
// 09-May-2025, tatu: Not sure where to get "optional" (last arg) value...
// 25-Aug-2025, tatu: ... or "useInput"
args[i] = ctxt.findInjectableValue(prop.getInjectableValueId(), prop,
null, null, null);
args[i] = ctxt.findInjectableValue(prop.getInjectableValueId(), prop, null,
null, null);
}
}
// and then try calling with full set of arguments
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
package com.fasterxml.jackson.databind.deser.inject;

import com.fasterxml.jackson.annotation.JacksonInject;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.OptBoolean;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.InjectableValues;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.exc.ValueInstantiationException;
import com.fasterxml.jackson.databind.testutil.DatabindTestUtil;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

class JacksonInject1381DeserializationFeatureDisabledTest extends DatabindTestUtil {
static class InputDefault {
@JacksonInject(value = "key")
@JsonProperty("field")
private final String _field;

@JsonCreator
public InputDefault(@JsonProperty("field") final String field) {
_field = field;
}

public String getField() {
return _field;
}
}

static class InputDefaultConstructor {
private final String _field;

@JsonCreator
public InputDefaultConstructor(@JacksonInject(value = "key")
@JsonProperty("field") final String field) {
_field = field;
}

public String getField() {
return _field;
}
}

static class InputTrue {
@JacksonInject(value = "key", useInput = OptBoolean.TRUE)
@JsonProperty("field")
private final String _field;

@JsonCreator
public InputTrue(@JsonProperty("field") final String field) {
_field = field;
}

public String getField() {
return _field;
}
}

static class InputTrueConstructor {
private final String _field;

@JsonCreator
public InputTrueConstructor(@JacksonInject(value = "key", useInput = OptBoolean.TRUE)
@JsonProperty("field") final String field) {
_field = field;
}

public String getField() {
return _field;
}

}

static class InputFalse {
@JacksonInject(value = "key", useInput = OptBoolean.FALSE)
@JsonProperty("field")
private final String _field;

@JsonCreator
public InputFalse(@JsonProperty("field") final String field) {
_field = field;
}

public String getField() {
return _field;
}
}

static class InputFalseConstructor {
private final String _field;

@JsonCreator
public InputFalseConstructor(@JacksonInject(value = "key", useInput = OptBoolean.FALSE)
@JsonProperty("field") final String field) {
_field = field;
}

public String getField() {
return _field;
}
}

private final String empty = "{}";
private final String input = "{\"field\": \"input\"}";

private final ObjectMapper plainMapper = jsonMapperBuilder()
.disable(DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE)
.build();
private final ObjectMapper injectedMapper = jsonMapperBuilder()
.injectableValues(new InjectableValues.Std().addValue("key", "injected"))
.disable(DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE)
.build();

@Test
@DisplayName("FAIL_ON_UNKNOWN_INJECT_VALUE NO, input NO, injectable NO, useInput DEFAULT|TRUE|FALSE => exception")
void test1() {
assertThrows(ValueInstantiationException.class,
() -> plainMapper.readValue(empty, InputDefault.class));
assertThrows(ValueInstantiationException.class,
() -> plainMapper.readValue(empty, InputDefaultConstructor.class));

assertThrows(ValueInstantiationException.class,
() -> plainMapper.readValue(empty, InputTrue.class));
assertThrows(ValueInstantiationException.class,
() -> plainMapper.readValue(empty, InputTrueConstructor.class));

assertThrows(ValueInstantiationException.class,
() -> plainMapper.readValue(empty, InputFalse.class));
assertThrows(ValueInstantiationException.class,
() -> plainMapper.readValue(empty, InputFalseConstructor.class));
}

@Test
@DisplayName("FAIL_ON_UNKNOWN_INJECT_VALUE NO, input NO, injectable YES, useInput DEFAULT|TRUE|FALSE => injected")
void test2() throws Exception {
assertEquals("injected", injectedMapper.readValue(empty, InputDefault.class).getField());
assertEquals("injected", injectedMapper.readValue(empty, InputDefaultConstructor.class).getField());
assertEquals("injected", injectedMapper.readValue(empty, InputTrue.class).getField());
assertEquals("injected", injectedMapper.readValue(empty, InputTrueConstructor.class).getField());
assertEquals("injected", injectedMapper.readValue(empty, InputFalse.class).getField());
assertEquals("injected", injectedMapper.readValue(empty, InputFalseConstructor.class).getField());
}

@Test
@DisplayName("FAIL_ON_UNKNOWN_INJECT_VALUE NO, input YES, injectable NO, useInput DEFAULT|FALSE => exception")
void test3() throws Exception {
assertEquals("input", plainMapper.readValue(input, InputDefault.class).getField());
assertEquals("input", plainMapper.readValue(input, InputDefaultConstructor.class).getField());
assertEquals("input", plainMapper.readValue(input, InputFalse.class).getField());
assertEquals("input", plainMapper.readValue(input, InputFalseConstructor.class).getField());
}

@Test
@DisplayName("FAIL_ON_UNKNOWN_INJECT_VALUE NO, input YES, injectable NO, useInput TRUE => input")
void test4() throws Exception {
assertEquals("input", plainMapper.readValue(input, InputTrue.class).getField());
assertEquals("input", plainMapper.readValue(input, InputTrueConstructor.class).getField());
}

@Test
@DisplayName("FAIL_ON_UNKNOWN_INJECT_VALUE NO, input YES, injectable YES, useInput DEFAULT|FALSE => injected")
void test5() throws Exception {
assertEquals("injected", injectedMapper.readValue(input, InputDefault.class).getField());
assertEquals("injected", injectedMapper.readValue(input, InputDefaultConstructor.class).getField());
assertEquals("injected", injectedMapper.readValue(input, InputFalse.class).getField());
assertEquals("injected", injectedMapper.readValue(input, InputFalseConstructor.class).getField());
}

@Test
@DisplayName("FAIL_ON_UNKNOWN_INJECT_VALUE NO, input YES, injectable YES, useInput TRUE => input")
void test6() throws Exception {
assertEquals("input", injectedMapper.readValue(input, InputTrue.class).getField());
assertEquals("input", injectedMapper.readValue(input, InputTrueConstructor.class).getField());
}
}
Loading
Loading