«

2022年7月13日 Gradle项目打包相关配置

时间:2022-7-13     作者:Mahalalel     分类: Gradle


近期,小编在用Gradle构建工具来开发项目,期间遇到了打包的问题。
众所周知,SpringBoot项目可以通过配置Maven的打包插件,就可以很轻松构建依赖jar与可执行jar。

特此记录下Gradle项目的打包配置

一、SpringBoot可执行jar打包

1.1、配置打包插件

首先需要在项目根目录下的build.gradle文件中配置插件

plugins {
    id "org.springframework.boot" version "2.4.2"
}

1.2、指定使用插件 并配置main方法入口类

配置指定使用的插件,尤其是在多模块工程下

// 配置所有项目公共的内容
allprojects {
    // springboot项目打jar包
    apply plugin: "org.springframework.boot"

    // 指定main方法所在的class
    springBoot {
        mainClass = "com.xxx.xxx.xxx.XxxXxxApplication"
    }
}

1.3、子模块配置依赖jar

启动部署模块,需要依赖其他模块,故此,在部署模块的依赖module的build.gradle中配置

jar {
    enabled = true
}

1.4、打包

打开IDEA开发工具中找到 gradle 窗口
在启动类所在模块中找到 Tasks ==>> build ==>> bootJar

Gradle打Jar包

点击运行,即可在模块下 build ==>> libs ==>> xxx.jar

Gradle打包后目录

二、SpringBoot项目war类型打包

2.1、指定使用插件

配置使用的插件

allprojects {

    apply plugin: 'war'
    // 指定main方法所在的class
    springBoot {
        mainClass = "com.xxx.xxx.xxx.XxxXxxApplication"
    }
}

2.2、新建Initializer类并继承SpringBootServletInitializer,重写configure

注:Initializer类应该与项目的启动类在同一级目录下

package com.xxxx.demo;

import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

public class ServletInitializer extends SpringBootServletInitializer {
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
                                    //Application的类名
        return application.sources(XxxApplication.class);
    }
}

2.3、同1.3

2.4、打war包

打开IDEA开发工具中找到 gradle 窗口
在启动类所在模块中找到 Tasks ==>> build ==>> bootWar
Gradle打包命令
点击运行,即可在模块下 build ==>> libs ==>> xxx.war

三、SpringBoot依赖jar包打包

在build.gradle中加入以下配置

jar {
    enabled = true
    // 分类器(打包成功后的会以 `项目名-dependency` 为包名)
    classifier = "dependency"
}

执行jar任务,即可将项目打成依赖包
SpringBoot生成依赖jar包

标签: Gradle jar包 war包