注解 - 码农教程

内容

元数据
注解的分类
内置注解
自定义注解
注解处理器
Servlet3.0

注解是Java 1.5引入的，目前已被广泛应用于各种Java框架，如Hibernate，Jersey，

Spring。注解相当于是一种嵌入在程序中的元数据，可以使用注解解析工具或编译器对

其进行解析，也可以指定注解在编译期或运行期有效。

在注解诞生之前，程序的元数据存在的形式仅限于java注释或javadoc，但注解可以提

供更多功能，它不仅包含元数据，还能作用于运行期，注解解析器能够使用注解决定处

理流程。

Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和任何元数据

(metadata)的途径和方法。Annotation是一个接口，程序可以通过反射来获取指定

程序元素的Annotation对象，然后通过Annotation对象来获取注解里面的元数据。

注解API非常强大，被广泛应用于各种Java框架，如Spring，Hibernate，JUnit。

一、元数据metadata

元数据从metadata一词译来，就是“关于数据的数据”的意思，即描述数据的结构信息。元数据的功能作用有很多，比如：你可能用过Javadoc的注释自动生成文档。这就是元数据功能的一种。总的来说，元数据可以用来创建文档，跟踪代码的依赖性，执行编译时格式检查，代替已有的配置文件。

在Java中元数据以标签的形式存在于Java代码中，元数据标签的存在并不影响程序代码的编译和执行，被用来生成其它的文件或只在运行时知道被运行代码的描述信息。

其作用如下:

①生成文档：这是最常见的，也是java 最早提供的注解。常用的有@param @return 等;

② 跟踪代码依赖性，实现替代配置文件功能。常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量。;

③在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。

二、注解的分类

根据注解参数的个数:

1)、标记注解:一个没有成员定义的Annotation类型被称为标记注解。

2)、单值注解:只有一个值

3)、完整注解:拥有多个值

根据注解使用方法和用途:

1)、JDK内置系统注解

2)、元注解

3)、自定义注解

三、内置注解

JavaSE中内置三个标准注解，定义在java.lang中：

@Override

限定重写父类方法，若想要重写父类的一个方法时，需要使用该注解告知编译器我们正在重写一个方法。如此一来，当父类的方法被删除或修改了，编译器会提示错误信息；或者该方法不是重写也会提示错误。

public interface Car {

void run();

}

class QQ implements Car{

@Override

public void run() {}

}

class Bmw implements Car{

@Override

void run() {}

}

QQ 类编译不会有任何问题，Bmw类在编译的时候会提示相应的错误。父类中省略了public abstract修饰符。@Override注解只能用于方法，不能用于其他程序元素。

@Deprecated

标记已过时，当我们想要让编译器知道一个方法已经被弃用(deprecate)时，应该使用这个注解。Java推荐在javadoc中提供信息，告知用户为什么这个方法被弃用了，以及替代方法是什么；

