投稿
  1. 极客之音首页
  2. 技术随笔

JavaWeb——过滤器

小半 • • 技术随笔 • 阅读 212

导读：本篇文章讲解 JavaWeb——过滤器，希望对大家有帮助，欢迎收藏，转发！站点地址：www.bmabk.com

初识过滤器

  • 过滤器(Filter) 是J2EE Servlet模块下的组件

  • Filter的作用是对URL进行统一的拦截处理

  • Filter通常用于应用程序层面进行全局处理

过滤流程

JavaWeb——过滤器

 

开发过滤器的三要素

  • 任何过滤器都要实现javax.servlet.Filter接口

  • 在Filter接口的doFilter()方法中编写过滤器的功能代码

  • 在web.xmI中对过滤器进行配置，说明拦截URL的范围

开发第一个过滤器

public class AdminFilter implements Filter {
/**
* doFilter 方法，专门用于拦截请求。可以做权限检查
*/
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain
	filterChain) throws IOException, ServletException {
         //参数ServletRequest并非是HttpServletRequest，所以需要强制转换
        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
        HttpSession session = httpServletRequest.getSession();
        Object user = session.getAttribute("user");
        // 如果等于 null，说明还没有登录
        if (user == null) {
			servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest,servletResponse);
				return;
        } else {
        // 让程序继续往下访问用户的目标资源
        //将请求和响应对象随着过滤链依次向后传递
        filterChain.doFilter(servletRequest,servletResponse);
	}
}
    
}

web.xml中的配置

<!--filter 标签用于配置一个 Filter 过滤器，用于说明哪个类是过滤器，并在应用启动时自动加载-->
<filter>
    <!--给 filter 起一个别名-->
    <filter-name>AdminFilter</filter-name>
    <!--配置 filter 的全类名-->
    <filter-class>com.atguigu.filter.AdminFilter</filter-class>
</filter>

