使用容器进行Java开发

目录

先决条件

按照步骤将您的应用程序容器化，请参阅 Containerize your app。

概述

在本节中，您将逐步设置一个本地开发环境，用于您在上一节中容器化的应用程序。这包括：

  • 添加本地数据库并持久化数据
  • 创建一个开发容器以连接调试器
  • 配置Compose以在您编辑和保存代码时自动更新正在运行的Compose服务

添加本地数据库并持久化数据

你可以使用容器来设置本地服务，比如数据库。在本节中，你将更新docker-compose.yaml文件来定义一个数据库服务和一个用于持久化数据的卷。此外，这个特定的应用程序使用系统属性来定义数据库类型，因此你需要更新Dockerfile以在启动应用程序时传递系统属性。

在克隆的仓库目录中，在IDE或文本编辑器中打开docker-compose.yaml文件。您的Compose文件有一个示例数据库服务，但需要根据您的独特应用程序进行一些更改。

在docker-compose.yaml文件中，您需要执行以下操作：

  • 取消注释所有数据库指令。你现在将使用数据库服务而不是本地存储来处理数据。
  • 移除顶层的 secrets 元素以及 db 服务内部的元素。此示例使用环境变量来存储密码，而不是使用 secrets。
  • 从db服务中移除user元素。此示例在环境变量中指定了用户。
  • 更新数据库环境变量。这些变量由Postgres镜像定义。有关更多详细信息，请参阅Postgres官方Docker镜像。
  • 更新db服务的健康检查测试并指定用户。默认情况下，健康检查使用root用户而不是你定义的petclinic用户。
  • 在server服务中添加数据库URL作为环境变量。这将覆盖在spring-petclinic/src/main/resources/application-postgres.properties中定义的默认值。

以下是更新后的 docker-compose.yaml 文件。所有注释已被移除。

services:
  server:
    build:
      context: .
    ports:
      - 8080:8080
    depends_on:
      db:
        condition: service_healthy
    environment:
      - POSTGRES_URL=jdbc:postgresql://db:5432/petclinic
  db:
    image: postgres
    restart: always
    volumes:
      - db-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=petclinic
      - POSTGRES_USER=petclinic
      - POSTGRES_PASSWORD=petclinic
    ports:
      - 5432:5432
    healthcheck:
      test: ["CMD", "pg_isready", "-U", "petclinic"]
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  db-data:

在IDE或文本编辑器中打开Dockerfile。在ENTRYPOINT指令中， 更新指令以传入spring-petclinic/src/resources/db/postgres/petclinic_db_setup_postgres.txt 文件中指定的系统属性。

- ENTRYPOINT [ "java", "org.springframework.boot.loader.launch.JarLauncher" ]
+ ENTRYPOINT [ "java", "-Dspring.profiles.active=postgres", "org.springframework.boot.loader.launch.JarLauncher" ]

保存并关闭所有文件。

现在，运行以下docker compose up命令来启动您的应用程序。

$ docker compose up --build

打开浏览器并在 http://localhost:8080查看应用程序。您应该会看到一个简单的宠物诊所应用程序。浏览应用程序。导航到兽医并通过能够列出兽医来验证应用程序是否已连接到数据库。

在终端中，按ctrl+c停止应用程序。

用于开发的Dockerfile

你现在拥有的Dockerfile非常适合一个小型、安全的生产镜像，只包含运行应用程序所需的组件。在开发时，你可能需要一个具有不同环境的不同镜像。

例如，在开发镜像中，您可能希望设置镜像以启动应用程序，以便您可以连接调试器到正在运行的Java进程。

与其管理多个Dockerfile，您可以添加一个新阶段。您的Dockerfile可以生成一个准备用于生产的最终镜像以及一个开发镜像。

将您的Dockerfile内容替换为以下内容。

# syntax=docker/dockerfile:1

FROM eclipse-temurin:21-jdk-jammy as deps
WORKDIR /build
COPY --chmod=0755 mvnw mvnw
COPY .mvn/ .mvn/
RUN --mount=type=bind,source=pom.xml,target=pom.xml \
    --mount=type=cache,target=/root/.m2 ./mvnw dependency:go-offline -DskipTests

