Part of databind#3072: Make @JacksonInject not fail when there's no corresponding value

release-notes/CREDITS-2.x

@@ -1215,10 +1215,13 @@ Oleg Chtchoukine (oshatrk@github)
     to incorrect output
   (2.11.1)
 
-Joshua Shannon (retrodaredevil@github)
+Lavender Shannon (retrodaredevil@github)
   * Reported, contributed fix for #2785: Polymorphic subtypes not registering on copied
     ObjectMapper (2.11.1)
   (2.11.2)
+  * Requested #3072: Allow specifying `@JacksonInject` does not fail when there's no
+    corresponding value
+  (2.20.0)
 
 Daniel Hrabovcak (TheSpiritXIII@github)
   * Reported #2796: `TypeFactory.constructType()` does not take `TypeBindings` correctly
@@ -1940,3 +1943,8 @@ Will Paul (@dropofwill)
 Ryan Schmitt (@rschmitt)
  * Contributed #5099: Fix regression in `ObjectNode.with()`
   (2.19.0)
+
+Giulio Longfils (@giulong)
+ * Contributed #3072: Allow specifying `@JacksonInject` does not fail when there's no
+   corresponding value
+  (2.20.0)

release-notes/VERSION-2.x

@@ -6,6 +6,10 @@ Project: jackson-databind
 
 2.20.0 (not yet released)
 
+#3072: Allow specifying `@JacksonInject` does not fail when there's no
+  corresponding value
+ (requested by Lavender S)
+ (contributed by Giulio L)
 #4136: Drop deprecated (in 2.12) `PropertyNamingStrategy` implementations
   from 2.20
 #5103: Use `writeStartObject(Object forValue, int size)` for `ObjectNode`

src/main/java/com/fasterxml/jackson/databind/DeserializationContext.java

@@ -6,17 +6,14 @@
 import java.util.*;
 import java.util.concurrent.atomic.AtomicReference;
 
+import com.fasterxml.jackson.annotation.JacksonInject;
 import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.ObjectIdGenerator;
 import com.fasterxml.jackson.annotation.ObjectIdResolver;
 
 import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.core.util.JacksonFeatureSet;
-import com.fasterxml.jackson.databind.cfg.CoercionAction;
-import com.fasterxml.jackson.databind.cfg.CoercionInputShape;
-import com.fasterxml.jackson.databind.cfg.ContextAttributes;
-import com.fasterxml.jackson.databind.cfg.DatatypeFeature;
-import com.fasterxml.jackson.databind.cfg.DatatypeFeatures;
+import com.fasterxml.jackson.databind.cfg.*;
 import com.fasterxml.jackson.databind.deser.*;
 import com.fasterxml.jackson.databind.deser.impl.ObjectIdReader;
 import com.fasterxml.jackson.databind.deser.impl.ReadableObjectId;
@@ -463,15 +460,35 @@ public final boolean hasSomeOfFeatures(int featureMask) {
      */
     public final JsonParser getParser() { return _parser; }
 
+    /**
+     * @since 2.20
+     */
     public final Object findInjectableValue(Object valueId,
-            BeanProperty forProperty, Object beanInstance)
+            BeanProperty forProperty, Object beanInstance, Boolean optional)
         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))) {
+                return JacksonInject.Value.empty();
+            }
             return reportBadDefinition(ClassUtil.classOf(valueId), String.format(
-"No 'injectableValues' configured, cannot inject value with id [%s]", valueId));
+"No 'injectableValues' configured, cannot inject value with id '%s'", valueId));
         }
-        return _injectableValues.findInjectableValue(valueId, this, forProperty, beanInstance);
+        return _injectableValues.findInjectableValue(valueId, this, forProperty, beanInstance, optional);
+    }
+
+    /**
+     * @deprecated in 2.20
+     */
+    @Deprecated // since 2.20
+    public final Object findInjectableValue(Object valueId,
+            BeanProperty forProperty, Object beanInstance)
+        throws JsonMappingException
+    {
+        return findInjectableValue(valueId, forProperty, beanInstance, null);
     }
 
     /**

src/main/java/com/fasterxml/jackson/databind/DeserializationFeature.java

@@ -1,5 +1,6 @@
 package com.fasterxml.jackson.databind;
 
+import com.fasterxml.jackson.annotation.JacksonInject;
 import com.fasterxml.jackson.databind.cfg.ConfigFeature;
 import com.fasterxml.jackson.databind.exc.InvalidNullException;
 
@@ -266,7 +267,7 @@ public enum DeserializationFeature implements ConfigFeature
      * white space or comments, if supported by data format).
      *<p>
      * Feature is disabled by default (so that no check is made for possible trailing
-     * token(s)) for backwards compatibility reasons.
+     * token(s)) for backwards-compatibility reasons.
      *
      * @since 2.9
      */
