Java 中的注解详解及示例代码_java

在Java中，注解(Annotation)引入始于Java5，用来描述Java代码的元信息，通常情况下注解不会直接影响代码的执行，尽管有些注解可以用来做到影响代码执行。

注解可以做什么

Java中的注解通常扮演以下角色

  1. 编译器指令
  2. 构建时指令
  3. 运行时指令

其中

  1. Java内置了三种编译器指令，本文后面部分会重点介绍
  2. Java注解可以应用在构建时，即当你构建你的项目时。构建过程包括生成源码，编译源码，生成xml文件，打包编译的源码和文件到JAR包等。软件的构建通常使用诸如Apache Ant和Maven这种工具自动完成。这些构建工具会依照特定的注解扫描Java代码，然后根据这些注解生成源码或文件。
  3. 通常情况下，注解并不会出现在编译后的代码中，但是如果想要出现也是可以的。Java支持运行时的注解，使用Java的反射我们可以访问到这些注解，运行时的注解的目的通常是提供给程序和第三方API一些指令。

注解基础

一个简单的Java注解类似与@Entity。其中@的意思是告诉编译器这是一个注解。而Entity则是注解的名字。通常在文件中，写法如下

public @interface Entity {
}

注解元素

Java注解可以使用元素来进行设置一些值，注解中的元素类似于属性或者参数。定义包含元素的注解示例代码

public @interface Entity {
  String tableName();
}

使用包含元素的注解示例代码

@Entity(tableName = "vehicles")

上述注解的元素名称为tableName，设置的值为vehicles。没有元素的注解不需要使用括号。

如果注解包含多个元素，使用方法如下

@Entity(tableName = "vehicles", primaryKey = "id")

如果注解只有一个元素，通常我们的写法是这样的

@InsertNew(value = "yes")

但是这种情况下，当且仅当元素名为value,我们也可以简写，即不需要填写元素名value，效果如下

@InsertNew("yes")

注解使用

注解可以用来修饰代码中的这些元素

  1. 类
  2. 接口
  3. 方法
  4. 方法参数
  5. 属性
  6. 局部变量

一个完整的使用示例如下

@Entity
public class Vehicle {

  @Persistent
  protected String vehicleName = null;

  @Getter
  public String getVehicleName() {
    return this.vehicleName;
  }

  public void setVehicleName(@Optional vehicleName) {
    this.vehicleName = vehicleName;
  }

  public List addVehicleNameToList(List names) {

    @Optional
    List localNames = names;

    if(localNames == null) {
      localNames = new ArrayList();
    }
    localNames.add(getVehicleName());

    return localNames;
  }

}

内置的Java注解

Java中有三种内置注解，这些注解用来为编译器提供指令。它们是

  1. @Deprecated
  2. @Override
  3. @SuppressWarnings

@Deprecated

可以用来标记类，方法，属性。
如果上述三种元素不再使用，使用@Deprecated注解
如果代码使用了@Deprecated注解的类，方法或属性，编译器会进行警告。

@Deprecated使用很简单，如下为注解一个弃用的类。

@Deprecated
public class MyComponent {

}

当我们使用@Deprecated注解后，建议配合使用对应的@deprecated JavaDoc符号，并解释说明为什么这个类，方法或属性被弃用，已经替代方案是什么。

@Deprecated
/**
 @deprecated This class is full of bugs. Use MyNewComponent instead.
*/
public class MyComponent {

}

@Override

@Override注解用来修饰对父类进行重写的方法。如果一个并非重写父类的方法使用这个注解，编译器将提示错误。

实际上在子类中重写父类或接口的方法，@Overide并不是必须的。但是还是建议使用这个注解，在某些情况下，假设你修改了父类的方法的名字，那么之前重写的子类方法将不再属于重写，如果没有@Overide，你将不会察觉到这个子类的方法。有了这个注解修饰，编译器则会提示你这些信息。

使用Override注解的例子

public class MySuperClass {

  public void doTheThing() {
    System.out.println("Do the thing");
  }
}

public class MySubClass extends MySuperClass{

  @Override
  public void doTheThing() {
    System.out.println("Do it differently");
  }
}

@SuppressWarnings

@SuppressWarnings用来抑制编译器生成警告信息。

可以修饰的元素为类，方法，方法参数，属性，局部变量

使用场景：当我们一个方法调用了弃用的方法或者进行不安全的类型转换，编译器会生成警告。我们可以为这个方法增加

@SuppressWarnings注解，来抑制编译器生成警告。

注意：使用@SuppressWarnings注解，采用就近原则，比如一个方法出现警告，我们尽量使用@SuppressWarnings注解这个方法，而不是注解方法所在的类。虽然两个都能抑制编译器生成警告，但是范围越小越好，因为范围大了，不利于我们发现该类下其他方法的警告信息。

使用示例

@SuppressWarnings
public void methodWithWarning() {

}

创建自己的注解

在Java中，我们可以创建自己的注解，注解和类，接口文件一样定义在自己的文件里面。如下

@interface MyAnnotation {
  String  value();
  String  name();
  int   age();
  String[] newNames();
}

上述代码定义了一个叫做MyAnnotation的注解，它有4个元素。再次强调一下，@interface这个关键字用来告诉java编译器这是一个注解。

仔细一看，你会发现，注解元素的定义很类似于接口的方法。这些元素有类型和名称。这些类型可以是

  1. 原始数据类型
  2. String
  3. Class
  4. annotation
  5. 枚举
  6. 一维数组

如下为应用自定义的注解

@MyAnnotation(
  value="123",
  name="Jakob",
  age=37,
  newNames={"Jenkov", "Peterson"}
)
public class MyClass {

}

注意，我们需要为所有的注解元素设置值，一个都不能少。

注解元素默认值

对于注解中的元素，我们可以为其设置默认值，使用方法为

@interface MyAnnotation {
  String  value() default "";
  String  name();
  int   age();
  String[] newNames();
}

上述代码，我们设置了value元素的默认值为空字符串。当我们在使用时，可以不设置value的值，即让value使用空字符串默认值。 使用示例代码

@MyAnnotation(
  name="Jakob",
  age=37,
  newNames={"Jenkov", "Peterson"}
)
public class MyClass {

}

@Retention

@Retention是用来修饰注解的注解，使用这个注解，我们可以做到

控制注解是否写入class文件
控制class文件中的注解是否在运行时可见

控制很简单，使用使用以下三种策略之一即可。

RetentionPolicy.SOURCE 表明注解仅存在源码之中，不存在.class文件，更不能运行时可见。常见的注解为@Override, @SuppressWarnings。
RetentionPolicy.CLASS 这是默认的注解保留策略。这种策略下，注解将存在与.class文件，但是不能被运行时访问。通常这种注解策略用来处于一些字节码级别的操作。
RetentionPolicy.RUNTIME 这种策略下可以被运行时访问到。通常情况下，我们都会结合反射来做一些事情。

@Retention的使用示例

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
  String  value() default "";
}

@Target

使用@Target注解，我们可以设定自定义注解可以修饰哪些java元素。简单示例

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target({ElementType.METHOD})
public @interface MyAnnotation {
  String  value();
}

上述的代码说明MyAnnotation注解只能修饰方法。

@Target可以选择的参数值有如下这些

  1. ElementType.ANNOTATION_TYPE（注：修饰注解）
  2. ElementType.CONSTRUCTOR
  3. ElementType.FIELD
  4. ElementType.LOCAL_VARIABLE
  5. ElementType.METHOD
  6. ElementType.PACKAGE
  7. ElementType.PARAMETER
  8. ElementType.TYPE（注：任何类型，即上面的的类型都可以修饰）

@Inherited

如果你想让一个类和它的子类都包含某个注解，就可以使用@Inherited来修饰这个注解。

java.lang.annotation.Inherited

@Inherited
public @interface MyAnnotation {

}
1
2
@MyAnnotation
public class MySuperClass { ... }
1
public class MySubClass extends MySuperClass { ... }

上述代码的大致意思是

1.使用@Inherited修饰注解MyAnnotation
2.使用MyAnnotation注解MySuperClass
3.实现一个类MySubclass继承自MySuperClass

通过以上几步，MySubClass也拥有了MyAnnotation注解。

关于Java中的注解，一些基本的概念就是这些。

以上 就是关于Java 中的注解资料整理，后续继续补充相关资料，谢谢大家对本站的支持！

以上是小编为您精心准备的的内容，在的博客、问答、公众号、人物、课程等栏目也有的相关内容，欢迎继续使用右上角搜索按钮进行搜索java
， 注解
， 中的注解
注解详解
java 注解示例、java注解详解、java自定义注解详解、java中的注解详解、java spring注解详解，以便于您获取更多的相关知识。

