小白学习java自定义注解
Java注解简介
1. Java注解(Annotation)
Java注解是附加在代码中的一些元信息，用于一些工具在编译、
运行时进行解析和使用，起到说明、配置的功能。
注解相关类都包含在java.lang.annotation包中。
2. Java注解分类
1 JDK基本注解
2 JDK元注解
3 自定义注解
3. JDK基本注解
1 @Override
重写
2 @Deprecated
已过时
3 @SuppressWarnings(value = “unchecked”)
压制编辑器警告
Java元注解
标红为重要注解
作用：元注解用于修饰其他的注解
| 注解 | 解释 |
|---|---|
@Retention | 定义注解的保留策略 |
| @Retention(RetentionPolicy.SOURCE) | 注解仅存在于源码中，在class字节码文件中不包含 |
| @Retention(RetentionPolicy.CLASS) | 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得， |
| @Retention(RetentionPolicy.RUNTIME) | 注解会在class字节码文件中存在，在运行时可以通过反射获取到 |
| 注解 | 作用范围 |
|---|---|
@Target | 指定被修饰的Annotation可以放置的位置(被修饰的目标) |
| @Target(ElementType.TYPE) | 接口、类 |
| @Target(ElementType.FIELD) | 属性 |
| @Target(ElementType.METHOD) | 方法 |
| @Target(ElementType.PARAMETER) | 方法参数 |
| @Target(ElementType.CONSTRUCTOR) | 构造函数 |
| @Target(ElementType.LOCAL_VARIABLE) | 局部变量 |
| @Target(ElementType.ANNOTATION_TYPE) | 注解 |
| @Target(ElementType.PARAMETER) | 包 |
注：可以指定多个位置，例如：
@Target({ElementType.METHOD, ElementType.TYPE})，也就是此注解可以在方法和类上面使用
@Inherited：指定被修饰的Annotation将具有继承性
@Documented：指定被修饰的该Annotation可以被javadoc工具提取成文档.
自定义注解
注解分类（根据Annotation是否包含成员变量,可以把Annotation分为两类）:
标记Annotation:
没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息
元数据Annotation:
包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;
如何自定义注解？
使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:
Annotation的成员变量在Annotation定义中是以无参的方法形式来声明的, 其方法名和返回值类型定义了该成员变量的名字和类型,
而且我们还可以使用default关键字为这个成员变量设定默认值；
注意：只有名字为“value”属性，赋值时可以省略属性名
案例测试
案例1.（获取类与方法上的注解值）
自己定义了个枚举
package com.liuchunming.annotation.p1;
/**
* @author liuchunming
* @site www.xiaoliu.com
* @company
* @create 2020-11-26 18:41
*/
public enum TranscationModel {
Read, Write, ReadWrite
}
注解类1
package com.liuchunming.annotation.p1;
import java.lang.annotation.*;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 18:41
*
* MyAnnotation1注解可以用在类、接口、属性、方法上
* 注解运行期也保留
* 不可继承
*/
@Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation1 {
String name();
}
注解类2
package com.liuchunming.annotation.p1;
import java.lang.annotation.*;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 18:41
*
* MyAnnotation2注解可以用在方法上
* 注解运行期也保留
* 不可继承
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation2 {
TranscationModel model() default TranscationModel.ReadWrite;
}
注解类3
package com.liuchunming.annotation.p1;
import java.lang.annotation.*;
/**
* @author liuchunming
* @site www.xiaoliu.com
* @company
* @create 2020-11-26 18:41
*
* MyAnnotation3注解可以用在方法上
* 注解运行期也保留
* 可继承
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface MyAnnotation3 {
TranscationModel[] models() default TranscationModel.ReadWrite;
}
定义个Demo1类使用前面定义的注解
package com.liuchunming.annotation.p1;
/**
* @author 小李飞刀
* @site www.javaxl.com
* @company
* @create 2019-10-23 18:43
*
* 获取类与方法上的注解值
*/
@MyAnnotation1(name = "abc")
public class Demo1 {
@MyAnnotation1(name = "xyz")
private Integer age;
@MyAnnotation2(model = TranscationModel.Read)
public void list() {
System.out.println("list");
}
@MyAnnotation3(models = {TranscationModel.Read, TranscationModel.Write})
public void edit() {
System.out.println("edit");
}
}
测试
package com.liuchunming.annotation.p1;
import org.junit.Test;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 18:41
*/
public class Demo1Test {
@Test
public void list() throws Exception {
// 获取类上的注解
MyAnnotation1 annotation1 = Demo1.class.getAnnotation(MyAnnotation1.class);
System.out.println(annotation1.name());//abc
// 获取到属性上的注解
MyAnnotation1 age = Demo1.class.getDeclaredField("age").getAnnotation(MyAnnotation1.class);
System.out.println(age.name());
// 获取方法上的注解
MyAnnotation2 myAnnotation2 = Demo1.class.getMethod("list").getAnnotation(MyAnnotation2.class);
System.out.println(myAnnotation2.model());//Read
}
@Test
public void edit() throws Exception {
MyAnnotation3 myAnnotation3 = Demo1.class.getMethod("edit").getAnnotation(MyAnnotation3.class);
for (TranscationModel model : myAnnotation3.models()) {
System.out.println(model);//Read,Write
}
}
}
案例2（获取类属性上的注解属性值）
定义注解类
package com.liuchunming.annotation.p2;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 18:48
*/
//@Retention(RetentionPolicy.SOURCE)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface TestAnnotation {
String value() default "默认value值";
String what() default "这里是默认的what属性对应的值";
}
Demo.java
package com.liuchunming.annotation.p2;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 18:49
*
* 获取类属性上的注解属性值
*/
public class Demo2 {
@TestAnnotation(value = "这就是value对应的值_msg1", what = "这就是what对应的值_msg1")
private static String msg1;
@TestAnnotation("这就是value对应的值1")
private static String msg2;
@TestAnnotation(value = "这就是value对应的值2")
private static String msg3;
@TestAnnotation(what = "这就是what对应的值")
private static String msg4;
}
测试
package com.liuchunming.annotation.p2;
import org.junit.Test;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 18:49
*/
public class Demo2Test {
@Test
public void test1() throws Exception {
TestAnnotation msg1 = Demo2.class.getDeclaredField("msg1").getAnnotation(TestAnnotation.class);
System.out.println(msg1.value());
System.out.println(msg1.what());
}
@Test
public void test2() throws Exception{
TestAnnotation msg2 = Demo2.class.getDeclaredField("msg2").getAnnotation(TestAnnotation.class);
System.out.println(msg2.value());
System.out.println(msg2.what());
}
@Test
public void test3() throws Exception{
TestAnnotation msg3 = Demo2.class.getDeclaredField("msg3").getAnnotation(TestAnnotation.class);
System.out.println(msg3.value());
System.out.println(msg3.what());
}
@Test
public void test4() throws Exception{
TestAnnotation msg4 = Demo2.class.getDeclaredField("msg4").getAnnotation(TestAnnotation.class);
System.out.println(msg4.value());
System.out.println(msg4.what());
}
}
案例3（获取参数修饰注解对应的属性值）
IsNotNull
package com.liuchunming.annotation.p3;
import java.lang.annotation.*;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 19:02
*
* 非空注解：使用在方法的参数上，false表示此参数可以为空，true不能为空
*/
@Documented
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface IsNotNull {
boolean value() default false;
}
Demo3
package com.liuchunming.annotation.p3;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 19:03
*
* 获取参数修饰注解对应的属性值
*/
public class Demo3 {
//@IsNotNull(true) 必填
public void hello1(@IsNotNull(true) String name) {//如果是多个测试并且为非必填 hello1(@IsNotNull(true) String name,@IsNotNull(false) Integer age)
System.out.println("hello:" + name);
}
public void hello2(@IsNotNull String name) {
System.out.println("hello:" + name);
}
}
Demo3Test
package com.liuchunming.annotation.p3;
import org.junit.Test;
import java.lang.reflect.Parameter;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 19:04
*/
public class Demo3Test {
@Test
public void hello1() throws Exception {
Demo3 demo3 = new Demo3();
for (Parameter parameter : demo3.getClass().getMethod("hello1", String.class).getParameters()) {//接收多个参数，直接添加参数类型通过反射获取 列如：demo3.getClass().getMethod("hello1", String.class,Integer.class).getParameters()
IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);
if(annotation != null){
System.out.println(annotation.value());//true
}
}
}
@Test
public void hello2() throws Exception {
Demo3 demo3 = new Demo3();
for (Parameter parameter : demo3.getClass().getMethod("hello2", String.class).getParameters()) {
IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);
if(annotation != null){
System.out.println(annotation.value());//false
}
}
}
}
Aop自定义注解的应用
MyLog.java
package com.liuchunming.annotation.springaop;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 19:08
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
String desc();
}
LogController
package com.liuchunming.annotation.springaop;
import org.springframework.stereotype.Component;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 19:10
*/
@Component
public class LogController {
@MyLog(desc = "这是结合spring aop知识，讲解自定义注解应用的一个案例")
public void testLogAspect(){
System.out.println("这里随便来点啥");
}
}
BaseTestCase
package com.liuchunming.annotation.springaop;
import org.junit.runner.RunWith;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 19:17
*/
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={"classpath:applicationContext.xml"})
public class BaseTestCase {
}
PagerAspect
package com.liuchunming.component;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.liuchunming.util.PageBean;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;
import java.util.List;
/**
* @author liuchunming
* @site www.liuchunming.com
* @company xxx公司
* @create 2020-10-19 19:56
*/
@Component
@Aspect
public class PagerAspect {
/**
* 切面：
* * 返回类型不限
* *.. 任意包下
* *.Service 任意以.Service结尾的接口或类
* *.Pager(..) 什么方法要被切
*
* 目的：
* 处理* *..*Service.*Pager这个方法，只要调用这个方法就能够达到分页的效果
* PageHelper.start();
* 调用目标方法之前
* 处理结果集
*
* 解决防止调用该方法传的类型不是pagebean
*
*/
@Around("execution(* *..*Service.*Pager(..))")
public Object invoke(ProceedingJoinPoint args) throws Throwable{
//判断符合条件的方法中是否包含pagebean
Object[] params = args.getArgs();//获取到所有的参数
PageBean pageBean =null;
for (Object param : params) {
if(param instanceof PageBean){ //如果匹配上pagebean
pageBean =(PageBean) param;
break;
}
}
if(pageBean !=null && pageBean.isPagination()){
PageHelper.startPage(pageBean.getPage(),pageBean.getRows());
}
Object list = args.proceed(params);//调用目标方法
if(pageBean !=null && pageBean.isPagination()){//处理总页数
PageInfo pageInfo =new PageInfo((List) list);
pageBean.setTotal(pageInfo.getTotal()+"");
}
return list;
}
}
最后在test层创建controller层测试类
LogControllerTest
package com.liuchunming.controller;
import com.liuchunming.SpringBaseTest;
import com.liuchunming.annotation.springaop.LogController;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
/**
* @author liuchunming
* * @site www.xiaoliu.com
* * @company
* * @create 2020-11-26 19:12
*/
public class LogControllerTest extends SpringBaseTest {
@Autowired
private LogController logController;
@Test
public void testLogAspect(){
logController.testLogAspect();
}
}
效果
想学习更都跳转链接：https://blog.csdn.net/licmi/article/details/107065765.
扫一扫
1892
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
