GoogleContainerTools Jib 插件中排除目录配置详解

在使用 GoogleContainerTools 的 Jib 插件构建容器镜像时，开发者经常需要精细控制哪些文件应该被包含在最终的镜像中。本文将深入探讨 Jib 插件中排除目录的正确配置方法，帮助开发者解决常见的文件排除问题。

问题背景

Jib 是一个流行的 Java 容器镜像构建工具，它允许开发者在不使用 Docker 的情况下构建容器镜像。在构建过程中，开发者可能需要通过 <extraDirectories> 配置来添加额外的文件到镜像中，同时排除某些不需要的目录和文件。

常见配置误区

许多开发者尝试使用类似以下的配置来排除 target 和 src 目录：

<excludes>
    <exclude>target/**</exclude>
    <exclude>src/**</exclude>
</excludes>

这种配置确实可以排除目录中的内容，但目录本身仍然会被创建在最终的镜像中。这是因为 target/** 模式只会匹配目录下的所有内容，而不会匹配目录本身。

正确配置方法

要实现完全排除目录（包括目录本身），需要同时添加两个排除规则：

<excludes>
    <exclude>target/**</exclude>  <!-- 排除目录内容 -->
    <exclude>target</exclude>     <!-- 排除目录本身 -->
    <exclude>src/**</exclude>     <!-- 排除目录内容 -->
    <exclude>src</exclude>        <!-- 排除目录本身 -->
</excludes>

这种双重排除模式确保了目录及其内容都不会出现在最终的容器镜像中。

实际应用示例

以下是一个完整的 Jib 插件配置示例，展示了如何正确排除多个目录和文件：

<plugin>
    <groupId>com.google.cloud.tools</groupId>
    <artifactId>jib-maven-plugin</artifactId>
    <version>3.4.0</version>
    <configuration>
        <extraDirectories>
            <paths>
                <path>
                    <from>${project.basedir}</from>
                    <into>/app</into>
                    <excludes>
                        <exclude>target/**</exclude>
                        <exclude>target</exclude>
                        <exclude>src/**</exclude>
                        <exclude>src</exclude>
                        <exclude>pom.xml</exclude>
                    </excludes>
                </path>
            </paths>
        </extraDirectories>
    </configuration>
</plugin>

技术原理

Jib 的文件排除功能基于 Ant 风格的模式匹配。理解以下几点有助于正确配置：

1. target 模式只匹配名为 "target" 的文件或目录
2. target/ 或 target/** 匹配 "target" 目录及其所有内容
3. 要完全排除目录，需要同时匹配目录本身和其内容

最佳实践建议

1. 对于需要完全排除的目录，总是同时添加目录名和目录内容两种排除模式
2. 使用相对路径进行匹配，路径相对于 <from> 指定的目录
3. 在开发过程中使用 mvn jib:build -DsendCredentialsOverHttp=true 命令快速验证配置效果
4. 考虑使用不同的目标路径（如 /copied）进行测试，以避免与应用程序的标准目录混淆

通过正确理解和使用 Jib 的排除模式，开发者可以精确控制容器镜像中的文件结构，构建出更精简、更符合需求的容器镜像。