一键打包插件技术文档

2024-12-29 22:03:50作者：吴年前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'
    }
}