Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能 1。它们可以用来标记类、方法、变量、参数和包等
简而言之,注解就是对于代码中某些鲜活个体的贴上去的一张标签。简化来讲,注解如同一张标签。
Java注解可以分为三类:标准注解,元注解和自定义注解。标准注解是Java语言预定义的一些注解,例如@Override、@Deprecated和@SuppressWarnings。元注解是用来定义其他注解的注解,例如@Retention、@Documented、@Target和@Inherited。此外,您还可以创建自定义注解来满足您的特定需求
Java定义了一套内置的注解,共有7个,其中3个在java.lang包中,剩下4个在java.lang.annotation包中。这些注解包括:@Override、@Deprecated、@SuppressWarnings、@Retention、@Documented、@Target和@Inherited
元注解是负责对其它注解进行说明的注解,自定义注解时可以使用元注解。Java 5 定义了 4 个注解,分别是 @Documented、@Target、@Retention 和 @Inherited。Java 8 又增加了 @Repeatable 和 @Native 两个注解。这些注解都可以在 java.lang.annotation 包中找到
Java注解可以应用于许多方面。它们可以用来提供有关代码的元数据,例如方法是否已被重写(@Override),或者方法是否已被弃用(@Deprecated)。它们还可以用来影响代码的运行方式,例如通过使用 @SuppressWarnings 来抑制编译器警告。此外,注解还可以用于框架中,例如Spring和Hibernate,以提供有关如何处理类和方法的信息。
在Java中,@Override是一个注解,它用于指示方法是覆盖超类中的方法。当您在子类中编写方法时,如果该方法具有与超类中的方法相同的名称和参数,则可以使用@Override注解来确保您实际上是在覆盖超类中的方法,而不是意外地创建一个新方法。
@Override注解不是必需的,但它可以帮助您更好地理解代码。如果您使用@Override注解,那么如果您意外地更改了超类中的方法签名,Java编译器将会发出错误,提醒您必须更新子类中的方法签名以匹配超类中的方法。
public class Animal {
public void makeSound() {
System.out.println("The animal makes a sound");
}
}
public class Dog extends Animal {
@Override
public void makeSound() {
System.out.println("The dog barks");
}
}
在这个例子中,Dog类继承自Animal类,并覆盖了makeSound()方法。@Override注解用于指示makeSound()方法实际上是在覆盖超类中的方法。
如果试图使用 @Override 标记一个实际上并没有覆写父类的方法时,java 编译器会告警。
class Parent {
public void foo() {
System.out.println("Parent's foo");
}
}
class Child extends Parent {
@Override
public void bar() {
System.out.println("Child's bar");
}
}
在Java中,@Deprecated是一个注解,用于标明被修饰的类或类成员、类方法已经废弃、过时,不建议使用。
使用@Deprecated注解可以帮助开发人员更好地管理代码库,以确保在未来的版本中,不会意外地使用不再受支持的代码。如果您在您的代码中使用了@Deprecated注解,编译器将会在编译时发出警告。
public class MyClass {
/**
* This method is deprecated and should not be used anymore.
* Use the newMethod() method instead.
*/
@Deprecated
public void oldMethod() {
System.out.println("This method is deprecated.");
}
public void newMethod() {
System.out.println("This is the new method.");
}
}
在这个例子中,MyClass类中的oldMethod()方法被标记为已弃用,并提供了一条注释,说明应该使用newMethod()方法代替。如果您在代码中使用了oldMethod()方法,Java编译器将会发出警告。
注意,@Deprecated注解仅仅是一个标记,它不会强制您停止使用已经被标记为已弃用的代码。但是,使用已经被弃用的代码可能会导致不良后果,因此,您应该尽可能地避免使用它们,除非您确实需要使用它们。
在Java中,@SuppressWarnings是一个注解,它用于告诉编译器忽略特定的警告。当您在编写代码时,Java编译器可能会发出一些警告,这些警告有时可能是不重要的或者您已经处理过了,但这些警告可能会影响代码的可读性。使用@SuppressWarnings注解可以帮助您清除这些无关紧要的警告,使得代码更易于理解。
public class MyClass {
@SuppressWarnings("unchecked")
public void myMethod() {
List myList = new ArrayList(); // 产生警告:使用原始类型
myList.add("Hello");
System.out.println(myList);
}
}
在这个例子中,MyClass类中的myMethod()方法使用了@SuppressWarnings注解,并指定了一个警告类型"unchecked"。这是因为在方法中,我们使用了一个未经泛型化的ArrayList对象,这将产生一个警告,提示我们使用了原始类型。
通过使用@SuppressWarnings注解,我们告诉编译器忽略这个警告,因为我们知道我们在使用ArrayList时,确实不需要使用泛型。
1)抑制单类型的警告
@SuppressWarnings("unchecked")
public void addItems(String item){
@SuppressWarnings("rawtypes")
List items = new ArrayList();
items.add(item);
}
2)抑制多类型的警告
@SuppressWarnings(value={"unchecked", "rawtypes"})
public void addItems(String item){
List items = new ArrayList();
items.add(item);
}
3)抑制所有类型的警告
@SuppressWarnings("all")
public void addItems(String item){
List items = new ArrayList();
items.add(item);
}
@SuppressWarnings 注解的常见参数值的简单说明:
1."unchecked":指示编译器在使用未经检查的转换时不发出警告。使用泛型时,可能会出现“未经检查的转换”警告,这是因为泛型擦除导致在运行时无法确定类型。但是在某些情况下,我们确信类型是安全的,因此可以使用@SuppressWarnings("unchecked")注解来抑制警告。
2."deprecation":指示编译器在使用已弃用的方法或类时不发出警告。如果您使用了已经被标记为已弃用的方法或类,Java编译器将会发出一个“已弃用”的警告,使用@SuppressWarnings("deprecation")可以抑制该警告。
3."rawtypes":指示编译器在使用未经泛型化的类或接口时不发出警告。使用泛型时,应该避免使用未经泛型化的类或接口,但是如果确实需要使用,可以使用@SuppressWarnings("rawtypes")来抑制警告。
4."unused":指示编译器在使用未使用的变量、方法或字段时不发出警告。未使用的代码可能会降低代码的可读性,但在某些情况下,我们可能需要暂时保留未使用的代码。使用@SuppressWarnings("unused")可以抑制该警告。
5."all":指示编译器在所有警告类型上都不发出警告。使用@SuppressWarnings("all")可以抑制所有警告,但这种做法不推荐,因为它会隐藏真正的问题
@FunctionalInterface是Java 8中引入的一个内置注解,用于标记一个接口为函数式接口。函数式接口指的是只有一个抽象方法的接口,它们通常用于支持Java中的Lambda表达式和方法引用。
使用@FunctionalInterface注解可以确保接口仅有一个抽象方法,并提供了一种简单的方法来检查接口是否符合函数式接口的标准。如果标记为@FunctionalInterface的接口具有多个抽象方法,则编译器会抛出一个错误。函数式接口(Functional Interface)就是一个有且仅有一个抽象方法,但是可以有多个非抽象方法的接口。
@FunctionalInterface
public interface MyInterface {
void doSomething();
}
在上面的示例中,MyInterface接口只有一个抽象方法doSomething(),因此可以使用@FunctionalInterface注解进行标记。如果您在该接口中添加另一个抽象方法,编译器会抛出错误,因为这个接口不再符合函数式接口的标准。
元注解是一种注解,它们用于注解其他注解。Java定义了几种元注解,它们可以用于自定义注解,以控制注解的行为和用途
@Target是Java内置注解之一,用于指定注解可以应用的元素类型。该注解可以应用在自定义注解上,用于控制自定义注解可以应用的元素类型,表示我们注解可以用在哪些地方包括:
@Target(ElementType.TYPE)
public @interface MyAnnotation {
String value();
}
在上面的示例中,MyAnnotation注解使用@Target注解指定了它只能应用于类、接口或枚举类型。如果您尝试将MyAnnotation注解应用于字段或方法等其他元素类型,则编译器会抛出错误。
使用@Target注解可以帮助控制自定义注解的应用范围,使其更加灵活和通用。
2.2.2@ Retention
@ Retention用来定义该注解在哪一个级别可用在源代码中(SOURCE)、类文件中(CLASS)或者运行时(RUNTIME)。
@Retention是Java内置注解之一,用于指定注解的保留时间。它包含三个值:SOURCE、CLASS和RUNTIME。其中,SOURCE表示注解仅在源代码中可见,不会被编译器编译进字节码文件中;CLASS表示注解会被编译器编译进字节码文件中,但在运行时不会被JVM保留;RUNTIME表示注解会被编译器编译进字节码文件中,并在运行时保留在JVM中,可以通过反射来获取注解信息。
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value();
}
在上面的示例中,MyAnnotation注解使用@Retention注解指定了它在运行时会被保留。这意味着可以在运行时通过反射来获取注解信息,以便执行一些特定的操作。
使用@Retention注解可以帮助控制注解的保留时间,使其可以被用于不同的场景。例如,在编写ORM框架时,可以使用@Retention(RetentionPolicy.RUNTIME)来标记注解,以便在运行时动态生成SQL语句。
@Documented是Java内置注解之一,用于指定注解是否包含在Java文档中。如果一个注解被标记了@Documented,则在使用javadoc生成Java文档时,该注解的信息将会被包含在文档中。
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value();
}
在上面的示例中,MyAnnotation注解使用@Documented注解指定了它在Java文档中应该被包含。这意味着在使用javadoc生成Java文档时,该注解的信息将会被包含在文档中,以便其他开发人员可以更好地理解如何使用该注解。
@Inherited是Java内置注解之一,用于指定一个注解是否可以被继承。如果一个注解被标记了@Inherited,则当子类继承了被标记的注解时,子类也会被自动标记上该注解。
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value();
}
在上面的示例中,MyAnnotation注解使用@Inherited注解指定了它可以被继承。这意味着如果一个类继承了被标记了@MyAnnotation注解的父类,则子类也会被自动标记上该注解。
使用@Inherited注解可以帮助提高注解的复用性,使得一些常见的注解可以被自动继承,从而减少代码的重复性。同时,使用@Inherited注解也可以避免因为父类上的注解没有被继承而导致一些意外的问题。
在Java 8及以上版本中,我们可以使用@Repeatable注解来标记一个注解可以重复使用多次。这样,我们就可以在一个元素上同时使用多个相同的注解,而不必像以前那样使用容器类型来包含多个注解。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {
String value();
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyAnnotations {
MyAnnotation[] value();
}
@MyAnnotation("foo")
@MyAnnotation("bar")
public class MyClass {
// Class body here
}
在上面的示例中,我们定义了一个名为MyAnnotation的注解,并使用@Repeatable注解标记该注解可以重复使用多次。我们还定义了一个名为MyAnnotations的注解来包含多个MyAnnotation注解。最后,我们在MyClass类上同时使用了两个@MyAnnotation注解。
当我们理解了内置注解, 元注解和获取注解的反射接口后,我们便可以开始自定义注解了。
创建自定义注解和创建一个接口相似,但是注解的interface关键字需要以@符号开头,我们可以为注解声明方法。
自定义注解格式:
// 元注解
public @interface 注解名称{
// 属性列表
}
在Java中,我们可以使用@interface关键字来定义自己的注解,这和定义接口或类类似。
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME) // 注解保留到运行时
@Target(ElementType.METHOD) // 注解作用于方法
public @interface MyAnnotation {
String value() default ""; // 定义一个名为value的属性,类型为String
}
在上面的示例中,我们使用@interface关键字定义了一个名为MyAnnotation的注解,并使用@Retention和@Target元注解指定注解的保留时间和目标范围。我们还定义了一个名为value的属性,类型为String,并使用default关键字指定了属性的默认值。
使用自定义注解时,我们可以为注解的属性赋值
public class MyClass {
@MyAnnotation("Hello, world!")
public void myMethod() {
// Method body here
}
}
在上面的示例中,我们在myMethod()方法上使用了@MyAnnotation注解,并为value属性赋了一个字符串值。
在运行时,我们可以通过反射来获取注解的信息,以便进行一些特定的操作,例如:
Method method = MyClass.class.getMethod("myMethod");
MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
String value = annotation.value(); // 获取注解属性的值
以上代码将获取MyClass类中的myMethod()方法上的@MyAnnotation注解,并获取注解的value属性的值。
一旦我们定义了自己的注解,我们就可以在代码中使用它们来添加额外的元数据信息。下面是一个示例,演示如何使用自定义注解:
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
String value() default "";
}
public class MyClass {
@MyAnnotation("Hello, world!")
public void myMethod() {
// Method body here
}
}
public class Main {
public static void main(String[] args) throws NoSuchMethodException {
MyClass obj = new MyClass();
Method method = obj.getClass().getMethod("myMethod");
MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
String value = annotation.value(); // 获取注解属性的值
System.out.println(value); // 输出 "Hello, world!"
}
}
在上面的示例中,我们定义了一个名为MyAnnotation的注解,并将其应用于MyClass类中的myMethod()方法上。我们还定义了一个名为Main的类,用于演示如何使用反射获取注解的信息。
在运行时,我们使用反射来获取MyClass对象的myMethod()方法,并获取其上的@MyAnnotation注解。然后,我们从注解中获取其属性值,并将其打印到控制台上。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyTest {
String value() default "";
}
public class Calculator {
public int add(int a, int b) {
return a + b;
}
@MyTest("testAdd")
public void testAdd() {
int result = add(2, 3);
if (result == 5) {
System.out.println("Test passed!");
} else {
System.out.println("Test failed.");
}
}
}
public class TestRunner {
public static void main(String[] args) throws NoSuchMethodException {
Calculator calculator = new Calculator();
Method method = calculator.getClass().getMethod("testAdd");
MyTest testAnnotation = method.getAnnotation(MyTest.class);
String testName = testAnnotation.value();
System.out.println("Running test: " + testName);
calculator.testAdd();
}
}
在上面的示例中,我们定义了一个名为MyTest的注解,并将其应用于Calculator类中的testAdd()方法上。该方法执行了一个简单的加法测试,用于验证add()方法的正确性。如果测试通过,则打印“Test passed!”消息;否则,打印“Test failed.”消息。
在TestRunner类中,我们使用反射来获取Calculator对象的testAdd()方法,并获取其上的@MyTest注解。我们从注解中获取其属性值,并将其打印到控制台上。最后,我们调用testAdd()方法以运行测试。
反射是框架设计的灵魂
(使用的前提条件:必须先得到代表的字节码的Class,Class类用于表示.class文件(字节码))
Java反射是指在Java运行时环境中,对于任意一个类,都能够知道这个类的所有属性和方法,对于任意一个对象,都能够调用它的任意一个方法,这种动态获取信息以及动态调用对象方法的能力就是Java反射机制。
Java反射机制提供了一种动态获取类信息和操作类成员的机制,能够使得Java程序可以在运行时分析自身的内部结构。利用Java反射机制,可以实现如下功能:
1.在运行时动态获取类的信息,包括类名、父类信息、接口信息、构造方法信息、字段信息、方法信息等。
2.在运行时动态创建对象实例,通过反射获取构造函数并调用构造函数创建对象。
3.在运行时动态访问对象的属性和方法,通过反射获取对象属性和方法并进行操作。
4.在运行时动态调用方法,可以在编译时不确定方法的名称,而是在运行时动态获取方法名称并进行调用。