自定义注解

一、简单介绍

Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。 注解相关类都包含在java.lang.annotation包中。

1.0 java注解分类

JDK基本注解
JDK元注解
自定义注解

1.0.1 JDK基本注解

@Override
重写

@SuppressWarnings(value = “unchecked”)
压制编辑器警告

1.0.2 JDK元注解

@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.PACKAGE) //包
注：可以指定多个位置，例如：
@Target({ElementType.METHOD, ElementType.TYPE})，也就是此注解可以在方法和类上面使用

@Inherited：指定被修饰的Annotation将具有继承性

@Documented：指定被修饰的该Annotation可以被javadoc工具提取成文档.

1.0.3 自定义注解

注解分类（根据Annotation是否包含成员变量,可以把Annotation分为两类）:

标记Annotation:
没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息

元数据Annotation:
包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;

1.0.4 如何自定义注解

使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:
Annotation的成员变量在Annotation定义中是以无参的方法形式来声明的, 其方法名和返回值类型定义了该成员变量的名字和类型,
而且我们还可以使用default关键字为这个成员变量设定默认值；

二、自定义注解

2.1 案例一（获取类上的注解值）

注解类

package com.zking.ssm.annotation;


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

/**
 *  MyAnnotation1注解可以用在类、接口、属性、方法上
 *  * 注解运行期也保留
 *  * 不可继承
 */

@Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.SOURCE)
public @interface MyAnnotation1 {
//    @interface  注解修饰符
//    指的是注解中的属性
        public String value() default  "可以修饰类和属性、方法";
        public String desc() default  "可以修饰类和属性、方法";
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

使用注解类

package com.zking.ssm.annotation;

/**
 * @author javaxy
 * @company xxx公司
 * @create  2022-11-17 9:18
 */
// value如果标记在属性上面可以省略
@MyAnnotation1(desc = "标记在类上面")
public class StudentController {

