Java注解注解处理器servlet30乐字节

jiezi

5 年前

大家好，我是乐字节的小乐，上次给大家带来了 Java 注解 - 元数据、注解分类、内置注解和自定义注解 | 乐字节，这次接着往下讲注解处理器和 servlet3.0

使用注解的过程中，很重要的一部分就是创建于使用注解处理器。Java SE5 扩展了反射机制的 API，以帮助程序员快速的构造自定义注解处理器。

Java 使用 Annotation 接口来代表程序元素前面的注解，该接口是所有 Annotation 类型的父接口。除此之外，Java 在 java.lang.reflect 包下新增了 AnnotatedElement 接口，该接口代表程序中可以接受注解的程序元素，该接口主要有如下几个实现类：

Class：类定义
Constructor：构造器定义
Field：累的成员变量定义
Method：类的方法定义
Package：类的包定义

java.lang.reflect 包下主要包含一些实现反射功能的工具类，实际上，java.lang.reflect 包所有提供的反射 API 扩充了读取运行时 Annotation 信息的能力。当一个 Annotation 类型被定义为运行时的 Annotation 后，该注解才能是运行时可见，当 class 文件被装载时被保存在 class 文件中的 Annotation 才会被虚拟机读取。

AnnotatedElement 接口是所有程序元素（Class、Method 和 Constructor）的父接口，所以程序通过反射获取了某个类的 AnnotatedElement 对象之后，程序就可以调用该对象的如下四个个方法来访问 Annotation 信息：

①<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回该程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回 null。

②Annotation[] getAnnotations(): 返回该程序元素上存在的所有注解。

③boolean is AnnotationPresent(Class<?extends Annotation> annotationClass): 判断该程序元素上是否包含指定类型的注解，存在则返回 true，否则返回 false.

④Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注释。与此接口中的其他方法不同，该方法将忽略继承的注释。（如果没有注释直接存在于此元素上，则返回长度为零的一个数组。）该方法的调用者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响。

public class ParseCoder {public static void main(String[] args) {
        String coderName="名称：";
        String coderType="类型：";
        String coderProvider="厂家信息如下";
        Field [] fields=Coder.class.getDeclaredFields();
        for(Field field:fields){if(field.isAnnotationPresent(Programmer.class)){Programmer pro=(Programmer)field.getAnnotation(Programmer.class);
                coderName=coderName+pro.value();
                System.out.println(coderName);
            }else if(field.isAnnotationPresent(ProgrammerType.class)){ProgrammerType type=(ProgrammerType)field.getAnnotation(ProgrammerType.class);
                coderType=coderType+type.type().toString();
                System.out.println(coderType);
            }else if(field.isAnnotationPresent(ProgrammerProductor.class)){ProgrammerProductor fruitProvider=(ProgrammerProductor)field.getAnnotation(ProgrammerProductor.class);
                coderProvider+="编号："+fruitProvider.id()+"名称："+fruitProvider.name()+"地址:"+fruitProvider.address();
                System.out.println(coderProvider);
            }
        }
    }
}

使用注解达到零配置，开发 servlet 项目，使用 @WebServlet 将一个继承于 javax.servlet.http.HttpServlet 的类定义为 Servlet 组件。在 Servlet3.0 中，可以使用 @WebServlet 注解将一个继承于 javax.servlet.http.HttpServlet 的类标注为可以处理用户请求的 Servlet。

@WebServlet 注解的相关属性

Servlet 的访问 URL 是 Servlet 的必选属性，可以选择使用 urlPatterns 或者 value 定义。如一个 Servlet 可以描述成:

@WebServlet(name=”ServletDemo”,value=”/ServletDemo”)。

也定义多个 URL 访问：如

@WebServlet(name=”ServletDemo”,urlPatterns={“/ServletDemo”,”/ServletDemo2″})

或者：

@WebServlet(name=”AnnotationServlet”,value={“/ServletDemo”,”/ServletDemo2″})

initParams 可以用来指定当前 Servlet 的初始化参数，它是一个数组，里面每一个 @WebInitParam 表示一个参数。

@WebServlet(value=”/servlet/init-param”, initParams={@WebInitParam(name=”param1″, value=”value1″)})

测试实例如下

/**
 * 使用 @WebServlet 将一个继承于 javax.servlet.http.HttpServlet 的类定义为 Servlet 组件。如 @WebServlet 有很多的属性：1、asyncSupported：声明 Servlet 是否支持异步操作模式。2、description：Servlet 的描述。3、displayName：Servlet 的显示名称。4、initParams：Servlet 的 init 参数。5、name：Servlet 的名称。6、urlPatterns：Servlet 的访问 URL。7、value：Servlet 的访问 URL。Servlet 的访问 URL 是 Servlet 的必选属性，可以选择使用 urlPatterns 或者 value 定义。如 @WebServlet(name="TestServlet",value="/TestServlet")，也定义多个 URL 访问：如 @WebServlet(name="TestServlet",urlPatterns={"/TestServlet","/Test"})
或 @WebServlet(name="TestServlet",value={"/TestServlet","/Test"})
 */
@WebServlet(name="/TestServlet",urlPatterns={"/test"})
public class TestServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {response.getWriter().print("hello servlet3");
    }
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {doGet(request, response);
    }
}

初始化参数

