Java利用过滤器实现完善登录功能

目录

• 1、问题引入
• 2、解决思路
• 3、代码实现
• 3.1 定义登录校验过滤器
• 3.2 开启组件扫描

1、问题引入

我们已经完成了后台系统的登录功能开发，但是目前还存在一个问题，就是用户如果不登录，直接访问系统首页面，照样可以正常访问。

很明显，上面这种情况并不合理，我们希望看到的效果应该是，只有登录成功后才可以访问系统中的页面，如果没有登录, 访问系统中的任何界面都直接跳转到登录页面。

2、解决思路

使用 过滤器或者拦截器来实现，在过滤器、拦截器中拦截前端发起的请求，判断用户是否已经完成登录，如果没有登录则返回提示信息，跳转到登录页面，那我这篇博客选择的是过滤器来实现这个效果。

过滤器具体的处理逻辑如下：

A. 获取本次请求的URI

B. 判断本次请求, 是否需要登录, 才可以访问

C. 如果不需要，则直接放行

D. 判断登录状态，如果已登录，则直接放行

E. 如果未登录, 则返回未登录结果

如果未登录,我们需要给前端返回什么样的结果呢? 这个时候, 可以去看看前端代码是如何处理的，大家可以先看看我这里的前端是如何处理的。（每个前端处理方式都不一样，随机应变）

这个是我们前端的拦截器，这个拦截器就是用来拦截我们服务端给页面上的响应的，一旦我们后端给前端响应之后，它就会执行下面的代码进行判断。

大家也可以看到它里面的if判断 ，如果我们后端给前端返回的数据是

res.data.code = 0 && res.data.msg='NOTLOGIN'

那它就会自动跳到登录界面。

3、代码实现

3.1 定义登录校验过滤器

首先我们创建一个过滤器 LoginCheckFilter 并实现 Filter 接口, 在doFilter方法中完成校验的逻辑。

/**
 * @description: 检查用户是否已经完成登录
 * @author: Jie
 * @date: 2022/8/10 9:48
 **/
@WebFilter(filterName = \"loginCheckFilter\", urlPatterns = \"/*\")
@Slf4j
public class LoginCheckFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
       
    }
}

注：

@WebFilter ：用于将一个类声明为过滤器，filterName 指定过滤器的名称，urlPatterns ：需要拦截的请求路径

首先我们要获取到 request 和 response 和请求路径，这三位后面都会用到。

现在我们获取到了请求路径，就可以去判断哪些请求路径是需要进行处理的，因为在项目实际开发中，我们的项目中有些地方是不需要登录也能进行访问的，比如淘宝和京东的首页，大家不登陆也能访问吧，所以我们要将这些路径定义出来，如果用户访问的是这些路径，那么我们就直接放行，就不处理了。

上面就是我定义不需要拦截的请求路径，相信大家看到了最后两个路径有些不一样，这里呢我们用的是通配符的方式。

通配符规则:

但是现在有一个问题，比如我现在请求的是/backend/index.html ,这对不上呀!那该如何去匹配呢？

这个时候我们就要认识一个新的对象 AntPathMatcher 。

现在我们通过这个路径匹配器，匹配一下这个请求过来的路径是否能匹配上我们定义不需要拦截的请求路径里的任意一项。

这里我们封装一个方法用来判断本次请求是否需要处理。

这样我们在上面调用，然后判断一下是否需要处理，如果不需要处理，那就直接放行即可。

反之就是需要判断是否需要登录，那我们如何判断用户是否登录呢？因为我是登录的时候将用户的信息存到session 里的 ，那这里我就是 从session 里 获取登录用户，如果能获取出来，就代表用户已经登录。

如果用户没有登录我们就需要通过输出流方式向客户端页面响应数据。

完整代码 ：

package com.jie.reggjie.filter;
 
import cn.hutool.core.text.AntPathMatcher;
import com.alibaba.fastjson.JSON;
import com.jie.reggjie.common.R;
import lombok.extern.slf4j.Slf4j;
 
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
 
/**
 * @description: 检查用户是否已经完成登录
 * @author: Jie
 * @date: 2022/8/10 9:48
 **/
@WebFilter(filterName = \"loginCheckFilter\", urlPatterns = \"/*\")
@Slf4j
public class LoginCheckFilter implements Filter {
 
    /**
     * 路径匹配器，支持通配符
     */
    public static final AntPathMatcher PATH_MATCHER = new AntPathMatcher();
 
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        String requestURI = request.getRequestURI();
        log.info(\"拦截到请求，{}\", requestURI);
 
        //2、判断本次请求是否需要处理
        //定义不需要处理的请求路径
        String[] urls = new String[]{
                \"/employee/login\",
                \"/employee/logout\",
                \"/backend/**\",
                \"/front/**\"
        };
        boolean check = check(urls, requestURI);
 
        //3、如果不需要处理，则直接放行
        if (check) {
            log.info(\"本次请求{}不需要处理\", requestURI);
            filterChain.doFilter(request, response);
            return;
        }
 
        //4、判断登录状态，如果已登录，则直接放行
        if (request.getSession().getAttribute(\"employee\") != null) {
            log.info(\"用户已登录，用户id为：{}\", request.getSession().getAttribute(\"employee\"));
            filterChain.doFilter(request, response);
            return;
        }
        log.info(\"用户未登录\");
        //5、如果未登录则返回未登录结果，通过输出流方式向客户端页面响应数据
        response.getWriter().write(JSON.toJSONString(R.error(\"NOTLOGIN\")));
        return;
    }
 
    public boolean check(String[] urls, String requestURI) {
        for (String url : urls) {
            boolean match = PATH_MATCHER.match(url, requestURI);
            if (match) {
                return true;
            }
        }
        return false;
    }
}

3.2 开启组件扫描

需要在启动类上, 加上Servlet组件扫描的注解, 来扫描过滤器配置的@WebFilter注解， 扫描上之后， 过滤器在运行时就生效了。