zoukankan      html  css  js  c++  java

  • 注解

    注释：用一个词就可以描述注解，那就是元数据，即一种描述数据的数据。所以，可以说注解就是源代码的元数据。比如，下面这段代码：

    1
    2
    3
    4
    @Override
    public String toString() {
        return "This is String Representation of current object.";
    }

    上面的代码中，我重写了toString()方法并使用了@Override注解。但是，即使我不使用@Override注解标记代码，程序也能够正常执行。那么，该注解表示什么？这么写有什么好处吗？事实上，@Override告诉编译器这个方法是一个重写方法(描述方法的元数据)，如果父类中不存在该方法，编译器便会报错，提示该方法没有重写父类中的方法。如果我不小心拼写错误，例如将toString()写成了toStrring(){double r}，而且我也没有使用@Override注解，那程序依然能编译运行。但运行结果会和我期望的大不相同。现在我们了解了什么是注解，并且使用注解有助于阅读程序。

    Annotation是一种应用于类、方法、参数、变量、构造器及包声明中的特殊修饰符。它是一种由JSR-175标准选择用来描述元数据的一种工具。

    为什么要引入注解？

    使用Annotation之前(甚至在使用之后)，XML被广泛的应用于描述元数据。不知何时开始一些应用开发人员和架构师发现XML的维护越来越糟糕了。他们希望使用一些和代码紧耦合的东西，而不是像XML那样和代码是松耦合的(在某些情况下甚至是完全分离的)代码描述。如果你在Google中搜索“XML vs. annotations”，会看到许多关于这个问题的辩论。最有趣的是XML配置其实就是为了分离代码和配置而引入的。上述两种观点可能会让你很疑惑，两者观点似乎构成了一种循环，但各有利弊。下面我们通过一个例子来理解这两者的区别。

    假如你想为应用设置很多的常量或参数，这种情况下，XML是一个很好的选择，因为它不会同特定的代码相连。如果你想把某个方法声明为服务，那么使用Annotation会更好一些，因为这种情况下需要注解和方法紧密耦合起来，开发人员也必须认识到这点。

    另一个很重要的因素是Annotation定义了一种标准的描述元数据的方式。在这之前，开发人员通常使用他们自己的方式定义元数据。例如，使用标记interfaces，注释，transient关键字等等。每个程序员按照自己的方式定义元数据，而不像Annotation这种标准的方式。

    目前，许多框架将XML和Annotation两种方式结合使用，平衡两者之间的利弊。

    J2SE5.0版本在 java.lang.annotation提供了四种元注解，专门注解其他的注解：

    @Documented –注解是否将包含在JavaDoc中
    @Retention –什么时候使用该注解
    @Target? –注解用于什么地方
    @Inherited – 是否允许子类继承该注解

    @Documented–一个简单的Annotations标记注解，表示是否将注解信息添加在java文档中。

    　@Documented:

    　　@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

    复制代码
    @Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}
    复制代码

    　　@Inherited：

    　　@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

    　　注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

    　　当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

     1 /**
 2  * 
 3  * @author peida
 4  *
 5  */
 6 @Inherited
 7 public @interface Greeting {
 8     public enum FontColor{ BULE,RED,GREEN};
 9     String name();
10     FontColor fontColor() default FontColor.GREEN;
11 }
    代码示例

    @Retention– 定义该注解的生命周期。

    RetentionPolicy.SOURCE – 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。

    RetentionPolicy.CLASS – 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式。

    RetentionPolicy.RUNTIME– 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

    @Retention：

    　　@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

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

    　　取值（RetentionPoicy）有：

    　　　　1.SOURCE:在源文件中有效（即源文件保留）
    　　　　2.CLASS:在class文件中有效（即class保留）
    　　　　3.RUNTIME:在运行时有效（即运行时保留）

    　　Retention meta-annotation类型有唯一的value作为成员，它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。

    Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理

    1 @Target(ElementType.FIELD)
2 @Retention(RetentionPolicy.RUNTIME)
3 public @interface Column {
4     public String name() default "fieldName";
5     public String setFuncName() default "setField";
6     public String getFuncName() default "getField"; 
7     public boolean defaultDBValue() default false;
8 }
    代码示例

    @Target – 表示该注解用于什么地方。如果不明确指出，该注解可以放在任何地方。以下是一些可用的参数。需要说明的是：属性的注解是兼容的，如果你想给7个属性都添加注解，仅仅排除一个属性，那么你需要在定义target包含所有的属性。

    @Target：

    　　　@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

    　　作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

    　　取值(ElementType)有：

    　　　　1.CONSTRUCTOR:用于描述构造器
    　　　　2.FIELD:用于描述域
    　　　　3.LOCAL_VARIABLE:用于描述局部变量
    　　　　4.METHOD:用于描述方法
    　　　　5.PACKAGE:用于描述包
    　　　　6.PARAMETER:用于描述参数
    　　　　7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

    注解Table 可以用于注解类、接口(包括注解类型) 或enum声明,而注解NoDBColumn仅可用于注解类的成员变量。

     1 @Target(ElementType.TYPE)
 2 public @interface Table {
 3     /**
 4      * 数据表名称注解，默认值为类名称
 5      * @return
 6      */
 7     public String tableName() default "className";
 8 }
 9 