    @MyAnnotation1( "标记在属性id上面")
    private  String id;
    @MyAnnotation1( "标记在属性name上面")
    private  String name;
    @MyAnnotation1
    public  void  test1(@MyAnnotation2("用来修饰id参数") String id,@MyAnnotation2("用来修饰参数name") String name){
        System.out.println("测试1");
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

注解类2

package com.zking.ssm.annotation;


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

@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.SOURCE)
public @interface MyAnnotation2 {
//    @interface  注解修饰符
//    指的是注解中的属性
        public String value() default  "可以修饰类和属性、方法";
        public String desc() default  "可以修饰类和属性、方法";
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

获取自定义注解中的类容

package com.zking.ssm.annotation.demo;

import com.zking.ssm.annotation.MyAnnotation1;
import com.zking.ssm.annotation.StudentController;

/**
 * @author javaxy
 * @company xxx公司
 * @create  2022-11-17 9:30
 *
 * 目标:
 * 1.获取studentcontroller 类上自定义注解中的类容
 * 2.获取studentcontroller 方法上自定义注解中的类容
 * 3. 获取studentcontroller 属性上自定义注解中的类容
 * 4.获取studentcontroller 参数上自定义注解中的类容
 *
 * *.Service.Pager(..)
 * com.yzp.service.BookService.queryPager(..);
 *
 */
public class Demo1 {
    public static void main(String[] args) {
        MyAnnotation1 annotation = StudentController.class.getAnnotation(MyAnnotation1.class);
        System.out.println(annotation.desc());
        System.out.println(annotation.value());
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

如果现在你现在直接运行代码会报错

如果要运行代码我们需要将这个@Retention(RetentionPolicy.SOURCE)改成
@Retention(RetentionPolicy.RUNTIME)
改完之后的代码

package com.zking.ssm.annotation;


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

/**
 *  MyAnnotation1注解可以用在类、接口、属性、方法上
 *  * 注解运行期也保留
 *  * 不可继承
 */

@Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
//RUNTIME 只有运行时才能使用的注解
public @interface MyAnnotation1 {
//    @interface  注解修饰符

//    指的是注解中的属性
        public String value() default  "可以修饰类和属性、方法";
        public String desc() default  "可以修饰类和属性、方法";
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

运行结果

2.2 案例二 获取注解上的属性值

package com.zking.ssm.annotation.demo;

import com.zking.ssm.annotation.MyAnnotation1;
import com.zking.ssm.annotation.MyAnnotation2;
import com.zking.ssm.annotation.StudentController;

import java.lang.reflect.Field;

/**
 * @author javaxy
 * @company xxx公司
 * @create  2022-11-17 9:30
 *
 * 目标:
 * 1.获取studentcontroller 类上自定义注解中的类容
 * 2.获取studentcontroller 方法上自定义注解中的类容
 * 3. 获取studentcontroller 属性上自定义注解中的类容
 * 4.获取studentcontroller 参数上自定义注解中的类容
 *
 * *.Service.Pager(..)
 * com.yzp.service.BookService.queryPager(..);
 *
 */
public class Demo1 {
    public static void main(String[] args) throws Exception {
        MyAnnotation1 annotation = StudentController.class.getAnnotation(MyAnnotation1.class);
//        System.out.println(annotation.desc());
//        System.out.println(annotation.value());

//        获取属性上的
        Field id = StudentController.class.getDeclaredField("id");
        Field name = StudentController.class.getDeclaredField("name");
        System.out.println(id.getAnnotation(MyAnnotation1.class).value());
        System.out.println(name.getAnnotation(MyAnnotation1.class).value());


//        Field[] declaredFields = StudentController.class.getDeclaredFields();
//        for (Field f:declaredFields){
//            MyAnnotation1 annotation1 = f.getAnnotation(MyAnnotation1.class);
//            if(annotation1!=null){
//
//            }
//        }
//
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

2.3 案例三、获取方法上的注解的类容

package com.zking.ssm.annotation.demo;

import com.zking.ssm.annotation.MyAnnotation1;
import com.zking.ssm.annotation.MyAnnotation2;
import com.zking.ssm.annotation.StudentController;

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

/**
 * @author javaxy
 * @company xxx公司
 * @create  2022-11-17 9:30
 *
 * 目标:
 * 1.获取studentcontroller 类上自定义注解中的类容
 * 2.获取studentcontroller 方法上自定义注解中的类容
 * 3. 获取studentcontroller 属性上自定义注解中的类容
 * 4.获取studentcontroller 参数上自定义注解中的类容
 *
 * *.Service.Pager(..)
 * com.yzp.service.BookService.queryPager(..);
 *
 */
public class Demo1 {
    public static void main(String[] args) throws Exception {
        MyAnnotation1 annotation = StudentController.class.getAnnotation(MyAnnotation1.class);
//        System.out.println(annotation.desc());
//        System.out.println(annotation.value());

//        获取属性上的
//        Field id = StudentController.class.getDeclaredField("id");
//        Field name = StudentController.class.getDeclaredField("name");
//        System.out.println(id.getAnnotation(MyAnnotation1.class).value());
//        System.out.println(name.getAnnotation(MyAnnotation1.class).value());

//        获取方法上的
        Method m1 = StudentController.class.getDeclaredMethod("test1", String.class, String.class);
        System.out.println(m1.getAnnotation(MyAnnotation1.class).value());

//        Field[] declaredFields = StudentController.class.getDeclaredFields();
//        for (Field f:declaredFields){
//            MyAnnotation1 annotation1 = f.getAnnotation(MyAnnotation1.class);
//            if(annotation1!=null){
//
//            }
//        }
//
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

2.4 案例四 获取参数上的注解

首先要将MyAnnotation2中的注解修改成这个@Retention(RetentionPolicy.RUNTIME)，要不然会报跟上面一样的错

package com.zking.ssm.annotation.demo;

import com.zking.ssm.annotation.MyAnnotation1;
import com.zking.ssm.annotation.MyAnnotation2;
import com.zking.ssm.annotation.StudentController;

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

/**
 * @author javaxy
 * @company xxx公司
 * @create  2022-11-17 9:30
 *
 * 目标:
 * 1.获取studentcontroller 类上自定义注解中的类容
 * 2.获取studentcontroller 方法上自定义注解中的类容
 * 3. 获取studentcontroller 属性上自定义注解中的类容
 * 4.获取studentcontroller 参数上自定义注解中的类容
 *
 * *.Service.Pager(..)
 * com.yzp.service.BookService.queryPager(..);
 *
 */
public class Demo1 {
    public static void main(String[] args) throws Exception {
        MyAnnotation1 annotation = StudentController.class.getAnnotation(MyAnnotation1.class);
//        System.out.println(annotation.desc());
//        System.out.println(annotation.value());

//        获取属性上的
//        Field id = StudentController.class.getDeclaredField("id");
//        Field name = StudentController.class.getDeclaredField("name");
//        System.out.println(id.getAnnotation(MyAnnotation1.class).value());
//        System.out.println(name.getAnnotation(MyAnnotation1.class).value());

//        获取方法上的
        Method m1 = StudentController.class.getDeclaredMethod("test1", String.class, String.class);
//        System.out.println(m1.getAnnotation(MyAnnotation1.class).value());

//        获取到参数上面的
        for (Parameter p:m1.getParameters()){
            System.out.println(p.getAnnotation(MyAnnotation2.class).value());
        }

//        Field[] declaredFields = StudentController.class.getDeclaredFields();
//        for (Field f:declaredFields){
//            MyAnnotation1 annotation1 = f.getAnnotation(MyAnnotation1.class);
//            if(annotation1!=null){
//
//            }
//        }
//
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

三、Aop自定义注解的应用

注解类

package com.zking.ssm.annotation.aop;

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

/**
 * @author javaxy
 * @company xxx公司
 * @create  2022-11-17 10:26
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
    String desc();
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

使用注解类

package com.zking.ssm.annotation.aop;

import org.springframework.stereotype.Controller;

/**
 * @author javaxy
 * @company xxx公司
 * @create  2022-11-17 10:28
 */
@Controller
public class DemoController {

    @MyLog( desc = "这是一个测试类的方法")
    public  void  test(){
        System.out.println("测试方法");
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

日志切面类，使用注解的切面的类

package com.zking.ssm.annotation.aop;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;


/**
 * @author javaxy
 * @company xxx公司
 * @create  2022-11-17 10:31
 */
@Component
@Aspect
public class MyLogAspect {

    private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);

    /**
     * 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的，就是目标类
     */
    @Pointcut("@annotation(com.zking.ssm.annotation.aop.MyLog)")
    private void MyValid() {
    }

    @Before("MyValid()")
    public void before(JoinPoint joinPoint) {
//        目标对象，目标方法，传递的参数
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        logger.debug("[" + signature.getName() + " : start.....]");
        System.out.println("[" + signature.getName() + " : start.....]");

        MyLog myLog = signature.getMethod().getAnnotation(MyLog.class);
        logger.debug("【目标对象方法被调用时候产生的日志，记录到日志表中】："+myLog.desc());
        System.out.println("【目标对象方法被调用时候产生的日志，记录到日志表中】：" + myLog.desc());
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

测试类

package com.zking.shiro;

import com.zking.ssm.annotation.aop.DemoController;
import com.zking.ssm.biz.ClazzBiz;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

/**
 * @author javaxy
 * @company xxx公司
 * @create  2022-10-26 15:29
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={"classpath:applicationContext.xml"})
public class DemoBizTest {
    @Autowired
    private DemoController dc;

    @Test
    public void test1(){
        dc.test();
    }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

pom.xml

  4.0.0

  org.example
  ssm2
  1.0-SNAPSHOT
  war

  ssm2 Maven Webapp
  
  http://www.example.com

  
    UTF-8
    1.8
    1.8
    3.7.0

    
    
    5.0.2.RELEASE
    
    3.4.5
    
    5.1.44
    
    5.1.2
    
    1.3.1
    
    2.1.1
    2.4.3
    
    2.9.1
    
    4.12
    4.0.0
    1.18.2

    2.10.0
    1.7.7

    
    2.9.0
    1.7.1.RELEASE
  

  
    
    
      org.springframework
      spring-context
      ${spring.version}
    
    
      org.springframework
      spring-orm
      ${spring.version}
    
    
      org.springframework
      spring-tx
      ${spring.version}
    
    
      org.springframework
      spring-aspects
      ${spring.version}
    
    
      org.springframework
      spring-web
      ${spring.version}
    
    
      org.springframework
      spring-test
      ${spring.version}
    

    
    
      org.mybatis
      mybatis
      ${mybatis.version}
    
    
    
      mysql
      mysql-connector-java
      ${mysql.version}
    
    
    
      com.github.pagehelper
      pagehelper
      ${pagehelper.version}
    
    
    
      org.mybatis
      mybatis-spring
      ${mybatis.spring.version}
    

    
    
      org.apache.commons
      commons-dbcp2
      ${commons.dbcp2.version}
    
    
      org.apache.commons
      commons-pool2
      ${commons.pool2.version}
    

    
    
    
      org.apache.logging.log4j
      log4j-core
      ${log4j2.version}
    
    
      org.apache.logging.log4j
      log4j-api
      ${log4j2.version}
    
    
    
      org.apache.logging.log4j
      log4j-web
      ${log4j2.version}
    

    
    
      junit
      junit
      ${junit.version}
      test
    
    
      javax.servlet
      javax.servlet-api
      ${servlet.version}
      provided
    
    
      org.projectlombok
      lombok
      ${lombok.version}
      provided
    

    
      org.springframework
      spring-webmvc
      ${spring.version}
    

    
    
      javax.servlet.jsp
      javax.servlet.jsp-api
      2.3.3
    
    
      jstl
      jstl
      1.2
    
    
      taglibs
      standard
      1.1.2
    

    
      commons-fileupload
      commons-fileupload
      1.3.3
    


    
      org.hibernate
      hibernate-validator
      6.0.7.Final
    


    
      com.fasterxml.jackson.core
      jackson-databind
      2.9.3
    
    
      com.fasterxml.jackson.core
      jackson-core
      2.9.3
    
    
      com.fasterxml.jackson.core
      jackson-annotations
      2.9.3
    


    
      org.apache.shiro
      shiro-core
      1.3.2
    

    
      org.apache.shiro
      shiro-web
      1.3.2
    

    
      org.apache.shiro
      shiro-spring
      1.3.2
    

    
      net.sf.ehcache
      ehcache
      ${ehcache.version}
    

    
    
      org.slf4j
      slf4j-api
      ${slf4j-api.version}
    
    
      org.slf4j
      jcl-over-slf4j
      ${slf4j-api.version}
      runtime
    

    
    
      org.apache.logging.log4j
      log4j-slf4j-impl
      ${log4j2.version}
    

    
    
      redis.clients
      jedis
      ${redis.version}
    
    
      org.springframework.data
      spring-data-redis
      ${redis.spring.version}
    
  

  
    ssm2
    
      
      
        src/main/java
        
          **/*.xml
        
      
      
      
        src/main/resources
        
          *.properties
          *.xml
        
      
    
    
      
        
          org.apache.maven.plugins
          maven-compiler-plugin
          ${maven.compiler.plugin.version}
          
            ${maven.compiler.source}
            ${maven.compiler.target}
            ${project.build.sourceEncoding}
          
        
        
          org.mybatis.generator
          mybatis-generator-maven-plugin
          1.3.2
          
            
            
              mysql
              mysql-connector-java
              ${mysql.version}
            
          
          
            true
          
        

        
          maven-clean-plugin
          3.1.0
        
        
        
          maven-resources-plugin
          3.0.2
        
        
          maven-compiler-plugin
          3.8.0
        
        
          maven-surefire-plugin
          2.22.1
        
        
          maven-war-plugin
          3.2.2
        
        
          maven-install-plugin
          2.5.2
        
        
          maven-deploy-plugin
          2.8.2
        
      
    
  


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352

测试结果：