Spring Boot电商项目27：商品分类模块六：统一校验管理员身份；（选用【J2EE中的过滤器】来实现需求；重难点是【如何在Spring Boot项目中，使用过滤器】；）

说明：

（1）本篇博客合理性说明：

          ● 在【增加目录分类】和【更新目录分类】的时候，都需要是管理员用户登录的状态；我们，在两个的校验代码是一样的；

          ● 由此，就引发了两个不好的地方：（1）任何需要校验管理员用户登录的状态的地方，我们都需要重复写一样的代码；（2）如果我们已经在很多地方都写了【校验管理员用户登录的状态的代码】，万一以后我们的校验逻辑发生变化后，我们就需要在很多地方都去修改，而这不仅麻烦，还可能会遗漏；

          ● 所以，我们目前就是把【校验管理员用户登录的状态】的逻辑代码，给统一一下；

（2）对于这种需求，我们肯定能想到可以使用：【J2EE中的过滤器】或【Spring 中的AOP】或【Spring MVC中的拦截器】来解决；有关这三个知识点的内容，在本专栏的前面我们介绍过；可以参考；

          ● 【附加：【J2EE中的过滤器】、【Spring 中的AOP】、【Spring MVC中的拦截器】的区别；（不要看，没写完……）】；

          ● 【Spring Boot电商项目11：数据库设计与项目初始化六：使用【AOP】来实现【打印，请求与响应的，日志信息】的需求；（遇到了RequestContextHolder来获取请求与响应对象）】；

          ● 而在本篇博客中，我们是选用【J2EE中的过滤器】来实现需求的；

（3）特别声明的一点：  有关【J2EE中的过滤器】的内容，可以参考【（5）常用功能与过滤器、监听器、FreeMarker；】的内容；但是，本篇博客存在一些不同，本篇博客的重难点是：如何在Spring Boot项目中，使用过滤器；

目录

一：正式开发：使用过滤器，来实现【统一校验管理员身份】的需求；

1.定义一个过滤器类； 

2.配置过滤器类，即注册过滤器类到容器；（这儿演示了，Spring Boot项目中，通过配置类去配置过滤器的案例）

3.测试，验证；

（1）说明；

（2）启动项目，测试；

（3）总结；

---

一：正式开发：使用过滤器，来实现【统一校验管理员身份】的需求；

1.定义一个过滤器类； 

AdminFilter过滤器类：

package com.imooc.mall.filter;

import com.imooc.mall.common.ApiRestResponse;
import com.imooc.mall.common.Constant;
import com.imooc.mall.exception.ImoocMallExceptionEnum;
import com.imooc.mall.model.pojo.Category;
import com.imooc.mall.model.pojo.User;
import com.imooc.mall.service.UserService;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
import javax.servlet.http.HttpSession;
import java.io.IOException;
import java.io.PrintWriter;

/**
 * 描述：过滤器类;
 * 功能：校验管理员身份;
 */
public class AdminFilter implements Filter {
    @Autowired
    UserService userService;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }


    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

        //首先，获取Session对象；以便可以尝试从Session对象中，获取当前登录用户；
        HttpServletRequest httpServletRequest = (HttpServletRequest) request;
        HttpSession session = httpServletRequest.getSession();


        //尝试获取当前登录用户
        User currentUser = (User) session.getAttribute(Constant.IMOOC_MALL_USER);
        //如果获取不到，说明当前没有用户登录；就返回【用户未登录】的信息
        if (currentUser == null) {
            PrintWriter out = new HttpServletResponseWrapper((HttpServletResponse) response).getWriter();
            out.write("{\n" +
                    "    \"status\": 10007,\n" +
                    "    \"msg\": \"NEED_LOGIN\",\n" +
                    "    \"data\": null\n" +
                    "}");
            out.flush();
            out.close();
            //直接return的意思是，直接结束方法；不会执行后面的内容了；（自然，这儿直接结束方法的结果就是：这个请求不会进入Controller）
            return;
        }

        //校验当前用户是否是管理员用户
        boolean isAdminRole = userService.checkAdminRole(currentUser);

        if (isAdminRole) {//如果是管理用户；就放行这个请求；执行【chain.doFilter(request, response);】会把这个请求放行到下一个过滤器或者Controller
            chain.doFilter(request, response);
        } else {//如果不是管理员用户；就没有放行这个请求，而是给出一个错误提示；
            PrintWriter out = new HttpServletResponseWrapper((HttpServletResponse) response).getWriter();
            out.write("{\n" +
                    "    \"status\": 10009,\n" +
                    "    \"msg\": \"NEED_ADMIN\",\n" +
                    "    \"data\": null\n" +
                    "}");
            out.flush();
            out.close();
            //这儿的return，是可以不添加的；因为，如果方法执行到这儿的时候，就已经结束了；
            return;
        }
    }


    @Override
    public void destroy() {
    }
}

说明：

（0）如果对过滤器的基础内，不清楚了，可以先去看看【（5）常用功能与过滤器、监听器、FreeMarker；】专栏中的内容；

