首页>>后端>>SpringBoot->java自定义注解实现(java自定义注解实现api文档)

java自定义注解实现(java自定义注解实现api文档)

时间:2023-12-01 本站 点击:0

java注解是怎么实现的

注解的使用一般是与java的反射一起使用,下面是一个例子

注解相当于一种标记,在程序中加了注解就等于为程序打上了某种标记,没加,则等于没有某种标记,以后,javac编译器,开发工具和其他程序可以用反射来了解你的类及各种元素上有无何种标记,看你有什么标记,就去干相应的事。标记可以加在包,类,字段,方法,方法的参数以及局部变量上。

自定义注解及其应用

1)、定义一个最简单的注解

public @interface MyAnnotation {

//......

}

2)、把注解加在某个类上:

@MyAnnotation

public class AnnotationTest{

//......

}

以下为模拟案例

自定义注解@MyAnnotation

1 package com.ljq.test;

2

3 import java.lang.annotation.ElementType;

4 import java.lang.annotation.Retention;

5 import java.lang.annotation.RetentionPolicy;

6 import java.lang.annotation.Target;

7

8 /**

9 * 定义一个注解

10 *

11 *

12 * @author jiqinlin

13 *

14 */

15 //Java中提供了四种元注解,专门负责注解其他的注解,分别如下

16

17 //@Retention元注解,表示需要在什么级别保存该注释信息(生命周期)。可选的RetentionPoicy参数包括:

18 //RetentionPolicy.SOURCE: 停留在java源文件,编译器被丢掉

19 //RetentionPolicy.CLASS:停留在class文件中,但会被VM丢弃(默认)

20 //RetentionPolicy.RUNTIME:内存中的字节码,VM将在运行时也保留注解,因此可以通过反射机制读取注解的信息

21

22 //@Target元注解,默认值为任何元素,表示该注解用于什么地方。可用的ElementType参数包括

23 //ElementType.CONSTRUCTOR: 构造器声明

24 //ElementType.FIELD: 成员变量、对象、属性(包括enum实例)

25 //ElementType.LOCAL_VARIABLE: 局部变量声明

26 //ElementType.METHOD: 方法声明

27 //ElementType.PACKAGE: 包声明

28 //ElementType.PARAMETER: 参数声明

29 //ElementType.TYPE: 类、接口(包括注解类型)或enum声明

30

31 //@Documented将注解包含在JavaDoc中

32

33 //@Inheried允许子类继承父类中的注解

34

35

36 @Retention(RetentionPolicy.RUNTIME)

37 @Target({ElementType.METHOD, ElementType.TYPE})

38 public @interface MyAnnotation {

39 //为注解添加属性

40 String color();

41 String value() default "我是林计钦"; //为属性提供默认值

42 int[] array() default {1, 2, 3};

43 Gender gender() default Gender.MAN; //添加一个枚举

44 MetaAnnotation metaAnnotation() default @MetaAnnotation(birthday="我的出身日期为1988-2-18");

45 //添加枚举属性

46

47 }

注解测试类AnnotationTest

1 package com.ljq.test;

2

3 /**

4 * 注解测试类

5 *

6 *

7 * @author jiqinlin

8 *

9 */

10 //调用注解并赋值

11 @MyAnnotation(metaAnnotation=@MetaAnnotation(birthday = "我的出身日期为1988-2-18"),color="red", array={23, 26})

12 public class AnnotationTest {

13

14 public static void main(String[] args) {

15 //检查类AnnotationTest是否含有@MyAnnotation注解

16 if(AnnotationTest.class.isAnnotationPresent(MyAnnotation.class)){

17 //若存在就获取注解

18 MyAnnotation annotation=(MyAnnotation)AnnotationTest.class.getAnnotation(MyAnnotation.class);

19 System.out.println(annotation);

20 //获取注解属性

21 System.out.println(annotation.color());

22 System.out.println(annotation.value());

23 //数组

24 int[] arrs=annotation.array();

25 for(int arr:arrs){

26 System.out.println(arr);

27 }

28 //枚举

29 Gender gender=annotation.gender();

30 System.out.println("性别为:"+gender);

31 //获取注解属性

32 MetaAnnotation meta=annotation.metaAnnotation();

33 System.out.println(meta.birthday());

34 }

35 }

36 }

枚举类Gender,模拟注解中添加枚举属性

1 package com.ljq.test;

2 /**

3 * 枚举,模拟注解中添加枚举属性

4 *

5 * @author jiqinlin

6 *

7 */

8 public enum Gender {

9 MAN{

10 public String getName(){return "男";}

11 },

12 WOMEN{

13 public String getName(){return "女";}

14 }; //记得有“;”

15 public abstract String getName();

16 }

