注解系列教材（四）- 元注解

工具版本兼容问题

经过上个知识点自定义注解的学习之后，对自定义注解有了感性的认识，现在我们再来稍微深入了解各种元注解以及他们的含义。

纠

步骤 1 : 元注解概念
步骤 2 : @Target
步骤 3 : @Retention
步骤 4 : @Inherited
步骤 5 : @Documented
步骤 6 : @Repeatable (java1.8 新增)
步骤 7 : @Repeatable 运用举例

步骤 1 :

元注解概念

edit 顶折

纠问

在讲解元注解概念之前，我们先建立元数据的概念。元数据在英语中对应单词 metadata, metadata在wiki中的解释是：
Metadata is data [information] that provides information about other data
为其他数据提供信息的数据

这样元注解就好理解了，元注解 meta annotation用于注解自定义注解的注解。
元注解有这么几种：
@Target
@Retention
@Inherited
@Documented
@Repeatable (java1.8 新增)
接下来挨个讲解

步骤 2 :

@Target

edit 顶折

纠问

@Target 表示这个注解能放在什么位置上，是只能放在类上？还是即可以放在方法上，又可以放在属性上。自定义注解@JDBCConfig 这个注解上的@Target是：@Target({METHOD,TYPE})，表示他可以用在方法和类型上（类和接口），但是不能放在属性等其他位置。可以选择的位置列表如下：
ElementType.TYPE：能修饰类、接口或枚举类型
ElementType.FIELD：能修饰成员变量
ElementType.METHOD：能修饰方法
ElementType.PARAMETER：能修饰参数
ElementType.CONSTRUCTOR：能修饰构造器
ElementType.LOCAL_VARIABLE：能修饰局部变量
ElementType.ANNOTATION_TYPE：能修饰注解
ElementType.PACKAGE：能修饰包

代码行数较多，请点击查看

package anno;
 
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
 
