Java凝视Override、Deprecated、SuppressWarnings具体解释

一、什么是凝视



    说起凝视，得先提一提什么是元数据(metadata)。所谓元数据就是数据的数据。也就是说，元数据是描写叙述数据的。就象数据表中的字段一样，每一个字段描写叙述了这个字段下的数据的含义。而J2SE5.0中提供的凝视就是java源码的元数据，也就是说凝视是描写叙述java源码的。在J2SE5.0中能够自己定义凝视。使用时在@后面跟凝视的名字。


                                                                                    

二、J2SE5.0中提前定义的凝视



    在J2SE5.0的java.lang包中提前定义了三个凝视。它们是Override、Deprecated和SuppressWarnings。以下分别解释它们的含义。




Override



    这个凝视的作用是标识某一个方法是否覆盖了它的父类的方法。那么为什么要标识呢？让我们来看看假设不用Override标识会发生什么事情。

    如果有两个类Class1和ParentClass1，用Class1中的myMethod1方法覆盖ParentClass1中的myMethod1方法。

class ParentClass1
            {
            public void myMethod1() {...}

            }

            class Class1 extends ParentClass1
            {
            public void myMethod2() {...}

            } 

建立Class1的实例，而且调用myMethod1方法

ParentClass1 c1 = new Class1();
            c1.myMethod1();
            

以上的代码能够正常编译通过和执行。可是在写Class1的代码时，误将myMethod1写成了myMethod2，然而在调用时，myMethod1并未被覆盖。因此，c1.myMethod1()调用的还是ParentClass1的myMethod1方法。更不幸的是，程序猿并未意识到这一点。因此，这可能会产生bug。




   假设我们使用Override来修饰Class1中的myMethod1方法，当myMethod1被误写成别的方法时，编译器就会报错。因此，就能够避免这类错误。

class Class1 extends ParentClass1
            {
             @Override // 编译器产生一个错误

            public void myMethod2()
            {...}

            }
            

以上代码编译不能通过，被Override凝视的方法必须在父类中存在相同的方法程序才干编译通过。也就是说仅仅有以下的代码才干正确编译。

class Class1 extends ParentClass1
            {
            @Override
            public void myMethod1() {...}

            }

Deprecated

这个凝视是一个标记凝视。所谓标记凝视，就是在源程序中增加这个标记后，并不影响程序的编译，但有时编译器会显示一些警告信息。

   

    那么Deprecated凝视是什么意思呢？假设你常常使用eclipse等IDE编写java程序时，可能会常常在属性或方法提示中看到这个词。假设某个类成员的提示中出现了个词，就表示这个并不建议使用这个类成员。由于这个类成员在未来的JDK版本号中可能被删除。之所以在如今还保留，是由于给那些已经使用了这些类成员的程序一个缓冲期。假设如今就去了，那么这些程序就无法在新的编译器中编译了。




    讲到这，可能你已经猜出来了。Deprecated凝视一定和这些类成员有关。说得对！使用Deprecated标注一个类成员后，这个类成员在显示上就会有一些变化。在eclipse中很明显。让我们看看图1有哪些变化。






图1 加上@Deprecated后的类成员在eclipse中的变化

从上图能够看出，有三个地方发生的变化。红色框里面的是变化的部分。

    1. 方法定义处

    2. 方法引用处

    3. 显示的成员列表中



    发生这些变化并不会影响编译，仅仅是提醒一下程序猿，这种方法以后是要被删除的，最好别用。



    Deprecated凝视另一个作用。就是假设一个类从另外一个类继承，而且override被继承类的Deprecated方法，在编译时将会出现一个警告。如test.java的内容例如以下：

class Class1
            {
            @Deprecated
            public void myMethod(){}

            }

            class Class2 extends Class1
            {
            public void myMethod(){}

            } 

执行javac test.java 出现例如以下警告：



    注意：test.java 使用或覆盖了已过时的 API。

    注意：要了解具体信息，请使用 -Xlint:deprecation 又一次编译

    使用-Xlint:deprecation显示更具体的警告信息：



    test.java:4: 警告：[deprecation] Class1 中的 myMethod() 已过时



    public void myMethod()

    ^

    1 警告



    这些警告并不会影响编译，仅仅是提醒你一下尽量不要用myMethod方法。



    SuppressWarnings



    这个世界的事物总是成对出现。即然有使编译器产生警告信息的，那么就有抑制编译器产生警告信息的。

    SuppressWarnings凝视就是为了这样一个目的而存在的。让我们先看一看例如以下的代码。