时间： 2024-12-03 17:42:28

Java 中的注解详解及示例代码_java的相关文章

Java Serializable和Parcelable详解及实例代码_java

对 Serializable和Parcelable理解 1.首先他们两个接口都是为了实现对象的序列化,使之可以传递,所谓序列化就是将对象信息装换成可以存储的介质的过程. 2.Serializable是jdk所提供的序列化接口,该接口存在于io包下,可想用于输入输出,使用非常简单,只要让你的类实现此接口就ok了:可以使用transient关键字修饰你不想序列化的属性. 3.Parcelable是sdk所提供的序列化接口,使用较上者麻烦,实现此接口后,需要重写writeToParcel方法,将需要序

Java Lambda 表达式详解及示例代码_java

Java Lambda 表达式是 Java 8 引入的一个新的功能,可以说是模拟函数式编程的一个语法糖,类似于 Javascript 中的闭包,但又有些不同,主要目的是提供一个函数化的语法来简化我们的编码. Lambda 基本语法 Lambda 的基本结构为 (arguments) -> body,有如下几种情况: 参数类型可推导时,不需要指定类型,如 (a) -> System.out.println(a) 当只有一个参数且类型可推导时,不强制写 (), 如 a -> System.o

java 多线程-锁详解及示例代码_java

自 Java 5 开始,java.util.concurrent.locks 包中包含了一些锁的实现,因此你不用去实现自己的锁了.但是你仍然需要去了解怎样使用这些锁. 一个简单的锁 让我们从 java 中的一个同步块开始: public class Counter{ private int count = 0; public int inc(){ synchronized(this){ return ++count; } } } 可以看到在 inc()方法中有一个 synchronized(th

Java 数组详解及示例代码_java

下面是stackoverflow中关于数组方法的相关问题中,获得最多票数的12个数组操作方法. 1.  声明一个数组 String[] aArray = new String[5]; String[] bArray = {"a","b","c", "d", "e"}; String[] cArray = new String[]{"a","b","c&quo

java Signleton模式详解及示例代码_java

Singleton模式是创建模式. 这种模式只涉及一个类是负责创建自己的对象. 该类确保只有一个对象获得创建. 这个类提供了一种方法来访问它的唯一对象. 例如,当设计一个用户界面,我们只能有一个主应用程序的窗口.我们可以使用Singleton模式,以确保有是MainApplicationWindow对象的一个​​实例. 下面的代码将创建一个主窗口类. MainWindow类有其私有的构造,并有其自身的静态实例. 主窗口类提供了一个静态方法来获取其静态实例外面的世界. 我们的演示类将使用主窗口类来

java中实现汉字按照拼音排序(示例代码)_java

最近項目中需要對繁體字按拼音進行排序 复制代码 代码如下: public static void main(String[] args) {    Comparator cmp = Collator.getInstance(java.util.Locale.CHINA);        String[] arr = { "张三", "李四", "王五", "刘六" ,"周濤","戴笠",

Java 调用天气Webservice详解及实例代码_java

Java调用天气Webservice的小应用 废话不多说,直接贴代码:  CityReq.java package com.weather; import javax.xml.bind.annotation.XmlElement; import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement(name="getWeatherbyCityName",namespace="http://WebXml.com.cn

Java中final关键字详解_php技巧

谈到final关键字,想必很多人都不陌生,在使用匿名内部类的时候可能会经常用到final关键字.另外,Java中的String类就是一个final类,那么今天我们就来了解final这个关键字的用法. 主要介绍:一.final关键字的基本用法.二.深入理解final关键字 一.final关键字的基本用法 在Java中,final关键字可以用来修饰类.方法和变量(包括成员变量和局部变量).下面就从这三个方面来了解一下final关键字的基本用法. 1.修饰类 当用final修饰一个类时,表明这个类不能

Java 反射机制详解及实例代码_java

Java反射详解 本篇文章依旧采用小例子来说明,因为我始终觉的,案例驱动是最好的,要不然只看理论的话,看了也不懂,不过建议大家在看完文章之后,在回过头去看看理论,会有更好的理解. 下面开始正文. [案例1]通过一个对象获得完整的包名和类名 package Reflect; /** * 通过一个对象获得完整的包名和类名 * */ class Demo{ //other codes... } class hello{ public static void main(String[] args) {