Servlet优化之功能重组成模块

Chemlez

Java

发布于：Aug 31, 2020

在之前的总结Java初试MVC及三层架构中，查看其目录结构仅仅对于User对象的操作就写了6，7个servlet，而每一个servlet只对应一个功能，但随着以后项目的扩大，业务逻辑的复杂化，我们需要操作的对象不仅仅是一个User类时，换句话说，我们操作数据库中的表不止一张时，那么可想而知我们的servlet需要写多少！

思考:我们能否像service层和dao层一样，将关于User的操作都写在一个类当中，方便我们的使用呢。从而减少Servlet的数量，现在是一个功能一个Servlet，将其优化为一个模块一个Servlet，相当于在数据库中一张表对应一个Servlet，在Servlet中提供不同的方法，完成用户的请求。

我们编写的所有servlet都继承了HttpServlet，与此同时都复写了doGet以及doPost方法。查看HttpServlet源码，可以看见对doGet以及doPost的方法的调用都写在service中。

HttpServlet中service方法源码

protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    String method = req.getMethod();
    long lastModified;
    if (method.equals("GET")) {
        lastModified = this.getLastModified(req);
        if (lastModified == -1L) {
            this.doGet(req, resp);
        } else {
            long ifModifiedSince;
            try {
                ifModifiedSince = req.getDateHeader("If-Modified-Since");
            } catch (IllegalArgumentException var9) {
                ifModifiedSince = -1L;
            }

            if (ifModifiedSince < lastModified / 1000L * 1000L) {
                this.maybeSetLastModified(resp, lastModified);
                this.doGet(req, resp);
            } else {
                resp.setStatus(304);
            }
        }
    } else if (method.equals("HEAD")) {
        lastModified = this.getLastModified(req);
        this.maybeSetLastModified(resp, lastModified);
        this.doHead(req, resp);
    } else if (method.equals("POST")) {
        this.doPost(req, resp);
    } else if (method.equals("PUT")) {
        this.doPut(req, resp);
    } else if (method.equals("DELETE")) {
        this.doDelete(req, resp);
    } else if (method.equals("OPTIONS")) {
        this.doOptions(req, resp);
    } else if (method.equals("TRACE")) {
        this.doTrace(req, resp);
    } else {
        String errMsg = lStrings.getString("http.method_not_implemented");
        Object[] errArgs = new Object[]{method};
        errMsg = MessageFormat.format(errMsg, errArgs);
        resp.sendError(501, errMsg);
    }

}

通过查看以上的源码，我们可以看到service是对当前进入到servlet方法进行判断，然后调用相对应的方法。受到源码的启发，我们是不是可以重写service方法，在里面对我们自己定义的方法进行判断，继而进行使用呢。

基本思路：定义一个BaseServlet类继承HttpServlet，用来重写service方法。然后，我们再定义一个User相关的servlet类继承BaseServlet，我们把之前功能分散的servlet都写在这个类中。

对于重写service方法，而覆盖了原有的doGet，doPost方法，如何对完成请求的疑惑解答。

(当时重写service时，产生了没有了doGet，doPost方法，那么我以后的请求都是如何请求，以及采用哪种请求方式的疑惑，后来查询了相关的博客，现将查询的资料以及自己的理解写在下方，如有不正确请指正)

HttpServlet中的service方法是用于转向(get,post,put,delete…对网页的请求方式进行判断)。当重写了service方法时，此时的service就不是用来转向的，而是用来处理业务的，现在不论客户端是用post还是get来请求此servlet,都会执行service方法来调用相应的方法。(可以简单理解为service是客户端向后端传递数据的接口，必须由此进入路径)

简而言之，后端只需要进行方法的调用，不必关心是采用哪种请求方式。是否还记得，在原来的doPost以及doGet中，其中一个方法中，会有这么一句，例如,在doGet方法体中会写this.doPost(request,response)，从而达到方法的复用。然而这一句是不是也间接的告诉了我们，两者内部的处理逻辑是一样的。

好了，有了以上的思路以及解答了上面的疑惑，下面我们开始对代码进行重构。

首先给出BaseServlet以及子类User的servlet：

BaseServlet的代码

public class BaseServlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // 1.获取请求路径
        String uri = request.getRequestURI(); //  请求路径(例如:xx/user/add)其中xx代表虚拟目录，而add既包含在请求的资源路径中，也是我们的方法名称
        // 2.获取方法名称
        String methodName = uri.substring(uri.lastIndexOf('/') + 1); // 通过访问路径，获取方法名称 -- 截取字符串的长度,返回结果 add
        try {
            // 3.获取方法对象Method
            Method method = this.getClass().getMethod(methodName, HttpServletRequest.class, HttpServletResponse.class);// 这里的this代表BaseServlet的子类调用者,这里就是UserServlet
            // 4.执行方法
            method.invoke(this, request, response);
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }
    }
}

UserServlet代码

