如何解决项目中的fat jar

明白了,你提到的确实有一定的重复性。针对你的需求,我重新整理了一个清晰、简洁的方案,集中在 如何通过拆分模块合理使用 Maven 的 provided 作用域 来解决 fat JAR 问题。

方案:通过拆分模块和使用 provided 作用域优化 SDK 和 API 的依赖

背景:

你们项目的 fat JAR 问题主要集中在 API 和 SDK 包里。通过将 SDK 和 API 进行模块化,并且合理使用 Maven 的 provided 作用域,可以避免不必要的依赖被打包到最终的 JAR 文件中,从而解决 fat JAR 问题。

1. 模块化项目结构:将 SDK 和 API 拆分为独立模块

目标:通过模块化管理 SDK 和 API,确保每个模块只包含必要的代码和依赖,不将所有依赖都打包在同一个 JAR 文件中。

步骤

  • 拆分 SDK 和 API 为独立模块:你可以将 SDK 和 API 分别拆分为独立的 Maven 模块,分别负责自己的功能。这样,SDK 模块可以单独发布,而 API 模块仅用于定义接口和通用服务,不包含实现代码。

  • API 模块:只包含 API 的定义(接口、DTO 等),不包含实现。这个模块将作为 SDK 模块的依赖。

  • SDK 模块:包含 SDK 的实现,依赖于 API 模块。

目录结构示例

my-project
│
├── api                 # API 模块
│   ├── src
│   └── pom.xml
│
└── sdk                 # SDK 模块
    ├── src
    └── pom.xml

Maven 配置示例

  • API 模块(api/pom.xml
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    
    <groupId>com.example</groupId>
    <artifactId>api</artifactId>
    <version>1.0.0</version>
    <packaging>jar</packaging>
    
    <dependencies>
        <!-- No external dependencies needed here, just API definitions -->
    </dependencies>
</project>
  • SDK 模块(sdk/pom.xml
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>sdk</artifactId>
    <version>1.0.0</version>
    <packaging>jar</packaging>
    
    <dependencies>
        <!-- SDK depends on the API module -->
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>api</artifactId>
            <version>1.0.0</version>
        </dependency>

        <!-- External dependencies such as Spring, Servlet API -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>4.0.1</version>
            <scope>provided</scope> <!-- Container provides this -->
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.3.10</version>
            <scope>provided</scope> <!-- Provided by external environment -->
        </dependency>
    </dependencies>
</project>

解释:

  • 拆分模块:通过将 SDK 和 API 拆分为独立模块,SDK 模块只依赖 API 模块,避免了所有依赖都被打包在同一个 JAR 文件中的问题。
  • 减少不必要的依赖:只将 SDK 和 API 需要的依赖包含在 SDK 模块中,并将这些依赖的 scope 设置为 provided,避免它们被打包进 SDK JAR 中。

2. 使用 provided 作用域来优化 SDK 和 API 依赖

目标:确保在编译和测试时需要的依赖,在打包时不会被包含在最终的 JAR 文件中。

步骤

  • 标记容器提供的依赖:对于那些由外部容器或环境提供的依赖(例如 Servlet API、JSP、Spring),使用 provided 作用域来标记它们。

  • SDK 中使用 provided 作用域:如果你的 SDK 依赖于一些框架(如 Spring 或 Servlet API),并且这些框架在运行时已经由外部容器提供,那么这些依赖应设置为 provided,这样就不会被打包进 JAR 文件中。

示例配置
在 SDK 模块中:

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>4.0.1</version>
    <scope>provided</scope> <!-- Servlet API 由容器提供 -->
</dependency>

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>5.3.10</version>
    <scope>provided</scope> <!-- Spring 由应用服务器提供 -->
</dependency>

解释:

  • provided 作用域:表示这些依赖只在编译时可用,运行时由外部容器提供。这样,它们不会被打包进 SDK 模块的 JAR 文件中。

  • 减少 fat JAR 大小:通过使用 provided 作用域,容器提供的依赖(如 Servlet API、Spring 等)将不会被打包进 JAR 文件中,减小了 SDK 的体积。


3. 结合 spring-boot-maven-pluginprovided 作用域避免 fat JAR

目标:如果你正在使用 Spring Boot,可以通过配置 Spring Boot Maven 插件,避免不必要的依赖被打包进最终的 JAR 文件中。

步骤

  • pom.xml 中配置 spring-boot-maven-plugin,并设置 includeDependenciesfalse,确保所有依赖不会被打包进 JAR 文件中。

示例配置

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <version>2.5.0</version>
            <configuration>
                <!-- 不包括 SDK 和 API 依赖 -->
                <includeDependencies>false</includeDependencies>
            </configuration>
        </plugin>
    </plugins>
</build>

解释:

  • spring-boot-maven-plugin 配置:通过设置 includeDependencies=false,Spring Boot 插件会跳过将 SDK 和 API 的依赖打包进最终的 JAR 文件中,只将应用的代码打包。

  • 减小 fat JAR:最终的 JAR 文件只包含应用代码,而不包含 SDK 和 API 中的外部依赖,从而避免生成 fat JAR。


总结

针对你的 SDK 和 API 模块的 fat JAR 问题,以下是优化的主要步骤:

  1. 模块化项目结构:将 SDK 和 API 拆分为独立模块,避免将所有代码和依赖打包进同一个 JAR 文件中。
  2. 使用 provided 作用域:对于由容器提供的依赖(如 Servlet API、Spring 等),在 SDK 模块中使用 provided 作用域,确保它们不会被打包进 JAR 文件中。
  3. Spring Boot 插件配置:通过 spring-boot-maven-plugin 配置 includeDependencies=false,避免将所有依赖打包进 JAR 文件中,最终减小 JAR 文件体积。

通过这些优化,你将能够有效避免 fat JAR 问题,减小 SDK 和 API 的体积,并且保持模块的清晰和可维护性。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,744评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,505评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,105评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,242评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,269评论 6 389
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,215评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,096评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,939评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,354评论 1 311
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,573评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,745评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,448评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,048评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,683评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,838评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,776评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,652评论 2 354

推荐阅读更多精彩内容