FROM deps as package
WORKDIR /build
COPY ./src src/
RUN --mount=type=bind,source=pom.xml,target=pom.xml \
    --mount=type=cache,target=/root/.m2 \
    ./mvnw package -DskipTests && \
    mv target/$(./mvnw help:evaluate -Dexpression=project.artifactId -q -DforceStdout)-$(./mvnw help:evaluate -Dexpression=project.version -q -DforceStdout).jar target/app.jar

FROM package as extract
WORKDIR /build
RUN java -Djarmode=layertools -jar target/app.jar extract --destination target/extracted

FROM extract as development
WORKDIR /build
RUN cp -r /build/target/extracted/dependencies/. ./
RUN cp -r /build/target/extracted/spring-boot-loader/. ./
RUN cp -r /build/target/extracted/snapshot-dependencies/. ./
RUN cp -r /build/target/extracted/application/. ./
ENV JAVA_TOOL_OPTIONS -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:8000
CMD [ "java", "-Dspring.profiles.active=postgres", "org.springframework.boot.loader.launch.JarLauncher" ]

FROM eclipse-temurin:21-jre-jammy AS final
ARG UID=10001
RUN adduser \
    --disabled-password \
    --gecos "" \
    --home "/nonexistent" \
    --shell "/sbin/nologin" \
    --no-create-home \
    --uid "${UID}" \
    appuser
USER appuser
COPY --from=extract build/target/extracted/dependencies/ ./
COPY --from=extract build/target/extracted/spring-boot-loader/ ./
COPY --from=extract build/target/extracted/snapshot-dependencies/ ./
COPY --from=extract build/target/extracted/application/ ./
EXPOSE 8080
ENTRYPOINT [ "java", "-Dspring.profiles.active=postgres", "org.springframework.boot.loader.launch.JarLauncher" ]

保存并关闭Dockerfile。

在Dockerfile中，您基于extract阶段添加了一个标记为development的新阶段。在此阶段中，您将提取的文件复制到一个公共目录，然后运行一个命令来启动应用程序。在命令中，您暴露了端口8000，并为JVM声明了调试配置，以便您可以附加调试器。

使用Compose进行本地开发

当前的Compose文件不会启动您的开发容器。为此，您必须更新您的Compose文件以针对开发阶段。同时，更新服务器服务的端口映射以提供调试器的访问权限。

打开 docker-compose.yaml 并在文件中添加以下指令。

services:
  server:
    build:
      context: .
      target: development
    ports:
      - 8080:8080
      - 8000:8000
    depends_on:
      db:
        condition: service_healthy
    environment:
      - POSTGRES_URL=jdbc:postgresql://db:5432/petclinic
  db:
    image: postgres
    restart: always
    volumes:
      - db-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=petclinic
      - POSTGRES_USER=petclinic
      - POSTGRES_PASSWORD=petclinic
    ports:
      - 5432:5432
    healthcheck:
      test: ["CMD", "pg_isready", "-U", "petclinic"]
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  db-data:

现在，启动您的应用程序并确认它正在运行。

$ docker compose up --build

最后，测试你的API端点。运行以下curl命令：

$ curl  --request GET \
  --url http://localhost:8080/vets \
  --header 'content-type: application/json'

您应该会收到以下响应：