/**
 * 对于UserServlet的优化
 * 将单一功能进行模块化
 */
@WebServlet("/user/*") // user路径下的所有资源都可以通过UserServlet被访问到
public class UserServlet extends BaseServlet {
    /**
     * 用户增加的方法
     *
     * @param request
     * @param response
     * @throws ServletException
     * @throws IOException
     */
    public void add(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        request.setCharacterEncoding("utf-8");
        User user = new User();
        Map<String, String[]> parameterMap = request.getParameterMap();
        try {
            BeanUtils.populate(user, parameterMap);
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }
        System.out.println(user.toString());
        UserService service = new UserServiceImpl();
        service.addUser(user);
        HttpSession session = request.getSession();
        response.sendRedirect(request.getContextPath() + "/user/find");
    }

    /**
     * 用户删除
     * @param request
     * @param response
     * @throws ServletException
     * @throws IOException
     */
    public void delete(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String id = request.getParameter("id");
        UserService service = new UserServiceImpl();
        service.delete(Integer.parseInt(id));
        response.sendRedirect(request.getContextPath() + "/user/find");
    }

    /**
     * 查询用户
     * @param request
     * @param response
     * @throws ServletException
     * @throws IOException
     */
    public void find(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        request.setCharacterEncoding("utf-8");
        String currentPage = request.getParameter("currentPage");
        String rows = request.getParameter("rows");
        if (currentPage == null || "".equals(currentPage)) {
            currentPage = "1";
        }
        if (rows == null || "".equals(rows)) {
            rows = "5";
        }

        Map<String, String[]> condition = request.getParameterMap();

        UserService service = new UserServiceImpl();
        PageBean<User> userByPage = service.findUserByPage(Integer.parseInt(currentPage), Integer.parseInt(rows),condition);
        request.setAttribute("userByPages", userByPage);
        request.setAttribute("condition",condition);
        request.getRequestDispatcher("/list.jsp").forward(request, response);
    }

    /**
     * 用户登录方法
     * @param request
     * @param response
     * @throws ServletException
     * @throws IOException
     */
    public void active(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        request.setCharacterEncoding("utf-8");// 设置编码
        User loginUser = new User();
        Map<String, String[]> parameterMap = request.getParameterMap(); // 获取request全部提交的参数
        String[] checkCodes = parameterMap.get("verifycode"); // 取验证码
        HttpSession session = request.getSession();
        String checkCode_session = (String) session.getAttribute("checkCode_session");// 取生成的真正正确的验证码
        session.removeAttribute("checkCode_session"); // 获取验证码后，销毁验证码信息
        // 判断验证码是否正确
        if (checkCode_session == null || !checkCode_session.equalsIgnoreCase(checkCodes[0])) { // 验证码不正确 -- 存储转发至首页重新登录
            request.setAttribute("code_error", "验证码输入错误");
            request.getRequestDispatcher("/login.jsp").forward(request, response);
        } else {
            // 对username和password进行封装
            try {
                BeanUtils.populate(loginUser, parameterMap);
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            } catch (InvocationTargetException e) {
                e.printStackTrace();
            }
            UserService service = new UserServiceImpl();
            User adminUser = service.adminUser(loginUser); // 查询数据库
            if (adminUser != null) { // 查询成功
                session.setAttribute("adminUser", adminUser);
                response.sendRedirect(request.getContextPath() + "/index.jsp");

            } else { // 查询失败 -- 存储转发至首页重新登录
                request.setAttribute("adminUser_error", "用户名或者密码错误");
                request.getRequestDispatcher("/login.jsp").forward(request, response);
            }
        }
    }
}

首先UserServlet继承BaseServlet，而请求的资源路径是由子类的UserServlet决定，其注解@WebServlet("/user/*")。其中的通配符*就是用来匹配下方对应的方法名称。这里需要发挥作用的就需要父类BaseServlet中service方法通过反射的技术获取到资源路径，而资源路径中就包含了我们子类UserServlet的方法名，所以就可以通过反射的技术来使用定义在子类中的方法。

还有需要注意的一点是，子类中方法采用public修饰而不用protect修饰是因为作用域的原因。

参考文献

[1] servlet中的service()方法重写与不重写

[2] 黑马讲义笔记

Java基础之Filter

一、概念Filter是Java Web的三大组件之一。Java Web三大组件分别是Servlet、Filter、Listener。 Filter的作用一般用于完成通用的操作。例如:登录验证、统...

前端之表单验证

一、简概因为，前端经常涉及到表单验证，故此篇博客用于记录前端JS对表单验证的方法。通过表单验证，当对form表单提交时，可以防止不合法的数据传递至后台(以及判空操作)。这里我们先定义一个表单，...

Servlet优化之功能重组成模块

参考文献

Java初试MVC及三层架构

从Servlet到HttpServlet都经历了什么

Java基础之反射初步理解

JDBC基础使用