你好，我是田哥

不管是项目中，还是各种框架中，都有着大量的注解。而且，我们在项目开发中，通常一个注解就能搞定好多事情，尤其是在Spring大家族里，注解那是被玩的飞起，另外其他框架中不少使用。

下面给大家罗列一下常用注解：

1、@Configuration 标识当前类是配置类

2、@ComponentScan 包扫描注解 扫描注解

3、@Bean 标识该方法的返回值交给Spring容器管理

4、@Scope 控制多例和单例

5、@Lazy 懒加载

6、@PostConstruct 初始化方法

7、@PreDestroy 销毁方法

8、@Component 将当前类未来的对象交给容器管理

9、@Autowired 按照类型进行注入

10、@Qualifier 按照名称进行注入

11、@Repository 标识持久层注解

12、@Service 标识Service层

13、@Controller 标识Controller层

14、@Value 为属性赋值 @Value("${key}")

15、@PropertySource 加载指定路径的配置文件properties

16、@Aspect 标识当前类是一个切面类

17、@Pointcut 用于定义切入点表达式 表达式写法4种

18、@EnableAspectJAutoProxy 让AOP的注解有效果

19、@Before AOP-前置通知

20、@AfterReturning AOP-后置通知

21、@AfterThrowing AOP-异常通知

22、@After AOP-最终通知

23、@Around AOP-环绕通知

24、@Order(1) //可以利用order关键字 实现AOP的排序 数字越小越先执行.

25、@ResponseBody 将返回的数据转化为JSON串, 如果是字符串本身 原数据返回

26、@RequestMapping("/hello") 实现浏览器的请求路径与方法的映射

27、@PathVariable restFul结构,接收参数的注解.

28、@GetMapping("") 只能接收GET请求类型

29、@DeleteMapping("") 只能接收DELETE请求类型

30、@PostMapping("") 只能接收POST请求类型

31、@PutMapping("") 只能接收PUT请求类型

32、@RestController 表示Controller类,同时要求返回值为JSON

33、@CrossOrigin 允许跨域访问

34、@RequestBody 参数接收时,将JSON串转化为java对象 json中的key与对象的属性一致.

35、@Data lombok动态生成get/set/toString/equals/hashcode等方法

36、@Accessors 控制是否开启链式加载结构

37、@NoArgsConstructor 生成无参构造方法

38、@AllArgsConstructor 生成全参构造方法

39、@Mapper mybatis将当前的接口交给Spring容器管理. Map<类名小写,JDK动态代理对象>

40、@SpringBootTest 该注解的作用在进行代码测试时启动spring容器,之后动态的获取对象 注意包路径 主

启动类的同包及子包中.

41、@Param Mybatis中将参数封装为Map集合. @Param(“maxAge”) int maxAge

42、@Alias Mybatis中定义对象的别名 @Alias(“User”)

43、@MapperScan Mybatis中扫描指定包路径的接口 为其创建代理对象.

44、@Insert Mybatis 新增操作注解

45、@Update Mybatis 修改操作注解

46、@Delete Mybatis 删除操作注解

47、@Select Mybatis 查询操作注解

48、@Transactional Spring中用来控制事务

49、@RestControllerAdvice Controller层的全局异常处理

50、@ExceptionHandler 按照某种异常类型进行拦截

51、@TableName(“item_cat”) MybatisPlus注解POJO与数据表绑定 注意表名

52、@TableId(type = IdType.AUTO) MybatisPlus注解 标识主键/主键自增

53、@TableField(exist = false) MybatisPlus注解 标识属性是否存在,及名称是否一致

54、@TableField("createdTime") 告诉MybatisPlus，下面的这个对象使用后面这个表示

.....

太多了，感觉全部罗列出来应该会超过100个。

注解对于我们开发而言，确实是好东西，能减少我们的代码量。但，也给我们挖了很多坑，很多人都只是停留在使用层面，永远也不想去学习背后是如何实现的，久而久之，我们也就成了只会使用，永远停留在CRUD的层面了。

由此可知，我们是很有必要搞清楚注解的，尤其是自定义注解的使用（以上说的这一堆注解，都是别人的自定义注解，咱们不妨也搞搞自定义注解？）。

