Java自定义注解

最新推荐文章于 2022-10-20 19:07:49 发布
最新推荐文章于 2022-10-20 19:07:49 发布
阅读量451 收藏
点赞数
分类专栏： java 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Java_Fly1/article/details/104981818
版权

Java注解

概念

Java提供了一种原程序中的元素关联任何信息和任何元数据的途径和方法

Java中的常见注解

JDK中的注解

@Deprecated:方法过时

package com.itcast.mybatis.pojo;

public interface Person {
	public String name();
	public int age();
	/*
	 * @Deprecated:方法过时
	 */
	@Deprecated
	public void sing();
}

@Override:重写父类的方法

package com.itcast.mybatis.pojo;

public class Child implements Person{

	@Override
	public String name() {
		// TODO Auto-generated method stub
		return null;
	}

	@Override
	public int age() {
		// TODO Auto-generated method stub
		return 0;
	}
	/*
	 *@Override:重写父类的方法 
	 */
	@Override
	public void sing() {
		// TODO Auto-generated method stub
		
	}

}

@SuppressWarnings:忽略警告

package com.itcast.mybatis.test;

import com.itcast.mybatis.pojo.Child;
import com.itcast.mybatis.pojo.Person;

public class TestCase {
	/*
	 *@SuppressWarnings:忽略警告 
	 */
	@SuppressWarnings("deprecation")
	public void sing() {
		Person p=new Child();
		p.sing();
	}
}

常见第三方注解

在这里插入图片描述

注解的分类

按照运行机制分

  • 源码注解

注解只在源码中存在，编译成.class文件就不存在了

  • 编译时注解

注解在源码和.class文件中都存在
@Override
@Deprecated:
@SuppressWarnings

  • 运行时注解

在运行阶段还起作用，甚至会影响运行逻辑的注解
@Autowired

按照来源分

  • 来自JDK的注解
  • 来自第三方的注解
  • 我们自己定义的注解

元注解

给注解的注解

自定义注解

  • 使用@interface关键字定义注解
  • 成员以无参无异常方式声明
  • 可以用default为成员指定一个默认值
  • 成员类型是受限的，合法的类型包括原始类型及String,Class,Annotation,Enumeration
  • 如果注解只有一个成员，则成员名必须取名为value(),在使用时可以忽略成员名和赋值号（=）
  • 注解类可以没有成员，没有成员的注解称为标识注解

@Target:自定义注解的作用域

  • TYPE:类，接口
  • FIELD:字段声明
  • MRTHOD:方法声明
  • PARAMETER:参数声明
  • CONSTRUCTOR：构造方法声明
  • LOCAL_VARIABLE:局部变量声明
  • PACKAGE:包声明

在这里插入图片描述

@Retention:生命周期

  • RetentionPolicy.SOURCE ：只在源码显示，编译时会丢弃
  • RetentionPolicy.CLASS： 编译时会记录到class中，运行时忽略
  • RetentionPolicy.RUNTIME：运行时存在，可以通过反射读取
    在这里插入图片描述

@Inherited 允许子类以注解的方式继承

在这里插入图片描述

@Documented :生成javadoc时会包含注解的信息

在这里插入图片描述

自定义注解的使用

使用注解的语法:
@注解名(成员名=成员值,成员名=成员值)

@Target注解的使用

在这里插入图片描述
在这里插入图片描述

@Retention注解的使用

创建注解

package com.itcast.mybatis.pojo;

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

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Description {
	String value();
}

使用注解

package com.itcast.mybatis.pojo;
@Description("I am class annotation")
public class Child implements Person{

	@Description("I am method annotation")
	public String name() {
		return null;
	}

	@Override
	public int age() {
		return 0;
	}
	/*
	 *@Override:重写父类的方法 
	 */
	@Override
	public void sing() {
		
	}

}

解析注解

通过反射获取类、函数或成员上的运行时注解信息，
从而实现动态控制程序运行的逻辑

package com.itcast.mybatis.test;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

import com.itcast.mybatis.pojo.Description;

