Java-Anwendungen erstellen, testen und containerisieren

Auf dieser Seite wird erläutert, wie Sie mit Cloud Build Java-basierte Anwendungen erstellen, testen und containerisieren, Container-Images in Artifact Registry hochladen und die Build-Herkunft generieren.

Hinweise

maven- oder gradle-Image verwenden

Sie können Cloud Build so konfigurieren, dass Java-Anwendungen mit dem maven-Image oder dem gradle-Image aus Docker Hub erstellt werden.

Zum Ausführen der Aufgaben im maven- oder gradle-Image geben Sie die URL des Images und die getaggte Version des Images im Feld name Ihrer Build-Konfigurationsdatei an. Wenn Sie das Image-Tag nicht angeben, verwendet Cloud Build standardmäßig das latest-Image. Cloud Build startet das in name angegebene Image mithilfe des Standardeinstiegspunkts des Images. Wenn Sie den Standardeinstiegspunkt überschreiben und maven oder gradle als Einstiegspunkt aufrufen möchten, geben Sie mvn oder gradle im Feld entrypoint an.

Die folgende Build-Konfigurationsdatei legt entrypoint für das maven- oder gradle-Image fest und gibt die Version des Build-Tools aus:

maven 

  steps:
  - name: maven:3.3-jdk-8
    entrypoint: mvn
    args: ['--version']

gradle 

  steps:
  - name: gradle:5.6.2-jdk8
    entrypoint: gradle
    args: ['--version']

Java-Builds konfigurieren

  1. Erstellen Sie im Stammverzeichnis des Projekts eine Build-Konfigurationsdatei mit dem Namen cloudbuild.yaml.

  2. Tests ausführen: maven und gradle stellen maven test und gradle test bereit. Dadurch werden die Abhängigkeiten heruntergeladen, die Anwendungen werden erstellt und alle in Ihrem Quellcode angegebenen Tests werden ausgeführt. Im Feld args eines Build-Schritts wird eine Liste von Argumenten abgerufen und an das Image übergeben, auf das im Feld name verwiesen wird.

    Fügen Sie in Ihrer Build-Konfigurationsdatei dem Feld args den Wert test hinzu, um test innerhalb von maven und gradle aufzurufen:

    maven 

     steps:
 - name: maven:3.3-jdk-8
   entrypoint: mvn
   args: ['test']

    gradle 

     steps:
 - name: gradle:5.6.2-jdk8
   entrypoint: gradle
   args: ['test']

  3. Anwendung verpacken: Geben Sie im Feld args den Befehl package an, um Ihre Anwendung in einer JAR-Datei für das maven-Image zu verpacken. Mit dem Befehl package wird in /workspace/target/ eine JAR-Datei erstellt.

    Geben Sie im Feld args den Befehl assemble ein, um Ihre Anwendung in einer JAR-Datei für das gradle-Image zu verpacken. Mit dem Befehl assemble wird in workspace/build/libs eine JAR-Datei erstellt.

    Mit dem folgenden Build-Schritt wird Ihre Java-Anwendung verpackt:

    maven 

     steps:
 - name: maven:3.3-jdk-8
   entrypoint: mvn
   args: ['package','-Dmaven.test.skip=true']

    gradle 

    steps:
