Annotation介绍

最新推荐文章于 2024-01-19 11:35:05 发布
最新推荐文章于 2024-01-19 11:35:05 发布
阅读量271 收藏
点赞数
分类专栏： SpringBoot 文章标签： java spring spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_37428161/article/details/115106982
版权

Annotation介绍

元注解（基础）

@Target

  • 用来声明被修饰的注解可以用在什么位置。可以在**@Target的属性中设置ElementType**类型的数组来指定可以使用的位置。如果不用此元注解修饰，默认注解可以用在任意位置。（为常用注解）
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
//Type表示->注解作用于类
//FIELD表示->注解作用于属性
//METHOD表示->注解作用于方法

@Retention

  • 生命周期,用来声明被修饰的注解会被保留到什么阶段。（为常用注解）
名称解释备注
RetentionPolicy.SOURCE此注解将会被保留到源码阶段，即.java中，在编译过程中被删除。这种类型的注解通常是给编译器看的。
RetentionPolicy.CLASS此注解将会被保留在源码阶段和编译阶段，即.java和.class中，在类加载的过程中被删除。这种类型的注解通常是给类加载器看的。
RetentionPolicy.RUNTIME此注解将会被保留在源码阶段 、编译阶段 和 运行段。即.java .class和内存中的字节码中都会存在这种类型的注解通常用来在运行阶段进行反射，控制程序运行过程。

补充：只有RUNTIME级别的注解才可以通过反射技术进行反射。

@Documented

  • 用来声明被修饰注解是否要被文档提取工具提取到文档中。默认不提取。

@Inherited

  • 被修饰的注解是否具有继承性，默认没有继承性。

SSM框架常用注解(Spring/SpringMVC/Mybatis)

Application启动类常用注解

@SpringBootApplication
  • 该注解放置在Springboot启动类上
  • 作用：表明该类是开启Springboot容器的入口，它是一个复合注解，里面包含了包扫描，自动注入，配置注入的功能。

源码如下（片段）：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
@ConfigurationPropertiesScan
@EnableAutoConfiguration
  • 该注解标注在类上
  • 它表示开启自动配置功能。

源码如下（片段）：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage		
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {}
@AutoConfigurationPackage
  • 该注解标注在类上
  • 作用：表示自动注入包，将@SpringBootApplication修饰的类的同包，子孙包下的所有组件都扫描到Spring容器中。

源码如下（片段）：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {}
  • @Import({Registrar.class})表明给容器导入一个组件，这个组件的内容就由Registrar.class传入的对象决定。
@ComponentScan
  • 该注解标注在类上
  • 作用：用来将指定包(如果未指定就是将当前类所在包及其子孙包)加入SpringIOC的包扫描，本质上等于：
<context:component-scan>配置

源码如下（片段）：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Repeatable(ComponentScans.class)
public @interface ComponentScan {}
@MapperScan

  • 该注解标注在类上

  • 作用：在启动类中使用@MapperScan(“mapper接口所在包全名”)即可，不用一个一个的在Mapper接口中加@Mapper注解。@Mapper注解是识别他为mybatis的mapper接口，会自动的把 加@Mapper 注解的接口生成动态代理类。

源码如下（片段）：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(MapperScannerRegistrar.class)
@Repeatable(MapperScans.class)
public @interface MapperScan {}
@SpringBootTest
  • 该注解标注在类上
  • 作用：表示此类为Springboot的单元测试类

源码如下（片段）：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@BootstrapWith(SpringBootTestContextBootstrapper.class)
@ExtendWith({SpringExtension.class})
public @interface SpringBootTest {}

Spring配置类常用注解

@SpringBootConfiguration
  • 该注解标注在类上
  • 作用：它表示的是该类会作为Springboot的一个配置类，进入该注解，发现里面包含@Configuration注解，进入@Configuration注解，我们发现他是被@Component所修饰的，所以该配置类也是一个组件。

源码如下（片段）：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration		//该类为配置类
public @interface SpringBootConfiguration {}
@Configuration
  • 该注解标注在类上
  • 作用：在Spring里表示该类为配置类。

源码如下（片段）：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component		//该类为组件类
public @interface Configuration {}
@Component
  • 该注解标注在类上
  • 作用：在Spring里表示该类为组件类。