@@ -336,6 +337,22 @@ public enum DeserializationFeature implements ConfigFeature
      */
     FAIL_ON_UNEXPECTED_VIEW_PROPERTIES(false),
 
+    /**
+     * Feature that determines the handling of injected properties during deserialization.
+     *<p>
+     * When enabled, if an injected property without matching value is encountered
+     * during deserialization,  an exception is thrown.
+     * When disabled, no exception is thrown.
+     * See {@link JacksonInject#optional()} for per-property override
+     * of this setting.
+     *<p>
+     * This feature is enabled by default to maintain backwards-compatibility.
+     *
+     * @see JacksonInject#optional()
+     * @since 2.20
+     */
+    FAIL_ON_UNKNOWN_INJECT_VALUE(true),
+
     /*
     /******************************************************
     /* Structural conversion features

src/main/java/com/fasterxml/jackson/databind/InjectableValues.java

@@ -23,7 +23,16 @@ public abstract class InjectableValues
      * @param forProperty Bean property in which value is to be injected
      * @param beanInstance Bean instance that contains property to inject,
      *    if available; null if bean has not yet been constructed.
+     * @param optional Flag used for configuring the behavior when the value
+     *    to inject is not found
      */
+    public abstract Object findInjectableValue(Object valueId, DeserializationContext ctxt,
+            BeanProperty forProperty, Object beanInstance, Boolean optional) throws JsonMappingException;
+
+    /**
+     * @deprecated in 2.20
+     */
+    @Deprecated // since 2.20
     public abstract Object findInjectableValue(Object valueId, DeserializationContext ctxt,
             BeanProperty forProperty, Object beanInstance) throws JsonMappingException;
 
@@ -63,9 +72,13 @@ public Std addValue(Class<?> classKey, Object value) {
             return this;
         }
 
