English | 中文
In theory, Jimmer's runtime only requires Java 8 (if REST service documentation or TypeScript auto-generation features are used and the @FetchBy annotation is used, then Java 11 is needed to compile the code).
However, Java 25 requires a higher version of Gradle, which further affects the Spring-Boot version due to spring-gradle plugin issues, ultimately impacting the actual Java language version that can be adopted. Therefore, examples involving Spring can no longer comprehensively support the full range from Java 8 to Java 25.
To ensure that users with Java 25 can correctly execute these examples, all SpringBoot-related examples use Spring-Boot 3.x and must require Java 17.
This is a collection of examples for Jimmer, containing the following 4 sub-directories:
| Sub-directory | Description |
|---|---|
| java | Examples in Java |
| kotlin | Examples in Kotlin |
| rest-client | java/jimmer-sql/ and kotlin/jimmer-sql-kt/ are two examples of building REST services using Jimmer. Jimmer can automatically generate TypeScript code required by the web client (documentation link). This is a React-based web application that demonstrates how to use the automatically generated TypeScript code by Jimmer. |
| env-with-cache | Jimmer supports powerful caching (documentation link). Developers can specify a Spring profile to run java/jimmer-sql/, kotlin/jimmer-sql-kt/, java/jimmer-sql-graphql/, or kotlin/jimmer-sql-graphql-kt/ with caching support. In this running mode, these examples require an external environment, and this sub-directory is the installation directory for those external environments. |
For more details, please refer to the descriptions in the respective sub-directories.
| Java | Kotlin | Description | Importance |
|---|---|---|---|
| java/jimmer-core | kotlin/jimmer-core-kt | ORM-independent examples, showcasing immer-style immutable objects | ★★★★ |
| java/jimmer-simple | kotlin/jimmer-simple-kt | Using unconditional queries as an example to demonstrate the simplest way to use Jimmer ORM | ★★★★★ |
| java/jimmer-sql | kotlin/jimmer-sql-kt | Quickly build REST services using Jimmer. This example showcases most of Jimmer's features and is the most important and fundamental example | ★★★★ |
| java/jimmer-sql-graphql | kotlin/jimmer-sql-graphql-kt | Quickly build GraphQL services using Jimmer | ★★ |
| java/jimmer-cloud | kotlin/jimmer-cloud-kt | A microservices project based on Spring Cloud, showcasing Jimmer's remote association | ★ |
| java/save-command | kotlin/save-command-kt | A dedicated example for save commands | ★★★ |