public void myMethod()
            {
            List wordList = new ArrayList();
            wordList.add("foo");
            }

这是一个类中的方法。编译它，将会得到例如以下的警告。



    注意：Testannotation.java 使用了未经检查或不安全的操作。

    注意：要了解具体信息，请使用 -Xlint:unchecked 又一次编译。



    这两行警告信息表示List类必须使用范型才是安全的，才干够进行类型检查。假设想不显示这个警告信息有两种方法。一个是将这种方法进行例如以下改写：

public void myMethod()

{

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

  wordList.add("foo");

}



第二种方法就是使用@SuppressWarnings。

@SuppressWarnings (value={"unchecked"})

public void myMethod()

{

  List wordList = new ArrayList();

  wordList.add("foo");

}

要注意的是SuppressWarnings和前两个凝视不一样。这个凝视有一个属性。当然，还能够抑制其他警告，如:

@SuppressWarnings (value={"unchecked", "fallthrough"})

三、怎样自己定义凝视



    凝视的强大之处是它不仅能够使java程序变成自描写叙述的，并且同意程序猿自己定义凝视。凝视的定义和接口差点儿相同，仅仅是在interface前面多了一个“@”。

public @interface MyAnnotation
            {
            }

上面的代码是一个最简单的凝视。这个凝视没有属性。也能够理解为是一个标记凝视。就象Serializable接口一样是一个标记接口，里面没有定义不论什么方法。



    当然，也能够定义有属性的凝视。

public @interface MyAnnotation
            {
              String value();
            }

能够按例如以下格式使用MyAnnotation

@MyAnnotation("abc")
            public void myMethod()
            {
            }

看了上面的代码，大家可能有一个疑问。怎么没有使用value，而直接就写”abc”了。那么”abc”究竟传给谁了。事实上这里有一个约定。假设没有写属性名的值，而这个凝视又有value属性，就将这个值赋给value属性，假设没有，就出现编译错误。




    除了能够省略属性名，还能够省略属性值。这就是默认值。

public @interface MyAnnotation
            {
              public String myMethod(){} default “xyz”;
            }

能够直接使用MyAnnotation

@MyAnnotation // 使用默认值xyz

            public void myMethod()
            {
            }

也能够这样使用

@MyAnnotation(myMethod=”abc”)
            public void myMethod()
            {
            }

假设要使用多个属性的话。能够參考例如以下代码。

public @interface MyAnnotation
            {
            public enum MyEnum{A, B, C}

            public MyEnum.value1() {}

            public String value2() {}

            }

            @MyAnnotation(value1=MyAnnotation.MyEnum.A, value2 = “xyz”)
            public void myMethod()
            {
            }

这一节讨论了怎样自己定义凝视。那么定义凝视有什么用呢？有什么方法对凝视进行限制呢？我们能从程序中得到凝视吗？这些疑问都能够从以下的内容找到答案。

四、怎样对凝视进行凝视



    这一节的题目读起来尽管有些绕口，但它所蕴涵的知识却对设计更强大的java程序有非常大帮助。

在上一节讨论了自己定义凝视，由此我们可知凝视在J2SE5.0中也和类、接口一样。是程序中的一个主要的组成部分。既然能够对类、接口进行凝视，那么当然也能够对凝视进行凝视。


    使用普通凝视对凝视进行凝视的方法和对类、接口进行凝视的方法一样。所不同的是，J2SE5.0为凝视单独提供了4种凝视。它们是Target、Retention、Documented和Inherited。以下就分别介绍这4种凝视。




   Target

   这个凝视理解起来很easy。因为target的中文意思是“目标”，因此，我们可能已经猜到这个凝视和某一些目标相关。那么这些目标是指什么呢？大家能够先看看以下的代码。

@Target(ElementType.METHOD)
            @interface MyAnnotation {}

            @MyAnnotation // 错误的使用

            public class Class1
            {
            @MyAnnotation // 正确的使用

            public void myMethod1() {}

            }

以上代码定义了一个凝视MyAnnotation和一个类Class1，而且使用MyAnnotation分别对Class1和myMethod1进行凝视。假设编译这段代码是无法通过的。或许有些人感到吃惊，没错啊！但问题就出在@Target(ElementType.METHOD)上，因为Target使用了一个枚举类型属性，它的值是ElementType.METHOD。这就表明MyAnnotation仅仅能为方法凝视。而不能为其他的不论什么语言元素进行凝视。因此，MyAnnotation自然也不能为Class1进行凝视了。


  

