Javaweb 自定义 Servlet 实现按照访问路径转发

1,276 阅读2分钟

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第4天,点击查看活动详情

前言

  • HttpServlet Service方法 提供的 doGet()doPost() 方法只能根据请求方式进行分发,假设我们现在有多个服务(添加、删除、查询...),每个服务都要对应一个 Servlet(AddServlet、DeleteServlet、SelectServlet),这样管理起来是很不方便的,我们希望使用一个 Servlet 一个实体来处理其业务,比如 BrandServlet 处理 Brand 相关的业务(增删改查),UserServlet 处理 User 相关的业务
  • 这里我们的解决方案有两个
    • 方案一:在访问是携带参数,然后通过 request.getParameter 获取参数,通过 if 判断进行分发,如:访问链接为 http://localhost/BrandServlet?method=add,然后通过 request.getParameter("method") 即可获取到 add 参数,再通过 if 进行判断,调用 add() 方法即可
    • 方案二:重写 HttpServlet 的 Service 方法,自定义分发规则,直接通过访问路径进行业务处理
  • 这里要介绍的是第二种方法

自定义 BaseServlet

  • 新建一个 BaseServlet,继承 HttpServlet,重写 Service 方法
    package com.ruochen.web.servlet;
    
    import javax.servlet.ServletException;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.io.IOException;
    import java.lang.reflect.Method;
    
    /**
     * 替换 HttpServlet,根据请求的最后一段路径来进行方法分发
     */
    public class BaseServlet extends HttpServlet {
    
        // 根据请求的最后一段路径来进行方法分发
        @Override
        protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
            // 1. 获取请求路径 "/brand-case/brand/selectAll"
            String uri = req.getRequestURI();
            // 2. 获取最后一段路径,方法名
            int index = uri.lastIndexOf("/");
            String methodName = uri.substring(index + 1);  // selectAll
    
            // 3. 执行方法
            // 3.1 获取 BrandServlet / UserServlet 字节码对象 Class
            // 谁调用我(this 所在的方法),我(this)代表谁
            // System.out.println(this);  // BrandServlet
            Class<? extends BaseServlet> cls = this.getClass();
    
            // 3.2 获取方法 Method 对象,执行方法
            try {
                Method method = cls.getMethod(methodName, HttpServletRequest.class, HttpServletResponse.class);
                method.invoke(this, req, resp);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
    
  • 然后我们再写一个 UserServlet 测试一下,UserServlet 直接继承 BaseServlet 类就可以
    package com.ruochen.web.servlet;
    
    import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.io.IOException;
    
    @WebServlet("/user/*")
    public class UserServlet extends BaseServlet{
    
        public void selectAll(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            System.out.println("user selectAll...");
        }
    
        public void add(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            System.out.println("user add...");
        }
    }
    
  • 在浏览器中访问 /user/selectAll,可以看到控制台输出了 user selectAll...
  • 在浏览器中访问 /user/add,可以看到控制台输出了 user add...
  • 这样我们就实现了根据访问路径进行分发