Spring/spring-pulsar
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add AOT docs (#253)

Browse Source
This commit is contained in:
Chris Bono
2022-12-13 09:16:07 -06:00
committed by GitHub
parent e6afba5065
commit caf8cf71ff
2 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-pulsar-docs/src/main/asciidoc/index.adoc
View File

@@ -39,3 +39,5 @@ In addition to this reference documentation, we recommend a number of other reso
include::application-properties.adoc[leveloffset=+2]
include::non-ga-versions.adoc[leveloffset=+2]
include::native-image.adoc[leveloffset=+2]

23
spring-pulsar-docs/src/main/asciidoc/native-image.adoc Normal file
View File

@@ -0,0 +1,23 @@
[appendix]
[[appendix.native-images]]
= GraalVM Native Image Support
include::attributes.adoc[]
https://www.graalvm.org/native-image/[GraalVM Native Images] are standalone executables that can be generated by processing compiled Java applications ahead-of-time. Native Images generally have a smaller memory footprint and start faster than their JVM counterparts.
.Support
The required https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#core.aot.hints[AOT Runtime Hints] are built-in to Spring for Apache Pulsar so that it can seamlessly be used in native image based Spring applications.
[NOTE]
====
The native image support in Spring for Apache Pulsar has been tested in basic scenarios, and we expect it to "just work". However, it is possible that more advanced use cases could surface the need to add additional runtime hints to your own application. If this occurs please file a {github}/issues[Github issue] with some details.
====
.Next Steps
If you are interested in adding native image support to your own application then an excellent place to start is the https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#native-image[Spring Boot GraalVM Support] section of the Spring Boot reference docs.
Although there is no reference to Spring for Apache Pulsar in the aforementioned guide, you can find specific examples at the following coordinates:
* https://github.com/spring-projects/spring-aot-smoke-tests/tree/main/integration/spring-pulsar[Spring for Apache Pulsar (imperative)]
* https://github.com/spring-projects/spring-aot-smoke-tests/tree/main/integration/spring-pulsar-reactive[Spring for Apache Pulsar (reactive)]