public class ParseAnn {
	public static void main(String[] args) {
		// 1. 使用类加载器加载类
		try {
			// Class.forName(类的全名)
			Class c = Class.forName("com.itcast.mybatis.pojo.Child");
			// 2. 找到类上面的注解
			boolean isExist = c.isAnnotationPresent(Description.class);
			if (isExist) {
				// 3. 拿到注解实例
				Description d = (Description) c.getAnnotation(Description.class);
				System.out.println("类上的注解：\t" + d.value());

			}
			// 4. 找到方法上的注解
			Method[] m = c.getMethods();
			for (Method method : m) {
				boolean isMExist = method.isAnnotationPresent(Description.class);
				if (isMExist) {
					Description d = (Description) method.getAnnotation(Description.class);
					if (d != null) {
						System.out.println("方法上的注解：\t" + d.value());
					}
				}
			}
			// 另外一种解析方法
			// 1.先获得所有的方法的注解,再使用instanceof判断方法的类型
			for (Method method : m) {
				Annotation[] as = method.getAnnotations();
				for (Annotation a : as) {
					if (a instanceof Description) {
						System.out.println("另外一种方法获得方法上的注解：\t" +((Description) a).value());
					}
				}
			}

		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}
}

执行测试程序，控制台输出如下结果：
在这里插入图片描述

修改Description类的生命周期

在这里插入图片描述
再次执行上述测试程序com.itcast.mybatis.test.ParseAnn，控制台什么都没有输出
在这里插入图片描述
再次执行上述测试程序com.itcast.mybatis.test.ParseAnn，控制台什么都没有输出

@Inherited注解的使用

1.创建注解

package com.itcast.mybatis.pojo;

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

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
/**
 *自定义注解Description
 * @author 86182
 *
 */
public @interface Description {
	String value();
}

2.注解的使用

package com.itcast.mybatis.pojo;

@Description("I am interface")
public class Person {
	@Description("I am interface method")
	public String name() {
		return null;
	}

	public int age() {
		return 0;
	}

	/*
	 * @Deprecated:方法过时
	 */
	@Deprecated
	public void sing() {
	}
}


package com.itcast.mybatis.pojo;
public class Child extends Person{

	public String name() {
		return null;
	}

	@Override
	public int age() {
		return 0;
	}
	/*
	 *@Override:重写父类的方法 
	 */
	@Override
	public void sing() {
		
	}

}

3.测试程序

package com.itcast.mybatis.test;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

import com.itcast.mybatis.pojo.Description;

public class ParseAnn {
	public static void main(String[] args) {
		// 1. 使用类加载器加载类
		try {
			// Class.forName(类的全名)
			Class c = Class.forName("com.itcast.mybatis.pojo.Child");
			// 2. 找到类上面的注解
			boolean isExist = c.isAnnotationPresent(Description.class);
			if (isExist) {
				// 3. 拿到注解实例
				Description d = (Description) c.getAnnotation(Description.class);
				System.out.println("类上的注解：\t" + d.value());

			}
			// 4. 找到方法上的注解
			Method[] m = c.getMethods();
			for (Method method : m) {
				boolean isMExist = method.isAnnotationPresent(Description.class);
				if (isMExist) {
					Description d = (Description) method.getAnnotation(Description.class);
					if (d != null) {
						System.out.println("方法上的注解：\t" + d.value());
					}
				}
			}
			// 另外一种解析方法
			// 1.先获得所有的方法的注解,再使用instanceof判断方法的类型
			for (Method method : m) {
				Annotation[] as = method.getAnnotations();
				for (Annotation a : as) {
					if (a instanceof Description) {
						System.out.println("另外一种方法获得方法上的注解：\t" + a);
					}
				}
			}

		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}
}

4. 执行测试程序，输出结果

在这里插入图片描述

总结

@Inherited修饰的注解，子类继承此自定的注解，只作用于类上，方法上不起作用
@Inherited修饰的注解，接口继承此自定义的注解，类实现接口时不会继承任何接口中定义的注解

练习

有一张用户表，字段包括：用户ID、用户名、昵称、年龄、性别、所在城市、邮箱、手机号；
使用java注解来对用户表的每个字段或字段的组合条件进行动态生成SQL查询语句。

自定义注解@Table

package com.liyu.test;

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

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
	String value();
}

自定义注解@Column

package com.liyu.test;

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

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {

	String value();

}

定义映射到数据库的bean

package com.liyu.test;

@Table("user")
public class Filter {
	@Column("id")
	private int id;
	@Column("user_Name")
	private String userName;//用户名
	@Column("nick_Name")
	private String nickName;//绰号
	@Column("age")
	private int age;//年龄
	@Column("city")
	private String city;//城市
	@Column("email")
	private String email;//电子邮件
	@Column("mobile")
	private String mobile;//电话
	public int getId() {
		return id;
	}
	public void setId(int id) {
		this.id = id;
	}
	public String getUserName() {
		return userName;
	}
	public void setUserName(String userName) {
		this.userName = userName;
	}
	public String getNickName() {
		return nickName;
	}
	public void setNickName(String nickName) {
		this.nickName = nickName;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	public String getCity() {
		return city;
	}
	public void setCity(String city) {
		this.city = city;
	}
	public String getEmail() {
		return email;
	}
	public void setEmail(String email) {
		this.email = email;
	}
	public String getMobile() {
		return mobile;
	}
	public void setMobile(String mobile) {
		this.mobile = mobile;
	}
	
}

测试程序

package com.liyu.test;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

import javax.swing.text.FieldView;

public class Test {
	public static void main(String[] args) {
		Filter f1 = new Filter();
		f1.setId(10);// 查询id为10的用户

		Filter f2 = new Filter();
		f2.setUserName("lucy");// 模糊查询用户名为lucy的用户

		Filter f3 = new Filter();
		f3.setEmail("liu@sina.com,zh@163.com,77777@qq.com");// 查询邮箱为任意一个的

		String sql1 = query(f1);
		String sql2 = query(f2);
		String sql3 = query(f3);

		System.out.println(sql1);
		System.out.println(sql2);
		System.out.println(sql3);

	}

