This project serves as an initial framework for encapsulating any Java web application, such as those utilizing Springboot, within Electron to create a native executable. The build process exclusively employs Maven, and this repository includes all requisite configurations along with some placeholder files to facilitate a smooth startup.
The inspiration for this project derives significantly from electron-java-app, yet it incorporates several distinct differences:
- The build process utilizes Maven exclusively, with Node being involved indirectly.
- The Electron application build includes an OpenJDK to launch the Java web application.
The primary objective of this project was to explore the feasibility of a novel concept involving Electron, a shipped JDK, and a Java Web Application packaged as a Jar, purely out of personal interest. Before considering its implementation in a production environment, it is crucial to thoroughly assess your specific requirements.
As it stands, the project is not without its drawbacks. Electron inherently consumes significant client-side resources, and the inclusion of both an additional JVM and an embedded web server further exacerbates this issue. This raises the question: Is it necessary to use both a browser and OpenJDK to run a Java Web Application as a desktop application? If the application must remain in Java, alternatives such as Swing or JavaFX could be considered more resource-efficient. However, there are scenarios where this setup could prove beneficial, such as a transitional solution prior to cloud migration.
Potential enhancements to this concept could involve eliminating the OpenJDK by leveraging native images from GraalVM. Although completely removing the browser component is not currently feasible, significant improvements could be made by substituting Electron with Tauri. As Progressive Web Apps (PWAs) become more universally compatible and capable of running local applications, the necessity for a browser might diminish entirely. Presently, the project lacks updater functionality, and logging must be implemented manually, which are areas ripe for development.
master-> Java 17java-8-> Java 8
mvn clean install -Pproduction
The artifacts from the electron build will be put into:
target\electron\springboot-on-electron-darwin-x64target\electron\springboot-on-electron-win32-x64target\electron\springboot-on-electron-linux-x64
When using macOS or Linux, wine is required to build windows (check the maven build for further information).
When using Windows, admin privileges are required to build darwin (check the maven build for further information).
Since not all your users have the right JVM available via classpath an OpenJDK 17 will be packed into the electron builds
When executing mvn clean install -Pproduction by default the windows (x64), darwin (x64) and linux (x64) will be built.
The rest is currently not supported but adding those shouldn't be too hard but some changes will need to be made at the following files: