springboot-MVC 过滤器使用

一、前言

　　一下代码以SSO用户登录列子代码。完整代码https://gitee.com/xuxueli0323/xxl-sso

二、使用

　2.1 创建过滤器

　　创建一个过滤器，实现Filter 接口

public class XxlSsoTokenFilter extends HttpServlet implements Filter {

    private static Logger logger = LoggerFactory.getLogger(XxlSsoTokenFilter.class);

    private static final AntPathMatcher antPathMatcher = new AntPathMatcher();

    private String ssoServer;

    private String logoutPath;

    private String excludedPaths;

    @Override

    public void init(FilterConfig filterConfig) throws ServletException {

        ssoServer = filterConfig.getInitParameter(Conf.SSO_SERVER);

        logoutPath = filterConfig.getInitParameter(Conf.SSO_LOGOUT_PATH);

        excludedPaths = filterConfig.getInitParameter(Conf.SSO_EXCLUDED_PATHS);

        logger.info("XxlSsoTokenFilter init.");

    }

    @Override

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

        HttpServletRequest req = (HttpServletRequest) request;

        HttpServletResponse res = (HttpServletResponse) response;

        // make url

        String servletPath = req.getServletPath();

        // excluded path check

        if (excludedPaths!=null && excludedPaths.trim().length()>0) {

            for (String excludedPath:excludedPaths.split(",")) {

                String uriPattern = excludedPath.trim();

                // 支持ANT表达式

                if (antPathMatcher.match(uriPattern, servletPath)) {

                    // excluded path, allow

                    chain.doFilter(request, response);

                    return;

                }

            }

        }

        // logout filter

        if (logoutPath!=null

                && logoutPath.trim().length()>0

                && logoutPath.equals(servletPath)) {

            // logout

            SsoTokenLoginHelper.logout(req);

            // response

            res.setStatus(HttpServletResponse.SC_OK);

            res.setContentType("application/json;charset=UTF-8");

            res.getWriter().println("{\"code\":"+ReturnT.SUCCESS_CODE+", \"msg\":\"\"}");

            return;

        }

        // login filter

        XxlSsoUser xxlUser = SsoTokenLoginHelper.loginCheck(req);

        if (xxlUser == null) {

            // response

            res.setStatus(HttpServletResponse.SC_OK);

            res.setContentType("application/json;charset=UTF-8");

            res.getWriter().println("{\"code\":"+Conf.SSO_LOGIN_FAIL_RESULT.getCode()+", \"msg\":\""+ Conf.SSO_LOGIN_FAIL_RESULT.getMsg() +"\"}");

            return;

        }

        // ser sso user

        request.setAttribute(Conf.SSO_USER, xxlUser);

        // already login, allow

        chain.doFilter(request, response);

        return;

    }

}

　　2.2 注册filter

　　　使用java 配置 @Configuration 注解配置，通过FilterRegistrationBean ，向spring容器中注入过滤器。

@Configuration

public class XxlSsoConfig implements DisposableBean {

    @Value("${xxl.sso.server}")

    private String xxlSsoServer;

    @Value("${xxl.sso.logout.path}")

    private String xxlSsoLogoutPath;

    @Value("${xxl.sso.redis.address}")

    private String xxlSsoRedisAddress;

    @Value("${xxl-sso.excluded.paths}")

    private String xxlSsoExcludedPaths;

    @Bean

    public FilterRegistrationBean xxlSsoFilterRegistration() {

        // xxl-sso, redis init

        JedisUtil.init(xxlSsoRedisAddress);

        // xxl-sso, filter init

        FilterRegistrationBean registration = new FilterRegistrationBean();

        registration.setName("XxlSsoWebFilter");

        registration.setOrder(1);

        registration.addUrlPatterns("/*");

        registration.setFilter(new XxlSsoTokenFilter());

        registration.addInitParameter(Conf.SSO_SERVER, xxlSsoServer);

        registration.addInitParameter(Conf.SSO_LOGOUT_PATH, xxlSsoLogoutPath);

        registration.addInitParameter(Conf.SSO_EXCLUDED_PATHS, xxlSsoExcludedPaths);

        return registration;

    }

    @Override

    public void destroy() throws Exception {

        // xxl-sso, redis close

        JedisUtil.close();

    }

}