java自定注解完整示例代码

public class AnnotationDemo {
    //@Test注解修饰方法A
    @Test
    public static void A(){
        System.out.println("Test.....");
    }

    //一个方法上可以拥有多个不同的注解
    @Deprecated
    @SuppressWarnings("uncheck")
    public static void B(){

    }
}

    @SuppressWarnings({"unchecked","deprecation"})
    public void test1() {
    }

@Target(ElementType.TYPE)
public @interface Table {
    /**
     * 数据表名称注解，默认值为类名称
     * @return
     */
    public String tableName() default "className";
}

@Target(ElementType.FIELD)
public @interface NoDBColumn {
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField";
    public boolean defaultDBValue() default false;
}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Reference{
    boolean next() default false;
}

public @interface AnnotationElementDemo {
    //枚举类型
    enum Status {FIXED,NORMAL};

    //声明枚举
    Status status() default Status.FIXED;

    //布尔类型
    boolean showSupport() default false;

    //String类型
    String name()default "";

    //class类型
    Class<?> testCase() default Void.class;

    //注解嵌套
    Reference reference() default @Reference(next=true);

    //数组类型
    long[] value();
}

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Test {

    /**
     * Default empty exception
     */
    static class None extends Throwable {
        private static final long serialVersionUID = 1L;

        private None() {
        }
    }

    Class<? extends Throwable> expected() default None.class;

    long timeout() default 0L;
}

import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}

/**
 * @author pangzi
 * @version V1.0
 * @Description log4j多线程日志输出注解
 *    使用该注解的方法，其运行日志除了在正常的log文件中输出外。
 *    还会在 thread目录下 job:uuid-YYYYMMDD.log 文件中输出。
 * @date 2019-11-02 16:34
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogTreadAnnotation {
}

/**
 * @author pangzi
 * @version V1.0
 * @Description 用于aop类中当作切入点来选择数据源
 * @date 2019-06-03 14:43
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface DataSource {
    DataSourceEnum value() default DataSourceEnum.MYSQL;
}

/***********注解声明***************/
/**
 * 水果名称注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
    String value() default "";
}
/**
 * 水果颜色注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
    /**
     * 颜色枚举
     * @author peida
     *
     */
    public enum Color{ BULE,RED,GREEN};
    /**
     * 颜色属性
     * @return
     */
    Color fruitColor() default Color.GREEN;
}

/**
 * 水果供应者注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
    /**
     * 供应商编号
     * @return
     */
    public int id() default -1;
    /**
     * 供应商名称
     * @return
     */
    public String name() default "";
    /**
     * 供应商地址
     * @return
     */
    public String address() default "";
}
/***********注解使用***************/
public class Apple {
    @FruitName("Apple")
    private String appleName;
    @FruitColor(fruitColor=Color.RED)
    private String appleColor;
    @FruitProvider(id=1,name="陕西红富士集团",address="陕西省西安市延安路89号红富士大厦")
    private String appleProvider;
}
/***********注解处理器***************/
public class FruitInfoUtil {
    public static void getFruitInfo(Class</> clazz){

        String strFruitName=" 水果名称：";
        String strFruitColor=" 水果颜色：";
        String strFruitProvicer="供应商信息：";

        Field[] fields = clazz.getDeclaredFields();

        for(Field field :fields){
            if(field.isAnnotationPresent(FruitName.class)){
                FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);
                strFruitName=strFruitName+fruitName.value();
                System.out.println(strFruitName);
            }
            else if(field.isAnnotationPresent(FruitColor.class)){
                FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);
                strFruitColor=strFruitColor+fruitColor.fruitColor().toString();
                System.out.println(strFruitColor);
            }
            else if(field.isAnnotationPresent(FruitProvider.class)){
                FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);
                strFruitProvicer=" 供应商编号："+fruitProvider.id()+" 供应商名称："+fruitProvider.name()+" 供应商地址："+fruitProvider.address();
                System.out.println(strFruitProvicer);
            }
        }
    }
}
/***********输出结果***************/
public class FruitRun {
    /**
     * @param args
     */
    public static void main(String[] args) {
        FruitInfoUtil.getFruitInfo(Apple.class);
    }
}

/**
 * @author pangzi
 * @version V1.0
 * @Description log4j多线程日志输出注解
 *    使用该注解的方法，其运行日志除了在正常的log文件中输出外。
 *    还会在 thread目录下 job:uuid-YYYYMMDD.log 文件中输出。
 * @date 2019-11-02 16:34
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogTreadAnnotation {
}

/**
 * @author pangzi
 * @version V1.0
 * @Description log4j多线程日志控制切面
 * @date 2019-11-02 16:30
 */
@Component      //声明组件
@Aspect         //声明切面
@ComponentScan  //组件自动扫描
@EnableAspectJAutoProxy //spring自动切换JDK动态代理和CGLIB
public class LogTreadRecordAspect {