源码如下（片段）：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Indexed
public @interface Component {}

POJO层

@DateTimeFormat
  • 该注解可标注在注解/方法/属性/参数上
  • 作用：当使用@DateTimeFormat(pattern = "yyyy/MM/dd HH:mm:ss")注解描述此属性时，客户端传值时会调用set方法去给对象属性赋值，客户端需要按此格式为属性传入值，否则客户端报400异常！
  • 默认格式：@DateTimeFormat(pattern = "yyyy/MM/dd HH:mm:ss")
    在这里插入图片描述
    在这里插入图片描述
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
public @interface DateTimeFormat {}
@JsonFormat

  • 该注解可标注在注解/类/方法/属性/参数上

  • 作用： 当使用@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")注解描述属性时，表示调用此属性的get方法取值并转换为字符串时按照pettern指定的格式进行转换。

  • 默认值为：@DateTimeFormat(pattern = "yyyy/MM/dd HH:mm:ss")若不按照对应格式传值，客户端会报400异常！

  • 注意点：被转换的时间因时区问题，会少8小时，若需解决此问题，还需在注解参数中添加约束timezone=“GMT+8”。

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")
private Date createdTime;

源码如下（片段）：

@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
    ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonFormat
{}
@RestControllerAdvice
  • 该注解可标注在类上
  • 作用：描述此类为全局异常处理类，拦截异常并统一处理。等价于@ControllerAdvice+@ResponseBody注解。
  • 作为特化@Component，允许通过类路径扫描自动检测实现类。它通常用于定义@ExceptionHandler，@InitBinder和 @ModelAttribute 适用于所有@RequestMapping方法的方法。
  • 默认行为（即：如果没有任何选择器使用），带@ControllerAdvice注释的类将协助所有已知的控制器。

案例：

package com.cy.pj.sys.web.exception;

import com.cy.pj.sys.web.pojo.JsonResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {
    private static Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
    @ExceptionHandler(RuntimeException.class)
    public JsonResult doHandleRunTimeException(RuntimeException e){
        e.printStackTrace();
        log.error("exception msg is {}",e.getMessage());
        return new JsonResult(e);
    }

  @ExceptionHandler(IllegalArgumentException.class)
    public JsonResult doHandleIllegalArgumentException(IllegalArgumentException e){
        e.printStackTrace();
        log.error("exception msg is {}",e.getMessage());
        return new JsonResult(e);
    }
}

源码如下（片段）：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ControllerAdvice
@ResponseBody
public @interface RestControllerAdvice {}
@ExceptionHandler

  • 该注解可标注在方法上

  • 作用：需要配合@RestControllerAdvice或者@ControllerAdvice注解才能使用，当被@RestControllerAdvice注解拦截到某个异常，会通过@ExceptionHandler注解，跳转到该异常的处理方法去进行处理，处理完成后会返回异常信息并封装返回结果。

源码如下（片段）：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExceptionHandler {
    Class<? extends Throwable>[] value() default {};
}
全局异常案例

在这里插入图片描述

Controller控制层常用注解

@Controller
  • 该注解标注在类上
  • 作用：表示此类为SpringMVC的Controller对象，定义了此类为控制器类，分发处理器会扫描使用该注解类的方法，并检测该方法是否使用了@RequestMapping注解。
  • 被@Controller注解标注的类，类里的方法return时会被视图处理器识别成静态文件的路径。默认为templates文件夹下。如return "test/hello"表示的是默认路径下的test文件夹中的名叫hello的文件，带上后缀名.html或btl等也可以识别，也可以在.yml文件中配置页面路径。

源码如下（片段）：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component		//该类为组件类
public @interface Controller {}
@RestController
  • 该注解标注在类上
  • 作用：类中方法return返回的值将被转换成json，字符串除外，直接写入HTTP相应体返回到页面中。
  • 等价于@Controller+@ResponseBody（两者效果一样）

