自定义注解

自定义注解

/**
 * 自定义导出Excel数据注解
 * 
 * @author ruoyi
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Excel
{
    /**
     * 导出时在excel中排序
     */
    public int sort() default Integer.MAX_VALUE;

    /**
     * 导出到Excel中的名字.
     */
    public String name() default "";

    /**
     * 日期格式, 如: yyyy-MM-dd
     */
    public String dateFormat() default "";

    /**
     * 如果是字典类型，请设置字典的type值 (如: sys_user_sex)
     */
    public String dictType() default "";

    /**
     * 读取内容转表达式 (如: 0=男,1=女,2=未知)
     */
    public String readConverterExp() default "";

    /**
     * 分隔符，读取字符串组内容
     */
    public String separator() default ",";

    /**
     * BigDecimal 精度 默认:-1(默认不开启BigDecimal格式化)
     */
    public int scale() default -1;

    /**
     * BigDecimal 舍入规则 默认:BigDecimal.ROUND_HALF_EVEN
     */
    public int roundingMode() default BigDecimal.ROUND_HALF_EVEN;

    /**
     * 导出类型（0数字 1字符串）
     */
    public ColumnType cellType() default ColumnType.STRING;

    /**
     * 导出时在excel中每个列的高度 单位为字符
     */
    public double height() default 14;

    /**
     * 导出时在excel中每个列的宽 单位为字符
     */
    public double width() default 16;

    /**
     * 文字后缀,如% 90 变成90%
     */
    public String suffix() default "";

    /**
     * 当值为空时,字段的默认值
     */
    public String defaultValue() default "";

    /**
     * 提示信息
     */
    public String prompt() default "";

    /**
     * 设置只能选择不能输入的列内容.
     */
    public String[] combo() default {};

    /**
     * 是否导出数据,应对需求:有时我们需要导出一份模板,这是标题需要但内容需要用户手工填写.
     */
    public boolean isExport() default true;

    /**
     * 另一个类中的属性名称,支持多级获取,以小数点隔开
     */
    public String targetAttr() default "";

    /**
     * 是否自动统计数据,在最后追加一行统计数据总和
     */
    public boolean isStatistics() default false;

    /**
     * 导出字段对齐方式（0：默认；1：靠左；2：居中；3：靠右）
     */
    Align align() default Align.AUTO;

    public enum Align
    {
        AUTO(0), LEFT(1), CENTER(2), RIGHT(3);
        private final int value;

        Align(int value)
        {
            this.value = value;
        }

        public int value()
        {
            return this.value;
        }
    }

    /**
     * 字段类型（0：导出导入；1：仅导出；2：仅导入）
     */
    Type type() default Type.ALL;

    public enum Type
    {
        ALL(0), EXPORT(1), IMPORT(2);
        private final int value;

        Type(int value)
        {
            this.value = value;
        }

        public int value()
        {
            return this.value;
        }
    }

    public enum ColumnType
    {
        NUMERIC(0), STRING(1), IMAGE(2);
        private final int value;

        ColumnType(int value)
        {
            this.value = value;
        }

        public int value()
        {
            return this.value;
        }
    }
}

自定义类注解

 // Retention注解决定MyAnnotation注解的生命周期
    @Retention (RetentionPolicy.RUNTIME)
// Target注解决定MyAnnotation注解可以加在哪些成分上，如加在类身上，或者属性身上，或者方法身上等成分
    @Target ({ ElementType.METHOD, ElementType.TYPE,ElementType.FIELD })
    public @interface AnnotationForTest{
        String value();
    }

使用注解

public class ClassWithAnnotation{

        @Excel(name = "name1",sort = 1)
        private String id;

        public String getId () {
            return id;
        }

        public void setId (String id) {
            this.id = id;
        }
    }

获取注解信息

List<Field> tempFields = new ArrayList<> ();
        tempFields.addAll(Arrays.asList(ClassWithAnnotation.class.getSuperclass().getDeclaredFields()));
        tempFields.addAll(Arrays.asList(ClassWithAnnotation.class.getDeclaredFields()));
        for (Field field : tempFields){
            if (field.isAnnotationPresent(Excel.class))
            {
                System.out.println (field.getAnnotation(Excel.class).name ());
            }
            if (field.isAnnotationPresent(Excels.class))
            {
                System.out.println (1);
                Excels attrs = field.getAnnotation(Excels.class);
                Excel[] excels = attrs.value();
                System.out.println (excels);
                for (Excel excel : excels)
                {
                    System.out.println (excel);
                }
            }
        }

获取类注解信息--第三方插件

        Map<String, Object> annotationValueMap = AnnotationUtil.getAnnotationValueMap (ClassWithAnnotation.class, AnnotationForTest.class);
        System.out.println (annotationValueMap);

自定义注解基础使用

1. 
package com.ruoyi.crm.annotation;

import java.lang.annotation.*;

/**
 * @author liuhuan
 * @title: myAnnotation
 * @description: TODO
 * @projectName RuoyiCRM
 * @date 2023/5/1515:27
 * @return V1.0.0
 */
@Documented
//@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})//只能写在类上
public @interface myAnnotation {
    String value() default "vu";
    Class type();
}
2. 
public class demoApi extends BaseController {
    @myAnnotation(type = demoApi.class,value = "ab")
    @Test
    public void demo(){
        for (Annotation annotation :demoApi.class.getAnnotations()) {
            if(annotation instanceof myAnnotation){
                System.out.println(((myAnnotation)annotation).value());
            }
        }
    }
}