Skip to content

Commit

Permalink
Merge pull request quarkusio#6269 from gytis/spring-boot-properties
Browse files Browse the repository at this point in the history
Spring Boot properties extension
  • Loading branch information
gsmet authored Dec 24, 2019
2 parents a3ee2d8 + bfeb1ee commit b181352
Show file tree
Hide file tree
Showing 33 changed files with 723 additions and 50 deletions.
5 changes: 5 additions & 0 deletions bom/deployment/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,11 @@
<artifactId>quarkus-spring-data-deployment</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-spring-boot-properties-deployment</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-jgit-deployment</artifactId>
Expand Down
23 changes: 23 additions & 0 deletions bom/runtime/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@
<spring.version>5.1.8.RELEASE</spring.version>
<spring-data.version>2.1.9.RELEASE</spring-data.version>
<spring-security.version>5.2.0.RELEASE</spring-security.version>
<spring-boot.version>2.1.10.RELEASE</spring-boot.version>
<mvel2.version>2.4.4.Final</mvel2.version>
<mockito.version>3.0.0</mockito.version>
<jna.version>5.3.1</jna.version>
Expand Down Expand Up @@ -640,6 +641,11 @@
<artifactId>quarkus-spring-data-jpa</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-spring-boot-properties</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-swagger-ui</artifactId>
Expand Down Expand Up @@ -2556,6 +2562,23 @@
</exclusions>
</dependency>

<!-- Spring Boot -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot</artifactId>
<version>${spring-boot.version}</version>
<exclusions>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
</exclusion>
</exclusions>
</dependency>

<!-- Keycloak -->
<dependency>
<groupId>org.keycloak</groupId>
Expand Down
1 change: 1 addition & 0 deletions ci-templates/stages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,7 @@ stages:
- spring-di
- spring-web
- spring-data-jpa
- spring-boot-properties
name: spring