import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Target({METHOD,TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface JDBCConfig {
     String ip(); 
     int port() default 3306; 
     String database(); 
     String encoding(); 
     String loginName(); 
     String password(); 
}

步骤 3 :

@Retention

edit 顶折

纠问

@Retention 表示生命周期，自定义注解@JDBCConfig 上的值是 RetentionPolicy.RUNTIME, 表示可以在运行的时候依然可以使用。 @Retention可选的值有3个：

RetentionPolicy.SOURCE：注解只在源代码中存在，编译成class之后，就没了。@Override 就是这种注解。
RetentionPolicy.CLASS：注解在java文件编程成.class文件后，依然存在，但是运行起来后就没了。@Retention的默认值，即当没有显式指定@Retention的时候，就会是这种类型。
RetentionPolicy.RUNTIME：注解在运行起来之后依然存在，程序可以通过反射获取这些信息，自定义注解@JDBCConfig 就是这样。
大家可以试试把自定义注解@JDBCConfig的@Retention改成其他两种，并且运行起来，看看有什么不同

代码行数较多，请点击查看

package anno;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;

import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({METHOD,TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented

public @interface JDBCConfig {
     String ip(); 
     int port() default 3306; 
     String database(); 
     String encoding(); 
     String loginName(); 
     String password(); 
}

步骤 4 :

@Inherited

edit 顶折

纠问

@Inherited 表示该注解具有继承性。如例，设计一个DBUtil的子类，其getConnection2方法，可以获取到父类DBUtil上的注解信息。

代码行数较多，请点击查看

package util;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

import anno.JDBCConfig;

public class DBUtilChild extends DBUtil {
	
	public static Connection getConnection2() throws SQLException, NoSuchMethodException, SecurityException {
		JDBCConfig config = DBUtilChild.class.getAnnotation(JDBCConfig.class);
		String ip = config.ip();
		int port = config.port();
		String database = config.database();
		String encoding = config.encoding();
		String loginName = config.loginName();
		String password = config.password();

		String url = String.format("jdbc:mysql://%s:%d/%s?characterEncoding=%s", ip, port, database, encoding);
		return DriverManager.getConnection(url, loginName, password);
	}
	
	public static void main(String[] args) throws NoSuchMethodException, SecurityException, SQLException {
		Connection c = getConnection2();
		System.out.println(c);
	}
}

步骤 5 :

@Documented

edit 顶折

纠问

@Documented 如图所示，在用javadoc命令生成API文档后，DBUtil的文档里会出现该注解说明。

注：使用eclipse把项目中的.java文件导成API文档步骤：
1. 选中项目
2. 点开菜单File
3. 点击Export
4. 点开java->javadoc->点next
5. 点finish

步骤 6 :

@Repeatable (java1.8 新增)

edit 顶折

纠问

当没有@Repeatable修饰的时候，注解在同一个位置，只能出现一次，如例所示：
@JDBCConfig(ip = "127.0.0.1", database = "test", encoding = "UTF-8", loginName = "root", password = "admin")
@JDBCConfig(ip = "127.0.0.1", database = "test", encoding = "UTF-8", loginName = "root", password = "admin")
重复做两次就会报错了。
使用@Repeatable之后，再配合一些其他动作，就可以在同一个地方使用多次了。
如何使用@Repeatable 单独拿出来讲解：@Repeatable运用举例

代码行数较多，请点击查看

package util;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

import anno.JDBCConfig;

@JDBCConfig(ip = "127.0.0.1", database = "test", encoding = "UTF-8", loginName = "root", password = "admin")
@JDBCConfig(ip = "127.0.0.1", database = "test", encoding = "UTF-8", loginName = "root", password = "admin")
public class DBUtil {
	static {
		try {
			Class.forName("com.mysql.jdbc.Driver");
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}

	public static Connection getConnection() throws SQLException, NoSuchMethodException, SecurityException {
		JDBCConfig config = DBUtil.class.getAnnotation(JDBCConfig.class);
		System.out.println(config);

		String ip = config.ip();
		int port = config.port();
		String database = config.database();
		String encoding = config.encoding();
		String loginName = config.loginName();
		String password = config.password();

		String url = String.format("jdbc:mysql://%s:%d/%s?characterEncoding=%s", ip, port, database, encoding);
		return DriverManager.getConnection(url, loginName, password);
	}
	
	public static void main(String[] args) throws NoSuchMethodException, SecurityException, SQLException {
		Connection c = getConnection();
		System.out.println(c);
	}
}

步骤 7 :

@Repeatable 运用举例

edit 顶折

纠问

比如在练习练习-查找文件内容中有一个要求，即查找文件后缀名是.java的文件，我们把部分代码修改为注解，并且使用@Repeatable 这个元注解来表示，文件后缀名的范围可以是java, html, css, js 等等。

为了紧凑起见，把注解作为内部类的形式放在一个文件里。
1. 注解FileTypes，其value()返回一个FileType数组
2. 注解FileType，其@Repeatable的值采用FileTypes
3. 运用注解：在work方法上重复使用多次@FileType注解
4. 解析注解：在work方法内，通过反射获取到本方法上的FileType类型的注解数组，然后遍历本数组

代码行数较多，请点击查看

package annotation;
import static java.lang.annotation.ElementType.METHOD;

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

public class FindFiles {
    @Target( METHOD)
    @Retention( RetentionPolicy.RUNTIME )
    public @interface FileTypes {
        FileType[] value();
    }

    @Target(  METHOD )
    @Retention( RetentionPolicy.RUNTIME )
    @Repeatable( FileTypes.class )
    public @interface FileType {
        String value();
    };

    @FileType( ".java" )
    @FileType( ".html" )
    @FileType( ".css" )
    @FileType( ".js" )
    public void work(){
    	
    	try {
    		FileType[] fileTypes= this.getClass().getMethod("work").getAnnotationsByType(FileType.class);
    		System.out.println("将从如下后缀名的文件中查找文件内容");
    		for (FileType fileType : fileTypes) {
				System.out.println(fileType.value());
			}
    		System.out.println("查找过程略。。。");
		} catch (NoSuchMethodException | SecurityException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
    }

    public static void main(String[] args) {
    	new FindFiles().work();
    }
}

注解系列教材（三）- 自定义注解

注解系列教材（五）- 仿Hibernate注解

HOW2J公众号，关注后实时获知最新的教程和优惠活动，谢谢。

问答区域

2024-06-18 RetentionPolicy.CLASS是给谁用的呢？JVM吗？

lishen24

关于 JAVA 高级-注解-元注解的提问

RetentionPolicy.SOURCE是给编译器用的，RetentionPolicy.RUNTIME是给代码用的，RetentionPolicy.CLASS是给谁用的？JVM吗？有啥用？

回答已经提交成功，正在审核。请于我的回答处查看回答记录，谢谢

2024-06-18 注解是不是一种给类型附加信息的方法？

lishen24

关于 JAVA 高级-注解-元注解的提问

注解是不是一种给类型附加信息的方法？如果代码中不获取注解内容并对注解做出操作的话，注解不会改变类本身的行为？

回答已经提交成功，正在审核。请于我的回答处查看回答记录，谢谢

2020-04-09 关于元注解注解我自己的情况，各位可以参考下这个

2020-01-03 元注解理解

2019-02-25 不明白步骤七里@Repeatable里用来文件查找具体怎么使用，谁能写点代码，或者站长就是为了讲才用的，其实这个场景不适合文件查找？

minibao

关于 JAVA 高级-注解-元注解的提问

不明白步骤七里@Repeatable里用来文件查找具体怎么使用，谁能写点代码，或者站长就是为了讲才用的，其实这个场景不适合文件查找？

4 个答案

LCJjjj
答案时间：2020-04-09

你应该是想知道怎么利用这几个值去完成查找文件吧？这还不简单？你都有这几个后缀了，通过IO找到的文件你判断一下后缀是否是这几个值就行了

genglong
答案时间：2019-11-06

https://blog.csdn.net/sun_promise/article/details/51315032 这篇文章对@repeatable解释更容易理解

genglong
答案时间：2019-03-27

可以看一看这篇文章了解一下注解 https://blog.csdn.net/briblue/article/details/73824058

娶一个昵称
答案时间：2019-03-01

这个东西怎么讲呢，你如果想多了解建议搜一下 Java注解——Repeatable

回答已经提交成功，正在审核。请于我的回答处查看回答记录，谢谢

提问太多，页面渲染太慢，为了加快渲染速度，本页最多只显示几条提问。还有 3 条以前的提问，请点击查看

提问之前请登陆

提问已经提交成功，正在审核。请于我的提问处查看提问记录，谢谢

关于 JAVA 高级-注解-元注解的提问

尽量提供截图、代码和异常信息，有助于分析和解决问题。也可进本站QQ群交流: 578362961

提问尽量提供完整的代码，环境描述，越是有利于问题的重现，您的问题越能更快得到解答。
对教程中代码有疑问，请提供是哪个步骤，哪一行有疑问，这样便于快速定位问题，提高问题得到解答的速度
在已经存在的几千个提问里，有相当大的比例，是因为使用了和站长不同版本的开发环境导致的,比如 jdk, eclpise, idea, mysql,tomcat 等等软件的版本不一致。
请使用和站长一样的版本，可以节约自己大量的学习时间。站长把教学中用的软件版本整理了，都统一放在了这里，方便大家下载： https://how2j.cn/k/helloworld/helloworld-version/1718.html

上传截图