讲到这，大家可能已经基本明确了。原来target所指的目标就是java的语言元素。如类、接口、方法等。当然，Target还能够对其他的语言元素进行限制，如构造函数、字段、參数等。如仅仅同意对方法和构造函数进行凝视能够写成：

@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
            @interface MyAnnotation {}

Retention

     既然能够自己定义凝视，当然也能够读取程序中的凝视（怎样读取凝视将在下一节中讨论）。可是凝视仅仅有被保存在class文件里才干够被读出来。而Retention就是为设置凝视是否保存在class文件里而存在的。以下的代码是Retention的具体使用方法。

@Retention(RetentionPolicy.SOURCE)
            @interface MyAnnotation1 { }

            @Retention(RetentionPolicy.CLASS)
            @interface MyAnnotation2 {}

            @Retention(RetentionPolicy.RUNTIME)
            @interface MyAnnotation3 {}

当中第一段代码的作用是不将凝视保存在class文件里，也就是说象“//”一样在编译时被过滤掉了。第二段代码的作用是仅仅将凝视保存在class文件里，而使用反射读取凝视时忽略这些凝视。第三段代码的作用是即将凝视保存在class文件里，也能够通过反射读取凝视。




Documented



    这个凝视和它的名子一样和文档有关。在默认的情况下在使用javadoc自己主动生成文档时，凝视将被忽略掉。假设想在文档中也包括凝视，必须使用Documented为文档凝视。

@interface MyAnnotation{ }

            @MyAnnotation
            class Class1
            {
            public void myMethod() { }

            }

使用javadoc为这段代码生成文档时并不将@MyAnnotation包括进去。生成的文档对Class1的描写叙述例如以下：

class Class1extends java.lang.Object
            而假设这样定义MyAnnotation将会出现还有一个结果。
            @Documented
            @interface MyAnnotation {}

            生成的文档：
            @MyAnnotation // 这行是在加上@Documented后被加上的

            class Class1extends java.lang.Object
            

Inherited



     继承是java基本的特性之中的一个。在类中的protected和public成员都将会被子类继承，可是父类的凝视会不会被子类继承呢？非常遗憾的告诉大家，在默认的情况下，父类的凝视并不会被子类继承。假设要继承，就必须加上Inherited凝视。

@Inherited
            @interface MyAnnotation { }

            @MyAnnotation
            public class ParentClass {}

            public class ChildClass extends ParentClass { }

            在以上代码中ChildClass和ParentClass一样都已被MyAnnotation凝视了。 

五、怎样使用反射读取凝视



    前面讨论了怎样自己定义凝视。可是自己定义了凝视又有什么用呢？这个问题才是J2SE5.0提供凝视的关键。自己定义凝视当然是要用的。那么怎样用呢？解决问题就须要使用java最令人兴奋的功能之中的一个：反射(reflect)。


在曾经的JDK版本号中，我们能够使用反射得到类的方法、方法的參数以及其他的类成员等信息。那么在J2SE5.0中相同也能够象方法一样得到凝视的各种信息。



    在使用反射之前必须使用import java.lang.reflect.* 来导入和反射相关的类。

    假设要得到某一个类或接口的凝视信息，能够使用例如以下代码：



Annotation annotation = TestAnnotation.class.getAnnotation(MyAnnotation.class);



假设要得到所有的凝视信息可使用例如以下语句：

Annotation[] annotations = TestAnnotation.class.getAnnotations();

或

Annotation[] annotations = TestAnnotation.class.getDeclaredAnnotations();



getDeclaredAnnotations与getAnnotations类似，但它们不同的是getDeclaredAnnotations得到的是当前成员全部的凝视，不包含继承的。而getAnnotations得到的是包含继承的全部凝视。




    假设要得到其他成员的凝视，可先得到这个成员，然后再得到对应的凝视。如得到myMethod的凝视。

Method method = TestAnnotation.class.getMethod("myMethod", null);
            Annotation annotation = method.getAnnotation(MyAnnotation.class);
            注：要想使用反射得到凝视信息，这个凝视必须使用
            @Retention(RetentionPolicy.RUNTIME)进行凝视。
            

总结

    凝视是J2SE5.0提供的一项很有趣的功能。它不但有趣，并且还很实用。EJB3规范就是借助于凝视实现的。这样将使EJB3在实现起来更简单，更人性化。还有Hibernate3除了使用传统的方法生成hibernate映射外，也能够使用凝视来生成hibernate映射。总之，假设能将凝视灵活应用到程序中，将会使你的程序更加简洁和强大。

转自【来自网络，原始出处已不可考】