如何自定义gradle bootBuildImage打包的Docker镜像解决日志目录缺失问题

• spring-boot: 3.3.0
• jdk: 21
• gradle: 8.6

我有一个Spring Boot应用，计划使用Docker进行容器化部署（主要用于运行时管理）。该应用采用logback日志框架，配置了两个滚动文件Appender，核心配置如下：

<substitutionProperty name="log.dir" value="/workspace/logs" />

<appender name="SYSTEM" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <File>${log.dir}/system.log</File>
    <append>true</append>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <fileNamePattern>
            ${log.base}/%d{yyyy-MM, aux}/system-%d{yyyy-MM-dd}-%i.log.gz
        </fileNamePattern>
        <maxFileSize>100MB</maxFileSize>
        <totalSizeCap>1GB</totalSizeCap>
        <cleanHistoryOnStart>true</cleanHistoryOnStart>
    </rollingPolicy>

    <encoder charset="UTF-8">
        <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] %-5level [%thread] [%X{traceId}] %file:%line - %msg%n</pattern>
        <charset>UTF-8</charset>
    </encoder>
</appender>

<appender name="AI-SERVICE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <File>${log.dir}/ai-service.log</File>
    <append>true</append>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <fileNamePattern>
            ${log.base}/%d{yyyy-MM, aux}/ai-service-%d{yyyy-MM-dd}-%i.log.gz
        </fileNamePattern>
        <maxFileSize>100MB</maxFileSize>
        <totalSizeCap>1GB</totalSizeCap>
        <cleanHistoryOnStart>true</cleanHistoryOnStart>
    </rollingPolicy>

    <encoder charset="UTF-8">
        <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] %-5level [%thread] [%X{traceId}] %file:%line - %msg%n</pattern>
        <charset>UTF-8</charset>
    </encoder>
</appender>

原本打算通过-v参数将容器内的/workspace/logs目录映射到主机目录，以便直接在主机查看日志文件。但直接使用gradle bootBuildImage打包镜像后，启动容器时会抛出异常：'file /workspace/logs not found'。

方法一：自定义Dockerfile构建镜像 #

1. 在项目根目录创建Dockerfile，内容如下：

# 使用对应版本的JRE基础镜像
FROM eclipse-temurin:21-jre-jammy
# 设置工作目录
WORKDIR /workspace
# 创建日志目录并设置权限（避免运行用户无写入权限）
RUN mkdir -p /workspace/logs && chown -R 1001:1001 /workspace/logs
# 指定运行容器的非root用户（符合容器安全最佳实践）
USER 1001
# 复制构建好的jar包到容器内
COPY build/libs/*.jar app.jar
# 启动命令
ENTRYPOINT ["java","-jar","/workspace/app.jar"]

2. 在build.gradle中配置bootBuildImage使用自定义Dockerfile：

bootBuildImage {
    // 指定自定义Dockerfile路径
    dockerfile = file('Dockerfile')
    // 可选：设置镜像名称
    imageName = 'your-app-image:latest'
}

3. 执行构建命令：./gradlew bootBuildImage，构建完成后启动容器即可。

方法二：通过Gradle插件配置添加目录创建步骤 #

如果不想自定义Dockerfile，可以通过Spring Boot Gradle插件的自定义构建步骤，在镜像构建过程中创建目录：

在build.gradle中添加如下配置：

bootBuildImage {
    builder = 'paketobuildpacks/builder-jammy-base:latest'
    customizers {
        // 添加自定义构建步骤，创建日志目录并设置权限
        customizer { context ->
            context.appendBuildpack {
                it.id = 'custom-dir-creator'
                it.version = '0.0.1'
                it.description = 'Creates log directory'
                it.detect = { true }
                it.build = { process ->
                    process.exec(['mkdir', '-p', '/workspace/logs'])
                    process.exec(['chown', '-R', '1001:1001', '/workspace/logs'])
                }
            }
        }
    }
}

方法三：在应用启动时自动创建目录 #

可以在Spring Boot应用中添加初始化逻辑，确保日志目录存在：

1. 创建一个配置类：

import org.springframework.context.annotation.Configuration;
import javax.annotation.PostConstruct;
import java.io.File;

@Configuration
public class LogDirInitializer {

    @PostConstruct
    public void initLogDir() {
        String logDir = System.getProperty("log.dir", "/workspace/logs");
        File dir = new File(logDir);
        if (!dir.exists()) {
            boolean created = dir.mkdirs();
            if (!created) {
                throw new RuntimeException("Failed to create log directory: " + logDir);
            }
        }
    }
}

2. 启动容器时，如果目录不存在，应用会自动创建（注意需要确保运行用户有创建目录的权限，若使用非root用户，可能需要提前在镜像中赋予对应路径权限）。

额外提示 #

• 若使用容器卷映射，启动容器时命令示例：

docker run -d -v /host/path/to/logs:/workspace/logs your-app-image:latest

• 建议使用非root用户运行容器，避免权限过大带来的安全风险，这也是方法一、二中设置USER 1001的原因。

内容的提问来源于stack exchange，提问作者greyWolf