@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Autowired {
    boolean required() default true;
}

public enum ElementType {
    /** 類，接口（包括注解類型）或枚舉的聲明 */
    TYPE,

    /** 屬性的聲明 */
    FIELD,

    /** 方法的聲明 */
    METHOD,

    /** 方法形式參數(shù)聲明 */
    PARAMETER,

    /** 構(gòu)造方法的聲明 */
    CONSTRUCTOR,

    /** 局部變量聲明 */
    LOCAL_VARIABLE,

    /** 注解類型聲明 */
    ANNOTATION_TYPE,

    /** 包的聲明 */
    PACKAGE
}

// 可以作用在 構(gòu)造方法、方法、方法形參、屬性、注解類型 上
@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})

public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     * （注解將被編譯器忽略掉）
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     * （注解將被編譯器記錄在class文件中，但在運(yùn)行時(shí)不會(huì)被虛擬機(jī)保留，這是一個(gè)默認(rèn)的行為）
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     * （注解將被編譯器記錄在class文件中，而且在運(yùn)行時(shí)會(huì)被虛擬機(jī)保留，因此它們能通過反射被讀取到）
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

{
    #返回狀態(tài)碼
    code:integer,       
    #返回信息描述
    message:string,
    #返回?cái)?shù)據(jù)值
    data:object
}

/**
 * @author 【 木子雷 】 公眾號(hào)
 * @Title: ResponseCode
 * @Description: 使用枚舉類封裝好的響應(yīng)狀態(tài)碼及對(duì)應(yīng)的響應(yīng)消息
 * @date: 2019年8月23日 下午7:12:50
 */
public enum ResponseCode {

    SUCCESS(1200, "請(qǐng)求成功"),

    ERROR(1400, "請(qǐng)求失敗");


    private Integer code;

    private String message;

    private ResponseCode(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public Integer code() {
        return this.code;
    }

    public String message() {
        return this.message;
    }

}

import com.alibaba.fastjson.JSONObject;
import java.io.Serializable;

/**
 * @author 【 木子雷 】 公眾號(hào)
 * @Title: Response
 * @Description: 封裝的統(tǒng)一的響應(yīng)返回類
 * @date: 2019年8月23日 下午7:07:13
 */
@SuppressWarnings("serial")
public class Response<T> implements Serializable {

    /**
     * 響應(yīng)數(shù)據(jù)
     */
    private T date;

    /**
     * 響應(yīng)狀態(tài)碼
     */
    private Integer code;

    /**
     * 響應(yīng)描述信息
     */
    private String message;

    public Response(T date, Integer code, String message) {
        super();
        this.date = date;
        this.code = code;
        this.message = message;
    }


    public T getDate() {
        return date;
    }

    public void setDate(T date) {
        this.date = date;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }


    @Override
    public String toString() {
        return JSONObject.toJSONString(this);
    }
}

@GetMapping("/user/findAllUser")
public Response<List<User>> findAllUser() {
    logger.info("開始查詢所有數(shù)據(jù)...");

    List<User> findAllUser = new ArrayList<>();
    findAllUser.add(new User("木子雷", 26));
    findAllUser.add(new User("公眾號(hào)", 28));

    // 返回響應(yīng)進(jìn)行包裝
    Response response = new Response(findAllUser, ResponseCode.SUCCESS.code(), ResponseCode.SUCCESS.message());

    logger.info("response: {} \n", response.toString());
    return response;
}

{
    "code": 1200,
    "date": [
        {
            "age": 26,
            "name": "木子雷"
        },
        {
            "age": 28,
            "name": "公眾號(hào)"
        }
    ],
    "message": "請(qǐng)求成功"
}

/**
 * @author 【 木子雷 】 公眾號(hào)
 * @PACKAGE_NAME: com.lyl.annotation
 * @ClassName: ResponseResult
 * @Description: 標(biāo)記方法返回值需要進(jìn)行包裝的 自定義注解
 * @Date: 2020-11-10 10:38
 **/
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ResponseResult {

}

/**
 * @author 【 木子雷 】 公眾號(hào)
 * @PACKAGE_NAME: com.lyl.interceptor
 * @ClassName: ResponseResultInterceptor
 * @Description: 攔截器：攔截請(qǐng)求，判斷請(qǐng)求的方法或類上是否使用了自定義的@ResponseResult注解，
 *               并在請(qǐng)求內(nèi)設(shè)置是否使用了自定義注解的標(biāo)志位屬性；
 * @Date: 2020-11-10 10:50
 **/
@Component
public class ResponseResultInterceptor implements HandlerInterceptor {

    /**
     * 標(biāo)記位，標(biāo)記請(qǐng)求的controller類或方法上使用了到了自定義注解，返回?cái)?shù)據(jù)需要被包裝
     */
    public static final String RESPONSE_ANNOTATION = "RESPONSE_ANNOTATION";

