`lein-native-image` 使用手册

lein-native-image 使用手册

lein-native-imageA Leiningen plugin to build GraalVM native images项目地址:https://gitcode.com/gh_mirrors/le/lein-native-image

---

1. 项目目录结构及介绍

lein-native-image 是一个用于通过 Leiningen 构建 GraalVM 原生镜像的插件。以下是该GitHub仓库的基本目录结构及其简介：

.
├── CHANGELOG.md          # 版本更新日志
├── CONTRIBUTING.md       # 贡献指南
├── example               # 示例应用目录，展示如何使用插件
│   ├── ...
├── LICENSE               # 许可证文件，遵循 MIT 协议
├── project.clj           # 插件自身的一个示例Leiningen项目配置
├── README.md             # 主要的项目说明文档
├── src                   # 源代码目录
│   └── leiningen         # 包含插件的主要实现代码
│       └── native_image.clj
└── test                  # 测试目录，包含相关测试用例
    └── ...

• src/leiningen/native_image.clj：这是插件的核心源码，实现了与Leiningen的集成以及原生镜像构建的逻辑。
• example/：含有示范项目，帮助用户理解如何将插件应用于实际项目中。
• project.clj：虽然每个项目会有自己的project.clj，但这里提供了插件示例配置。

2. 项目的启动文件介绍

在使用lein-native-image时，并没有特定的“启动文件”概念，而是依赖于Clojure的应用架构。通常，你需要有一个定义了:main入口点的Clojure项目。例如，在你的project.clj中指定如下的:main字段：

(defproject your-project "version"
  :main ^:skip-aot your-project.core)

当你准备构建原生镜像时，是通过执行lein native-image命令来启动构建过程，而不是直接运行某个启动文件。

3. 项目的配置文件介绍

在lein-native-image的上下文中，主要关注的是project.clj中的配置。你可以在这里添加特定于原生镜像构建的选项：

:native-image {                       ; 在project.clj中加入这个键值对进行配置
  :graal-bin "/path/to/graalvm/bin" ; GraalVM的bin目录路径
  :name "your-native-image-name"   ; 自定义生成的原生镜像名称
  :opts ["任意额外参数"]            ; 可以指定其他native-image CLI参数
}

此外，这些配置也可以在用户的Leiningen配置文件（通常是~/.lein/profiles.clj）中全局设置，以便影响所有项目：

{:user {:plugins ...                 ; 插件列表
        :native-image {...}}}        ; 全局的native-image配置

确保在使用前安装了正确的GraalVM版本，并且注意到从某个版本开始，native-image工具不再默认包含在GraalVM中，可能需要单独安装或指明其路径。

通过以上配置和理解，您可以有效地利用此插件为您的Clojure应用创建原生可执行文件，享受更快的启动速度和更小的部署足迹。

lein-native-imageA Leiningen plugin to build GraalVM native images项目地址:https://gitcode.com/gh_mirrors/le/lein-native-image