[FEATURE REQ] Support building native images for Spring Cloud Azure using Spring Native

moarychan commented 2 years ago

Context

More and more Spring Boot applications are pursuing an instant startup, instant peak performance, and reduced memory consumption. The Spring team has also helped to provide the Spring Native framework, and it will be officially GA soon, it is necessary for us to support Spring Native for all Spring Cloud Azure libraries.

The Azure SDK level is ready to support the Graal VM native image compiler, although it has not released any version. But there is no available solution for Spring Cloud Azure users to build Native Image when using Spring Cloud Azure libraries. And some Spring Cloud Azure users have proposed to build applications based on Spring Native: https://github.com/Azure/azure-sdk-for-java/issues/20489.

Goal

Based on JDK 11, the latest Spring Native (the current version is 0.11.3), and Graal VM SDK (The current version is 22.0.0.2) versions, the beta version should be provided as early as possible to support. Include the following:

Support azure-aot-graalvm-support, the azure-aot-graalvm-support-netty will be later. Depends on dependency azure-aot-graalvm-support to enable the native image compilation in Azure SDK level.
Does not affect the existing code logic, supports existing Spring Cloud Azure libraries, and can quickly support newly added libraries. Add a new module called spring-cloud-azure-native-configuration, which targets the compilation in the Spring Cloud Azure level, it will combine the dependency spring-native to compile a native image based on Spring Cloud Azure application.
Samples for Azure Native Support
- A new sample to demo how to build a native executable or a container containing a native executable image.
- Make existing samples support Spring Native to build images, and generate a native executable or a container containing a native executable.
Add a section for Spring Native support in Spring Cloud Azure reference docs A new section called Spring Native Support will be added, it will introduce how to enable the Azure Native support.
Add a tutorial page of Spring Native for Spring Cloud Azure support in MS docs It will introduce how to build a spring boot application using spring-cloud-azure-starter-storage-blob, spring-cloud-azure-native-configuration, and spring-native, and generate a native executable or a container containing a native executable.
Support adding spring native capability for Spring Cloud Azure libraries in Spring Initializr Spring developers can add Azure Support, Spring Native, Azure Native Support, in Spring Initializr, then the application can be built to a native executable or a container containing a native executable.

Solution

Spring Cloud Azure libraries will follow the Spring Native pattern to build a native executable image, a configuration module called spring-cloud-azure-native-configuration is added to find out the additional configuration for Spring Cloud Azure level, this module is required to combine the dependency Spring Native to build a native image. It needs to meet the following requirements:

It shouldn't have any effect on the Spring Cloud Azure libraries when you don't build a native image.
Use @NativeHint to configure all classes that need to be explicitly declared.
Each library's native configuration should be independent of its root package, the configuration is only enabled when the corresponding library is in the current classpath.
The Azure Native Configuration and Spring Native should be enabled together.

stliu commented 2 years ago

Support adding spring native capability for Spring Cloud Azure libraries in Spring Initializr Spring developers can add Azure Support, Spring Native, Azure Native Support, in Spring Initializr, then the application can be built to a native executable or a container containing a native executable.

About the experience on Spring Initializr, I don' think we need a Azure Native Support in spring initialize. But we need to make sure when a user chooses "Spring Native" and "Azure Support", the generated pom is correctly confined.

Since by choose above two dependencies, it is clearly meaning that the user wants to

Build a Spring Native application
Use Spring Cloud Azure

Spring Initializr is scenario based, we don't want to break this experience

stliu commented 2 years ago

@moarychan here is my thoughts of the goal of this feature

Goal

Users should be able to use Spring Cloud Azure within their Spring Native enabled applications.
Users should be able to migrate their existing spring boot application (Spring Cloud Azure included) to Spring Native ones easily, idealy by simply add a dependency or configuration properties change, should not require code change
When user is creating new project on https://start.spring.io, the generated project should be spring native ready if 'Spring Native' and 'Spring Cloud Azure' are listed as project dependency
Documentation - We should provide document about how to use Spring Cloud Azure within Spring Native environment.
Toturial - user should be able to follow a toturial to build a spring cloud azure application using one or more azure service

Netyyyy commented 2 years ago

close in #28158

moarychan commented 2 years ago

Add a perf data reference, it's tested through Spring Cloud Azure Starter Blob and Azure Storage Blob Emulator:

Env info: Windows 11, i5-1135G7 @ 2.4GHz, 16G; Jdk 11.0.15; Graal VM CE-Java11-22.0.0.2; Azure Storage Blob Emulator; Spring Boot 2.6.6; Spring Native 0.11.4; Spring Cloud Azure Starter Storage Blob 4.1.0;

Azure / azure-sdk-for-java