- template: native-build-steps.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ public final class FeatureBuildItem extends MultiBuildItem {
public static final String SPRING_WEB = "spring-web";
public static final String SPRING_DATA_JPA = "spring-data-jpa";
public static final String SPRING_SECURITY = "spring-security";
public static final String SPRING_BOOT_PROPERTIES = "spring-boot-properties";
public static final String SWAGGER_UI = "swagger-ui";
public static final String TIKA = "tika";
public static final String UNDERTOW_WEBSOCKETS = "undertow-websockets";
Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +1,16 @@
package io.quarkus.arc.deployment.configproperties;

import static io.quarkus.runtime.util.StringUtil.camelHumpsIterator;
import static io.quarkus.runtime.util.StringUtil.join;
import static io.quarkus.runtime.util.StringUtil.lowerCase;
import static io.quarkus.runtime.util.StringUtil.withoutSuffix;

import java.lang.reflect.Modifier;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import javax.inject.Singleton;

import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.AnnotationValue;
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName;
import org.jboss.jandex.IndexView;

import io.quarkus.arc.config.ConfigProperties;
import io.quarkus.arc.deployment.ConfigPropertyBuildItem;
import io.quarkus.arc.deployment.GeneratedBeanBuildItem;
import io.quarkus.arc.deployment.GeneratedBeanGizmoAdaptor;
Expand All @@ -35,17 +27,24 @@

public class ConfigPropertiesBuildStep {

@BuildStep
void produceConfigPropertiesMetadata(CombinedIndexBuildItem combinedIndex,
BuildProducer<ConfigPropertiesMetadataBuildItem> configPropertiesMetadataProducer) {
for (AnnotationInstance annotation : combinedIndex.getIndex().getAnnotations(DotNames.CONFIG_PROPERTIES)) {
configPropertiesMetadataProducer.produce(new ConfigPropertiesMetadataBuildItem(annotation));
}
}

@BuildStep
void setup(CombinedIndexBuildItem combinedIndex,
ApplicationIndexBuildItem applicationIndex,
List<ConfigPropertiesMetadataBuildItem> configPropertiesMetadataList,
BuildProducer<GeneratedClassBuildItem> generatedClasses,
BuildProducer<GeneratedBeanBuildItem> generatedBeans,
BuildProducer<RunTimeConfigurationDefaultBuildItem> defaultConfigValues,
BuildProducer<ConfigPropertyBuildItem> configProperties,
DeploymentClassLoaderBuildItem deploymentClassLoader) {
IndexView index = combinedIndex.getIndex();
Collection<AnnotationInstance> instances = index.getAnnotations(DotNames.CONFIG_PROPERTIES);
if (instances.isEmpty()) {
if (configPropertiesMetadataList.isEmpty()) {
return;
}

Expand All @@ -62,11 +61,10 @@ void setup(CombinedIndexBuildItem combinedIndex,
.build();
producerClassCreator.addAnnotation(Singleton.class);

Set<DotName> configClassesThatNeedValidation = new HashSet<>(instances.size());
for (AnnotationInstance configPropertiesInstance : instances) {
ClassInfo classInfo = configPropertiesInstance.target().asClass();
Set<DotName> configClassesThatNeedValidation = new HashSet<>(configPropertiesMetadataList.size());
for (ConfigPropertiesMetadataBuildItem configPropertiesMetadata : configPropertiesMetadataList) {
ClassInfo classInfo = configPropertiesMetadata.getClassInfo();

String prefixStr = determinePrefix(configPropertiesInstance);
if (Modifier.isInterface(classInfo.flags())) {
/*
* In this case we need to generate an implementation of the interface that for each interface method
Expand All @@ -75,7 +73,7 @@ void setup(CombinedIndexBuildItem combinedIndex,
*/

String generatedClassName = InterfaceConfigPropertiesUtil.generateImplementationForInterfaceConfigProperties(
classInfo, nonBeansClassOutput, index, prefixStr,
classInfo, nonBeansClassOutput, combinedIndex.getIndex(), configPropertiesMetadata.getPrefix(),
defaultConfigValues, configProperties);
InterfaceConfigPropertiesUtil.addProducerMethodForInterfaceConfigProperties(producerClassCreator,
classInfo.name(), generatedClassName);
Expand All @@ -86,8 +84,8 @@ void setup(CombinedIndexBuildItem combinedIndex,
* and call setters for value obtained from MP Config
*/
boolean needsValidation = ClassConfigPropertiesUtil.addProducerMethodForClassConfigProperties(
deploymentClassLoader.getClassLoader(), classInfo, producerClassCreator, prefixStr,
applicationIndex.getIndex(), configProperties);
deploymentClassLoader.getClassLoader(), classInfo, producerClassCreator,
configPropertiesMetadata.getPrefix(), applicationIndex.getIndex(), configProperties);
if (needsValidation) {
configClassesThatNeedValidation.add(classInfo.name());
}
Expand All @@ -101,35 +99,4 @@ void setup(CombinedIndexBuildItem combinedIndex,
configClassesThatNeedValidation);
}
}

/**
* Use the annotation value
*/
private String determinePrefix(AnnotationInstance configPropertiesInstance) {
String fromAnnotation = getPrefixFromAnnotation(configPropertiesInstance);
if (fromAnnotation != null) {
return fromAnnotation;
}
return getPrefixFromClassName(configPropertiesInstance.target().asClass().name());
}

private String getPrefixFromAnnotation(AnnotationInstance configPropertiesInstance) {
AnnotationValue annotationValue = configPropertiesInstance.value("prefix");
if (annotationValue == null) {
return null;
}
String value = annotationValue.asString();
if (ConfigProperties.UNSET_PREFIX.equals(value) || value.isEmpty()) {
return null;
}
return value;
}

private String getPrefixFromClassName(DotName className) {
String simpleName = className.isInner() ? className.local() : className.withoutPackagePrefix();
return join("-",
withoutSuffix(lowerCase(camelHumpsIterator(simpleName)), "config", "configuration",
"properties", "props"));
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
package io.quarkus.arc.deployment.configproperties;

import static io.quarkus.runtime.util.StringUtil.camelHumpsIterator;
import static io.quarkus.runtime.util.StringUtil.join;
import static io.quarkus.runtime.util.StringUtil.lowerCase;
import static io.quarkus.runtime.util.StringUtil.withoutSuffix;

import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.AnnotationValue;
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName;

import io.quarkus.arc.config.ConfigProperties;
import io.quarkus.builder.item.MultiBuildItem;

public final class ConfigPropertiesMetadataBuildItem extends MultiBuildItem {

private static final DotName CONFIG_PROPERTIES_ANNOTATION = DotName.createSimple(ConfigProperties.class.getName());

private final ClassInfo classInfo;

private final String prefix;

public ConfigPropertiesMetadataBuildItem(AnnotationInstance annotation) {
if (!CONFIG_PROPERTIES_ANNOTATION.equals(annotation.name())) {
throw new IllegalArgumentException(annotation + " is not an instance of " + ConfigProperties.class.getSimpleName());
}

this.classInfo = annotation.target().asClass();
this.prefix = extractPrefix(annotation);
}

public ConfigPropertiesMetadataBuildItem(ClassInfo classInfo, String prefix) {
this.classInfo = classInfo;
this.prefix = sanitisePrefix(prefix);
}

public ClassInfo getClassInfo() {
return classInfo;
}

public String getPrefix() {
return prefix;
}

private String extractPrefix(AnnotationInstance annotationInstance) {
AnnotationValue value = annotationInstance.value("prefix");
return sanitisePrefix(value == null ? null : value.asString());
}

private String sanitisePrefix(String prefix) {
if (isPrefixUnset(prefix)) {
return getPrefixFromClassName(classInfo.name());
}
return prefix;
}

private boolean isPrefixUnset(String prefix) {
return prefix == null || "".equals(prefix.trim()) || ConfigProperties.UNSET_PREFIX.equals(prefix.trim());
}

private String getPrefixFromClassName(DotName className) {
String simpleName = className.isInner() ? className.local() : className.withoutPackagePrefix();
return join("-",
withoutSuffix(lowerCase(camelHumpsIterator(simpleName)), "config", "configuration",
"properties", "props"));
}
}
1 change: 1 addition & 0 deletions extensions/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
<module>spring-web</module>
<module>spring-data-jpa</module>
<module>spring-security</module>
<module>spring-boot-properties</module>

<!-- Security -->
<module>security</module>
Expand Down
42 changes: 42 additions & 0 deletions extensions/spring-boot-properties/deployment/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>quarkus-spring-boot-properties-parent</artifactId>
<groupId>io.quarkus</groupId>
<version>999-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>

<artifactId>quarkus-spring-boot-properties-deployment</artifactId>
<name>Quarkus - Spring Boot - Properties - Deployment</name>

<dependencies>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-spring-boot-properties</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-arc-deployment</artifactId>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-extension-processor</artifactId>
<version>${project.version}</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</build>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
package io.quarkus.spring.boot.properties.deployment;

import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.DotName;
import org.jboss.jandex.IndexView;
import org.springframework.boot.context.properties.ConfigurationProperties;

import io.quarkus.arc.deployment.configproperties.ConfigPropertiesMetadataBuildItem;
import io.quarkus.deployment.annotations.BuildProducer;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
import io.quarkus.deployment.builditem.FeatureBuildItem;

public class ConfigurationPropertiesProcessor {

private static final DotName CONFIGURATION_PROPERTIES_ANNOTATION = DotName
.createSimple(ConfigurationProperties.class.getName());

@BuildStep
public FeatureBuildItem registerFeature() {
return new FeatureBuildItem(FeatureBuildItem.SPRING_BOOT_PROPERTIES);
}

@BuildStep
public void produceConfigPropertiesMetadata(CombinedIndexBuildItem combinedIndex,
BuildProducer<ConfigPropertiesMetadataBuildItem> configPropertiesMetadataProducer) {
combinedIndex.getIndex()
.getAnnotations(CONFIGURATION_PROPERTIES_ANNOTATION)
.stream()
.map(annotation -> createConfigPropertiesMetadata(annotation, combinedIndex.getIndex()))
.forEach(configPropertiesMetadataProducer::produce);
}

private ConfigPropertiesMetadataBuildItem createConfigPropertiesMetadata(AnnotationInstance annotation, IndexView index) {
switch (annotation.target().kind()) {
case CLASS:
return createConfigPropertiesMetadataFromClass(annotation);
case METHOD:
return createConfigPropertiesMetadataFromMethod(annotation, index);
default:
throw new IllegalArgumentException("Unsupported annotation target kind " + annotation.target().kind().name());
}
}

private ConfigPropertiesMetadataBuildItem createConfigPropertiesMetadataFromClass(AnnotationInstance annotation) {
return new ConfigPropertiesMetadataBuildItem(annotation.target().asClass(), getPrefix(annotation));
}

private ConfigPropertiesMetadataBuildItem createConfigPropertiesMetadataFromMethod(AnnotationInstance annotation,
IndexView index) {
return new ConfigPropertiesMetadataBuildItem(index.getClassByName(annotation.target().asMethod().returnType().name()),
getPrefix(annotation));
}

private String getPrefix(AnnotationInstance annotation) {
if (annotation.value() != null) {
return annotation.value().asString();
} else if (annotation.value("prefix") != null) {
return annotation.value("prefix").asString();
}

return null;
}
}
Loading

0 comments on commit b181352

Please sign in to comment.