java war(Web Application Archive)文件是Java Web应用的标准分发格式,本质为ZIP格式的压缩包,遵循J2EE/Jakarta EE规范。其命名规范以".war"结尾,用于封装整个Web应用及其依赖资源,便于在Servlet容器(如Tomcat、Jetty、WebLogic)中部署运行。
在企业级Java开发中,war包作为轻量级部署单元,广泛用于传统Web应用(如JSP/Servlet应用)及部分Spring MVC项目。与可执行jar不同,war包需部署于Servlet容器中运行,不能独立执行,因其依赖容器提供的Servlet API、JSP引擎及JNDI等服务。
〔背景知识〕
WAR格式由Sun Microsystems于2001年随Servlet 2.3规范引入,取代早期的EAR(Enterprise Archive)直接部署方式。其设计初衷是简化Web应用打包流程,使开发者只需关注应用逻辑,而无需处理容器特定的部署脚本。
一个标准war包内部结构严格遵循Java EE规范,必须包含以下核心目录与文件:
〔重要提示〕
自Servlet 3.0起,web.xml非强制要求,可通过@WebServlet、@WebFilter、@WebListener等注解实现零配置部署。但复杂场景(如安全约束、初始化参数)仍需web.xml支持,或结合Java配置类(@WebComponent、@ServletComponentScan)。
在实际开发中,构建工具(Maven/Gradle)自动完成war包生成。以Maven为例,需在pom.xml中设置<packaging>war</packaging>,并配置maven-war-plugin插件。典型构建命令mvn clean package生成war包至target目录,文件名默认为artifactId-version.war。
部署时,将war包放置于Servlet容器的webapps目录下(如Tomcat),容器检测到新war包后自动解压并部署。首次访问应用时触发类加载与初始化,若部署失败,容器会生成app-name.war.failed标记文件,记录错误日志于logs/catalina.out。
📌 实用技巧:部署前可使用jar tf app.war命令预览包内容,检查是否遗漏关键文件;或用unzip -l app.war查看压缩包结构,快速定位部署问题根源。
随着微服务兴起,Spring Boot项目默认生成可执行jar包,但部分企业仍坚持传统部署模式(如运维习惯、旧系统兼容性),此时需将Spring Boot应用打包为war。需执行:mvn dependency:copy-dependencies -DincludeScope=runtime,并在启动类继承SpringBootServletInitializer并重写configure方法。
深入理解war包结构是部署与调试的基础。以下以标准结构展开说明,每项均附实际示例与注意事项:
存放用户可直接访问的静态文件与动态页面,路径即访问URL路径。例如:
/index.jsp → 访问URL:http://host:port/appname/(容器自动匹配欢迎页)/static/css/style.css → 访问URL:http://host:port/appname/static/css/style.css/images/logo.png → 访问URL:http://host:port/appname/images/logo.png⚠️ 注意:JSP文件虽位于根目录,但需通过Servlet容器处理,不能像HTML一样静态提供;若直接请求JSP源码(如/WEB-INF/view/index.jsp),容器将返回404或403错误,因/WEB-INF为受保护目录。
该目录内容不可被外部直接访问,仅通过Servlet转发或包含访问,是安全机制的核心部分:
传统部署配置入口,定义应用级设置。示例片段如下:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<display-name>MyWebApp</display-name>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/applicationContext.xml</param-value>
</context-param>
<servlet>
<servlet-name>dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcher</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<filter>
<filter-name>encodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
关键配置项说明:
<load-on-startup>1</load-on-startup>:启动时初始化Servlet,数字越小优先级越高<url-pattern>/</url-pattern>:拦截所有请求(除静态资源),需配合web.xml中<welcome-file-list>定义欢迎页<filter-mapping><url-pattern>/*</url-pattern></filter-mapping>:过滤所有请求,包括Servlet请求与JSP存放Java类文件,结构必须与包名一致。例如:
src/main/java/com/example/service/UserService.java/WEB-INF/classes/com/example/service/UserService.class⚠️ 注意:类文件必须符合JVM规范,若使用JDK新特性(如Java 17的record),需确保Servlet容器版本兼容(Tomcat 9.0+支持Java 11,Tomcat 10.1+支持Java 17)。
存放应用依赖的JAR包,容器通过WebAppClassLoader加载。常见依赖示例:
| JAR包 | 用途 | 注意事项 |
|---|---|---|
| mysql-connector-java-8.0.33.jar | MySQL数据库驱动 | 必须与MySQL版本匹配;8.0+需指定serverTimezone |
| spring-webmvc-5.3.39.jar | Spring MVC框架核心 | 需同步依赖spring-core、spring-context等 |
| commons-io-2.15.1.jar | IO工具类库 | 避免与容器自带JAR冲突(如Tomcat的catalina.jar) |
| log4j2-core-2.23.0.jar | 日志实现 | 需同步log4j-api;避免与slf4j-simple共存 |
〔冲突警告〕
若war包与容器共享同一JAR(如servlet-api),可能导致java.lang.ClassCastException或NoClassDefFoundError。解决方案:在Maven中设置依赖范围为<scope>provided</scope>,构建时排除该依赖。
存放元数据文件,常用文件包括:
META-INF/MANIFEST.MF:清单文件,定义主类、类路径等(对war包作用有限)META-INF/context.xml:Tomcat专用配置,覆盖server.xml中全局设置META-INF/services/:Java SPI机制存放接口实现类配置示例context.xml配置:
<Context path="/myapp" docBase="myapp" reloadable="true" crossContext="true">
<Resource name="jdbc/mydb" auth="Container" type="javax.sql.DataSource"
maxTotal="100" maxIdle="30" maxWaitMillis="10000"
username="root" password="123456"
driverClassName="com.mysql.cj.jdbc.Driver"
url="jdbc:mysql://localhost:3306/test?useSSL=false&serverTimezone=UTC"/>
</Context>
部署后,该配置会被Tomcat自动加载至$CATALINA_HOME/conf/Catalina/localhost/myapp.xml,实现应用级数据源配置。
Tomcat作为最广泛使用的Servlet容器,其war部署流程如下:
$CATALINA_HOME/webapps/目录(如cp app.war $CATALINA_HOME/webapps/)$CATALINA_HOME/bin/startup.sh(Linux)或startup.bat(Windows)$CATALINA_HOME/logs/catalina.out,确认Deploying web application archive信息http://localhost:8080/app-name/,触发解压与初始化〔部署验证〕
成功部署后,webapps目录将生成app-name/解压目录与app-name.war文件。若部署失败,会生成app-name.war.failed文件,内容为错误摘要。
常见部署问题及解决方案:
server.xml中为<Connector>添加URIEncoding="UTF-8"server.xml中port="8080"为未占用端口(如8081)bin/setenv.sh中JAVA_OPTS="-Xms512m -Xmx1024m"Spring Boot默认生成jar包,部署为war需额外配置:
pom.xml:<packaging>war</packaging><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-tomcat</artifactId><scope>provided</scope></dependency>SpringBootServletInitializer:import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
@SpringBootApplication
public class MyApplication extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
return application.sources(MyApplication.class);
}
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
mvn clean package -DskipTestswebapps目录⚠️ 注意:若使用嵌入式Tomcat(spring-boot-starter-tomcat),必须设置provided作用域,否则会与外部容器冲突。
WebLogic作为商业级应用服务器,部署流程略有不同:
http://host:7001/consoleDeployments → InstallInstall this deployment as an applicationAdminServer),完成部署WebLogic需额外配置weblogic.xml(位于WEB-INF)定义上下文路径与类加载策略:
<?xml version="1.0" encoding="UTF-8"?>
<weblogic-web-app xmlns="http://xmlns.oracle.com/weblogic/weblogic-web-app"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.oracle.com/weblogic/weblogic-web-app
http://xmlns.oracle.com/weblogic/weblogic-web-app/1.4/weblogic-web-app.xsd">
<context-root>/myapp</context-root>
<container-descriptor>
<prefer-web-inf-classes>true</prefer-web-inf-classes>
</container-descriptor>
</weblogic-web-app>
war包部署应用易受以下攻击:
../../../WEB-INF/web.xml路径读取敏感文件shell.jsp)执行任意代码对上传功能进行白名单校验,示例代码:
String fileName = file.getOriginalFilename();
String ext = fileName.substring(fileName.lastIndexOf(".") + 1).toLowerCase();
Set allowedExts = Set.of("jpg", "png", "gif", "pdf");
if (!allowedExts.contains(ext)) {
throw new IllegalArgumentException("Invalid file type");
}
将JSP文件移至/WEB-INF/views/目录,通过Controller转发访问:
@GetMapping("/home")
public String home() {
return "home"; // 对应 /WEB-INF/views/home.jsp
}
在web.xml中配置:
<error-page> <error-code>404</error-code> <location>/error/404.jsp</location> </error-page> <error-page> <exception-type>java.lang.Throwable</exception-type> <location>/error/error.jsp</location> </error-page>
在web.xml中添加:
<context-param> <param-name>org.apache.catalina.connector.REPLY_HTTP_STATUS_CODE</param-name> <param-value>true</param-value> </context-param>
防止Tomcat在错误页面显示堆栈信息。
针对Tomcat应用,推荐JVM参数配置:
export JAVA_OPTS="-Xms2048m -Xmx2048m -XX:MetaspaceSize=256m -XX:MaxMetaspaceSize=512m -XX:+UseG1GC -XX:MaxGCPauseMillis=200 -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/logs/heapdump.hprof"
关键参数说明:
-Xms/-Xmx:堆内存初始/最大值,建议设为相同值避免动态扩容-XX:+UseG1GC:使用G1垃圾回收器,适合大内存应用-XX:MaxGCPauseMillis=200:GC停顿时间目标,200ms内编辑server.xml中<Connector>配置:
<Connector port="8080" protocol="org.apache.coyote.http11.Http11NioProtocol"
maxThreads="500" minSpareThreads="20" acceptCount="1000"
connectionTimeout="20000" keepAliveTimeout="15000"
maxKeepAliveRequests="100"
URIEncoding="UTF-8" useBodyEncodingForURI="true"
compression="on" compressionMinSize="2048"
compressableMimeType="text/html,text/xml,text/plain,application/json"/>
优化点说明:
maxThreads:最大线程数,根据CPU核心数调整(通常为2×CPU核心数)compression="on":启用GZIP压缩,减少传输体积keepAliveTimeout:长连接超时时间,避免连接堆积通过web.xml配置静态资源缓存策略:
<servlet>
<servlet-name>default</servlet-name>
<init-param>
<param-name>cacheControl</param-name>
<param-value>max-age=31536000, public</param-value>
</init-param>
</servlet>
此配置使浏览器缓存静态资源1年,显著提升页面加载速度。
症状:java.lang.NoClassDefFoundError: javax/servlet/Servlet
原因:servlet-api被重复引入(war包与容器均包含)
解决:pom.xml中设置<scope>provided</scope>
症状:java.lang.OutOfMemoryError: Java heap space
原因:堆内存不足,常见于大文件处理或缓存滥用
解决:增加-Xmx值,或使用jmap分析堆转储文件
症状:访问URL返回404,但war包已部署
原因:web.xml中Servlet映射错误或欢迎页缺失
解决:
<servlet-mapping>的<url-pattern>是否匹配web.xml添加欢迎页列表:<welcome-file-list><welcome-file>index.jsp</welcome-file></welcome-file-list>症状:页面显示“?”或乱码
原因:请求/响应编码不一致
解决:
request.setCharacterEncoding("UTF-8"); response.setCharacterEncoding("UTF-8");URIEncoding="UTF-8"| 工具 | 功能 | 适用场景 |
|---|---|---|
jar tf |
查看war包内容 | 快速检查文件结构 |
| Apache Maven Dependency Plugin | 分析依赖树 | 排查JAR冲突 |
| Tomcat Manager | Web管理界面 | 远程部署与监控 |
| JProfiler | 性能分析 | JVM内存/CPU分析 |
结合CI/CD工具实现一键部署:
pipeline {
agent any
stages {
stage('Build') {
steps {
sh 'mvn clean package -DskipTests'
}
}
stage('Deploy') {
steps {
sh 'scp target/app.war user@server:/opt/tomcat/webapps/'
}
}
}
}
- name: Deploy WAR to Tomcat
copy:
src: target/app.war
dest: /opt/tomcat/webapps/
owner: tomcat
group: tomcat
war包需部署于Servlet容器,适合传统Web应用;jar包可独立运行(含嵌入式容器),适合微服务。选择依据:是否需利用容器特性(如JNDI、集群管理)。
方法一:tomcat/conf/server.xml中<Context>设置reloadable="true";方法二:使用JRebel热部署插件;方法三:通过Tomcat Manager API实现自动化重载。
可以。需继承SpringBootServletInitializer并设置依赖范围为provided。注意:Spring Boot 3.0+需使用Servlet 5.0兼容容器(如Tomcat 10.1+)。
① 使用Maven ProGuard插件压缩JAR;② 移除未使用依赖(mvn dependency:tree分析);③ 启用GZIP压缩(server.xml中compression="on");④ 将静态资源移至CDN。