用戶登陸過濾器

功能描述

        用於檢查用戶是否登陸了系統，若是未登陸，則重定向到指的登陸頁面。

使用方法

        在 java web 項目的 web.xml 文件中添加以下代碼，對每一個參數都進行了詳細的說明。

 <!—檢查用戶是否登陸了系統的過濾器配置  開始 -->
 <filter>
  <filter-name>SessionFilter</filter-name>
  <filter-class>com.hmw.filter.SessionFilter</filter-class>
  <init-param>
      <description>將當前登陸的用戶的信息保存在 session 中時使用的key，若是沒有配置此參數，則該過濾器不起做用</description>
      <param-name>sessionKey</param-name>
      <param-value>userInfo</param-value>
  </init-param>
  <init-param>
      <description>
          若是用戶未登陸（即在 session 中 key 爲 sessionKey 的屬性不存在或爲空），則將請求重定向到該 url。
          該 url 不包含web應用的 ContextPath。
          若是不配置此參數，則在用戶未登陸系統的狀況下，直接重定向到web應用的根路徑（/）
      </description>
      <param-name>redirectUrl</param-name>
      <param-value>/login.jsp</param-value>
  </init-param>
  <init-param>
      <description>
          不須要進行攔截的 url 的正則表達式，即：若是當前請求的 url 的 servletPath 能匹配該正則表達式，則直接放行（即便未登陸系統）。
          此參數的值通常爲 loginServlet 和 registServlet 等。
          另外，參數 redirectUrl 的值不用包含在該正則表達式中，由於 redirectUrl 對應的 url 會被自動放行。
          還有一點須要說明的是，該參數的值不包含web應用的 ContextPath。
      </description>
      <param-name>excepUrlRegex</param-name>
      <!-- 不攔截 /servlets/loginServlet 和 /servlets/registServlet -->
      <param-value>/servlets/(login|regist)Servlet</param-value>
  </init-param>
 </filter>
 
 <filter-mapping>
  <filter-name>SessionFilter</filter-name>
  <url-pattern>/servlets/*</url-pattern>
 </filter-mapping>
 <filter-mapping>
  <filter-name>SessionFilter</filter-name>
  <url-pattern>/jsp/*</url-pattern>
 </filter-mapping>
 <!—檢查用戶是否登陸了系統的過濾器配置  結束 -->

過濾器源碼

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;

/**
 * 用於檢查用戶是否登陸了系統的過濾器<br>
 * 建立日期：2012-01-09
 * @author <a href="mailto:hemingwang0902@126.com">何明旺</a>
 */
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() {
    }
}