    /**
     * 請(qǐng)求預(yù)處理，判斷是否使用了自定義注解
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        // 請(qǐng)求的接口方法
        if (handler instanceof HandlerMethod) {
            final HandlerMethod handlerMethod = (HandlerMethod) handler;
            final Class<?> clazz = handlerMethod.getBeanType();
            final Method method = handlerMethod.getMethod();
            // 判斷是否在類對(duì)象上加了注解
            if (clazz.isAnnotationPresent(ResponseResult.class)) {
                // 在請(qǐng)求中設(shè)置需要進(jìn)行響應(yīng)包裝的屬性標(biāo)志，在下面的ResponseBodyAdvice增強(qiáng)中進(jìn)行處理
                request.setAttribute(RESPONSE_ANNOTATION, clazz.getAnnotation(ResponseResult.class));
            } else if (method.isAnnotationPresent(ResponseResult.class)) {
                // 在請(qǐng)求中設(shè)置需要進(jìn)行響應(yīng)包裝的屬性標(biāo)志，在下面的ResponseBodyAdvice增強(qiáng)中進(jìn)行處理
                request.setAttribute(RESPONSE_ANNOTATION, method.getAnnotation(ResponseResult.class));
            }
        }
        return true;
    }
}

/**
 * @author 【 木子雷 】 公眾號(hào)
 * @PACKAGE_NAME: com.lyl.interceptor
 * @ClassName: ResponseResultHandler
 * @Description: 對(duì) 返回響應(yīng) 進(jìn)行包裝 的增強(qiáng)處理
 * @Date: 2020-11-10 13:49
 **/
@ControllerAdvice
public class ResponseResultHandler implements ResponseBodyAdvice<Object> {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    /**
     * 標(biāo)記位，標(biāo)記請(qǐng)求的controller類或方法上使用了到了自定義注解，返回?cái)?shù)據(jù)需要被包裝
     */
    public static final String RESPONSE_ANNOTATION = "RESPONSE_ANNOTATION";

    /**
     * 請(qǐng)求中是否包含了 響應(yīng)需要被包裝的標(biāo)記，如果沒有，則直接返回，不需要重寫返回體
     *
     * @param methodParameter
     * @param aClass
     * @return
     */
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        ServletRequestAttributes ra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest sr = (HttpServletRequest) ra.getRequest();
        // 查詢是否需要進(jìn)行響應(yīng)包裝的標(biāo)志
        ResponseResult responseResult = (ResponseResult) sr.getAttribute(RESPONSE_ANNOTATION);
        return responseResult == null ? false : true;
    }


    /**
     * 對(duì) 響應(yīng)體 進(jìn)行包裝; 除此之外還可以對(duì)響應(yīng)體進(jìn)行統(tǒng)一的加密、簽名等
     *
     * @param responseBody  請(qǐng)求的接口方法執(zhí)行后得到返回值(返回響應(yīng))
     */
    @Override
    public Object beforeBodyWrite(Object responseBody, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        logger.info("返回響應(yīng) 包裝進(jìn)行中。。。");
        Response response;
        // boolean類型時(shí)判斷一些數(shù)據(jù)庫新增、更新、刪除的操作是否成功
        if (responseBody instanceof Boolean) {
            if ((Boolean) responseBody) {
                response = new Response(responseBody, ResponseCode.SUCCESS.code(), ResponseCode.SUCCESS.message());
            } else {
                response = new Response(responseBody, ResponseCode.ERROR.code(), ResponseCode.ERROR.message());
            }
        } else {
            // 判斷像查詢一些返回?cái)?shù)據(jù)的情況，查詢不到數(shù)據(jù)返回 null;
            if (null != responseBody) {
                response = new Response(responseBody, ResponseCode.SUCCESS.code(), ResponseCode.SUCCESS.message());
            } else {
                response = new Response(responseBody, ResponseCode.ERROR.code(), ResponseCode.ERROR.message());
            }
        }
        return response;
    }
}

// 自定義注解用在了方法上
@ResponseResult
@GetMapping("/user/findAllUserByAnnotation")
public List<User> findAllUserByAnnotation() {
    logger.info("開始查詢所有數(shù)據(jù)...");

    List<User> findAllUser = new ArrayList<>();
    findAllUser.add(new User("木子雷", 26));
    findAllUser.add(new User("公眾號(hào)", 28));

    logger.info("使用 @ResponseResult 自定義注解進(jìn)行響應(yīng)的包裝，使controller代碼更加簡介");
    return findAllUser;
}

/**
 * @author 【 木子雷 】 公眾號(hào)
 * @PACKAGE_NAME: com.lyl.annotation
 * @ClassName: GetDistributedLock
 * @Description: 獲取redis分布式鎖 注解
 * @Date: 2020-11-10 16:24
 **/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface GetDistributedLock {

    // 分布式鎖 key
    String lockKey();

    // 分布式鎖 value，默認(rèn)為 lockValue
    String lockValue() default "lockValue";

    // 過期時(shí)間，默認(rèn)為 300秒
    int expireTime() default 300;

}

/**
 * @author: 【 木子雷 】 公眾號(hào)
 * @PACKAGE_NAME: com.lyl.aop
 * @ClassName: DistributedLockAspect
 * @Description: 自定義注解結(jié)合AOP切面編程優(yōu)雅的使用分布式鎖
 * @Date: 2020-11-10 16:52
 **/
@Component
@Aspect
public class DistributedLockAspect {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Autowired
    RedisService redisService;


