This is a proof of concept project, which introduces a minimal example of a Java implementation of the Aspire framework. For an overview of Aspire, see .NET Aspire overview. It aims to provide a Java-idiomatic developer experience that mimics the concepts introduced by the Aspire framework for .net. In particular, it introduces the concept of the AppHost, allowing for Java developers to define infrastructure as code, whilst continuing to rely on the existing Java ecosystem frameworks such as Spring, Micronaut, and Quarkus.
Tip
Aspire4J JavaDoc is published on every push to this repo. It's a great way to see all of the available APIs and how to use them.
This GitHub repository is split into many sub-projects, but they can be broadly categorised as follows:
- Aspire4J:
/aspire4j: The core library that provides the AppHost and the ability to define infrastructure as code./extensions/*: Extensions for the Aspire4J library, providing support for Azure, Spring, etc./aspire4j-maven-tools: A Maven archetype that can be used to create new Aspire4J App Hosts.
- Sample Applications:
- Storage Explorer: Refer to the StorageExplorerReadme for more information.
In this way, the file of most interest is the StorageExplorerAppHost file, which defines the infrastructure as code.
Important
Because this project is a very early proof of concept, azd does not know how to work with Aspire4J projects yet. To work around this, we have developed a fork of azd that can be used to work with Aspire4J projects. Instructions on how to work with this fork should be followed here.
With the new azd installed, you can proceed with running this project locally, and having it be deployed into Azure by following these instructions:
- Clone this repository onto your machine.
- Open a terminal and navigate to the root of the repository.
- Run
azd init, followed byazd up.
Feedback is welcome!
If you want to use Aspire4J in your Java microservice projects, you can! Refer to the Aspire4J Maven Tools sub-project for more information.