解决用户登录的session过滤器

功能描述
用于检查用户是否登录了系统，如果未登录，则重定向到指的登录页面。
使用方法
在 java web 项目的 web.xml 文件中添加如下代码，对每个参数都进行了详细的说明。
过滤器源码
package com.hmw.filter;

import java.io.IOException;
import java.net.URLEncoder;
import java.util.regex.Pattern;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.lang.StringUtils;

/**

• 用于检查用户是否登录了系统的过滤器
  

• 创建日期：2020-06-19
  */
  public class SessionFilter implements Filter {

  /** 要检查的 session 的名称 */
  private String sessionKey;

  /** 需要排除（不拦截）的URL的正则表达式 */
  private Pattern excepUrlPattern;

  /** 检查不通过时，转发的URL */
  private String forwardUrl;

  @Override
  public void init(FilterConfig cfg) throws ServletException {
  sessionKey = cfg.getInitParameter(“sessionKey”);

   String excepUrlRegex = cfg.getInitParameter("excepUrlRegex");
   if (!StringUtils.isBlank(excepUrlRegex)) {
       excepUrlPattern = Pattern.compile(excepUrlRegex);
   }
   forwardUrl = cfg.getInitParameter("forwardUrl");
  

  }
  @Override
  public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
  // 如果 sessionKey 为空，则直接放行
  if (StringUtils.isBlank(sessionKey)) {
  chain.doFilter(req, res);
  return;
  }

// * 请求 http://127.0.0.1:8080/webApp/home.jsp?&a=1&b=2 时
// * request.getRequestURL()： http://127.0.0.1:8080/webApp/home.jsp
// * request.getContextPath()： /webApp
// * request.getServletPath()：/home.jsp
// * request.getRequestURI()： /webApp/home.jsp
// * request.getQueryString()：a=1&b=2
HttpServletRequest request = (HttpServletRequest) req;
HttpServletResponse response = (HttpServletResponse) res;
String servletPath = request.getServletPath();

    // 如果请求的路径与forwardUrl相同，或请求的路径是排除的URL时，则直接放行
    if (servletPath.equals(forwardUrl) || excepUrlPattern.matcher(servletPath).matches()) {
        chain.doFilter(req, res);
        return;
    }

    Object sessionObj = request.getSession().getAttribute(sessionKey);
    // 如果Session为空，则跳转到指定页面
    if (sessionObj == null) {
        String contextPath = request.getContextPath();
        String redirect = servletPath + "?" + StringUtils.defaultString(request.getQueryString());
        /*
         * login.jsp 的 <form> 表单中新增一个隐藏表单域：
         * <input type="hidden" name="redirect" value="${param.redirect }">
         * 
         *  LoginServlet.java 的 service 的方法中新增如下代码：
         *  String redirect = request.getParamter("redirect");
         *  if(loginSuccess){
         *      if(redirect == null || redirect.length() == 0){
         *          // 跳转到项目主页（home.jsp）
         *      }else{
         *          // 跳转到登录前访问的页面（java.net.URLDecoder.decode(s, "UTF-8")）
         *      }
         *  } 
         */
        response.sendRedirect(contextPath + StringUtils.defaultIfEmpty(forwardUrl, "/")
                        + "?redirect=" + URLEncoder.encode(redirect, "UTF-8"));
    } else {
        chain.doFilter(req, res);
    }
}

@Override
public void destroy() {
}

}