如何快速上手microservice-kafka:Java + Maven + Docker开发环境搭建与首次运行分步教程
【免费下载链接】microservice-kafkaDemo to show how Apache Kafka can be used for communication between microservices项目地址: https://gitcode.com/gh_mirrors/mi/microservice-kafka
microservice-kafka 是一个用 Java 编写的微服务示例项目,演示如何基于 Apache Kafka 实现订单(Order)、发货(Shipping)和开票(Invoicing)三个微服务之间的消息通信。本文是一份面向新手的分步教程:从安装 JDK 和 Docker,到用 Maven 构建项目、用 Docker Compose 一键启动全部容器,最后访问本地页面完成你的第一笔"跨服务"订单。全程约 20 分钟。
项目长什么样:3个微服务 + Kafka 消息总线
先理解整体结构,跑起来后你才知道在看什么:
| 组件 | 角色 | 本地访问端口 |
|---|---|---|
| Apache httpd | 统一入口,转发 HTTP 请求 | 8080 |
| Order 订单服务 | 创建订单,用KafkaTemplate向 Kafka 发消息 | 8081 |
| Shipping 发货服务 | 用@KafkaListener消费消息,生成发货单 | 8082 |
| Invoicing 开票服务 | 用@KafkaListener消费消息,生成发票 | 8083 |
| Kafka + Zookeeper | 消息队列与协调 | 容器内部 9092 |
| Postgres | 每个微服务各用一个独立数据库 | 容器内部 5432 |
所有订单数据都进入名为order的 topic(5 个分区),发货与开票各自使用独立的消费者组,因此可以横向扩展多实例并行消费。三个微服务的代码分别位于:
- 订单:
microservice-kafka/microservice-kafka-order/ - 发货:
microservice-kafka/microservice-kafka-shipping/ - 开票:
microservice-kafka/microservice-kafka-invoicing/
容器编排定义在 docker/docker-compose.yml,官方运行说明见 HOW-TO-RUN.md。
第一步:安装 Java JDK 与 Docker(2个必备工具)
本项目基于 Java 17 和 Spring Boot 3.0.6(见根 pommicroservice-kafka/pom.xml),需要:
- JDK(不是 JRE):安装后确认命令行能执行
java和javac。 - Docker Community Edition:安装后确认能执行
docker。 - Docker Compose:确认能执行
docker-compose(较新版本的 Docker 中写作docker compose)。 - 内存配置:容器较多,请在 Docker 设置(Preferences → Advanced)中为 Docker 分配4 GB 内存,否则容器可能因内存不足被杀掉。
第二步:克隆仓库并用 Maven 构建(约2分钟)
克隆代码(项目仓库地址:https://gitcode.com/gh_mirrors/mi/microservice-kafka ):
git clone https://gitcode.com/gh_mirrors/mi/microservice-kafka进入microservice-kafka/microservice-kafka目录,执行项目自带的 Maven Wrapper 构建(首次会下载依赖,需要等待):
cd microservice-kafka ./mvnw clean package # Windows 下使用 mvnw.cmd clean package看到BUILD SUCCESS即成功,三个微服务会各生成一个可执行 jar 包。
构建失败怎么办(常见4个原因):
- 端口冲突:测试占用了本机 9092(Kafka)和 8080(HTTP)等端口,请先停掉占用它们的程序;
- 跳过测试构建:
./mvnw clean package -Dmaven.test.skip=true; - 删除主目录下
.m2中的settings.xml(如果其中配置了特殊 Maven 仓库); - 依赖下载异常:删除主目录下
.m2/repository目录后重新构建,让依赖全部重新下载。
第三步:Docker Compose 构建并启动7个容器
进入docker目录,先构建镜像(会拉取基础镜像并安装软件,需要一些时间):
cd docker docker-compose build构建完成后用docker images应能看到mskafka_前缀的镜像:mskafka_order、mskafka_shipping、mskafka_invoicing、mskafka_postgres、mskafka_apache等。
然后后台启动所有容器:
docker-compose up -d首次启动会自动下载 Zookeeper 和 Kafka 的基础镜像。用docker ps检查,应看到 7 个容器全部处于Up状态:zookeeper、kafka、postgres、apache、order、shipping、invoicing。
第四步:首次运行——创建一笔订单,看消息如何流动 🚀
打开浏览器访问http://localhost:8080/,首页有三个入口:
- Order:进入订单服务,选择客户和商品,创建一个订单;
- 稍等片刻,切换到Shipping:可以看到这笔订单已自动生成发货单;
- 再切换到Invoicing:对应发票也已生成。
整个过程中,订单服务并没有直接调用发货和开票服务——它只是把订单以 JSON 格式发到 Kafka 的ordertopic,另外两个服务各自监听并"按需取数":开票服务只读取开票所需字段,发货服务只读取发货所需字段。这正是微服务之间"无代码依赖"通信的典型方式。
验证 Kafka 中确实有消息:可以进入 Kafka 容器查看 topic 内容:
docker exec -it mskafka_kafka_1 /bin/sh kafka-console-consumer.sh --bootstrap-server kafka:9092 --topic order --from-beginning进阶玩法:扩展消费者实例(一行命令)
由于发货和开票使用独立消费者组,你可以直接扩展实例数量来观察分区如何被分配:
docker-compose scale shipping=2 docker logs mskafka_shipping_1日志会显示每个实例分别监听哪些分区、消费哪些记录——这是理解 Kafka 分区与消费者组最直观的方式。
收尾:优雅停止与清理
docker-compose down # 停止所有容器 docker-compose rm # 删除已停止的容器两条命令组合即可回到"干净的全新起点",随时重新up再跑一遍。
排错速查表(5个高频问题)
| 现象 | 原因与解决 |
|---|---|
| 容器启动后立刻退出 | docker ps -a查看已终止容器,docker logs <容器名>看日志 |
日志中出现killed | Docker 内存不足,把内存调到 4 GB 后重启 |
| 构建卡在测试阶段 | 加-Dmaven.test.skip=true跳过测试 |
| 首页 8080 打不开 | 检查mskafka_apache_1容器是否在运行 |
| 微服务页面空白 | 查看对应容器日志,多为连接 Kafka/Postgres 的时序问题,重启该服务即可 |
总结
到这里你已经完成了 microservice-kafka 的完整上手路径:安装 JDK + Docker → Maven 构建 → Docker Compose 启动 → 创建订单验证消息流。项目虽小,却浓缩了微服务架构中最关键的几个实践:消息解耦、JSON 柔性契约、独立数据库、按消费者组扩展。建议下一步阅读 README.md 中"Remarks on the Code"部分,看看订单数据是如何被"复制"而非"共享"到下游服务的——这是理解微服务数据一致性的绝佳切入点。
【免费下载链接】microservice-kafkaDemo to show how Apache Kafka can be used for communication between microservices项目地址: https://gitcode.com/gh_mirrors/mi/microservice-kafka
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考