    @Pointcut("@annotation(com.zznode.gum.task.core.aop.LogTreadAnnotation)")
    public void addLogTread(){}

    @Before("addLogTread()")
    public void beforeAdvide(){
        //TODO 操作日志@Before 方法执行前
    }

    @After("addLogTread()")
    public void afterAdvide() {
        //TODO 操作日志@After 方法执行后
    }

    @Around("addLogTread()")
    public void aroundAvide(ProceedingJoinPoint pjp) throws Throwable {
        //操作日志@Around 方法执行前
        Object[] args = pjp.getArgs();
        if(args != null && args.length >1) {
           String jobId = args[0].toString();
           String uuid = args[1].toString();
           LogUtils.logThreadBegin(jobId+":"+uuid);
        }
        //方法执行
        pjp.proceed();

        //操作日志@Around 方法执行后
        LogUtils.logTreadEnd();
    }
}

/**
 * @author pangzi
 * @version V1.0
 * @Description Log4j2多线程输出日志工具类
 * @date 2019-11-02 15:07
 */
public class LogUtils {

    /**
     * 开始日志输出到指定线程
     * @param key
     */
    public static void logThreadBegin(String key) {
        ThreadContext.put("JobUUID",key);
    }

    /**
     * 结束日志输出
     */
    public static void logTreadEnd() {
        ThreadContext.remove("JobUUID");
    }
}

/**
 * @author pangzi
 * @version V1.0
 * @Description 数据汇聚计算Controller
 * @date 2019-09-16 14:20
 */
@Slf4j
@RestController
@RequestMapping("/dataConverge")
@Api(value = "数据计算任务RESTFUL")
public class DataConvergeController {

    @Autowired
    private DataConvergeService dataConvergeService;

    @ApiOperation(value = "报表指标天汇聚计算任务", notes = "报表指标天汇聚计算任务")
    @GetMapping("/rptIndexDayConverge")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "jobId", value = "任务编号", required = true, dataType = "String", paramType = "query"),
            @ApiImplicitParam(name = "uuid", value = "任务实例编号", required = true, dataType = "String", paramType = "query")
    })
    @ResponseBody
    @LogTreadAnnotation
    protected Result<String> rptIndexDayConverge(@RequestParam(name="jobId") String  jobId,
                                                 @RequestParam(name="uuid") String  uuid) {
        dataConvergeServiceAh.rptIndexDayConverge(jobId,uuid);
        //返回处理中
        return new Result<>(EnumResult.EXECUTING.getIndex(), EnumResult.EXECUTING.getName());
    }

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="WARN" monitorInterval="60">
    <Properties>
        <Property name="PATTERN">%d{DEFAULT} [%t] %-5p %c{1.}.%M %L - %msg%xEx%n</Property>
    </Properties>
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout pattern="${PATTERN}" />
        </Console>

        <RollingFile name="TRACE" fileName="${sys:app.log.home}/task-all.log" filePattern="${sys:app.log.home}/$${date:yyyy-MM}/task-all-%d{MM-dd-yyyy}-%i.log.gz">
            <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout pattern="${PATTERN}" />
            <SizeBasedTriggeringPolicy size="20MB" />
        </RollingFile>

        <RollingFile name="DEBUG" fileName="${sys:app.log.home}/task-debug.log" filePattern="${sys:app.log.home}/$${date:yyyy-MM}/task-debug-%d{MM-dd-yyyy}-%i.log.gz">
            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout pattern="${PATTERN}" />
            <SizeBasedTriggeringPolicy size="20MB" />
        </RollingFile>

        <RollingFile name="INFO" fileName="${sys:app.log.home}/task-info.log" filePattern="${sys:app.log.home}/$${date:yyyy-MM}/task-info-%d{MM-dd-yyyy}-%i.log.gz">
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout pattern="${PATTERN}" />
            <SizeBasedTriggeringPolicy size="20MB" />
        </RollingFile>

        <RollingFile name="ERROR" fileName="${sys:app.log.home}/task-error.log" filePattern="${sys:app.log.home}/$${date:yyyy-MM}/task-error-%d{MM-dd-yyyy}-%i.log.gz">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout pattern="${PATTERN}" />
            <SizeBasedTriggeringPolicy size="20MB" />
        </RollingFile>

        <Routing name="thread">
            <Routes pattern="$${ctx:JobUUID}">
                <Route>
                    <File name="File-${ctx:JobUUID}" fileName="${sys:app.log.home}/threads/${ctx:JobUUID}.log">
                        <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
                        <PatternLayout pattern="${PATTERN}" />
                    </File>
                </Route>
            </Routes>
        </Routing>
    </appenders>

    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效 -->
    <loggers>
        <!--过滤掉spring和mybatis的一些无用的DEBUG信息 -->
        <logger name="org.springframework" level="INFO" />
        <logger name="org.mybatis" level="debug" />
        <logger name="springfox.documentation" level="ERROR" />
        <logger name="io.netty" level="INFO" />
        <logger name="org.apache" level="info" />
        <logger name="reactor.util" level="info" />
        <logger name="org.flowable" level="info" />
        <logger name="com.test" level="debug" />
        <logger name="io.lettuce" level="info" />
        <logger name="org.quartz" level="info" />
        <logger name="org.hibernate.validator" level="info" />

        <root level="trace">
            <appender-ref ref="Console" />
            <appender-ref ref="TRACE" />
            <appender-ref ref="DEBUG" />
            <appender-ref ref="INFO" />
            <appender-ref ref="ERROR" />
            <appender-ref ref="thread" />
        </root>
    </loggers>