（1）过滤器类需要实现javax.servlet.Filter接口；然后，去实现init()，doFilter()，destroy()方法；；；这儿我们主要是在doFilter()方法中，编写逻辑；

（2）方法说明：先获取Session对象，然后尝试获取当前登录用户； 

（3）（PS：理解这儿的思考逻辑，很重要哦）如果获取不到当前登录用户（也就意味着，当前是未登录状态）：那么这个请求就不向后传递了，而是直接根据对应的接口返回信息，组织错误信息，然后输出；

          ● 首先，原来的时候，在需要登录的地方，如果检测到用户未登录；我们需要构建对应的ApiRestResponse统一返回对象，然后序列化为JSON，返回给前端；

          ● 现在，有了过滤器；我们依然要这么做；；只是，这个校验用户登录与否的工作，由【Controller】变成了【过滤器】；

          ● 自然，如果过滤器检测到用户未登录；那么这个请求就没必要向后传递给Controller了；；；；过滤器就地组织对应的返回信息就行了，然后把这个信息写到响应中；（当然，过滤器组织返回信息时，要根据原先Controller的标准也就是接口的要求啦，去组织）

          ● 所以，这儿我们直接复制【原先的，提示未登录的ApiRestResponse统一返回对象，序列化为JSON的，字符串】；作为此种情况下，过滤器返回的内容；

（4）同理，如果登录了，但不是管理员用户；一样的处理方式；

（5）如果，校验通过了，是管理员用户登录了；那么就把这个请求，向后传递给Controller；（PS：如果后面还有过滤器的话，就是向后先传递给下个过滤器）

2.配置过滤器类，即注册过滤器类到容器；（这儿演示了，Spring Boot项目中，通过配置类去配置过滤器的案例）

AdminFilterConfig类：

package com.imooc.mall.config;

import com.imooc.mall.filter.AdminFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 描述：【校验管理员用户的过滤器：AdminFilter】的配置类；
 */
@Configuration
public class AdminFilterConfig {
    @Bean
    public AdminFilter adminFilter() {
        return new AdminFilter();
    }

    @Bean(name = "adminFilterConf")
    public FilterRegistrationBean adminFilterConfig() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(adminFilter());
        filterRegistrationBean.addUrlPatterns("/admin/category/*");
        filterRegistrationBean.addUrlPatterns("/admin/product/*");
        filterRegistrationBean.addUrlPatterns("/admin/order/*");
        filterRegistrationBean.setName("adminFilterConfig");
        return filterRegistrationBean;
    }
}

说明：

（0）这儿明显发现，这儿在Spring Boot项目中配置过滤器，和  【（5）常用功能与过滤器、监听器、FreeMarker；】中配置过滤器的方式，在表象上是存在不同的；

（1.1）【@Configuration】注解，最近的一次使用，是在本专栏的配置Swagger的时候【Spring Boot电商项目25：商品分类模块四：使用Swagger自动生成API文档；（PS：在配置类上，又一次遇到了使用@Configuration注解的情况）】；是使用【@Configuration注解】，来指明当前类是一个配置类；

（1.2）第一次介绍【@Configuration注解】和【@Bean注解】是在【Spring IoC容器与Bean管理25：使用Java Config方式实现Spring IoC一：对象实例化；（@Configuration，@Bean）】；如有需要，可以先去快速参考这篇博客内容；

（1.3）主要内容就是：

          ● @Configuration：这个注解，放在配置类上； 即，如果一个类使用了@Configuration注解，说明这个类就是个Java Config的配置类，这个配置类的作用就是完全替代xml文件；

          ● @Bean：这个注解用在方法上，那么这个方法返回的对象将被IoC容器管理，同时这个bean的bean Id默认为方法名；

（2）配置内容说明；

PS：有关这个配置的内容呐，暂时可以先不深究；目前，能做到比着葫芦画瓢就OK了；；；以后，如果需要可以深入研究一下；

（3）过滤器拦截的URL说明：

那么，是这样的吗？经过回顾项目内容，和，查看接口文档；发现，是这样的；深刻感觉到，和数据库设计能力一样，【接口（文档）的设计能力】也是很重要的；（结构清晰，架构合理的接口设计，这种能力需要慢慢提升）

3.测试，验证；

（1）说明；

我们已经编写了上面的过滤器，按理说原先的【新增目录分类接口】和【更新目录分类接口】的校验管理员用户登录的逻辑代码可以删除了；

但是，这人为了图省事，原先的【新增目录分类接口】和【更新目录分类接口】代码就懒得该了；而是创建【删除分类目录】的接口（反正，接下来我们要开发这个接口），通过这个接口来测试；

---

 

（2）启动项目，测试；

 

……………………………………………………

……………………………………………………

---

 

（3）总结；

有了这个过滤器后；再开发其他【需要管理员用户登录才能进行的接口】时，我们即不用关心登录校验的问题了；我们在开发Controller的时候，只需要关心【业务逻辑】就可以了；

其实，能够知道，遇到其他类似需求时，这儿的解决思路完全可以参考；