Skip to content

Commit

Permalink
Document @NestedConstructorBinding in all cases
Browse files Browse the repository at this point in the history
This covers Kotlin data classes, constructor injection and records.

Closes gh-33235
  • Loading branch information
mhalbritter committed Nov 18, 2022
1 parent 931cc8a commit 517ec65
Show file tree
Hide file tree
Showing 6 changed files with 146 additions and 17 deletions.
Expand Up @@ -5,20 +5,36 @@

[[native-image.advanced.nested-configuration-properties]]
=== Nested Configuration Properties

Reflection hints are automatically created for configuration properties by the Spring ahead-of-time engine.
Nested configuration properties which are no inner classes, however, *must* be annotated with `@NestedConfigurationProperty`, otherwise they won't be detected and will not be bindable.

include::code:MyProperties[]

where `Nested` is:

include::code:Nested[]

The example above produces configuration properties for `my.properties.name` and `my.properties.nested.number`.
Without the `@NestedConfigurationProperty` annotation on the `nested` field, the `my.properties.nested.number` property would not be bindable in a native image.

NOTE: Please use public getters and setters, otherwise the properties will not be bindable.
When using constructor binding, you have to annotate the field with `@NestedConfigurationProperty`:

include::code:MyPropertiesCtor[]

When using records, you have to annotate the parameter with `@NestedConfigurationProperty`:

include::code:MyPropertiesRecord[]

When using Kotlin, you need to annotate the parameter of a data class with `@NestedConfigurationProperty`:

include::code:MyPropertiesKotlin[]

NOTE: Please use public getters and setters in all cases, otherwise the properties will not be bindable.

[[native-image.advanced.converting-executable-jars]]
=== Converting a Spring Boot Executable Jar

It is possible to convert a Spring Boot <<executable-jar#appendix.executable-jar, executable jar>> into a native image as long at the jar contains the AOT generated assets.
This can be useful for a number of reasons, including:

Expand Down
Expand Up @@ -42,19 +42,3 @@ public Nested getNested() {
// @fold:off

}

class Nested {

private int number;

// @fold:on // getters / setters...
public int getNumber() {
return this.number;
}

public void setNumber(int number) {
this.number = number;
}
// @fold:off

}
@@ -0,0 +1,45 @@
/*
* Copyright 2012-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.boot.docs.nativeimage.advanced.nestedconfigurationproperties;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.NestedConfigurationProperty;

@ConfigurationProperties(prefix = "my.properties")
public class MyPropertiesCtor {

private final String name;

@NestedConfigurationProperty
private final Nested nested;

public MyPropertiesCtor(String name, Nested nested) {
this.name = name;
this.nested = nested;
}

// @fold:on // getters / setters...
public String getName() {
return this.name;
}

public Nested getNested() {
return this.nested;
}
// @fold:off

}
@@ -0,0 +1,25 @@
/*
* Copyright 2012-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.boot.docs.nativeimage.advanced.nestedconfigurationproperties;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.NestedConfigurationProperty;

@ConfigurationProperties(prefix = "my.properties")
public record MyPropertiesRecord(String name, @NestedConfigurationProperty Nested nested) {

}
@@ -0,0 +1,33 @@
/*
* Copyright 2012-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.boot.docs.nativeimage.advanced.nestedconfigurationproperties;

public class Nested {

private int number;

// @fold:on // getters / setters...
public int getNumber() {
return this.number;
}

public void setNumber(int number) {
this.number = number;
}
// @fold:off

}
@@ -0,0 +1,26 @@
/*
* Copyright 2012-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.boot.docs.nativeimage.advanced.nestedconfigurationproperties

import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.boot.context.properties.NestedConfigurationProperty

@ConfigurationProperties(prefix = "my.properties")
data class MyPropertiesKotlin(
val name: String,
@NestedConfigurationProperty val nested: Nested
)

0 comments on commit 517ec65

Please sign in to comment.