    /**
     * Around 環(huán)繞增強(qiáng)通知
     *
     * @param joinPoint 連接點(diǎn)，所有方法都屬于連接點(diǎn)；但是當(dāng)某些方法上使用了@GetDistributedLock自定義注解時(shí)，
     *                  則其將連接點(diǎn)變?yōu)榱饲悬c(diǎn)；然后在切點(diǎn)上織入額外的增強(qiáng)處理；切點(diǎn)和其相應(yīng)的增強(qiáng)處理構(gòu)成了切面Aspect 。
     */
    @Around(value = "@annotation(com.lyl.annotation.GetDistributedLock)")
    public Boolean handlerDistributedLock(ProceedingJoinPoint joinPoint) {
        // 通過反射獲取自定義注解對(duì)象
        GetDistributedLock getDistributedLock = ((MethodSignature) joinPoint.getSignature())
                .getMethod().getAnnotation(GetDistributedLock.class);

        // 獲取自定義注解對(duì)象中的屬性值
        String lockKey = getDistributedLock.lockKey();
        String LockValue = getDistributedLock.lockValue();
        int expireTime = getDistributedLock.expireTime();

        if (redisService.tryGetDistributedLock(lockKey, LockValue, expireTime)) {
            // 獲取分布式鎖成功后，繼續(xù)執(zhí)行業(yè)務(wù)邏輯
            try {
                return (boolean) joinPoint.proceed();
            } catch (Throwable throwable) {
                logger.error("業(yè)務(wù)邏輯執(zhí)行失敗。", throwable);
            } finally {
                // 最終保證分布式鎖的釋放
                redisService.releaseDistributedLock(lockKey, LockValue);
            }
        }
        return false;
    }

}

// 自定義注解的使用
@GetDistributedLock(lockKey = "userLock")
@GetMapping("/user/getDistributedLock")
public boolean getUserDistributedLock() {
    logger.info("獲取分布式鎖...");
    // 寫具體的業(yè)務(wù)邏輯

    return true;
}

/**
 * @Author: 【 木子雷 】 公眾號(hào)
 * @PACKAGE_NAME: com.lyl.annotation
 * @ClassName: PrintLog
 * @Description: 自定義注解實(shí)現(xiàn)日志打印
 * @Date: 2020-11-10 18:05
 **/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PrintLog {

}

/**
 * @author: 【 木子雷 】 公眾號(hào)
 * @PACKAGE_NAME: com.lyl.aop
 * @ClassName: PrintLogAspect
 * @Description: 自定義注解結(jié)合AOP切面編程優(yōu)雅的實(shí)現(xiàn)日志打印
 * @Date: 2020-11-10 18:11
 **/
@Component
@Aspect
public class PrintLogAspect {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    /**
     *  Around 環(huán)繞增強(qiáng)通知
     *
     * @param joinPoint 連接點(diǎn)，所有方法都屬于連接點(diǎn)；但是當(dāng)某些方法上使用了@PrintLog自定義注解時(shí)，
     *                  則其將連接點(diǎn)變?yōu)榱饲悬c(diǎn)；然后在切點(diǎn)上織入額外的增強(qiáng)處理；切點(diǎn)和其相應(yīng)的增強(qiáng)處理構(gòu)成了切面Aspect 。
     */
    @Around(value = "@annotation(com.lyl.annotation.PrintLog)")
    public Object handlerPrintLog(ProceedingJoinPoint joinPoint) {
        // 獲取方法的名稱
        String methodName = joinPoint.getSignature().getName();
        // 獲取方法入?yún)?
        Object[] param = joinPoint.getArgs();

        StringBuilder sb = new StringBuilder();
        for (Object o : param) {
            sb.append(o + "; ");
        }
        logger.info("進(jìn)入《{}》方法, 參數(shù)為: {}", methodName, sb.toString());

        Object object = null;
        // 繼續(xù)執(zhí)行方法
        try {
            object = joinPoint.proceed();

        } catch (Throwable throwable) {
            logger.error("打印日志處理error。。", throwable);
        }
        logger.info("{} 方法執(zhí)行結(jié)束。。", methodName);
        return object;
    }

}

@PrintLog
@GetMapping(value = "/user/findUserNameById/{id}", produces = "application/json;charset=utf-8")
public String findUserNameById(@PathVariable("id") int id) {
    // 模擬根據(jù)id查詢用戶名
    String userName = "木子雷 公眾號(hào)";
    return userName;
}