/**

* Deprecated -->该方法过时(有更好的解决方案)

* @author Administrator

public class TestDeprecated {

@Deprecated

public int test(){

System.out.println("TestDeprecated.test()");

return 0;

}

public void test(int a){

System.out.println("TestDeprecated.test(int)");

}

3. @SuppressWarnings

抑制编译器警告，该注解仅仅告知编译器，忽略它们产生了特殊警告。如：在java泛型中使用原始类型。其保持性策略(retention policy)是SOURCE，在编译器中将被丢弃。

/**

* SuppressWarnings 压制警告

* @author Administrator

public class TestSuppressWarnings {

public static void main(String[] args) {

@SuppressWarnings("unused")

List<String> list =new ArrayList<String>();

}

@SuppressWarnings("rawtypes") //没有定义范型

public static List test(){

return new ArrayList();

}

四、自定义注解

1、简单入门

@interface:用来声明一个注解。注解类里的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型。可以通过default来声明参数的默认值。

@interface Simple{

//这里定义了一个空的注解 }

2、元注解

元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解有四个，

这些类型和它们所支持的类在java.lang.annotation包中可以找到。

@Target

用于描述注解的使用范围（即：被描述的注解可以用在什么地方）。表示支持注解的程序元素的种类，一些可能的值有TYPE, METHOD, CONSTRUCTOR, FIELD等等。如果Target元注解不存在，那么该注解就可以使用在任何程序元素之上。

取值(ElementType)有：

　1.CONSTRUCTOR:用于描述构造器

　2.FIELD:用于描述域

　3.LOCAL_VARIABLE:用于描述局部变量

　4.METHOD:用于描述方法

　5.PACKAGE:用于描述包

　6.PARAMETER:用于描述参数

　7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

此时在空注解中加入@Target元注解如:

//此注解只能用在方法上

@Target(ElementType.METHOD)

@interface TestMethod {}

@Retention

表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）表示注解类型保留时间的长短。

取值(RetentionPoicy)有：

1.SOURCE:在源文件中有效（即源文件保留）

2.CLASS:在class文件中有效（即class保留）

3.RUNTIME:在运行时有效（即运行时保留）

此时在上述注解中加入@Retention元注解如:

// 此注解可以用于注解类、接口(包括注解类型) 或enum声明

@Target(ElementType.TYPE)

//该注解运行时有效。注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理

@Retention(RetentionPolicy.RUNTIME)

@interface TestRn{

}

@Documented

表示使用该注解的元素应被javadoc或类似工具文档化，它应用于类型声明，类型声明的注解会影响客户端对注解元素的使用。如果一个类型声明添加了Documented注解，那么它的注解会成为被注解元素的公共API的一部分，@Documented是一个标记注解。

//可以被例如javadoc此类的工具文档化

@Documented

@interface TestDoc{

}

@Inherited

表示一个注解类型会被自动继承，如果用户在类声明的时候查询注解类型，同时类声明中也没有这个类型的注解，那么注解类型会自动查询该类的父类，这个过程将会不停地重复，直到该类型的注解被找到为止，或是到达类结构的顶层（Object）。

//被子类继承的注解

@Inherited

@interface TestInheri{}

3、深入自定义注解

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。

⑴定义注解格式：

@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

public @interface 注解名{定义体s}

⑵注解参数(即方法)

注解里面的每一个方法实际上就是声明了一个配置参数，其规则如下:

①修饰符

只能用public或默认(default)这两个访问权修饰，默认为default

②类型

注解参数只支持以下数据类型：

基本数据类型（int,float,boolean,byte,double,char,long,short)；

String类型；

Class类型；

enum类型；

Annotation类型;

以上所有类型的数组

③命名

对取名没有要求，如果只有一个参数成员,最好把参数名称设为"value",后加小括号。

④参数

注解中的方法不能存在参数

⑤默认值

可以包含默认值，使用default来声明默认值。

⑶实例如下

* 码农定义注解

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

@interface Programmer{

String value() default "马云";

}

/**

* 码农类型注解

* @author peida

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

@interface ProgrammerType {

/**

* 类型枚举程序猿射鸡师

public enum CoderType{MONKEYS,LION,CHOOK};

/**

* 颜色属性

CoderType type() default CoderType.MONKEYS;

}

/**

* 码农制造厂

* @author Administrator

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

@interface ProgrammerProductor {

/**

* 厂家编号

* @return

public int id() default -1;

/**

* 厂家名称

* @return

public String name() default "shsxt";

/**

* 厂家地址

* @return

public String address() default "上海";

}

/**

* 注解使用

class Coder{

@Programmer("老裴")

private String coderName;

@ProgrammerType(type=CoderType.MONKEYS)

private String coderType;

@ProgrammerProductor(id=1,name="程序猿乐园",address="荣乐东路")

private String coderProductor;

public String getCoderName() {

return coderName;

}

public void setCoderName(String coderName) {

this.coderName = coderName;

}

public String getCoderType() {

return coderType;

}

public void setCoderType(String coderType) {

this.coderType = coderType;

}

public String getCoderProductor() {

return coderProductor;

}

public void setCoderProductor(String coderProductor) {

this.coderProductor = coderProductor;

}

五、注解处理器

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

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

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

2、解析实例

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);s

coderProvider+="编号："+fruitProvider.id()+" 名称："+fruitProvider.name()+" 地址:"+fruitProvider.address();

System.out.println(coderProvider);

}

注意：

注解解析器原理

* 1. 先拿到反射对象--- 属性或者方法 --> 他的注解对象-> 渠道注解的数据信息注解

六、 Servlet3.0

@WebServlet

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

@WebServlet注解的相关属性
NO.	属性名	描述
1	asyncSupported	声明Servlet是否支持异步操作模式
2	description	Servlet的描述信息
3	displayName	Servlet的显示名称
3	initParams	Servlet的初始化参数
5	name	Servlet的名称
6	urlPatterns	Servlet的访问URL
7	value	Servlet的访问URL

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

/**

* 使用注解标注过滤器:@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

使用注解@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>

</head>

<body>

上传文件:<input type="file" name="file1"><br/>

上传文件:<input type="file" name="file2"><br/>

</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("\"", "");

}

@WebListener

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());

}

原文地址：https://www.cnblogs.com/lotus-wmm/p/12102344.html

注解

内容

一、 元数据metadata

二、 注解的分类

三、 内置注解

四、 自定义注解

1、简单入门

2、元注解

3、深入自定义注解

五、 注解处理器

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

2、解析实例

六、 Servlet3.0

@WebServlet

@WebFilter

@MultipartConfig

1)、页面制作

2)、编写Servlet

@WebListener

一、元数据metadata

二、注解的分类

三、内置注解

四、自定义注解

五、注解处理器