@WebServlet(value="/init", 
initParams={@WebInitParam(name="param1", value="sxt")})
public class TestInit extends HttpServlet {
    private static final long serialVersionUID = 1L;
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {Enumeration<String> paramNames = this.getServletConfig().getInitParameterNames();  
      String paramName;  
      while (paramNames.hasMoreElements()) {paramName = paramNames.nextElement();  
         response.getWriter().append(paramName + "=" + this.getServletConfig().getInitParameter(paramName));  
      }  
      response.getWriter().close();  
    }
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {doGet(request, response);
    }
}

/**
 * 使用注解标注过滤器:@WebFilter 将一个实现了 javax.servlet.Filter
 * 接口的类定义为过滤器，属性 filterName 声明过滤器的名称, 可选
 * 属性 urlPatterns 指定要过滤 的 URL 模式, 也可使用属性 value 来声明.
 * (指定要过滤的 URL 模式是必选属性),
 * 可以指定多种过滤模式 @WebFilter(filterName="TestFilter",
 * urlPatterns={"/User","/index.jsp"})
 * @author Administrator
 */
@WebFilter(filterName="TestFilter",urlPatterns="/*")
public class TestFilter implements Filter  {
    @Override
    public void destroy() {System.out.println("过滤器销毁");
    }
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {System.out.println("执行过滤操作");
        chain.doFilter(request, response);
    }
    @Override
    public void init(FilterConfig arg0) throws ServletException {System.out.println("过滤器初始化");
    }
}

使用注解 @MultipartConfig 将一个 Servlet 标识为支持文件上传。Servlet3.0 将 multipart/form-data 的 POST 请求封装成 Part，通过 Part 对上传的文件进行操作。

注意:Servlet3 没有提供直接获取文件名的方法, 需要从请求头中解析出来

1)、页面制作

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title> 文件上传 </title>
</head>
<body>
    <fieldset>
        <legend> 上传文件 </legend>
        <!-- 文件上传时必须要设置表单的 enctype="multipart/form-data" -->
        <form action="${pageContext.request.contextPath}/upload" method="post" enctype="multipart/form-data">
            上传文件:<input type="file" name="file1"><br/>
            上传文件:<input type="file" name="file2"><br/>
            <input type="submit" value="上传">
        </form>
    </fieldset>
</body>
</html>

2)、编写 Servlet

/**
 * Servlet3.0 将 multipart/form-data 的 POST 请求封装成 Part，* 通过 Part 对上传的文件进行操作,Servlet3 没有提供直接获取文件名的方法,
 * 需要从请求头中解析出来, 获取请求头，请求头的格式：* 火狐和 google 浏览器下：form-data; name="file"; filename="snmp4j--api.zip"
* @author Administrator
 */
@WebServlet(name = "TestUpload", urlPatterns = "/upload")
@MultipartConfig
public class TestUpload extends HttpServlet {public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {request.setCharacterEncoding("utf-8");
        response.setCharacterEncoding("utf-8");
        response.setContentType("text/html;charset=utf-8");
        // 存储路径
String savePath = request.getServletContext().getRealPath("/WEB-INF/upload");
        // 获取上传的文件集合
        Collection<Part> parts = request.getParts();
        // 上传单个文件
        if (parts.size()==1) {
            // 通过文件名获取文件
            Part part = request.getPart("file");
            // 从请求头中获取文件
            String header = part.getHeader("content-disposition");
            // 获取文件名
            String fileName = getFileName(header);
            // 把文件写到指定路径
            part.write(savePath+File.separator+fileName);
        }else{for (Part part : parts) {// 循环处理上传的文件
// 请求头的格式：form-data; name="file"; filename="snmp4j--api.zip"
                 String header = part.getHeader("content-disposition");
                 // 获取文件名
String fileName = getFileName(header);
                if(!fileName.equals("")){
                    // 把文件写到指定路径
                    part.write(savePath+File.separator+fileName);
                }                 
             }
        }
        PrintWriter out = response.getWriter();
        out.println("上传成功");
        out.flush();
        out.close();}
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {this.doGet(req,resp);
    }
    /**
     * 获取文件名
* 火狐和 google 浏览器下：form-data; name="file"; filename="snmp4j--api.zip"
     * @param header
     * @return
     */
    private  String getFileName(String header) {String[] headArr = header.split(";")[2].split("=");
        // 获取文件名，兼容各种浏览器的写法        
        return headArr[1].substring(headArr[1].lastIndexOf("\\")+1).replaceAll("\"", "");
        
    }
}

Servlet3.0 提供 @WebListener 注解将一个实现了特定监听器接口的类定义为监听器。将实现了 ServletContextListener 接口的 MyServletContextListener 标注为监听器。

@WebListener
public class TestListener implements ServletContextListener {
    @Override
    public void contextDestroyed(ServletContextEvent event) {System.out.println("ServletContext 销毁");
    }
    @Override
    public void contextInitialized(ServletContextEvent event) {System.out.println("ServletContex 初始化");
         System.out.println(event.getServletContext().getServerInfo());
    }
}

有关注解就介绍到这里了，感谢各位老板的光顾和学习。

请继续关注乐字节，后续不断更新 Java 干货资料和视频。

Java注解注解处理器servlet30乐字节

一、注解处理器

1、注解处理器类库 java.lang.reflect.AnnotatedElement

2、解析实例

二、Servlet3.0

1、@WebServlet

2、@WebFilter

3、@MultipartConfig

4、@WebListener