一、学习目标
- 通过自定义实现一个springmvc框架,去理解springmvc的实现原理;
- 学习设计模式中的策略模式和适配器模式;
- 通过由浅入深的方式去体会springmvc的源码设计思路,方便阅读springmvc的源码,包括:
1)前端控制器DispatcherServlet的作用及实现;
2)Handler处理器的作用及实现;
3)HandlerMapping处理器映射器的作用及实现;
4)HandlerAdapter处理器适配器的作用及实现。
二、搭建开发环境
1、创建一个maven工程,因为是web工程所以打包方式选择war包;
2、创建好之后,会发现缺失web.xml文件,可以自动生成,右键项目–》Java EE tools–》Generate Deployment Descriptor stub,再看发现web.xml就出来了;
3、编辑pom.xml文件,添加相关的jar依赖;
4、如果项目报红叉的话,可以通过右击项目–》maven–》update project更新项目解决;
5、通过原生servlet实现一个简单的用户查询和用户添加。
三、具体实现
1、创建QueryUserServlet类,然后继承HttpServlet,重写doGet、doPost方法。
public class QueryUserServlet extends HttpServlet{
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
//1、设置相应类型和字符编码
response.setCharacterEncoding("text/html;charset=utf-8");
//2、使用输出流输出内容
PrintWriter out =response.getWriter();
out.write("用户查询servlet");
out.close();
}
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doGet(request,response);
}
}
2、在web.xml文件中配置servlet及路径
<servlet>
<!--servlet的名字 -->
<servlet-name>queryUserServlet</servlet-name>
<!--servlet的类路径 -->
<servlet-class>springMVCDemo.QueryUserServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>queryUserServlet</servlet-name>
<!--servlet的访问配置 -->
<url-pattern>/QueryUserServlet</url-pattern>
</servlet-mapping>
3、运行程序,打印结果如图
4、附图,客户端浏览器发出请求访问servlet的过程如图:
客户端发出请求http://localhost:8080/QueryUserServlet,tomcat服务器接收到后,会去webapps下查找对应的项目去访问(如果不写访问项目名称的话,会默认访问ROOT中配置的默认项目),根绝web.xml配置的查找对应的servlet访问执行。问题:
现在是只有一种操作需要处理,只需要创建一个servlet类,那如果是多种请求操作,岂不是要建许许多多的servlet类,这不是特别好,所以对应的有两种处理方案,
1)所有的servlet类都继承自定义的BaseServlet类
BaseServlet继承HttpServlet类,重写doGet和doPost方法,通过这个基类把不同的请求分发到不同的方法上去执行,需要请求URL中通过method参数传递要调用的方法名称,然后根据需求编写servlet子类,不同的URL对应不同的method方法,这种处理方式就是Struts2的原型,如图所示,
2)只编写一个servlet去进行请求分发(即SpringMVC中的DispatcherServlet控制器),后台通过处理器去处理不同的请求
根据请求URL查找对应的请求处理类,调用请求处理类的方法处理请求,处理相应结果,这种处理方式就是SpringMVC的原型,如图所示,
接下来就简单的实现一下Dispatcher Servlet类。
首先,创建一个servlet,名为DispatcherServlet,前面已经说过了,因为此类只作为派发请求的,而不是具体执行某个方法,为了代码更整洁,创建一个父类,FrameWorkServlet来接收请求,并提供一个请求分发的方法,然后让DispatcherServlet继承这个父类,真正的分发动作交给DispatcherServlet来完成,代码如下,
FrameWorkServlet类
public class FrameWorkServlet extends HttpServlet{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doDispatcherServlet(req,resp);
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doGet(req,resp);
}
/**
* 请求分发
* @param request
* @param response
*/
public void doDispatcherServlet(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException{
}
}
DispatcherServlet类
/**
* Servlet implementation class DispatcherServlet
*/
public class DispatcherServlet extends FrameWorkServlet {
private static final long serialVersionUID = 1L;
@Override
public void doDispatcherServlet(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {
//1、根据不同的请求查找对应的处理器类
//2、执行处理器中的方法
}
}
然后再创建两个相应的handler处理器,在处理器里只简单的打印一句话,代码如下,
Add User Handler处理器
public class AddUserHandler {
public void handlerRequest(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {
response.setContentType("text/html;charset=utf-8");
response.getWriter().write("添加用户 处理器");
}
}
QueryUserHandler处理器
public class QueryUserHandler {
public void handlerRequest(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {
response.setContentType("text/html;charset=utf-8");
response.getWriter().write("查询用户 处理器");
}
}
接下来就是在DispatcherServlet里快快乐乐的代码分发了,让我们继续。
首先,完成第一步,根据不同的请求查找对应的处理器类,也就是说要根据请求来判断,我们该获得哪一个类型的处理器,所以需要单独写一个获取处理器的方法。
第二步,获得处理器之后,对处理器类型做判断,执行处理器中的方法。所以编写好之后的Dispatcher Servlet变成了这样,
public class DispatcherServlet extends FrameWorkServlet {
private static final long serialVersionUID = 1L;
@Override
public void doDispatcherServlet(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {
//1、根据不同的请求查找对应的处理器类
Object handler=getHandler(request);
//2、执行处理器中的方法
if(handler == null ) {
return ;
}
//向下转型为具体某一个handler处理器
if(handler instanceof AddUserHandler) {
((AddUserHandler)handler).handlerRequest(request, response);
}else if(handler instanceof QueryUserHandler) {
((QueryUserHandler)handler).handlerRequest(request, response);
}
}
public Object getHandler(HttpServletRequest request) {
//1、获取请求uri
String uri=request.getRequestURI();
//2、判断
if("/addUser".equals(uri)) {
return new AddUserHandler();
}else if("/queryUser".equals(uri)) {
return new QueryUserHandler();
}
return null;
}
}
然后我们测试一下,看下打印结果,输入queryUser的时候,应该显示 “查询用户 处理器”,
输入addUser的时候,应该显示“添加用户 处理器”
这样就实现了一个简单的请求分发过程,但是有这样一个小问题,就是在分发的时候都是调用某个处理器的handlerRequest方法,也就是说以后再添加某种请求,比如删除,更改等等时,在写这个handlerRequest方法时,如果名字敲错了,可能就会导致分发请求的失败,而且每次都需要手动敲一遍很麻烦。所以我们需要给它们添加一个规范,这时候接口的作用就体现了,我们在接口中定义这个方法,然后以后写的所有的handler处理器都去实现这个接口,这样就不用担心写错名字而导致分发失败了,所以对上面两个所写的处理器优化一下,首先创建一个接口,
HandlerInterface接口
public interface HandlerInterface {
public void handlerRequest(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException;
}
优化后的处理器,
AddUserHandler
public class AddUserHandler implements HandlerInterface{
@Override
public void handlerRequest(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
response.setContentType("text/html;charset=utf-8");
response.getWriter().write("添加用户 处理器");
}
}
QueryUserHandler
public class QueryUserHandler implements HandlerInterface{
@Override
public void handlerRequest(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
response.setContentType("text/html;charset=utf-8");
response.getWriter().write("添加用户 处理器");
}
}