注解类MetaAnnotation,模拟注解中添加注解属性

1 package com.ljq.test;

2

3 /**

4 * 定义一个注解,模拟注解中添加注解属性

5 *

6 * @author jiqinlin

7 *

8 */

9 public @interface MetaAnnotation {

10 String birthday();

11 }

Java ,自定义注解怎么使用

java中自定义注解的使用方法:

首先声明一个接口,并未它添加注解内容!

package testAnnotation;

import java.lang.annotation.Documented;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

@Documented

@Retention(RetentionPolicy.RUNTIME)

public @interface Person{

String name();

int age();

}

2、然后利用反射机制查看类的注解内容

package testAnnotation;

@Person(name="xingoo",age=25)

public class test3 {

public static void print(Class c){

System.out.println(c.getName());

//java.lang.Class的getAnnotation方法,如果有注解,则返回注解。否则返回null

Person person = (Person)c.getAnnotation(Person.class);

if(person != null){

System.out.println("name:"+person.name()+" age:"+person.age());

}else{

System.out.println("person unknown!");

}

}

public static void main(String[] args){

test3.print(test3.class);

}

}

运行结果,读取到了注解的内容

testAnnotation.test3

name:xingoo age:25

通过注解实现自定义Spring Boot Starter自动装配

以Spring boot 作为微服务开发的项目中会用到很多第三方,或者自建的一些依赖SDK,例如 分布式锁、文件管理、数据库连接、统一错误拦截等组件。为了达到通用的目的,都会创建自定义的spring boot stater 组件。以下介绍创建步骤:

一、创建Maven测试项目test-starter pom文件如下:

二、创建自动装配类TestServiceConfiguration.java

三、创建配置类TestServiceProperties.java

四、创建提供服务的接口TestService.java

五、创建TestService的实现类型TestServiceImpl.java

六、创建自定义注解@EnableTest

通过以上步骤就实现了自定义Spring boot starter test-spring-boot-starter 组件,下面创建测试项目去调用这个starter组件。

创建starter组件使用项目

一、创建maven测试项目test-service,pom文件如下

二、创建启动类Application.java

三、创建配置文件application.yml

四、创建测试类TestController.java

到这里整个自定义spring boot starter 创建就完成了,同时也依赖到项目中进行使用了。

项目代码:starter-test: 自定义starter组件

如何实现自定义注解

首先,定义一个注解:

package com.guxiang.test;

import java.lang.annotation.Documented;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

首先自定义一个 myTest注解

/**

 * @author guxiang

 * @date 2016年12月24日 下午10:22:11

 * 自定义的myTest注解

 */

@Documented

@Retention(RetentionPolicy.RUNTIME)

@Target({ElementType.METHOD,ElementType.ANNOTATION_TYPE})

public @interface MyTest {

    long time() default -1;

}

其次,写一个类用于被myTest注解,实现测试:

package com.guxiang.test;

public class SomeDaoImpl {

    public void save(){

        System.out.println("保存了数据");

    }

    public void update(){

        System.out.println("更新了数据");

    }

}

写一个测试类 这个类 引用myTest注解:

package com.guxiang.test;

public class SomeDaoImplTest {

    private SomeDaoImpl dao= new SomeDaoImpl();

    /**

     * 测试添加

     */

    @MyTest

    public void testAdd(){

        dao.save();

    }

    @MyTest

    public void testUpdate(){

        dao.update();

    }

最后,写一个myTestRunner类使用反射实现注解的功能:

package com.guxiang.test;

import java.lang.reflect.InvocationTargetException;

import java.lang.reflect.Method;

// 反射注解

public class MyTestRunner {

    public static void main(String[] args) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, InstantiationException {

        Class clazz = SomeDaoImplTest.class;

        Method[] ms = clazz.getMethods();

        for (Method method : ms) {

            boolean hasMyTest = method.isAnnotationPresent(MyTest.class);

            if (hasMyTest) {

                method.invoke(clazz.newInstance(), null);

            }

        }

    }

}

Java自定义注解注解实现实体类与数据库表字段的映射

这个 按照我的理解

首先自定义注解要有自己的编译解释方法的

在这个便已解释方法中估计需要连接数据库(当然最基本的jdbc什么的)

当然连接数据库什么的涉及到配置文件

通过jdbc获取到数据库信息 把注解中的参数与数据库中的信息关联(简单的就可以存成ListMap等方式)由于注解的参数一般是类名。你可以 用反射的方式或其他方式(比如字节码什么的)来处理获取类的属性

然后 我感觉关联完了 就没啥然后了 感觉主要是在注解的编译解释方法中做写东西 当然 提高效率也可以用数据库连接池什么的


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若转载,请注明出处:/SpringBoot/6018.html