java如何自定義注解

更新時(shí)間：2024年02月19日 14:28:31 作者：學(xué)、渣

這篇文章主要介紹了java如何自定義注解問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

聲明一個(gè)注解要用到的東西

修飾符：訪(fǎng)問(wèn)修飾符必須為public,不寫(xiě)默認(rèn)為pubic
關(guān)鍵字：關(guān)鍵字為@interface
注解名稱(chēng)：注解名稱(chēng)為自定義注解的名稱(chēng)，使用時(shí)還會(huì)用到
注解類(lèi)型元素：注解類(lèi)型元素是注解中內(nèi)容

其次，JDK中還有一些元注解，這些元注解可以用來(lái)修飾注解。

主要有：@Target，@Retention，@Document，@Inherited。

@Target

作用：

用于描述注解的使用范圍（即：被描述的注解可以用在什么地方）。

取值有：

@Retention

作用：

表示需要在什么級(jí)別保存該注釋信息，用于描述注解的生命周期（即：被描述的注解在什么范圍內(nèi)有效）

即：注解的生命周期。

@Document

作用：

表明該注解標(biāo)記的元素可以被Javadoc 或類(lèi)似的工具文檔化

@Inherited

作用：

表明使用了@Inherited注解的注解，所標(biāo)記的類(lèi)的子類(lèi)也會(huì)擁有這個(gè)注解。

自定義注解中參數(shù)可支持的數(shù)據(jù)類(lèi)型：

1.八大基本數(shù)據(jù)類(lèi)型

2.String類(lèi)型

3.Class類(lèi)型

4.enum類(lèi)型

5.Annotation類(lèi)型

6.以上所有類(lèi)型的數(shù)組

自定義一個(gè)注解，如下所示：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OperationLog {
 
    String username() default "";
 
    OperationType type();
 
    String content() default "";
 
}

通過(guò)AOP加自定義注解簡(jiǎn)單實(shí)現(xiàn)一個(gè)操作日志的記錄

自定義注解類(lèi)：

package com.redistext.log;
 
import java.lang.annotation.*;
 
/**
 * @author: maorui
 * @description: TODO
 * @date: 2021/10/27 21:23
 * @description: V1.0
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OperationLog {
 
    String username() default "admin";
 
    String type(); //記錄操作類(lèi)型
 
    String content() default ""; //記錄操作內(nèi)容
 
}

切面類(lèi)：

package com.redistext.log;
 
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
 
import java.lang.reflect.Method;
 
/**
 * @author: maorui
 * @description: TODO
 * @date: 2021/10/27 21:29
 * @description: V1.0
 */
@Aspect
@Component("logAspect")
public class LogAspect {
 
    // 配置織入點(diǎn)
    @Pointcut("@annotation(OperationLog)")
    public void logPointCut() {
    }
 
    /**
     * 前置通知 用于攔截操作，在方法返回后執(zhí)行
     *
     * @param joinPoint 切點(diǎn)
     */
    @AfterReturning(pointcut = "logPointCut()")
    public void doBefore(JoinPoint joinPoint) {
        handleLog(joinPoint, null);
    }
 
    /**
     * 攔截異常操作，有異常時(shí)執(zhí)行
     *
     * @param joinPoint
     * @param e
     */
    @AfterThrowing(value = "logPointCut()", throwing = "e")
    public void doAfter(JoinPoint joinPoint, Exception e) {
        handleLog(joinPoint, e);
    }
 
    private void handleLog(JoinPoint joinPoint, Exception e){
        try {
            // 得到注解
            OperationLog operationLog = getAnnotationLog(joinPoint);
            System.out.println("---------------自定義注解：" + operationLog);
            if (operationLog == null) {
                return;
            }
            // 得到方法名稱(chēng)
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            String type = operationLog.type();
            String content = operationLog.content();
            String username = operationLog.username();
            // 打印日志
            System.out.println("操作類(lèi)型：" + type);
            System.out.println("操作名稱(chēng)：" + content);
            System.out.println("操作人員：" + username);
            System.out.println("類(lèi)名：" + className);
            System.out.println("方法名：" + methodName);
        } catch (Exception e1) {
            System.out.println("======前置通知異常======");
            e1.printStackTrace();
        }
    }
 
 
    private static OperationLog getAnnotationLog(JoinPoint joinPoint) throws Exception{
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();
        if (method != null) {
            // 拿到自定義注解中的信息
            return method.getAnnotation(OperationLog.class);
        }
        return null;
    }
 
}

測(cè)試類(lèi)：

package com.redistext.log;
 
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
/**
 * @author: maorui
 * @description: TODO
 * @date: 2021/10/27 21:40
 * @description: V1.0
 */
@RestController
@RequestMapping("/operationLog")
public class OperationLogController {
 
    @OperationLog(type = "add", content = "添加")
    @GetMapping(value = "/add")
    public String addOperation(){
        return "add";
    }
 
    @OperationLog(type = "update", username = "adminFather")
    @GetMapping(value = "/update")
    public String updateOperation(){
        return "update";
    }
 
    @OperationLog(type = "delete", content = "刪除", username = "adminMother")
    @GetMapping(value = "/delete")
    public String deleteOperation(){
        return "delete";
    }
 
    @OperationLog(type = "find")
    @GetMapping(value = "/find")
    public String findOperation(){
        return "find";
    }
}

依次調(diào)用測(cè)試類(lèi)各個(gè)接口，記錄的操作日志信息如下：