java注解简单使用

Posted 2022-09-03 xiaostudy

java注解可以比喻成标签，可以贴在任何地方，也可以限制只能贴在固定地方，比如类上方、方法上方、属性[字段]上方等，然后通过反射，判断是否存在这个注解。

 

注解形式

public @interface Test 

应用

//类上
@Test
public class Entity
   // 属性上
    @Test
    private int id;
    //方法上
    @Test
    public void test()
    

元注解

元注解是什么意思呢？

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。

如果难于理解的话，你可以这样理解。元注解也是一张标签，但是它是一张特殊的标签，它的作用和目的就是给其他普通的标签进行解释说明的。

元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Retention

Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。

它的取值如下：

• RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
• RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
• RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

@Documented

顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

@Target

Target 是目标的意思，@Target 指定了注解运用的地方。

你可以这样理解，当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。

类比到标签，原本标签是你想张贴到哪个地方就到哪个地方，但是因为 @Target 的存在，它张贴的地方就非常具体了，比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值

• ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
• ElementType.CONSTRUCTOR 可以给构造方法进行注解
• ElementType.FIELD 可以给属性进行注解
• ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
• ElementType.METHOD 可以给方法进行注解
• ElementType.PACKAGE 可以给一个包进行注解
• ElementType.PARAMETER 可以给一个方法内的参数进行注解
• ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举

@Inherited

Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。

 

例子

打印实体类的sql查询语句

注解Test_Table，用于注解类，数据库表注解

 1 package com.xiaostudy.test;
 2 
 3 import java.lang.annotation.*;
 4 
 5 //RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
 6 //RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
 7 //RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。
 8 @Retention(RetentionPolicy.RUNTIME)
 9 //它的作用是能够将注解中的元素包含到 Javadoc 中去。
10 @Documented
11 //ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
12 //ElementType.CONSTRUCTOR 可以给构造方法进行注解
13 //ElementType.FIELD 可以给属性进行注解
14 //ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
15 //ElementType.METHOD 可以给方法进行注解
16 //ElementType.PACKAGE 可以给一个包进行注解
17 //ElementType.PARAMETER 可以给一个方法内的参数进行注解
18 //ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举
19 @Target(ElementType.TYPE)
20 public @interface Test_Table 
21     String value();
22 

注解Test_Column，注解属性，数据库列注解

 1 package com.xiaostudy.test;
 2 
 3 import java.lang.annotation.*;
 4 
 5 @Retention(RetentionPolicy.RUNTIME)
 6 @Documented
 7 @Target(ElementType.FIELD)
 8 public @interface Test_Column 
 9     String value();
10 

student类

 1 package com.xiaostudy.test;
 2 
 3 @Test_Table("t_student")
 4 public class Student 
 5     @Test_Column("id")
 6     private int id;
 7 
 8     @Test_Column("name")
 9     private String name;
10 
11     @Test_Column("age")
12     private int age;
13 
14     public int getId() 
15         return id;
16     
17 
18     public void setId(int id) 
19         this.id = id;
20     
21 
22     public String getName() 
23         return name;
24     
25 
26     public void setName(String name) 
27         this.name = name;
28     
29 
30     public int getAge() 
31         return age;
32     
33 
34     public void setAge(int age) 
35         this.age = age;
36     
37 

 

测试

 1 package com.xiaostudy.test;
 2 
 3 import java.lang.reflect.Field;
 4 import java.lang.reflect.InvocationTargetException;
 5 import java.lang.reflect.Method;
 6 
 7 public class Test 
 8 
 9     public static void main(String[] agrs) 
10         Student student = new Student();
11         student.setId(333);
12         student.setName("xiaostudy,xiaoming");
13         student.setAge(23);
14         System.out.println(querySql(student));
15     
16 
17     private static String querySql(Object f) 
18         StringBuilder sql = new StringBuilder();
19         //获取到class
20         Class c1 = f.getClass();
21         //获取table的名字
22         boolean exists = c1.isAnnotationPresent(Test_Table.class);
23         if(!exists) 
24             return null;
25         
26         Test_Table t = (Test_Table)c1.getAnnotation(Test_Table.class);
27         //定义表名
28         String tableName = t.value();
29         sql.append("select * from ").append(tableName).append(" where 1=1 ");
30         //遍历所有的字段
31         Field[] fields = c1.getDeclaredFields();
32         for (Field field : fields) 
33             //判断是否存在这个注解
34             boolean Fexists = field.isAnnotationPresent(Test_Column.class);
35             if(!Fexists) 
36                 continue;
37             
38             //获取注解
39             Test_Column column = field.getAnnotation(Test_Column.class);
40             String ColumuName = column.value();
41             //获取字段的值
42             String fieldName = field.getName();
43             String getMethodName = "get" + fieldName.substring(0,1).toUpperCase() + fieldName.substring(1);
44             Method method = null;
45             Object ColumuValue = null;
46             try 
47                 method = c1.getMethod(getMethodName);
48                 ColumuValue = method.invoke(f);
49 
50              catch (InvocationTargetException e) 
51                 e.printStackTrace();
52              catch (NoSuchMethodException e) 
53                 e.printStackTrace();
54              catch (IllegalAccessException e) 
55                 e.printStackTrace();
56             
57             //int型不需要加单引号，String型需要加单引号
58             if(ColumuValue instanceof Integer && 0 != (Integer)ColumuValue)
59                 sql.append("and " + ColumuName + " = " + ColumuValue + " ");
60             else if(ColumuValue instanceof String)
61                 if( ((String) ColumuValue).contains(",") )
62                     String[] values = ((String) ColumuValue).split(",");
63                     sql.append("and " + ColumuName + " in (");
64                     for(int i=0; i<values.length; i++) 
65                         sql.append("‘").append(values[i]).append(" ‘,");
66                     
67                     sql.deleteCharAt(sql.length() -1);
68                     sql.append(")");
69                 else
70                     sql.append(" and " + ColumuName + " = ‘" + ColumuValue + "‘ ");
71                 
72             
73         
74         return sql.toString();
75     
76 

 

参考文章：https://blog.csdn.net/qq1404510094/article/details/80577555

              https://www.cnblogs.com/lrzy/articles/8405723.html