	@SuppressWarnings("unchecked")
	private static String query(Filter f) {
		StringBuilder sb = new StringBuilder();
		try {
			// 1.获取到Class
			Class c = Class.forName("com.liyu.test.Filter");
			// 2.获取到table的名字
			boolean isExist = c.isAnnotationPresent(Table.class);
			if (!isExist) {
				return null;
			}
			Table t = (Table) c.getAnnotation(Table.class);
			String tableName = t.value();
			sb.append("select * from ").append(tableName).append(" where 1=1");
			// 3.遍历所有的字段
			Field[] fArry = c.getDeclaredFields();
			for (Field field : fArry) {
				// 4.处理每个字段对应的sql
				// 4.1拿到字段名
				boolean fExists = field.isAnnotationPresent(Column.class);
				if (!fExists) {
					continue;
				}
				Column column = field.getAnnotation(Column.class);
				String columnName = column.value();
				// 4.2拿到字段的值
				String filedName = field.getName();
				String getMethodName = "get" + filedName.substring(0, 1).toUpperCase() + filedName.substring(1);
				Object filedValue = null;
				try {
					Method getMethod = c.getMethod(getMethodName);
					// java反射
					filedValue = getMethod.invoke(f);
				} catch (Exception e) {
					e.printStackTrace();
				}
				// 4.3拼装sql
				if (filedValue == null || (filedValue instanceof Integer && (Integer) filedValue == 0)) {
					continue;
				}
				sb.append(" and ").append(filedName);
				if (filedValue instanceof String) {
					if (((String) filedValue).contains(",")) {
						String[] values = ((String) filedValue).split(",");
						sb.append(" in(");
						for (String v : values) {
							sb.append("'").append(v).append("'").append(",");
						}
						sb.deleteCharAt(sb.length() - 1);
						sb.append(")");
					} else {
						sb.append("=").append("'").append(filedValue).append("'");
					}
				} else if (filedValue instanceof Integer) {
					sb.append("=").append(filedValue);
				}
			}
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
		return sb.toString();
	}
}

执行测试程序，输出结果

在这里插入图片描述

迷失的小鹿
关注
专栏目录
自定义注解捕获异常
XuXuDuoDuo_的博客
10-19 1195
/** * 定义切点 */ @Pointcut("@annotation(com.alibaba.sec.appcenter.aop.ServiceExceptionCatch)") private void servicePointCut() { } @AfterThrowing(throwing = "error", pointcut = "servicePointCut()") public void afterThrowingAdvice()
Java 自定义注解
qq_44641053的博客
11-06 505
Java自定义注解Java注解简介Java元注解自定义注解代码演示 本章点知识总览： 1、Java 注解简介 2、Java 元注解（重点） 3、自定义注解 4、Aop 自定义注解的应用（重点） Java注解（Annotation） 分类 编程技术 Java注解（Annotation）又称Java标注，是JDK5.0约会的一种注释机制。 和Javadoc不同，Java标注可以通过反射获取标注内容。 ...
自定义Annotation应用实例：给自定义的错误码加上注解
码疯的专栏
03-07 2187
Annotation，即注解，是Java5的新特性，注解的优点还包括：更加干净易读的代码以及编译器类型检查等。虽然Java SE5预先定义了一些元数据，但一般来说，主要还是需要程序员自己添加新的注解，并且按自己的方式使用它们。 总而言之，annotation主要目的介于源代码与API文件说明之间。annotation对程序代码做出一些说明和解释。让自己和别人看得方便。 在本次实例代码中，使用了annotation来标注自定义的错误码。具体代码如下： Error.java 注解的定义 package
java中输出自定义注解的实际内容
jackyrongvip的专栏
07-07 287
关于java自定义anootation的介绍见:http://jackyrong.iteye.com/blog/1900712 这里的一个例子,是输出一个使用了java自定义注解的实际内容的例子: [code="java"] @Retention(RetentionPolicy.RUNTIME) public @interface DeveloperInfo { ...
gradle编译自定义注解(annotation)的未解决问题
一个码农的博客
05-14 7565
最近把一个用eclipse构建的项目，加上了Gradle脚本，用它来编译。虽然最后编译是显示BUILD SUCCESSFUL，但是在编译过程中，却打印出一大堆栈信息，似乎是在编译我自定义的注解时出现的异常。 打印的栈信息前面部分如下： :assemble :lint Failed converting ECJ parse tree to Lombok for file E:\code\git\
自定义参数验证注解，触发验证抛出异常报错
weixin_61845680的博客
10-20 616
自定义参数验证注解，触发验证抛出异常报错
java自定义注解
lllwwyy的博客
03-30 188
java自定义注解 注解是获取有注解的地方的方法变量等信息 例： @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface RequiresPermissions{ String[] value() default {}; } @Target:注解的作用目标 @Target(ElementType.TYPE)——接口、类
java 自定义注解的实例详解
08-29
Java 自定义注解的实例详解 Java 自定义注解是 Java 语言中的一种重要特性，它可以用于创建文档，跟踪代码中的依赖性，并且可以执行编译时期检查。自定义注解可以让开发者根据需要创建自己的注解，以满足特定的需求...
java 自定义注解验证
02-23
在本案例中，作者创建了三个自定义注解，具体细节虽未详述，但我们可以深入探讨一下Java自定义注解的基本概念、创建过程以及如何进行验证。 首先，我们需要理解Java注解的基本原理。注解是一种元数据，它提供了一种...
Java自定义注解使用反射获取字段注解
10-31
Java自定义注解是Java语言中的一个重要特性，它允许我们创建自己的元数据，为代码提供额外的信息。在Java中，注解（Annotation）主要用于编译器检查、代码生成、运行时处理等方面。本文将深入探讨如何通过反射机制来...
Java自定义注解的详解
08-29
Java自定义注解的详解 Java 注解（Annotation）是一种元数据，它提供了关于代码的一些信息，但并不直接作用于它所注解的代码内容。在这个教程中，我们将学习 Java 的注解，如何定制注解，注解的使用以及如何通过...
java自定义注解接口限流demo
最新发布
06-19
java自定义注解接口限流demo； java自定义注解接口限流demo； java自定义注解接口限流demo； java自定义注解接口限流demo； java自定义注解接口限流demo； java自定义注解接口限流demo； java自定义注解接口限流demo...
Java自定义注解解析
Smile_Miracle的博客
05-11 1111
什么是注解Annotation（注解）就是Java提供了一种元程序中的元素关联任何信息和着任何元数据（metadata）的途径和方法。Annotion(注解)是一个接口，程序可以通过反射来获取指定程序元素的Annotion对象，然后通过Annotion对象来获取注解里面的元数据。　　Annotation(注解)是JDK5.0及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时
Java 注解 基础
weixin_34059951的博客
07-29 78
2019独角兽企业重金招聘Python工程师标准>>> ...
java 切片_JAVA自定义注解并切片应用
weixin_39690401的博客
02-20 1220
Java支持注解形式，合理使用注解，可以对我们的编程提供极大的便利。JAVA自身提供了三种注解，分别是：@Override,@Deprecated,@SuppreWarnings.大家平时应该看见这个这三个注解，除此之外，我们还可以自定义注解。对于自定义的注解，可以加上自己的处理逻辑，这样在某些场合，我们就可以用注解标示某些类或这个方法，这样即可做到不侵入类或者方法内部修改代码，就可以完成我们指定...
自定义注解之编译时注解(RetentionPolicy.CLASS)（三）—— 常用接口介绍
Rukey7的博客
08-10 7397
前面介绍了关于编译时注解的使用方式，这里再补充一个关于注解处理器开发中的一些常用类、接口的使用方式和概念。 Element和TypeMirror 我觉得这两个是开发注解处理器最重要的两个概念，理解这两个的概念和使用是非常重要的。 这两个都是接口，先来看一下Element的定义：
Java 高级 annotation 注解、内置注解、元注解、自定义注解 （含源码 2020年最新）
CTRA®王大大技术中心
05-12 400
注解 Annotation 1、什么是注解？ Annotation 是从 JDK5.0 开始引入的新技术 Annotation的作用： 不是程序本身，可以对程序作出解释（这一点和注解 comment 没什么区别） 可以被其他程序（比如：编译器等 ）读取 Annotation的格式： 注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如-抑制警告：@SuppressWarnings(value=“unchecked”) Annotation 在哪里使用？ 可以附加在package、c
程序员常用的工具网站
Java_Fly1的博客
06-06 2626
程序员常用的工具网站
Java自定义注解详解与使用示例
"Java自定义注解用于创建框架或增强代码可读性，常与拦截器、AOP结合使用。本文介绍了注解的基本概念、体系结构以及常用的元注解，帮助开发者理解如何自定义和使用注解。" 在Java编程语言中，自定义注解是一种强大...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值