JavaWeb学习笔记九 过滤器、注解
过滤器 Filter
filter 是对客户端访问资源的过滤，符合条件放行，不符合条件不放行，并且可以对目标资源访问前后进行逻辑处理。
步骤：
- 编写一个过滤器的类实现 Filter 接口
- 实现接口中尚未实现的方法 (着重实现 doFilter 方法)
- 在 web.xml 中进行配置 (主要是配置要对哪些资源进行过滤)
例子，过滤器实现类：
package com.yyb.filter;import java.io.IOException;
import javax.servlet.*;/**
Created by Administrator on 2017/7/28.
*/
public class FilterDemo implements Filter {
@Override
//Filter 创建的时候执行 init 方法
public void init(FilterConfig filterConfig) throws ServletException {
//1、获得 web.xml 中 filter 的名称 <filter-name>FilterDemo</filter-name>
System.out.println(filterConfig.getFilterName());
//2、获得当前 filter 的初始化参数
System.out.println(filterConfig.getInitParameter("aaa"));
//3、获得 servletContext
filterConfig.getServletContext();System.out.println(</span>"init ...."<span style="color: rgba(0, 0, 0, 1)">);}
@Override
//doFilter 是 Filter 的核心过滤的方法
/*
request: 内部封装是客户端 http 请求的内容
response: 代表是响应
FilterChain: 过滤器链对象
*/
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {System.out.println("quick1 running....");
//放行请求
chain.doFilter(request, response);
}@Override
//Filter 对象销毁的时候执行 destory 方法
public void destroy() {
System.out.println("destroy...");
}
}
web.xml
<filter> <filter-name>FilterDemo</filter-name> <filter-class>com.yyb.filter.FilterDemo</filter-class> </filter> <filter-mapping> <filter-name>FilterDemo</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
Filter 的 API 详解
filter 生命周期及其与生命周期相关的方法，Filter 接口有三个方法，并且这个三个都是与 Filter 的生命相关的方法：
- init(Filterconfig)：代表 filter 对象初始化方法，filter 对象创建时执行。
- doFilter(ServletRequest,ServletResponse,FilterCha)：代表 filter 执行过滤的核心方法，如果某资源在已经被配置到这个 filter 进行过滤的话，那么每次访问这个资源都会执行 doFilter 方法。
- destory()：代表是 filter 销毁方法，当 filter 对象销毁时执行该方法。
Filter 对象的生命周期
- Filter 何时创建：服务器启动时就创建该 filter 对象
- Filter 何时销毁：服务器关闭时 filter 销毁
init(FilterConfig)：其中参数 config 代表该 Filter 对象的配置信息的对象，内部封装是该 filter 的配置信息。
destory() 方法：filter 对象销毁时执行。
doFilter 方法：doFilter(ServletRequest,ServletResponse,FilterChain)，其中的参数 ServletRequest/ServletResponse 是每次在执行 doFilter 方法时 web 容器负责创建一个 request 和一个 response 对象作为 doFilter 的参数传递进来。该 request 与 response 就是在访问目标资源的 service 方法时的 request 和 response。FilterChain 是过滤器链对象，通过该对象的 doFilter 方法可以放行该请求。chain 对象根据配置的 filter-mapping 顺序依次执行 filter。
Filter 的配置
<filter> <filter-name>FilterDemo</filter-name> <filter-class>com.yyb.filter.FilterDemo</filter-class> </filter> <filter-mapping> <filter-name>FilterDemo</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
url-pattern 配置
- 完全匹配
/Servlet1, 只有访问 Servlet1 时才执行
- 目录匹配 /aaa/bbb/*
/user/*：访问前台的资源进入此过滤器
/admin/*：访问后台的资源时执行此过滤器
- 扩展名匹配 *.abc *.jsp
注意：url-pattern 可以使用 servlet-name 替代，也可以混用。
<filter-mapping> <filter-name>FilterDemo</filter-name> <!--<url-pattern>/*</url-pattern>--> <servlet-name>FilterTest</servlet-name> <servlet-name>FilterTest1</servlet-name> </filter-mapping>
dispatcher：访问的方式
- REQUEST：默认值，代表直接访问某个资源时执行 filter
- FORWARD：转发时才执行 filter
- INCLUDE: 包含资源时执行 filter
- ERROR：发生错误时 进行跳转时执行 filter
例子：web.xml
<filter> <filter-name>FilterDemo</filter-name> <filter-class>com.yyb.filter.FilterDemo</filter-class> </filter> <filter-mapping> <filter-name>FilterDemo</filter-name> <url-pattern>/*</url-pattern> <dispatcher>REQUEST</dispatcher> </filter-mapping>
在 FilterTest 中, 添加转发代码 request.getRequestDispatcher("/index.jsp").forward(request, response); ，此时当访问 FilterTest 时，过滤器只会执行依次，而不是两次。转发时不会执行过滤器。
但是重定向会执行两次，在 FilterTest 中, 添加转发代码 response.sendRedirect(request.getContextPath()+"/index.jsp"); ，可以看到执行结果。
Filter 的作用
- 公共代码的提取
- 可以对 request 和 response 中的方法进行增强 (装饰者模式 / 动态代理)
- 进行权限控制
使用 filter 解决参数中文乱码
package com.ithiema.web.filter;import java.io.IOException;
import java.io.UnsupportedEncodingException;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.HttpServletRequestWrapper;public class EncodingFilter implements Filter{
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {</span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">request.setCharacterEncoding("UTF-8"); </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">在传递request之前对request的getParameter方法进行增强</span> <span style="color: rgba(0, 128, 0, 1)">/*</span><span style="color: rgba(0, 128, 0, 1)"> * 装饰者模式(包装) * * 1、增强类与被增强的类要实现统一接口 * 2、在增强类中传入被增强的类 * 3、需要增强的方法重写 不需要增强的方法调用被增强对象的 * </span><span style="color: rgba(0, 128, 0, 1)">*/</span> <span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">被增强的对象</span> HttpServletRequest req =<span style="color: rgba(0, 0, 0, 1)"> (HttpServletRequest) request; </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">增强对象</span> EnhanceRequest enhanceRequest = <span style="color: rgba(0, 0, 255, 1)">new</span><span style="color: rgba(0, 0, 0, 1)"> EnhanceRequest(req); chain.doFilter(enhanceRequest, response); } @Override </span><span style="color: rgba(0, 0, 255, 1)">public</span> <span style="color: rgba(0, 0, 255, 1)">void</span><span style="color: rgba(0, 0, 0, 1)"> destroy() { } @Override </span><span style="color: rgba(0, 0, 255, 1)">public</span> <span style="color: rgba(0, 0, 255, 1)">void</span> init(FilterConfig filterConfig) <span style="color: rgba(0, 0, 255, 1)">throws</span><span style="color: rgba(0, 0, 0, 1)"> ServletException { }}
class EnhanceRequest extends HttpServletRequestWrapper{
private HttpServletRequest request;
public EnhanceRequest(HttpServletRequest request) {
super(request);
this.request = request;
}</span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">对getParaameter增强</span>@Override
public String getParameter(String name) {
String parameter = request.getParameter(name);//乱码
try {
parameter = new String(parameter.getBytes("iso8859-1"),"UTF-8");
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
return parameter;
}
}
注解
注解就是符合一定格式的语法 @xxxx，是给jvm 看的，给机器看的。注解在目前而言最主流的应用是代替配置文件。
关于配置文件与注解开发的优缺点：
- 优点：开发效率高，成本低
- 缺点：耦合性大，并且不利于后期维护
jdk5 提供的注解
@Override：告知编译器此方法是覆盖父类的
@Deprecated：标注过时
@SuppressWarnings：压制警告
不同的注解只能在不同的位置使用(方法上、字段上、类上)
自定义注解
怎样去编写一个自定义的注解，使用 @interface 关键字。
public @interface MyAnno { //注解的属性 String name(); int age() default 28; }
怎样去使用注解
@MyAnno(name="",age=20) public void show(){ }@MyAnno(name</span>=""<span style="color: rgba(0, 0, 0, 1)">) </span><span style="color: rgba(0, 0, 255, 1)">public</span> <span style="color: rgba(0, 0, 255, 1)">void</span><span style="color: rgba(0, 0, 0, 1)"> show1(){ }</span></pre>
注意：如果属性的名字是 value，并且注解的属性值只有一个，那么在使用注解时可以省略 value。注解属性类型只能是以下几种: 基本类型；String；枚举类型；注解类型；Class 类型 ；以上类型的一维数组类型。
public @interface MyAnno2 {//String value();
String[]value();
}
//@MyAnno2("aa")
//public void show2(){//}
@MyAnno3({"name","age"})
public void show3(){
}</span></pre>
怎样去解析注解 ----- 使用反射知识
介入一个概念，元注解。代表修饰注解的注解，作用是限制定义的注解的特性。
@Retention
- SOURCE: 注解在源码级别可见，在字节码文件中就没有了。
- CLASS：注解在字节码文件级别可见
- RUNTIME：注解在整个运行阶段都可见
@Target 代表注解修饰的范围：类上使用，方法上使用，字段上使用
- FIELD: 字段上可用此注解
- METHOD: 方法上可以用此注解
- TYPE: 类 / 接口上可以使用此注解
import java.lang.reflect.Method;/**
Created by Administrator on 2017/7/28.
*/
public class MyAnnoParse {
public static void main(String[]args) throws NoSuchMethodException {</span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">解析show方法上面的@MyAnno </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">直接的目的是 获得show方法上的@MyAnno中的参数 </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">获得show方法的字节码对象</span> Class clazz = MyAnnoTest.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">; Method method </span>= clazz.getMethod("show", String.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">); </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">获得show方法上的@MyAnno</span> MyAnno annotation = method.getAnnotation(MyAnno.<span style="color: rgba(0, 0, 255, 1)">class</span><span style="color: rgba(0, 0, 0, 1)">); </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">获得@MyAnno上的属性值</span> System.out.println(annotation.name());<span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">zhangsan</span> System.out.println(annotation.age());<span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">28 </span><span style="color: rgba(0, 128, 0, 1)">//</span><span style="color: rgba(0, 128, 0, 1)">根据业务需求写逻辑代码</span>}
}
注意：要想解析使用了注解的类 ，那么该注解的 Retention 必须设置成 Runtime，注解解析的实质是从注解中解析出属性值
字节码对象存在于获得注解相关的方法
isAnnotationPresent(Class<? extends Annotation> annotationClass) ： 判断该字节码对象身上是否使用该注解了 getAnnotation(Class<A> annotationClass) ：获得该字节码对象身上的注解对象