GitLab CI多Job环境下Java/Maven环境无法复用问题排查

问题根源 #

GitLab CI的每个任务（job）都是独立运行的容器实例，setup任务里安装的软件和环境变量不会自动继承到build任务：

• Java是通过apt-get安装到系统目录/usr/lib/jvm的，这个目录不在项目目录下，GitLab CI的cache无法缓存系统级目录，所以build任务的容器里根本没有Java文件。
• Maven是解压到项目目录的，但setup任务的artifacts只指定了./target，没把Maven目录包含进去，build任务拿不到Maven文件。
• 你在build任务里手动export的路径只是设置了环境变量，但对应的文件不存在，自然会报"command not found"。

解决方法 #

方法1：使用预装好Java和Maven的官方镜像（最推荐） #

直接用官方的Maven镜像，里面已经包含了对应版本的Java，不用手动安装：

image: maven:3.9.5-openjdk-17

stages:
  - build

variables:
  MAVEN_CACHE_DIR: $CI_PROJECT_DIR/.m2/repository
  MAVEN_OPTS: "-Dmaven.repo.local=$MAVEN_CACHE_DIR"

cache:
  paths:
    - $MAVEN_CACHE_DIR

build:
  stage: build
  script:
    - java -version
    - mvn --version

这样直接省去setup任务，所有环境都由镜像自带，简单可靠。

方法2：在build任务里重复安装依赖（适合必须用ubuntu镜像的场景） #

既然每个容器独立，就在build任务里也安装Java和Maven：

image: ubuntu:latest

stages:
  - setup
  - build

variables:
  MAVEN_CACHE_DIR: $CI_PROJECT_DIR/.m2/repository
  MAVEN_OPTS: "-Dmaven.repo.local=$MAVEN_CACHE_DIR"
  JAVA_HOME: /usr/lib/jvm/java-17-openjdk-amd64
  MAVEN_HOME: $CI_PROJECT_DIR/apache-maven-3.9.5

cache:
  paths:
    - $MAVEN_CACHE_DIR
    - apache-maven-3.9.5/ # 缓存Maven目录，避免重复下载

setup:
  stage: setup
  script:
    - apt-get update && apt-get install -y wget openjdk-17-jdk
    - mkdir -p $MAVEN_CACHE_DIR
    - if [ ! -d $MAVEN_HOME ]; then wget https://dlcdn.apache.org/maven/maven-3/3.9.5/binaries/apache-maven-3.9.5-bin.tar.gz && tar -xzf apache-maven-3.9.5-bin.tar.gz; fi

build:
  stage: build
  before_script:
    - apt-get update && apt-get install -y openjdk-17-jdk
    - export PATH=$JAVA_HOME/bin:$MAVEN_HOME/bin:$PATH
  script:
    - java -version
    - mvn --version
  dependencies: 
    - setup

这里把Maven目录加入cache，避免重复下载；build任务里重新安装Java，确保容器里有这个软件。

方法3：通过artifacts传递Maven，build任务安装Java #

如果一定要拆分任务，setup任务把Maven目录加入artifacts，build任务安装Java：

image: ubuntu:latest

stages:
  - setup
  - build

variables:
  MAVEN_CACHE_DIR: $CI_PROJECT_DIR/.m2/repository
  MAVEN_OPTS: "-Dmaven.repo.local=$MAVEN_CACHE_DIR"
  JAVA_HOME: /usr/lib/jvm/java-17-openjdk-amd64
  MAVEN_HOME: $CI_PROJECT_DIR/apache-maven-3.9.5

cache:
  paths:
    - $MAVEN_CACHE_DIR

setup:
  stage: setup
  before_script:
    - apt-get update && apt-get install -y wget
  script:
    - mkdir -p $MAVEN_CACHE_DIR
    - wget https://dlcdn.apache.org/maven/maven-3/3.9.5/binaries/apache-maven-3.9.5-bin.tar.gz
    - tar -xzf apache-maven-3.9.5-bin.tar.gz
  artifacts:
    paths:
      - apache-maven-3.9.5/ # 传递Maven目录到build任务

build:
  stage: build
  before_script:
    - apt-get update && apt-get install -y openjdk-17-jdk
    - export PATH=$JAVA_HOME/bin:$MAVEN_HOME/bin:$PATH
  script:
    - java -version
    - mvn --version
  dependencies: 
    - setup

关键注意点 #

• GitLab CI的cache只能缓存项目目录内的文件，系统目录（比如/usr/lib/jvm）无法被缓存，不要在cache paths里加这些。
• artifacts是用来传递任务间的文件的，必须明确指定要传递的目录/文件。
• 每个job的容器是全新的，环境变量、安装的软件都不会自动继承，要么用镜像预装，要么在每个job里重新配置。

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