什么是注解

注解是一种能被添加到java源代码中的元数据 ，方法、类、参数和包都可以用注解来修饰。

注解可以看作是一种特殊的标记，可以用在方法、类、参数和包上，程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。

元注解

元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。

Java5.0定义的元注解：

@Target,@Retention,@Documented,@Inherited

下面我们看一下每个元注解的作用和相应分参数的使用说明。

@Target

表明该注解可以应用的java元素类型：

@Retention

表明该注解的生命周期。

@Document

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

@Inherited

表明使用了@Inherited注解的注解，所标记的类的子类也会拥有这个注解。

自定义注解

为什么要自定义注解？

我们很多时候，也希望像文章前面的那些注解一样，只要在某个类上或者某些方法上加上自己定义的注解后，就可以实现某些功能。

注解的定义

修饰符：访问修饰符必须为public,不写默认为pubic；

关键字：关键字为@interface；

注解名称：注解名称为自定义注解的名称，使用时还会用到；

注解内容：注解中内容，对注解的描述。

自定义注解案例(基础)

定义自己的注解

/** * @author tianwc  公众号：java后端技术全栈、面试专栏 * @version 1.0.0 * @date 2022年11月01日  * 自定义注解 */ @Target(ElementType.TYPE) @Documented @Retention(RetentionPolicy.RUNTIME)public @interface MyAnnotation {    //设置默认值 tian    String name() default "tian";    int age();}

简单说明：

@Target(ElementType.TYPE)：该注解可以应用于类、接口（包括注解类型）、枚举

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

@Retention(RetentionPolicy.RUNTIME)：该注解的生命周期，由JVM 加载，包含在类文件中，在运行时可以被获取到。

自定义注解的使用

/** * @author tianwc  公众号：java后端技术全栈、面试专栏 * @version 1.0.0 * @date 2022年11月01日 * *  应用 MyAnnotation 注解到User类 */@MyAnnotation(age = 20)public class User {    private String name;    private Integer age;}

注解解析

/** * @author tianwc  公众号：java后端技术全栈、面试专栏 * @version 1.0.0 * @date 2022年11月01日 * <p> * 自定义注解的使用 */public class AnnotationTest {    public static void main(String[] args) {        //获取User的Class对象        Class<?> userClass = User.class;        //判断Class对象上是否有 MyAnnotation 的注解        if (userClass.isAnnotationPresent(MyAnnotation.class)) {            System.out.println("User上配置了 MyAnnotation 注解");            //获取 MyAnnotation 注解            MyAnnotation config = userClass.getAnnotation(MyAnnotation.class);             System.out.println("MyAnnotation.name:" + config.name() + "; MyAnnotation.age:" + config.age());        } else {            System.out.println("User上没有配置 MyAnnotation 注解");        }    }}

上面，我们是把注解@MyAnnotation放到了User类上，所以，我们只要能获取到User的Class对象，那我们就可以通过反射来判断这个User类上是否有注解@MyAnnotation：

boolean hasAnnotation = userClass.isAnnotationPresent(MyAnnotation.class)

如果判断此类上有这个注解，那我们就可以继续使用反射获取这个注解信息：

MyAnnotation myAnnotation = userClass.getAnnotation(MyAnnotation.class);

最后，我们就可以获取注解信息：

System.out.println("MyAnnotation.name:" + myAnnotation.name() + "; MyAnnotation.age:" + myAnnotation.age());

最后输出结果：

User上配置了 MyAnnotation 注解MyAnnotation.name:tian; MyAnnotation.age:20

自定义注解案例(进阶)

我们来自对应一个注解，然后通过注解来对方法的出参和入参进行打印（医院项目）。

定义自己的注解

 /** * @author tianwc 公众号：java后端技术全栈、面试专栏 * @version 1.0.0 * @date 2022年11月01日 * <p> * 自定义注解 * <p> * 用于方法出入参打印 */@Target(ElementType.METHOD)@Documented@Retention(RetentionPolicy.RUNTIME)public @interface ArgsLogAnnotation {    //方法描述    String methodDescription() default "";}

简单说明：

@Target(ElementType.METHOD)：该方法上@Documented：该注解标记的元素可以被Javadoc 或类似的工具文档化@Retention(RetentionPolicy.RUNTIME)：该注解的生命周期，由JVM 加载，包含在类文件中，在运行时可以被获取到。

自定义注解的使用

//MenuController中/*** 登录  shiro 登录*///使用我们自定义的注解，并且给与方法说明@ArgsLogAnnotation(methodDescription = "用户登录")@RequestMapping("login")public String login(String userName, String pwd) {    //具体不想管代码这里就不贴出来了，}

注解解析

/** * @author tianwc  公众号：java后端技术全栈、面试专栏 * @version 1.0.0 * @date 2022年11月01日  */@Aspect@Component@Slf4jpublic class WebLogAspect {    /**     * 这里我们使用注解的形式     * 当然，我们也可以通过切点表达式直接指定需要拦截的package,需要拦截的class 以及 method     * 切点表达式:   execution(...)     */    @Pointcut("@annotation(com.tian.annotation.ArgsLogAnnotation)")    public void webLog() {    }    /**     * 接口请求参数、相应参数、耗时、路径等信息打印     */    @Around("webLog()")    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {        long startTime = System.currentTimeMillis();        //获取当前请求对象        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();        HttpServletRequest request = attributes.getRequest();        //记录请求信息(通过Logstash传入Elasticsearch)        WebLog webLog = new WebLog();        Object result = joinPoint.proceed();        Signature signature = joinPoint.getSignature();        MethodSignature methodSignature = (MethodSignature) signature;        Method method = methodSignature.getMethod();           ArgsLogAnnotation argsLogAnnotation = method.getAnnotation(ArgsLogAnnotation.class);        String methodDescription = argsLogAnnotation.methodDescription();        long endTime = System.currentTimeMillis();        String urlStr = request.getRequestURL().toString();        webLog.setBasePath(StrUtil.removeSuffix(urlStr, URLUtil.url(urlStr).getPath()));        webLog.setUsername(request.getRemoteUser());        webLog.setIp(request.getRemoteAddr());        webLog.setMethod(request.getMethod());        webLog.setParameter(getParameter(method, joinPoint.getArgs()));        webLog.setResult(result);        webLog.setSpendTime((int) (endTime - startTime));        webLog.setStartTime(startTime);        webLog.setUri(request.getRequestURI());        webLog.setUrl(request.getRequestURL().toString());        Map<String, Object> logMap = new HashMap<>(8);        logMap.put("url：", webLog.getUrl());        logMap.put("method：", webLog.getMethod());        logMap.put("parameter：", webLog.getParameter());        logMap.put("cost Time：", webLog.getSpendTime());        logMap.put("method description：", methodDescription);        log.info("{}", JSONUtil.parse(logMap));        return result;    }    /**     * 根据方法和传入的参数获取请求参数     */    private Object getParameter(Method method, Object[] args) {        List<Object> argList = new ArrayList<>();        Parameter[] parameters = method.getParameters();        for (int i = 0; i < parameters.length; i++) {            //将RequestBody注解修饰的参数作为请求参数            RequestBody requestBody = parameters[i].getAnnotation(RequestBody.class);            if (requestBody != null) {                argList.add(args[i]);            }            //将RequestParam注解修饰的参数作为请求参数            RequestParam requestParam = parameters[i].getAnnotation(RequestParam.class);            if (requestParam != null) {                Map<String, Object> map = new HashMap<>();                String key = parameters[i].getName();                if (!StrUtil.isEmpty(requestParam.value())) {                    key = requestParam.value();                }                map.put(key, args[i]);                argList.add(map);            }        }        if (argList.size() == 0) {            return null;        } else if (argList.size() == 1) {            return argList.get(0);        } else {            return argList;        }    }}

在医院项目中，其实这个功能已经实现了的，但是，针对的是controller下所有方法的出入参打印。

最后输出：

{"cost Time：":875,"method description：":"用户登录","url：":"http://localhost:9001/sel/login","method：":"POST"}

最后

我们在使用自定义注解通常三个步骤：

• 自定义注解（确定好类型和生命周期）
• 在我们业务代码中的使用
• 获取注解并解析（实现注解的具体业务功能）

好了，今天就分享这么多。

创作不易，望点赞+收藏+转发！