+        /**
+         * @since 2.20
+         */
         @Override
         public Object findInjectableValue(Object valueId, DeserializationContext ctxt,
-                BeanProperty forProperty, Object beanInstance) throws JsonMappingException
+                BeanProperty forProperty, Object beanInstance, Boolean optional)
+            throws JsonMappingException
         {
             if (!(valueId instanceof String)) {
                 ctxt.reportBadDefinition(ClassUtil.classOf(valueId),
@@ -76,9 +89,26 @@ public Object findInjectableValue(Object valueId, DeserializationContext ctxt,
             String key = (String) valueId;
             Object ob = _values.get(key);
             if (ob == null && !_values.containsKey(key)) {
-                throw new IllegalArgumentException("No injectable value with id '"+key+"' found (for property '"+forProperty.getName()+"')");
+                if (Boolean.FALSE.equals(optional)
+                        || ((optional == null)
+                                && ctxt.isEnabled(DeserializationFeature.FAIL_ON_UNKNOWN_INJECT_VALUE))) {
+                    return ctxt.reportBadDefinition(ClassUtil.classOf(valueId), String.format(
+                            "No injectable value with id '" + key + "' " +
+                            "found (for property '" + forProperty.getName() + "')"));
+                }
             }
             return ob;
         }
+
+        /**
+         * @deprecated in 2.20
+         */
+        @Override
+        @Deprecated // since 2.20
+        public Object findInjectableValue(Object valueId, DeserializationContext ctxt,
+                BeanProperty forProperty, Object beanInstance) throws JsonMappingException
+        {
+            return this.findInjectableValue(valueId, ctxt, forProperty, beanInstance, null);
+        }
     }
 }

src/main/java/com/fasterxml/jackson/databind/deser/BeanDeserializerBuilder.java

@@ -239,13 +239,16 @@ public void  addBackReferenceProperty(String referenceName, SettableBeanProperty
         */
     }
 
+    /**
+     * @since 2.20
+     */
     public void addInjectable(PropertyName propName, JavaType propType,
             Annotations contextAnnotations, AnnotatedMember member,
-            Object valueId)
+            Object valueId, Boolean optional)
         throws JsonMappingException
     {
         if (_injectables == null) {
-            _injectables = new ArrayList<ValueInjector>();
+            _injectables = new ArrayList<>();
         }
         if ( _config.canOverrideAccessModifiers()) {
             try {
@@ -254,7 +257,19 @@ public void addInjectable(PropertyName propName, JavaType propType,
                 _handleBadAccess(e);
             }
         }
-        _injectables.add(new ValueInjector(propName, propType, member, valueId));
+        _injectables.add(new ValueInjector(propName, propType, member, valueId, optional));
+    }
+
+    /**
+     * @deprecated in 2.20
+     */
+    @Deprecated // since 2.20
+    public void addInjectable(PropertyName propName, JavaType propType,
+            Annotations contextAnnotations, AnnotatedMember member,
+            Object valueId)
+        throws JsonMappingException
+    {
+        this.addInjectable(propName, propType, contextAnnotations, member, valueId, null);
     }
 
     /**

src/main/java/com/fasterxml/jackson/databind/deser/BeanDeserializerFactory.java

@@ -812,11 +812,16 @@ protected void addInjectables(DeserializationContext ctxt,
     {
         Map<Object, AnnotatedMember> raw = beanDesc.findInjectables();
         if (raw != null) {
+            final AnnotationIntrospector introspector = ctxt.getAnnotationIntrospector();
+
             for (Map.Entry<Object, AnnotatedMember> entry : raw.entrySet()) {
                 AnnotatedMember m = entry.getValue();
+                final JacksonInject.Value injectableValue = introspector.findInjectableValue(m);
+                final Boolean optional = injectableValue == null ? null : injectableValue.getOptional();
+
                 builder.addInjectable(PropertyName.construct(m.getName()),
                         m.getType(),
-                        beanDesc.getClassAnnotations(), m, entry.getKey());
+                        beanDesc.getClassAnnotations(), m, entry.getKey(), optional);
             }
         }
     }

src/main/java/com/fasterxml/jackson/databind/deser/CreatorProperty.java

@@ -103,7 +103,7 @@ public CreatorProperty(PropertyName name, JavaType type, PropertyName wrapperNam
     {
         this(name, type, wrapperName, typeDeser, contextAnnotations, param, index,
                 (injectableValueId == null) ? null
-                        : JacksonInject.Value.construct(injectableValueId, null),
+                        : JacksonInject.Value.construct(injectableValueId, null, null),
                 metadata);
     }
 

src/main/java/com/fasterxml/jackson/databind/deser/impl/PropertyValueBuffer.java

@@ -269,7 +269,7 @@ protected Object _findMissing(SettableBeanProperty prop) throws JsonMappingExcep
         Object injectableValueId = prop.getInjectableValueId();
         if (injectableValueId != null) {
             return _context.findInjectableValue(prop.getInjectableValueId(),
-                    prop, null);
+                    prop, null, null);
         }
         // Second: required?
         if (prop.isRequired()) {

src/main/java/com/fasterxml/jackson/databind/deser/impl/ValueInjector.java

@@ -2,6 +2,7 @@
 
 import java.io.IOException;
 
+import com.fasterxml.jackson.annotation.JacksonInject;
 import com.fasterxml.jackson.databind.*;
 import com.fasterxml.jackson.databind.introspect.AnnotatedMember;
 
@@ -21,33 +22,46 @@ public class ValueInjector
      */
     protected final Object _valueId;
 
+    /**
+     * Flag used for configuring the behavior when the value to inject is not found.
+     *
+     * @since 2.20
+     */
+    protected final Boolean _optional;
+
+    /**
+     * @since 2.20
+     */
     public ValueInjector(PropertyName propName, JavaType type,
-            AnnotatedMember mutator, Object valueId)
+            AnnotatedMember mutator, Object valueId, Boolean optional)
     {
         super(propName, type, null, mutator, PropertyMetadata.STD_OPTIONAL);
         _valueId = valueId;
+        _optional = optional;
     }
 
     /**
-     * @deprecated in 2.9 (remove from 3.0)
+     * @deprecated in 2.20 (remove from 3.0)
      */
-    @Deprecated // see [databind#1835]
+    @Deprecated // since 2.20
     public ValueInjector(PropertyName propName, JavaType type,
-            com.fasterxml.jackson.databind.util.Annotations contextAnnotations, // removed from later versions
             AnnotatedMember mutator, Object valueId)
     {
-        this(propName, type, mutator, valueId);
+        this(propName, type, mutator, valueId, null);
     }
 
     public Object findValue(DeserializationContext context, Object beanInstance)
         throws JsonMappingException
     {
-        return context.findInjectableValue(_valueId, this, beanInstance);
+        return context.findInjectableValue(_valueId, this, beanInstance, _optional);
     }
 
     public void inject(DeserializationContext context, Object beanInstance)
         throws IOException
     {
-        _member.setValue(beanInstance, findValue(context, beanInstance));
+        final Object value = findValue(context, beanInstance);
+        if (!JacksonInject.Value.empty().equals(value)) {
+            _member.setValue(beanInstance, value);
+        }
     }
-}
+}

src/main/java/com/fasterxml/jackson/databind/deser/std/StdValueInstantiator.java

@@ -673,7 +673,8 @@ private Object _createUsingDelegate(AnnotatedWithParams delegateCreator,
                 if (prop == null) { // delegate
                     args[i] = delegate;
                 } else { // nope, injectable:
-                    args[i] = ctxt.findInjectableValue(prop.getInjectableValueId(), prop, null);
+                    // 09-May-2025, tatu: Not sure where to get "optional" (last arg) value...
+                    args[i] = ctxt.findInjectableValue(prop.getInjectableValueId(), prop, null, null);
                 }
             }
             // and then try calling with full set of arguments