Spring自定义注解与使用

首先JDK注解分为两种：

1、元注解（@Target、@Retention、@Inherited、@Documented）

2、普通注解（@Overried、@Deprecated、@suppresswarnings）

元注解是什么？

可以理解为最小的注解，基础注解

元注解的作用是什么？

就是为了解决一些重复的功能

Java自定义注解的使用范围？

可以通过注解来实现一些重复的逻辑，就像一个封装了的方法，可以用在一些权限校验、字段校验、字段属性注入、保存日志、缓存。

那接下来了解一下，元注解中里面四个注解的作用分别是什么

@Target：用于描述注解的作用范围，该注解使用在什么地方

例如：@Target（ElementRType.METHOD）|标注该注解使用在方法上，如果将在该注解标志在类上就会报错。

@Retention：表明该注解的生命周期

例如：@Retention(RetentionPolicy.RUNTIME)|由JVM加载，包含在类文件中，在运行时可以被获取到

@Inherited：是一个标记注解，加上该注解表示被标注的类型是可以被继承的。如果一个使用了 @Inherited修饰的annotation类型被用于一个class，则这个 annotation将被用于该class的子类。

@Documented：表明该注解标记的元素可以被Javadoc或类似的工具文档化。

创建注解的基本元素

1、访问修饰符必须为public,不写默认是public

2、创建注解的关键字:@interface

元注解的实现步骤

1、首先需要创建一个注解，使用@interface关键字

2、创建一个AOP切面来拦截这个注解，会去拦截使用这个注解的方法，同时会去获取注解上面的requestParam参数，校验里面必填的属性是否存在

实现元注解的Demo

1、创建注解

package com.nanfeng.annotations.anno;

/**
 * @Retention是注解的注解，称为注解的元注解
 */

import java.lang.annotation.*;

@Target({ElementType.METHOD}) //标记该注解是作用在方法上
@Retention(RetentionPolicy.RUNTIME) //运行时有效
public @interface RequestLog {
    /**
     *在注解中可以自定义属性值
     * 注解中定义的方法，如果没有返回值，就返回我们注解中该属性的默认值
     * 后面我们要获取注解上的一些参数，没有就去获取到默认值
     */
    String[] value() default "南风"; // 比如这个默认值“南风”，如果注解上的参数没有获取到这个参数，就会返回南风

}

2、创建一个AOP切面

package com.nanfeng.annotations.aspect;

import com.nanfeng.annotations.anno.RequestLog;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;

@Aspect
@Component
@Order(0) //定义Spring IOC容器中Bean的执行顺序的优先级，数字越小优先级越高
public class RequestLogAspect {


    /**
     * 第一个* 表示匹配返回值的类型任意;也可以指定匹配固定的返回值类型
     * com.nanfeng.annotations.controller表示切点拦截controller包下的类，对其他包下不拦截
     * ..表示当前及以下，..*表示当前以下的全部子包匹配
     * (..)表示任何方法名，括号表示参数，两个点表示任何参数类型
     */
    @Pointcut("execution(* com.nanfeng.annotations.controller..*(..))")
    public void pointCut() {

    }

    /**
     * @Around("pointCut() && @annotation(requestLog)") ：表示匹配满足定义pointCut()的类路径，并且被标记了@RequestLog注解的方法会进入这个切面
     */
    @Around("pointCut() && @annotation(requestLog)")
    public Object arround(ProceedingJoinPoint point, RequestLog requestLog) {
        // 保存原方法返回的值
        Object o = null;
        try {
            //获取方法的请求入参
            Object[] requestParam = point.getArgs();
            //获取执行的方法名
            String runMethodName=point.getSignature().getDeclaringTypeName();
            //获取当前的请求，可以通过这个得到访问此次请求的url地址
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            String sessionId = attributes.getSessionId();
            HttpServletRequest request = attributes.getRequest();
            //获取请求的api路径
            String url = request.getRequestURL().toString();

            String[] value = requestLog.value();//获取注解里面的参数
            o = point.proceed();//返回值为原方法的返回值
            return o;//调用切点的proceed方法表示放行
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        return o;//调用切点的proceed方法表示放行
    }
}

3、创建实体进行测试

package com.nanfeng.annotations.entity;

public class User {

    private String name; // 姓名
    private String address; // 地址
    private String number; // 编号

    public String getNumber() {
        return number;
    }

    public void setNumber(String number) {
        this.number = number;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", address='" + address + '\'' +
                ", number='" + number + '\'' +
                '}';
    }
}

Controller层

package com.nanfeng.annotations.controller;


import com.nanfeng.annotations.anno.RequestLog;
import com.nanfeng.annotations.entity.User;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class indexController {



    @PostMapping("/test")
    @RequestLog
    public String test(@RequestBody User user){
        return user.toString();
    }
}

postman进行测试