<!--filter-mapping 配置 Filter 过滤器的拦截路径 url的范围-->
<filter-mapping>
    <!--filter-name 表示当前的拦截路径给哪个 filter 使用-->
    <filter-name>AdminFilter</filter-name>
    <!--url-pattern 配置拦截路径，说明过滤器的作用范围
        / 表示请求地址为：http://ip:port/工程路径/ 映射到 IDEA 的 web 目录
        /admin/* 表示请求地址为：http://ip:port/工程路径/admin/*
    -->
<url-pattern>/admin/*</url-pattern>
</filter-mapping>

过滤器的生命周期

  1. 构造器方法

  2. init 初始化方法

    第 1，2 步，在 web 工程启动的时候执行（Filter 已经创建），init执行完之后并不会立即执行doFilter。

  3. doFilter 过滤方法

    第 3 步，每次拦截到请求，就会执行 ，doFilter 执行的时机是在每一个请求过来以后被doFilter 方法拦截处理。

  4. destroy 销毁

    第 4 步，停止 web 工程的时候，就会执行（停止 web 工程，也会销毁 Filter）

过滤器的特性

  • 过滤器对象在Web应用启动时被创建且全局唯一

  • 唯一的过滤器对象在并发环境中采用“多线程”提供服务

    • 保证过滤器不会频繁创建对象消耗系统资源

    • 采用多线程有效提高多用户在同一个过滤器当中的执行速度

过滤器的两种开发形式

配置形式：

<!--filter 标签用于配置一个 Filter 过滤器，用于说明哪个类是过滤器，并在应用启动时自动加载-->
<filter>
    <!--给 filter 起一个别名-->
    <filter-name>AdminFilter</filter-name>
    <!--配置 filter 的全类名-->
    <filter-class>com.atguigu.filter.AdminFilter</filter-class>
</filter>

<!--filter-mapping 配置 Filter 过滤器的拦截路径 url的范围-->
<filter-mapping>
    <!--filter-name 表示当前的拦截路径给哪个 filter 使用-->
    <filter-name>AdminFilter</filter-name>
    <!--url-pattern 配置拦截路径，说明过滤器的作用范围
        / 表示请求地址为：http://ip:port/工程路径/ 映射到 IDEA 的 web 目录
        /admin/* 表示请求地址为：http://ip:port/工程路径/admin/*
    -->
<url-pattern>/admin/*</url-pattern>
</filter-mapping>

注解形式：

@WebFilter(filterName="MyAnnoationFilter",urlPatterns= "/*")
public class MyAnnotationFilter implements Filter { 
    ....
}

配置形式维护性更好，适合应用全局过滤，并且易于维护。

注解形式开发体验更好，适用于小型项目敏捷开发。

案例——字符集过滤器

web中文乱码的解决

  • GET请求——server.xml增加URIEncoding=”UTF-8″

  • POST请求——使用request.setCharacterEncoding(“UTF-8”);

  • 响应——response.setContentType(” text/html; charset=UTF-8″)

@WebFilter(filterName="CharacterEncodingFilter",urlPatterns= "/*")
public class MyAnnotationFilter implements Filter { 
        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain
        filterChain) throws IOException, ServletException {
        
        HttpServletRequest req = (HttpServletRequest) request;
        req.setCharacterEncoding("UTF-8") ;
        HttpServletResponseres = (HttpServletResponse) response;
        res.setContentType ("text/html ; charset=UTF-8") ;
        chain.doFilter(request, response) ;
	}
}

ServletRequest 是所有请求中最顶级的定义，定义了所有请求的共同特点。

HttpServletRequest接口继承了ServletRequest接口，并且扩展定义了自己的方法，并且只对Http协议有效。

FilterConfig 类

FilterConfig 类见名知义，它是 Filter 过滤器的配置文件类。

Tomcat 每次创建 Filter 的时候，也会同时创建一个 FilterConfig 类，这里包含了 Filter 配置文件的配置信息。

FilterConfig 类的作用是获取 filter 过滤器的配置内容

  1. 获取 Filter 的名称 filter-name标签 的内容

  2. 获取在 Filter 中配置的 init-param 初始化参数 ,即过滤器参数化

    过滤器为了增强灵活性，允许配置信息放在web.xml

    在web.xml中配置<init-param>设置过滤器参数

  3. 获取 ServletContext 对象

<!--filter 标签用于配置一个 Filter 过滤器-->
<filter>
    <!--给 filter 起一个别名-->
    <filter-name>AdminFilter</filter-name>
    <!--配置 filter 的全类名-->
    <filter-class>com.atguigu.filter.AdminFilter</filter-class>
        <init-param>
        <param-name>username</param-name>
        <param-value>root</param-value>
        </init-param>
    
        <init-param>
        <param-name>url</param-name>
        <param-value>jdbc:mysql://localhost3306/test</param-value>
        </init-param>
</filter>
@Override
public void init(FilterConfig filterConfig) throws ServletException {
    System.out.println("2.Filter 的 init(FilterConfig filterConfig)初始化");
    // 1、获取 Filter 的名称 filter-name 的内容
    System.out.println("filter-name 的值是：" + filterConfig.getFilterName());
    // 2、获取在 web.xml 中配置的 init-param 初始化参数
    System.out.println("初始化参数 username 的值是：" + filterConfig.getInitParameter("username"));
    System.out.println("初始化参数 url 的值是：" + filterConfig.getInitParameter("url"));
    // 3、获取 ServletContext 对象
    System.out.println(filterConfig.getServletContext());
}

过滤器参数化的注解形式

@WebFilter(filterName="CharacterEncodingFilter",urlPatterns= "/*"
initParams= {
    @WebInitParam (name="encoding"，value="UTF-8"),
    @WebInitParam (name="p1"，value="v1"),
    @WebInitParam (name= "p2" ，value="v2")
})
)
public class MyAnnotationFilter implements Filter {

    private String encoding;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        encoding = filterConfig.getInitParameter ("encoding") ;
        System.out.println("encoding: "+encoding) ;
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest req = (HttpServletRequest) request;
        req.setCharacterEncoding(encoding) ;
        HttpServletResponseres = (HttpServletResponse) response;
        res.setContentType ("text/html ; charset="+encoding) ;
        chain.doFilter(request, response) ;
	}
}

UrlPattern设置过滤范围

  • –精确匹配

    /target.jsp 以上配置的路径，表示请求地址必须为：http://ip:port/工程路径/target.jsp

  • –目录匹配

    /admin/* 以上配置的路径，表示请求地址必须为：http://ip:port/工程路径/admin/*

  • –后缀名匹配

    *.html 以上配置的路径，表示请求地址必须以.html 结尾才会拦截到 *.do 以上配置的路径，表示请求地址必须以.do 结尾才会拦截到 *.action 以上配置的路径，表示请求地址必须以.action 结尾才会拦截到

Filter 过滤器它只关心请求的地址是否匹配，不关心请求的资源是否存在

过滤链

注意事项

  • 每一个过滤器应具有单独职能

  • 过滤器的执行顺序以<filter-mapping>为准

  • 调用chain.doFilter()将请求向后传递

JavaWeb——过滤器

        可以看到，在多个filter过滤器执行的时候，他们执行的优先顺序是由在web.xml中从上到下配置的顺序决定。如果是用注解配置filter呢？

        作为利用注解描述的过滤器，它按照类名的排序规则来决定，默认的执行顺序是按照字母表的升序进行排列，且不区分大小写。

@WebFilter (filterName="FilterA"，urlPatterns="/*")
public class FilterA implements Filter { }

@WebFilter (filterName="FilterB"，urlPatterns="/*")
public class FilterB implements Filter { }

@WebFilter (filterName="FilterC"，urlPatterns="/*")
public class FilterC implements Filter { }

执行顺序为 FilterA–>FilterB–>FilterC

        在实际项目中并不推荐用过滤链的情况下使用注解形式，一旦使用注解便会按照类名进行排序，这会影响到系统的维护性以及让系统变得不稳定。

案例——多端设备自动适配

开发一个设备适配的过滤器，通过客户端的特征来决定网页显示PC端和界面还是移动端界面。

public class DeviceAdapterFilter implements Filter { 
    
      public void doFilter(ServletRequest request, ServletResponse response, FilterChain
        filterChain) throws IOException, ServletException {

            HttpServletRequest req = (HttpServletRequest) request;
            HttpServletResponse res = (HttpServletResponse) response ;

            /*
            /index.html
            PC: /desktop/index.html
            MOBILE: /mobile/index.html
            /test.html
            PC: /desktop/test.html
            MOBILE: /mobile/test.html
            */

            String uri = req.getRequestURI();   //这里的uri其实就是/index.html或/test.html
            if (uri.startsWith ("/desktop") || uri.startsWith("/mobile")) {
                /*
                如果浏览器发来的请求天然的在前面带/mobile或者/desktop这两个前缀的话
                就代表这是一个正确的PC端或者手机端的链接
                我们就不需要进行处理，直接把请求向后送就行了
                */
                chain.doFilter(request, response);
            }else{
                //客户端的特征在请求头user-agent有所体现(简单判断)
                String userAgent = req.getHeader("user-agent").toLowerCase();
                if(userAgent.indexOf("android")!=-1||userAgent.indexOf("iphone")!=-1){
                    /*
                    可以看到手机端并没有最后去执行chain.doFilter，而且使用了重定向
                    它的含义是如果遇到移动端的话，那么重新构建了要跳转的url之后，请求在这个过滤器就会被中断
                    同时通知客户端的浏览器重新发起一个请求向目录下的对应页面进行获取
                    */
                    targetURI = "/mobile" + uri;
                    System.out.prin1n("i移动端设备正在访问，重新跳转URI："+ targetURI);
                    res.sendRedirect(targetURI);
                }else{
                    targetURI = "/mdesktop" + uri;
                    System.out.prin1n("PC端设备正在访问，重新跳转URI："+ targetURI);
                    res.sendRedirect(targetURI);
                }
            }
      	 }  
      }

 

版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 举报，一经查实，本站将立刻删除。

文章由极客之音整理，本文链接：https://www.bmabk.com/index.php/post/99482.html

赞 (0)
小半的头像小半
0 0

相关推荐

极客之音——专业性很强的中文编程技术网站，欢迎收藏到浏览器，订阅我们！