Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oswaldobapvicjr/confectory

The modular configuration framework for Java applications
https://github.com/oswaldobapvicjr/confectory

configuration configuration-management deserialization ini java java-library json json-parser jsonpath properties toml xml yaml yaml-parser

Last synced: 20 days ago
JSON representation

The modular configuration framework for Java applications

Host: GitHub
URL: https://github.com/oswaldobapvicjr/confectory
Owner: oswaldobapvicjr
License: apache-2.0
Created: 2019-02-15T18:09:33.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-12-12T07:56:26.000Z (22 days ago)
Last Synced: 2024-12-12T08:33:24.425Z (22 days ago)
Topics: configuration, configuration-management, deserialization, ini, java, java-library, json, json-parser, jsonpath, properties, toml, xml, yaml, yaml-parser
Language: Java
Homepage:
Size: 1.81 MB
Stars: 9
Watchers: 2
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        ![confectory-logo](resources/confectory-logo.svg)

[![Contributors](https://img.shields.io/github/contributors-anon/oswaldobapvicjr/confectory)](https://github.com/oswaldobapvicjr/confectory/graphs/contributors)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/oswaldobapvicjr/confectory/maven.yml?branch=master)](https://github.com/oswaldobapvicjr/confectory/actions/workflows/maven.yml)

[![Coverage](https://img.shields.io/codecov/c/github/oswaldobapvicjr/confectory)](https://codecov.io/gh/oswaldobapvicjr/confectory)

[![License](https://img.shields.io/badge/license-apache%202.0-brightgreen.svg)](https://opensource.org/licenses/Apache-2.0)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-core)

[![Javadoc](https://javadoc.io/badge2/net.obvj/confectory-core/javadoc.svg)](https://javadoc.io/doc/net.obvj/confectory-core)

The modular, multi-format configuration framework for Java applications.

---

## Overview

**Confectory** is a modular framework designed to hide the complexity of handling multiple configuration files for Java applications in general, providing a **reliable** and **fast** API for parsing data from different **sources** (file or URL) in a variety of formats, and allowing data access using a **unified query language**.

````mermaid

flowchart TD

    User(["User"]) -->|"property"| c((("`**confectory**`"))):::larger

    User -->|"xpath"| c

    User -->|"jsonpath"| c

    c-->properties("properties"):::condensed

    c-->ini("INI"):::expanded

    c-->xml("XML"):::expanded

    c-->json("JSON"):::expanded

    c-->yaml("YAML"):::expanded

    c-->toml("TOML"):::expanded

    classDef larger font-size:18pt

    classDef condensed letter-spacing:-0.8px

    classDef expanded letter-spacing:1.2px

````

## Features

- Easy configuration setup via **intuitive API**

- Simple data query using **JSONPath**, **XPath**, or user-defined beans

- Support for the **best providers** available in the community (e.g.: Jackson, GSON)

- **Multiple configuration formats** (e.g.: XML, JSON, or YAML) with custom **precedence levels**

- **Lazy loading** of configuration sources

## Examples

### 1. Load data from a local Properties file in the classpath:

```mermaid

flowchart LR

  subgraph Configuration

    direction LR

    object["☕ Properties"]

  end

  u(["User"]) -- 1️⃣ build --> Configuration

  object -- 2️⃣ load --> file["📄 application.properties"]

  u -- 3️⃣ get...(key) --> Configuration

```

````java

Configuration config = Configuration.builder()

        .source("classpath://application.properties")

        .build();

````

Then access document data using one of the *getter* methods, using keys:

````java

System.out.println(config.getBoolean("web.enable"));

````

### 2. Load data from a JSON document in a Web server:

```mermaid

flowchart LR

  subgraph Configuration

    direction LR

    object["⭕ JSONObject"]

  end

  u(["User"]) -- 1️⃣ build --> Configuration

  object -- 2️⃣ load --> file["🌍 http://time.jsontest.com"]

  u -- 3️⃣ get...(jsonpath) --> Configuration

```

````java

Configuration config = Configuration.builder()

        .source("http://time.jsontest.com")

        .mapper(new JSONObjectMapper())

        .build();

````

Then access document data using [JSONPath expressions](https://goessner.net/articles/JsonPath/index.html#e2):

````java

System.out.println(config.getString("$.time"));

````

> ℹ️ [Find more examples in the wiki.](https://github.com/oswaldobapvicjr/confectory/wiki/Examples/)

## How to include it

Confectory was designed to work with the lowest possible number of transitive dependencies. So, we offer separate modules that can be selected according to the client's needs, optimizing your application:

| Module                                                                                                                                   | Providers         | Properties | XML     | JSON    | YAML    | TOML    |

|------------------------------------------------------------------------------------------------------------------------------------------|-------------------|:----------:|:-------:|:-------:|:-------:|:-------:|

| [**confectory-core**](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-core)                                         | Java + json-smart | ☑    | ☑ | ☑ |         |         |

| [**confectory-datamapper-json-org**](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-datamapper-json-org)           | Json.org          | ☑    | ☑ | ☑ |         |         |

| [**confectory-datamapper-gson**](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-datamapper-gson)                   | Google Gson       |            |         | ☑ |         |         |

| [**confectory-datamapper-jackson2-json**](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-datamapper-jackson2-json) | Jackson 2         |            |         | ☑ |         |         |

| [**confectory-datamapper-jackson2-toml**](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-datamapper-jackson2-toml) | Jackson 2         |            |         | ☑ |         | ☑ |

| [**confectory-datamapper-jackson2-xml**](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-datamapper-jackson2-xml)   | Jackson 2         |            | ☑ | ☑ |         |         |

| [**confectory-datamapper-jackson2-yaml**](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-datamapper-jackson2-yaml) | Jackson 2         |            |         | ☑ | ☑ |         |

| [**confectory-datamapper-saxon12**](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-datamapper-saxon12)             | Saxon-HE 12       |            | ☑ |         |         |         |

| [**confectory-datamapper-snakeyaml**](https://maven-badges.herokuapp.com/maven-central/net.obvj/confectory-datamapper-snakeyaml)         | SnakeYAML         |            |         | ☑ | ☑ |         |

## Contributing

If you want to contribute to the **Confectory** project, check the [issues](http://obvj.net/confectory/issues) page, or write an e-mail to [[email protected]](mailto:[email protected]).

**Confectory** uses [GitHub Actions](https://docs.github.com/actions) for CI/CD.

---

The Confectory logo and the file-factory animation were created with [Inkscape](http://www.inkscape.org) and [Natron](https://natrongithub.github.io), both **free and open-source** Software tools.