Files
kenaito-lab/demo/app/spring-war8/README.md
T

91 lines
5.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# spring-war8 示例
演示如何用 `compile-maven3-jdk8` 打出 **war 包**,再部署到外置 Tomcat 9 运行。与
[`demo/app/springboot-jar8`](../springboot-jar8/README.md) 对照:应用代码几乎一样,区别只在打包方式与运行容器。这是 Java 8 版本的 `spring-war17` 对照示例。
> Java 8 era 用 **Spring 5.3 + javax.servlet + Tomcat 9**(Servlet 4.0)。Spring 6 / Jakarta EE 要求 JDK 17+,只适用于 `spring-war17`;Tomcat 9(`javax.servlet`)跑不了 war17 的包,反之 Tomcat 10(`jakarta.servlet`)也跑不了本示例。
| 阶段 | 镜像 | 说明 |
| --- | --- | --- |
| 编译 | `registry.cn-shanghai.aliyuncs.com/odboy/kenaito:compile-maven3-jdk8` | JDK 8(Dragonwell)+ Maven 3.9.9 + 阿里云 Maven 源(见 `image/compile-maven3-jdk8`) |
| 运行 | `registry.cn-shanghai.aliyuncs.com/odboy/kenaito:runtime-tomcat9` | 自建镜像:JDK 8 + Tomcat 9.0.124(Servlet 4.0 / javax.servlet,对应 Spring 5),见 `image/runtime-tomcat9` |
### 示例内容
```
spring-war8/
├── pom.xml # packaging=war,Spring 5.3.39 + thymeleaf-spring5 3.0.15 + javax.servlet 4.0.1,不依赖 Boot
├── src/main/java/cn/odboy/demo/
│ ├── WebAppInitializer.java # 替代 web.xml,注册 DispatcherServlet(映射 /api/*)
│ ├── WebConfig.java # @EnableWebMvc + Thymeleaf 视图解析 + Jackson
│ ├── DemoController.java # @RestController:/ 、/info、/hello/{name}(在 /api 前缀下)
│ └── PageController.java # @Controller:/api/page 渲染模板
├── src/main/resources/templates/index.html
├── src/main/webapp/WEB-INF/web.xml # Servlet 4.0 描述符,仅声明 metadata-complete=false 与会话超时,无 servlet 映射
├── Dockerfile # 两阶段:compile-maven3-jdk8 -> runtime-tomcat9
├── build.sh # 构建镜像(PUSH=1 时同时推送)
├── docker-compose.yml # 部署编排(8095 -> 容器 8080,固定 IP 172.30.4.20)
├── startup.sh # docker-compose up -d
└── shutdown.sh # docker-compose down
```
### 构建与部署
```shell
sh build.sh # docker build -t registry.cn-shanghai.aliyuncs.com/odboy/kenaito:demo-spring-war8 .
PUSH=1 sh build.sh # 构建并推送
sh startup.sh # docker-compose -f docker-compose.yml -p spring-war8-demo up -d
```
war 部署后上下文路径为 **`/spring-war8`**,接口都在该前缀下:
```shell
curl http://127.0.0.1:8095/spring-war8/api/ # {"message":"spring-war8 is running","java":"1.8.0_502",...}
curl http://127.0.0.1:8095/spring-war8/api/info # 同上
curl http://127.0.0.1:8095/spring-war8/api/hello/demo
```
浏览器打开 http://127.0.0.1:8095/spring-war8/api/page 可看到渲染后的运行信息页面。
### 关键点
**Java 8 的版本选择**:Spring 5.3.39(最后支持 Java 8 的 Spring 5 线)+ thymeleaf-spring5 3.0.15 + Jackson 2.13.5 + javax.servlet 4.0.1。这套组合与 `spring-war17` 的 Spring 6 / Jakarta 一一对应,便于对照迁移差异。
**没有 servlet 映射的 web.xml**:`WebAppInitializer` 继承 `AbstractAnnotationConfigDispatcherServletInitializer`,Tomcat 9 通过 Servlet 3+ 的 `ServletContainerInitializer` 机制自动发现它并注册 DispatcherServlet。`web.xml` 只声明 `metadata-complete="false"` 和会话超时,不写任何 servlet 映射;`maven-war-plugin` 设置了 `failOnMissingWebXml=false`,即使删掉它也能打包。
**DispatcherServlet 只映射 `/api/*`**:`/api` 前缀外的请求仍由 Tomcat 默认 Servlet 处理(404 或欢迎页),避免传统 war 里 DispatcherServlet 抢占 `/` 后静态资源失效。
**上下文路径**:war 文件名即上下文路径,`finalName` 固定为 `spring-war8`,所以是 `/spring-war8`。想让应用直接挂在根路径 `/`,把 war 改名为 `ROOT.war` 即可。
**两阶段构建**:build 阶段在 `compile-maven3-jdk8` 里 `mvn package`,runtime 阶段只把 war 拷进 `runtime-tomcat9`,运行镜像不含 Maven/源码。
**端口**:容器内 Tomcat 仍是 8080(基础镜像默认),宿主机映射到 8095(避开 spring-war17 的 8085 及其它 demo)。
**JSON 输出**:非 Boot 项目里 `@EnableWebMvc` 不会自动带入 Jackson,所以 `pom.xml` 显式声明了 `jackson-databind`;Spring 检测到它会自动注册 `MappingJackson2HttpMessageConverter`,`/api/*` 返回 `Map` 即得 JSON。缺了它会返回 `HTTP 406 Not Acceptable`。
**健康检查**:compose 用 `curl` 探测 `/spring-war8/api/info`,`start_period: 30s` 覆盖 war 解压与 Spring 初始化;`curl` 由 `runtime-tomcat9` 基座(`runtime-jdk8`)自带,镜像构建时不做任何 yum 联网安装。
### 运维命令
```shell
docker logs -f spring-war8-demo # catalina.out 日志
docker exec spring-war8-demo ls /usr/local/tomcat/webapps # 查看已部署应用(war 与解包目录)
docker exec spring-war8-demo java -version # 确认 JDK 版本(1.8.0_502 / Dragonwell)
```
### 调试时直接在编译镜像里跑
```shell
docker run --rm -it -v "$PWD":/src -w /src \
registry.cn-shanghai.aliyuncs.com/odboy/kenaito:compile-maven3-jdk8 \
mvn -B clean package
```
得到的 `target/spring-war8.war` 可以拷到任意 Tomcat 9 的 `webapps/` 下部署。
### 停止
```shell
sh shutdown.sh
```