源码如下（片段）：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {}
@ResponseBody
  • 该类标注在方法/类上
  • 作用：当标注方法时表示该方法的返回值会被解析成json（字符串会不会被转换），直接写入HTTP Response Body中，视图处理器将不会将return的参数识别成路径。当它标注类时，类中所有方法的返回值都将直接返回值到页面，相当于给所有的类都加上@ResponseBody注解。
  • 底层的DispatcherServlet会调用Jackson API将方法的返回值转换为Json格式字符串。
  • 底层转换时会调用返回值对象的get方法，以get方法的方法名（去掉get单词，首字母小写）为key，get方法的返回值为value，来构建Json字符串。
  • 可尝试删掉POJO层对象属性的get方法进测试，若缺少某个get方法，仍可以正常返回其他属性的值，若缺少全部属性的get方法，只剩set方法，客户端会直接报500错误！！

源码如下（片段）：

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ResponseBody {}
@ResquestBody
  • 该类标注在参数上
  • 作用：告诉服务端接收json数据
  • 若参数被@ResquestBody描述,客户端提交数据的要求：
    • 请求方式：post
    • 请求Content-Type设计：application/json
    • 请求数据格式{“key1”:“value1”,“key2”:“value2”,…}
  • 假如服务端的方法参数使用了@ResquestBody修饰
    在这里插入图片描述
    源码如下（片段）：
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestBody {
    boolean required() default true;
}
@PathVariable
  • 该类标注在参数上
  • 作用：用来接收rest风格的url的参数
@GetMapping("/notice/doFindById/{id}")
@ResponseBody
public JsonResult doFindById(@PathVariable Long id){
    return new JsonResult();
}

源码如下（片段）：

@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PathVariable {}
@RequestParam
  • 该类标注在属性上
  • 作用：对传统请求参数进行约束。方法参数为Map时，必须用此注解进行描述。

源码如下（片段）：

@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestParam {}
@Autowired

  • 该注解可用在参数/属性/方法/注解/构造函数上

  • 作用：自动按照类型注入。当使用注解注入属性时，set方法可以省略。它只能注入被他管理的 bean 类型。当有多个类型匹配时，使用要注入的对象变量名称作为 bean 的 id，在 spring 容器查找，找到了也可以注入成功。找不到就报错。

  • 通俗来讲：告诉Spring框架，要基于反射机制给属性赋值（依赖注入），假如只有一个则直接注入，有多个相同类型的对象时，还会比较属性名（检测属性名是否与bean名字相同，有相同的则直接注入（没有相同的直接抛出异常）。

源码如下（片段）：

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

案例：

@Autowired
private UserMapper userMapper;
@RequestMapping
  • 该注解作用于类和方法上
  • 作用：在Spring MVC 中使用 @RequestMapping 来映射请求，也就是通过它来指定控制器可以处理哪些URL请求，相当于Servlet中在web.xml中配置

XML配置方法如下：

<servlet>
    <servlet-name>servletName</servlet-name>
    <servlet-class>ServletClass</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>servletName</servlet-name>
    <url-pattern>url</url-pattern>
</servlet-mapping>

源码如下（片段）：

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {}
@CrossOrigin
  • 该注解作用于类和方法上
  • 作用CORS（俗称跨域资源共享） 在响应头中标识哪些网址可以访问服务器，CORS的配置是服务器端的配置和浏览器没关系。（解决跨域问题，详见：https://blog.csdn.net/qq_16804847/article/details/115063493?spm=1001.2014.3001.5501）

源码如下（片段）：

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CrossOrigin {}

Mybatis忽略NULL值解决方法