10 @Target(ElementType.FIELD)
11 public @interface NoDBColumn {
12 
13 }
    代码示例

    ElementType.TYPE:用于描述类、接口或enum声明
    ElementType.FIELD:用于描述实例变量
    ElementType.METHOD
    ElementType.PARAMETER
    ElementType.CONSTRUCTOR
    ElementType.LOCAL_VARIABLE
    ElementType.ANNOTATION_TYPE 另一个注释
    ElementType.PACKAGE 用于记录java文件的package信息

    @Inherited – 定义该注释和子类的关系

    那么，注解的内部到底是如何定义的呢？Annotations只支持基本类型、String及枚举类型。注释中所有的属性被定义成方法，并允许提供默认值。

    1 @Target(ElementType.METHOD)
2 @Retention(RetentionPolicy.RUNTIME)
3 @interface Todo {
4 public enum Priority {LOW, MEDIUM, HIGH}
5 public enum Status {STARTED, NOT_STARTED}
6 String author() default "Yash";
7 Priority priority() default Priority.LOW;
8 Status status() default Status.NOT_STARTED;
9 }
    代码示例
     

    下面的例子演示了如何使用上面的注解。

    1 @Todo(priority = Todo.Priority.MEDIUM, author = "Yashwant", status = Todo.Status.STARTED)
2 public void incompleteMethod1() {
3 //Some business logic is written
4 //But it’s not complete yet
5 }
    代码示例
     

    如果注解中只有一个属性，可以直接命名为“value”，使用时无需再标明属性名。

    1
    2
    3
    4
    5
    6
    @interface Author{
    String value();
    }
    @Author("Yashwant")
    public void someMethod() {
    }

    但目前为止一切看起来都还不错。我们定义了自己的注解并将其应用在业务逻辑的方法上。现在我们需要写一个用户程序调用我们的注解。这里我们需要使用反射机制。如果你熟悉反射代码，就会知道反射可以提供类名、方法和实例变量对象。所有这些对象都有getAnnotation()这个方法用来返回注解信息。我们需要把这个对象转换为我们自定义的注释(使用 instanceOf()检查之后)，同时也可以调用自定义注释里面的方法。看看以下的实例代码，使用了上面的注解:

     1 Class businessLogicClass = BusinessLogic.class;
 2 for(Method method : businessLogicClass.getMethods()) {
 3 Todo todoAnnotation = (Todo)method.getAnnotation(Todo.class);
 4 if(todoAnnotation != null) {
 5 System.out.println(" Method Name : " + method.getName());
 6 System.out.println(" Author : " + todoAnnotation.author());
 7 System.out.println(" Priority : " + todoAnnotation.priority());
 8 System.out.println(" Status : " + todoAnnotation.status());
 9 }
10 }
    代码示例
     

    注解用例

    注解的功能很强大，Spring和Hebernate这些框架在日志和有效性中大量使用了注解功能。注解可以应用在使用标记接口的地方。不同的是标记接口用来定义完整的类，但你可以为单个的方法定义注释，例如是否将一个方法暴露为服务。

    在最新的servlet3.0中引入了很多新的注解，尤其是和servlet安全相关的注解。

    HandlesTypes –该注解用来表示一组传递给ServletContainerInitializer的应用类。

    HttpConstraint – 该注解代表所有HTTP方法的应用请求的安全约束，和ServletSecurity注释中定义的HttpMethodConstraint安全约束不同。

    HttpMethodConstraint – 指明不同类型请求的安全约束，和ServletSecurity 注解中描述HTTP协议方法类型的注释不同。

    MultipartConfig –该注解标注在Servlet上面，表示该Servlet希望处理的请求的 MIME 类型是 multipart/form-data。

    ServletSecurity 该注解标注在Servlet继承类上面，强制该HTTP协议请求遵循安全约束。

    WebFilter – 该注解用来声明一个Server过滤器；

    WebInitParam – 该注解用来声明Servlet或是过滤器的中的初始化参数，通常配合 @WebServlet 或者 @WebFilter 使用。

    WebListener –该注解为Web应用程序上下文中不同类型的事件声明监听器。

    WebServlet –该注解用来声明一个Servlet的配置。

     
  • 相关阅读:
    Web中的图标（Sprites雪碧图、Icon Font字体图标）
    那些不推荐使用的html标签
    Vim学习
    web前端性能优化建议
    开发基础
    数据库事务
    java集合详解
    java基础总结大纲（一）
    java设计模式之单例模式（饿汉）
    java设计模式之单例模式（内部静态类）
  • 原文地址：https://www.cnblogs.com/yang82/p/6885860.html
Copyright © 2011-2022 走看看