joel-jeremy/externalized-propertiesPublic

NotificationsYou must be signed in to change notification settings
Fork2
Star32

A lightweight and extensible library to resolve application properties from various external sources.

License

Apache-2.0 license

32 stars 2 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 235 Commits
.github		.github
build-logic		build-logic
docs		docs
externalized-properties-core		externalized-properties-core
externalized-properties-database		externalized-properties-database
externalized-properties-git		externalized-properties-git
gradle		gradle
.gitattributes		.gitattributes
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
build.gradle.kts		build.gradle.kts
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
settings.gradle.kts		settings.gradle.kts

Repository files navigation

Externalized Properties

A lightweight and extensible library to resolve application properties from various external sources.

Like the project?

Please consider giving the repository a ⭐. It means a lot! Thank you :)

Twelve Factor Methodology

Externalized Properties was inspired by theThe Twelve Factor Methodology's sectionIII. Config.

The goal of this library is to make it easy for applications to implement configuration best practices by providing easy-to-use APIs as well as providing the flexibility to choose where to store their configurations/properties.

🛠️ Installation

Gradle

implementation"io.github.joel-jeremy.externalized-properties:externalized-properties-core:${version}"// Optional/additional resolversimplementation"io.github.joel-jeremy.externalized-properties:externalized-properties-database:${version}"implementation"io.github.joel-jeremy.externalized-properties:externalized-properties-git:${version}"

Maven

<dependency>  <groupId>io.github.joel-jeremy.externalized-properties</groupId>  <artifactId>externalized-properties-core</artifactId>  <version>${version}</version></dependency><!-- Optional/additional resolvers--><dependency>  <groupId>io.github.joel-jeremy.externalized-properties</groupId>  <artifactId>externalized-properties-database</artifactId>  <version>${version}</version></dependency><dependency>  <groupId>io.github.joel-jeremy.externalized-properties</groupId>  <artifactId>externalized-properties-git</artifactId>  <version>${version}</version></dependency>

🧩 Java 9 Module Names

Externalized Properties jars are published with Automatic-Module-Name manifest attribute:

Core -io.github.joeljeremy.externalizedproperties.core
Database Resolver -io.github.joeljeremy.externalizedproperties.database
Git Resolver -io.github.joeljeremy.externalizedproperties.git

Module authors can use above module names in their module-info.java:

modulefoo.bar {requiresio.github.joeljeremy.externalizedproperties.core;requiresio.github.joeljeremy.externalizedproperties.database;requiresio.github.joeljeremy.externalizedproperties.git;}

🌟 Features

Externalized Properties takes full advantage of Java'sDynamic Proxies (Why Dynamic Proxies?).

✔️ Property Resolution

✔️ Conversion

✔️ Variable Expansion

✔️ Processing

✔️ Profiles

Profile-Specific Configurations

✔️ Ordinal Components

🏎️ Quick Start

Properties are mapped to proxy interface methods by using the@ExternalizedProperty annotation.

(For more advanced scenarios, please see the feature documentations.)

Given an interface:

publicinterfaceApplicationProperties {@ExternalizedProperty("java.home")StringjavaHome();@ExternalizedProperty("encrypted.property")@Decrypt("MyDecryptor")StringencryptedProperty();@ExternalizedProperty("java.version")intjavaVersion();}

We can initialize and start resolving external configurations/properties by:

publicstaticvoidmain(String[]args) {// 1. Configure and build the ExternalizedProperties instance.ExternalizedPropertiesexternalizedProperties =buildExternalizedProperties();// 2. Initialize a proxy using the ExternalizedProperties.ApplicationPropertiesprops =externalizedProperties.initialize(ApplicationProperties.class);// 3. Resolve the properties.StringjavaHome =props.javaHome();StringencryptedProperty =props.encryptedProperty();intjavaVersion =props.javaVersion();}privatestaticExternalizedPropertiesbuildExternalizedProperties() {returnExternalizedProperties.builder()      .defaults()       .resolvers(...)      .processors(...)      .converters(...)       .build();}