首页
/ 一键打包插件技术文档

一键打包插件技术文档

2024-12-29 09:34:29作者:吴年前Myrtle

本文档旨在详细阐述如何使用一款Gradle插件来简化项目的打包过程,将项目及其所有依赖打包成一个可执行的fat-jar。以下是关于如何安装、使用该插件以及API的详细说明。

1. 安装指南

首先,确保您的开发环境中已经安装了Git和JDK 1.6或更高版本。

检出源代码

git clone git://github.com/rholder/gradle-one-jar.git

编译和测试,构建所有jar包

./gradlew build

将所有jar包安装到本地Maven缓存

./gradlew install

2. 项目使用说明

在您的Gradle项目中,按照以下步骤使用该插件:

添加插件到构建脚本

apply plugin: 'gradle-one-jar'

配置插件

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'com.github.rholder:gradle-one-jar:1.0.4'
    }
}

创建OneJar任务

task awesomeFunJar(type: OneJar) {
    mainClass = 'com.github.rholder.awesome.MyAwesomeMain'
}

运行任务

gradle awesomeFunJar

发布构建结果

artifacts {
    archives awesomeFunJar
}

3. 项目API使用文档

以下是一些高级功能的配置示例:

选择One-JAR版本

task awesomeFunJar(type: OneJar) {
    mainClass = 'com.github.rholder.awesome.MyAwesomeMain'
    useStable = false
}

使用自定义One-JAR版本

configurations {
    oneJarLib
}

dependencies {
    oneJarLib files('custom-boot/one-jar-boot-0.97.2-custom.jar')
}

task awesomeFunJar(type: OneJar) {
    mainClass = 'com.github.rholder.awesome.MyAwesomeMain'
    useStable = false
    oneJarConfiguration = configurations.oneJarLib
}

使用自定义依赖配置

configurations {
    fatJarBuild
}

dependencies {
    compile 'org.slf4j:slf4j-api:1.7.2'
    fatJarBuild 'org.slf4j:slf4j-api:1.7.2'
    fatJarBuild 'org.slf4j:slf4j-simple:1.7.2'
}

task awesomeFunJar(type: OneJar) {
    mainClass = 'com.github.rholder.awesome.MyAwesomeMain'
    targetConfiguration = configurations.fatJarBuild
}

添加自定义MANIFEST.MF条目

task awesomeFunJar(type: OneJar) {
    mainClass = 'com.github.rholder.awesome.MyAwesomeMain'
    manifest {
        attributes 'Timestamp': String.valueOf(System.currentTimeMillis())
        attributes 'ContainsXML': 'No'
    }
}

其他高级功能配置

  • 合并基础Jar任务MANIFEST.MF条目
  • 添加自定义根MANIFEST.MF
  • 添加原生库
  • 将任意文件添加到根归档
  • 框架类加载器自定义

4. 项目安装方式

请参考上述“安装指南”部分。

以上是关于使用Gradle一键打包插件的详细技术文档。希望这对您有所帮助!

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
153
1.98 K
kernelkernel
deepin linux kernel
C
22
6
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
503
39
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
331
10
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
146
191
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
992
395
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
193
277
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
938
554
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
75
70