{
  "vetList": [
    {
      "id": 1,
      "firstName": "James",
      "lastName": "Carter",
      "specialties": [],
      "nrOfSpecialties": 0,
      "new": false
    },
    {
      "id": 2,
      "firstName": "Helen",
      "lastName": "Leary",
      "specialties": [{ "id": 1, "name": "radiology", "new": false }],
      "nrOfSpecialties": 1,
      "new": false
    },
    {
      "id": 3,
      "firstName": "Linda",
      "lastName": "Douglas",
      "specialties": [
        { "id": 3, "name": "dentistry", "new": false },
        { "id": 2, "name": "surgery", "new": false }
      ],
      "nrOfSpecialties": 2,
      "new": false
    },
    {
      "id": 4,
      "firstName": "Rafael",
      "lastName": "Ortega",
      "specialties": [{ "id": 2, "name": "surgery", "new": false }],
      "nrOfSpecialties": 1,
      "new": false
    },
    {
      "id": 5,
      "firstName": "Henry",
      "lastName": "Stevens",
      "specialties": [{ "id": 1, "name": "radiology", "new": false }],
      "nrOfSpecialties": 1,
      "new": false
    },
    {
      "id": 6,
      "firstName": "Sharon",
      "lastName": "Jenkins",
      "specialties": [],
      "nrOfSpecialties": 0,
      "new": false
    }
  ]
}

连接调试器

您将使用IntelliJ IDEA自带的调试器。您可以使用该IDE的社区版本。在IntelliJ IDEA中打开您的项目，转到运行菜单，然后选择编辑配置。添加一个新的远程JVM调试配置，类似于以下内容：

Java Connect a Debugger

设置一个断点。

打开 src/main/java/org/springframework/samples/petclinic/vet/VetController.java 并在 showResourcesVetList 函数内部添加一个断点。

要开始调试会话，请选择运行菜单，然后选择调试NameOfYourConfiguration。

Debug menu

您现在应该可以在您的Compose应用程序的日志中看到连接。

Compose log file

您现在可以调用服务器端点了。

$ curl --request GET --url http://localhost:8080/vets

你应该已经看到代码在标记的行上中断，现在你可以像平常一样使用调试器。你还可以检查和监视变量，设置条件断点，查看堆栈跟踪以及执行其他一系列操作。

Debugger code breakpoint

在终端中按下 ctrl+c 来停止你的应用程序。

自动更新服务

使用Compose Watch在您编辑和保存代码时自动更新正在运行的Compose服务。有关Compose Watch的更多详细信息，请参阅使用Compose Watch。

在IDE或文本编辑器中打开您的docker-compose.yaml文件，然后添加Compose Watch指令。以下是更新后的docker-compose.yaml文件。

services:
  server:
    build:
      context: .
      target: development
    ports:
      - 8080:8080
      - 8000:8000
    depends_on:
      db:
        condition: service_healthy
    environment:
      - POSTGRES_URL=jdbc:postgresql://db:5432/petclinic
    develop:
      watch:
        - action: rebuild
          path: .
  db:
    image: postgres
    restart: always
    volumes:
      - db-data:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=petclinic
      - POSTGRES_USER=petclinic
      - POSTGRES_PASSWORD=petclinic
    ports:
      - 5432:5432
    healthcheck:
      test: ["CMD", "pg_isready", "-U", "petclinic"]
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  db-data:

运行以下命令以使用Compose Watch运行您的应用程序。

$ docker compose watch

打开一个网页浏览器并在 http://localhost:8080查看应用程序。你应该会看到Spring Pet Clinic的主页。

现在，您本地机器上应用程序源文件的任何更改将自动反映在运行的容器中。

在IDE或文本编辑器中打开spring-petclinic/src/main/resources/templates/fragments/layout.html，并通过添加感叹号来更新Home导航字符串。

-   <li th:replace="~{::menuItem ('/','home','home page','home','Home')}">
+   <li th:replace="~{::menuItem ('/','home','home page','home','Home!')}">

将更改保存到layout.html，然后您可以继续开发，同时容器会自动重建。

容器重建并运行后，刷新 http://localhost:8080 然后验证菜单中是否出现了 Home!。

在终端中按下 ctrl+c 以停止 Compose Watch。

摘要

在本节中，您了解了如何在本地运行数据库并持久化数据。您还创建了一个包含JDK的开发镜像，允许您附加调试器。最后，您设置了Compose文件以暴露调试端口，并配置了Compose Watch以实时重新加载您的更改。

相关信息：

下一步

在下一节中，您将了解如何在Docker中运行单元测试。

Run your Java tests »