转载

Java – 透过maven理解servlet程序

本文的目的是基于Idea IDE，利用maven创建webapp，自己实现一个简单的servlet，将其运行到tomcat中。

希望透过这个过程可以理解一些关键内容：

maven的基本目录规范
maven编译源码的原理
maven对webapp的目录规范
maven生成war包的原理

学习前提是你懂classpath，如果不懂翻一下我之前的一篇博客。

配置阿里云的maven源

idea如何配置阿里云的maven源头自己了解一下即可，否则maven用起来会很慢。

创建maven项目

选择archtype是webapp，这样maven会初始化一个目录结构，符合maven制作web应用的目录规范。

所谓规范，就是我们把代码和前端资源放到指定路径，maven就帮我们打包war。

Java – 透过maven理解servlet程序

让maven自动导入pom.xml中配置的包。

webapp目录结构

Java – 透过maven理解servlet程序

maven会递归扫描src/main下面的java代码。

对于webapp来说，会规范放置一个webapp目录，里面规范有一个WEB-INF目录存放servlet配置，稍后会讲。除此之外，webapp目录下可以放置要打包发布的前端资源，这里我没用到。

pom.xml在项目根目录，用于配置maven项目。

引入依赖

为了开发servlet提供HTTP接口服务，需要引入包依赖。

Java – 透过maven理解servlet程序

maven会识别到新依赖，并下载。

创建source root

为了项目结构好看一点，我们创建一个和webapp平行的java目录作为source root，简单的说就是作为classpath，在其下面创建的类使用相对路径作为package名字。

Java – 透过maven理解servlet程序

java目录显示蓝色是因为我右键mark as source root，这个信息仅仅对IDE和开发者有用（相当于告知IDE classpath），对maven没有用（稍后解释），仅仅是帮助IDE正确进行package和classname的索引用的。

开发servlet

没啥好说的，servlet就是java web开发的规范，1个servlet相当于实现一个接口。

大家可以类比python中的wsgi规范，我觉得套路都是一码事。

Java – 透过maven理解servlet程序

配置web.xml

web.xml相当于配置路由，这个文件也是java servlet规范的一部分，稍后我们用tomcat去加载这个webapp的时候web.xml就是要被tomcat读取的。

Java – 透过maven理解servlet程序

首先要配置有哪些servlet类，因为我们把ServletDemo类放在source root下面，也就是没有包名（也叫默认包，或者说直接放在了classpath目录内），所以servlet-class就是ServletDemo，没有包名前缀即可加载到该类。

servlet-mapping配置/hello的URI请求交给ServletDemo处理，仅此而已。

maven编译项目

通过maven package命令可以编译项目。

Java – 透过maven理解servlet程序

maven扫描src/main目录下所有.class文件，根据其.class文件中的package名，将其编译后的.class放置到了target/classes中。

另外还有一个servlet-demo目录（这是我的项目名），里面拷贝过来了WEB-INF目录（包括里面的web.xml），但是额外的还把classes目录也拷贝了进来，以及我们透过maven安装的servlet-api依赖jar包也拷贝了进来。

这个servlet-demo目录可不得了，它包含了要启动这个webapp所有的东西，包括项目class、依赖class、web.xml，其实这个目录压缩一下就是servlet-demo.war包的由来了。

war包是一个可以直接部署到tomcat的完整应用环境，我猜测war包内的结构都是遵循servlet规范的固定摆放方式，这样tomcat会将war内的classes和lib下的jar包都作为classpath，并且根据web.xml的路由加载对应的servlet class（透过Class.forName()方法）处理HTTP请求。