// 实体类加此注解
@TableField(strategy=FieldStrategy.IGNORED)
草帽团、
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
Annotation 入门介绍
02-28
JDK5.0 Annotation 入门介绍 PDF
SpringBoot实践之（十五）---自定义注解Annotation的使用
luckykapok918的专栏
02-08 6129
首先导入相关包 在build.gradle中添加 dependencies { //支持AOP compile('org.springframework.boot:spring-boot-starter-aop') } 然后创建Aspect测试类 TestAspect： import com.great.annotation.OperateLogAnnotati...
Spring Boot Annotations
sanhao_的博客
04-26 167
介绍来自org.springframework.boot.autoconfigure和org.springframework.boot.autoconfigure.condition包的注解。对于更复杂的条件，我们可以创建一个评估自定义条件的类。请注意，我们必须将此注释与@Configuration一起使用,@Configuration是Spring的注解.通常，当我们编写自定义自动配置时，我们希望 Spring 有条件地使用它们。在接下来的部分中，我们将只介绍每个条件背后的基本概念。
Spring Boot项目中的Controller、Service、Mapper和Entity层的作用与联系
算命de博客
06-22 1万+
在Spring Boot项目中，常见的四个层次是Controller层、Service层、Mapper层和Entity层。它们各自承担着不同的职责，但彼此之间存在着紧密的联系。本文将详细介绍这四个层次的作用与联系，并提供相关实例来说明它们之间的关系。
@Documented注解的作用
热门推荐
知道这个有什么用？
10-10 4万+
许多注解头部都有@Documented注解，例如jdk中自带的@Deprecated注解，路径是：java/lang/Deprecated.java，头部就含有这个注解。 @Documented @Retention(RetentionPolicy.RUNTIME) @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE}) public @interface Deprecated { } 那么
JDK5.0 Java Annotation 介绍(ppt)
08-24
JDK5.0 - Java Annotation 介绍 (ppt格式)
Annotation注解的介绍和使用
04-01
1.Annotation注解的介绍和使用
Java注解Annotation解析
09-01
主要为大家详细介绍了Java注解Annotation,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
Java Annotation Overview详解
09-04
主要介绍了Java Annotation Overview,需要的朋友可以参考下
Mapstruct使用问题Couldn‘t retrieve @Mapper annotation
sutonline的博客
06-07 1万+
Mapstruct使用问题Couldn’t retrieve @Mapper annotation在同时使用swagger和mapstruct-jdk8的时候会报错:Couldn't retrieve @Mapper annotation这个错误解释: This actually is not a problem on our side. We have 2 packages, mapstruc
如何详解Java中的@Documented注解的作用和用法
专注于深入研究多种编程语言，以实战为导向，逐步拓展开发技能，提升工程化编码和思维能力，展现无敌技术实力。
07-26 1655
通过本文，我们详细介绍了Java中的@Documented注解的作用和用法。@Documented注解允许被它修饰的注解的信息出现在生成的API文档中，这对于标记重要元数据信息的注解非常有用。我们通过一个示例代码演示了@Documented注解的实际效果，包括如何在API文档中展示自定义注解的信息。
MapStruct
蓝天白云
05-28 867
/ 自定义的映射方法：转换boolen为String时，做一些判断然后返回对应的值。return "已完成";} else {return "未完成";return "该产品已完成";} else {return "该产品未完成";if (str.equals("已完成")) {} else {// 通过uses 来导入上面我们写的 自定义映射方法// 当有多个方法 拥有一样的参数和返回类型时，需要指定使用其中的哪一个，使用qualifiedByName指定。
MapStruct使用异常总结
yanweijie0317的专栏
06-21 2020
无
MapStruct - Couldn‘t retrieve @Mapper annotation
牧码的博客
02-28 1万+
报错信息 java: Couldn't retrieve @Mapper annotation 原因分析 Maven Pom 切换 MapStruct 版本的时候旧版本残留，没有清理干净，刷新下 Maven； 与 springfox-swagger2 冲突，该框架里也包含 mapstruct，如下解决方案。 解决方案 <dependency> <groupId>io.springfox</groupId> <artifac..
@Documented 的作用
howeres的博客
03-07 8787
1. @Documented 的含义 @Document 是 java 在生成文档，是否显示注解的开关 2. 加和不加有什么区别？ 使用命令 // 生成 java doc 的命令： javadoc -d doc demo.java` // -d <directory> 输出文件的目标目录 a. 加上的效果 b. 不加的效果 可以看到在 public class TerminalController 上面多了一个我们写的注解。这就是 @Documented 的用处。 ...
@Documented
qq_41177135的博客
07-29 675
@Documented
【已解决】MapStruct - Couldn‘t retrieve @Mapper annotation
最新发布
奇异果的博客
01-19 819
又降到 1.2.0.Final，这时生成的 impl 类有映射值了。
踩坑-Mapstruct使用问题Couldn’t retrieve @Mapper annotation
qq_39768867的博客
08-13 6834
网上说的方法都尝试了一遍，发现都没解决问题。。 尝试方向： 1.maven版本----->未解决问题 2.jar包的问题 因为同事机器上未出现此问题，遂让他把jar包给我，自己打进maven仓库。。问题解决
python annotation
07-28
- *1* [python的annotation介绍](https://blog.csdn.net/cnds123/article/details/129885822)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值