- name: gradle:5.6.2-jdk8
  entrypoint: gradle
  args: ['assemble']

  4. Anwendung containerisieren: Cloud Build bietet ein vordefiniertes Docker-Image, mit dem Sie Ihre Java-Anwendung containerisieren können. So können Sie Ihre Java-Anwendung in der Build-Konfigurationsdatei containerisieren:

    • Fügen Sie das Feld name hinzu und geben Sie das vordefinierte Docker-Image unter gcr.io/cloud-builders/docker an.
    • Fügen Sie das Feld args hinzu und geben Sie die build-Argumente an, einschließlich des Namens des zu erstellenden Container-Images und des Pfads zu Ihrem Build-Artefakt.
    • Fügen Sie das Feld images hinzu, um das erstellte Container-Image per Push an Artifact Registry zu übertragen und Informationen zur Build-Herkunft zu generieren. Wenn Sie das Feld images nicht verwenden, zeichnet Cloud Build keine Informationen zur Herkunft auf. Wenn Sie beispielsweise den Build-Schritt docker push verwenden, um Images in Artifact Registry hochzuladen, sind mit Ihrem Build keine Informationen zur Herkunft verknüpft.

    Mit dem folgenden Build-Schritt wird Ihre Anwendung containerisiert, das Container-Image per Push an Artifact Registry übertragen und Informationen zur Build-Herkunft generiert.

    maven 

    steps:
- name: gcr.io/cloud-builders/docker
  args: ['build', '-t', 'location-docker.pkg.dev/project-id/repository/image', '--build-arg=JAR_FILE=target/build-artifact', '.']
images: ['location-docker.pkg.dev/project-id/repository/image']

    gradle 

    steps:
- name: gcr.io/cloud-builders/docker
  args: ['build', '-t', 'location-docker.pkg.dev/project-id/repository/image', '--build-arg=JAR_FILE=build/libs/build-artifact', '.']
images: ['location-docker.pkg.dev/project-id/repository/image']

    Wobei:

    • location: der regionale oder multiregionale Standort des Repositorys.
    • project-id: die ID Ihres Google Cloud-Projekts.
    • repository: der Name Ihres Artifact Registry-Repositorys.
    • image ist der Name Ihres Container-Images.
    • build-artifact ist der Name der JAR-Datei, die aus dem Build-Schritt erstellt wurde.

  5. Optional: Herkunft für regionale Builds aktivieren

    Wenn Sie einen regionalen Build verwenden, fügen Sie in der Build-Konfigurationsdatei das Feld requestedVerifyOption in options ein. Legen Sie den Wert auf VERIFIED fest, um das Generieren von Herkunftsmetadaten zu aktivieren. Wenn Sie requestedVerifyOption: VERIFIED nicht hinzufügen, generiert Cloud Build die Herkunft nur für globale Builds.

    options:
  requestedVerifyOption: VERIFIED

  6. Build starten: Wenn die Build-Konfigurationsdatei fertig erstellt ist, starten Sie den Build. Geben Sie dazu den folgenden Befehl in Ihr Terminal ein:

    gcloud builds submit --region=REGION --config config-file-path source-directory

    Wobei:

    • config-file-path ist der Pfad zu Ihrer Build-Konfigurationsdatei. In diesem Beispiel hat die Build-Konfigurationsdatei den Namen cloudbuild.yaml.
    • source-directory ist der Pfad oder die URL zu Ihrem Quellcode.
    • REGION: Eine der unterstützten Build-Regionen.

    Wenn Sie config-file-path und source-directory im Befehl gcloud builds submit nicht angeben, geht Cloud Build davon aus, dass sich die Konfigurationsdatei und der Quellcode im aktuellen Arbeitsverzeichnis befinden.

    Sobald der Build abgeschlossen ist, können Sie die Repository-Details in Artifact Registry ansehen.

    Sie können auch Build-Metadaten aufrufen und Herkunft prüfen, um Ihre Softwarelieferkette zu schützen.

Codebeispiele

Hier sind einige Beispiel-Repositories, die Sie zum Erstellen von Java-Anwendungen verwenden können. Jede enthält eine Beispielanwendung und eine Build-Konfigurationsdatei, damit Sie die Anwendung erstellen und testen können:

  • maven-example: Eine Java-Anwendung und eine Beispiel-Build-Konfigurationsdatei, um die Anwendung mit mvn zu erstellen und zu testen.
  • gradle-example Eine Java-Anwendung und eine Beispiel-Build-Konfigurationsdatei, um die Anwendung mit gradle zu erstellen und zu testen.

Nächste Schritte