</configuration>

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ColumnCommandOrder {
    /**
     * 默认值处理顺序
     * @return 序号
     */
    int valueOrder() default 99;

    /**
     * 检查处理顺序
     * @return 序号
     */
    int checkOrder() default 99;

    /**
     * 指定报文类型。
     * 只有指定的报文类型，才使用该Command
     * @return 报文类型数组
     */
    String[] telexType() default {AnalyseConstants.TELEX_TYPE_NOTAMNCR};
}

@Component
public class AnalyseServiceContext implements ApplicationContextAware {

    private static ApplicationContext applicationContext=null;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        AnalyseServiceContext.applicationContext = applicationContext;
    }

    public static <T> T getBean(String beanName) {
        return (T)applicationContext.getBean(beanName);
    }

    public static <T> T getBean(Class<T> clazz) {
        return applicationContext.getBean(clazz);
    }

    public static Map<String,Object> getBeanMap(Class<? extends Annotation> tClass) {
          return applicationContext.getBeansWithAnnotation(tClass);
    }

    public static <T> Map<String,T> getBeansOfType(Class<T> clazz) {
        return applicationContext.getBeansOfType(clazz);
    }
}

public class TelexBusinessCheckParserHandler implements ITelexParserHandler{
    @Override
    public void parserTelex(ITelexBusinessHandler businessHandler) {
        if (businessHandler.isErrorOut()) {
            return;
        }
        TreeMap<Integer, ITelexColumnParserCommand> commandTreeMap= Maps.newTreeMap();
        Map<String,Object> maps = AnalyseServiceContext.getBeanMap(ColumnCommandOrder.class);
        for (Map.Entry<String, Object> bean: maps.entrySet()) {
            Object obj = bean.getValue();
            ColumnCommandOrder annotation = obj.getClass().getAnnotation(ColumnCommandOrder.class);
            if (null!=annotation) {
                int order = annotation.checkOrder();
                commandTreeMap.put(order, (ITelexColumnParserCommand) obj);
            }
        }

        commandTreeMap.forEach((k,v)->{
            v.setBusinessHandler(businessHandler);
            if (log.isDebugEnabled()) {
                log.debug("业务规则判断{},处理类{}",k,v.getClass().getSimpleName());
            }
            try {
                ColumnCommandOrder annotation = v.getClass().getAnnotation(ColumnCommandOrder.class);
                if (ArrayUtils.contains(annotation.telexType(),
                        businessHandler.getOutputType().getApplicationCode())) {
                    v.columnCheckHandler();
                }
            } catch (Exception e) {
                log.error("业务规则判断{},处理类{},异常{}",k,v.getClass().getSimpleName(),e);
            }
        });
    }
}

@Slf4j
@Component
@ColumnCommandOrder(valueOrder = 12,checkOrder = 12)
public class ItemBParserCommand extends AbstractColunmParserCommand {
...
}

//Java8前无法这样使用
@FilterPath("/web/update")
@FilterPath("/web/add")
public class A {}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface FilterPath {
    String [] value();
}

//使用
@FilterPath({"/update","/add"})
public class A { }

//使用Java8新增@Repeatable原注解
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(FilterPaths.class)//参数指明接收的注解class
public @interface FilterPath {
    String  value();
}

// 自定义一个包装类FilterPaths注解用来放置一组具体的FilterPath注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface FilterPaths {
    FilterPath[] value();
}

// 使用案例新方法
@FilterPath("/web/update")
@FilterPath("/web/add")
class AA{ }

// 使用案例旧方法
@FilterPaths ({@FilterPath("/web/update"), @FilterPath("/web/add")}) 
class AA{ }

// 用于构造函数，创建类实例
new@Interned MyObject();

// 用于强制类型转换和instanceof检查,注意这些注解中用于外部工具，它们不会对类型转换或者instanceof的检查行为带来任何影响。
myString = (@NonNull String) str;
if(input instanceof @NonNull String)

// 用于父类或者接口
class Image implements @Rectangular Shape { }

// 用于指定异常
void monitorTemperature() throws @Critical TemperatureException { ... }

// 标注在类型参数上
class D<@Parameter T> { }

@Target({ElementType.TYPE_PARAMETER, ElementType.TYPE_USE})
@interface MyAnnotation {}