肝了一周总结的SpringBoot常用注解大全，看完就炉火纯

　　平时使用SpringBoot开发项目，少不了要使用到它的注解。这些注解让我们摆脱了繁琐的传统SpringXML配置，让我们开发项目更加高效，今天我们就来聊聊SpringBoot中常用的注解！常用注解概览
　　这里整理了一张SpringBoot常用注解的思维导图，本文主要讲解这些注解的用法。
　　组件相关注解Controller
　　用于修饰MVC中controller层的组件，SpringBoot中的组件扫描功能会识别到该注解，并为修饰的类实例化对象，通常与RequestMapping联用，当SpringMVC获取到请求时会转发到指定路径的方法进行处理。authermacrozhengdescription后台用户管理Controllerdate2018426githubhttps：github。commacrozhengControllerRequestMapping（admin）publicclassUmsAdminController｛｝Service
　　用于修饰service层的组件，service层组件专注于系统业务逻辑的处理，同样会被组件扫描并生成实例化对象。authermacrozhengdescription后台用户管理Service实现类date2018426githubhttps：github。commacrozhengServicepublicclassUmsAdminServiceImplimplementsUmsAdminService｛｝Repository
　　用于修饰dao层的组件，dao层组件专注于系统数据的处理，例如数据库中的数据，同样会被组件扫描并生成实例化对象。authermacrozhengdescription后台用户与角色关系管理自定义Daodate2018108githubhttps：github。commacrozhengRepositorypublicinterfaceUmsAdminRoleRelationDao｛｝Component
　　用于修饰SpringBoot中的组件，会被组件扫描并生成实例化对象。Controller、Service、Repository都是特殊的组件注解。authermacrozhengdescription取消订单消息的生产者组件date2018914githubhttps：github。commacrozhengComponentpublicclassCancelOrderSender｛｝依赖注入注解Autowired
　　会根据对象的类型自动注入依赖对象，默认要求注入对象实例必须存在，可以配置requiredfalse来注入不一定存在的对象。authermacrozhengdescription后台用户管理Controllerdate2018426githubhttps：github。commacrozhengControllerRequestMapping（admin）publicclassUmsAdminController｛AutowiredprivateUmsAdminServiceadminService；｝Resource
　　默认会根据对象的名称自动注入依赖对象，如果想要根据类型进行注入，可以设置属性为typeUmsAdminService。class。authermacrozhengdescription后台用户管理Controllerdate2018426githubhttps：github。commacrozhengControllerRequestMapping（admin）publicclassUmsAdminController｛AutowiredResource（nameumsAdminServiceImpl）privateUmsAdminServiceadminService；｝Qualifier
　　当同一个对象有多个实例可以注入时，使用Autowired注解无法进行注入，这时可以使用Qualifier注解指定实例的名称进行精确注入。authermacrozhengdescription后台用户管理Controllerdate2018426githubhttps：github。commacrozhengControllerRequestMapping（admin）publicclassUmsAdminController｛AutowiredQualifier（umsAdminServiceImpl）privateUmsAdminServiceadminService；｝实例与生命周期相关注解Bean
　　用于修饰方法，标识该方法会创建一个Bean实例，并交给Spring容器来管理。authermacrozhengdescriptionRestTemplate相关配置date2018426githubhttps：github。commacrozhengConfigurationpublicclassRestTemplateConfig｛BeanpublicRestTemplaterestTemplate（）｛returnnewRestTemplate（）；｝｝Scope
　　用于声明一个SpringBean实例的作用域，作用域的范围有以下几种：singleton：单例模式，在Spring容器中该实例唯一，Spring默认的实例模式。prototype：原型模式，每次使用实例都将重新创建。request：在同一请求中使用相同的实例，不同请求重新创建。session：在同一会话中使用相同的实例，不同会话重新创建。authermacrozhengdescriptionRestTemplate相关配置date2018426githubhttps：github。commacrozhengConfigurationpublicclassRestTemplateConfig｛BeanScope（singleton）publicRestTemplaterestTemplate（）｛returnnewRestTemplate（）；｝｝Primary
　　当同一个对象有多个实例时，优先选择该实例。authermacrozhengdescriptionJackson相关配置，配置json不返回null的字段date201882githubhttps：github。commacrozhengConfigurationpublicclassJacksonConfig｛BeanPrimaryConditionalOnMissingBean（ObjectMapper。class）publicObjectMapperjacksonObjectMapper（Jackson2ObjectMapperBuilderbuilder）｛ObjectMapperobjectMapperbuilder。createXmlMapper（false）。build（）；objectMapper。setSerializationInclusion（JsonInclude。Include。NONNULL）；returnobjectMapper；｝｝PostConstruct
　　用于修饰方法，当对象实例被创建并且依赖注入完成后执行，可用于对象实例的初始化操作。PreDestroy
　　用于修饰方法，当对象实例将被Spring容器移除时执行，可用于对象实例持有资源的释放。PostConstruct、PreDestroy示例authermacrozhengdescription动态权限数据源，用于获取动态权限规则date202027githubhttps：github。commacrozhengpublicclassDynamicSecurityMetadataSourceimplementsFilterInvocationSecurityMetadataSource｛privatestaticMapString，ConfigAttributeconfigAttributeMapnull；AutowiredprivateDynamicSecurityServicedynamicSecurityService；PostConstructpublicvoidloadDataSource（）｛configAttributeMapdynamicSecurityService。loadDataSource（）；｝PostConstructpublicvoidloadDataSource（）｛configAttributeMapdynamicSecurityService。loadDataSource（）；｝PreDestroypublicvoidclearDataSource（）｛configAttributeMap。clear（）；configAttributeMapnull；｝｝SpringMVC相关注解RequestMapping
　　可用于将Web请求路径映射到处理类的方法上，当作用于类上时，可以统一类中所有方法的路由路径，当作用于方法上时，可单独指定方法的路由路径。
　　method属性可以指定请求的方式，如GET、POST、PUT、DELETE等。RequestBody
　　表示方法的请求参数为JSON格式，从Body中传入，将自动绑定到方法参数对象中。ResponseBody
　　表示方法将返回JSON格式的数据，会自动将返回的对象转化为JSON数据。RequestParam
　　用于接收请求参数，可以是如下三种形式：queryparam：GET请求拼接在地址里的参数。formdata：POST表单提交的参数。multipart：文件上传请求的部分参数。PathVariable
　　用于接收请求路径中的参数，常用于REST风格的API。RequestPart
　　用于接收文件上传中的文件参数，通常是multipartformdata形式传入的参数。authermacrozhengdescriptionMinIO对象存储管理Controllerdate20191225githubhttps：github。commacrozhengControllerRequestMapping（minio）publicclassMinioController｛RequestMapping（valueupload，methodRequestMethod。POST）ResponseBodypublicCommonResultupload（RequestPart（file）MultipartFilefile）｛省略文件上传操作。。。returnCommonResult。success（minioUploadDto）；｝｝SpringMVC注解示例authermacrozhengdescription后台用户管理Controllerdate2018426githubhttps：github。commacrozhengControllerRequestMapping（admin）publicclassUmsAdminController｛RequestMapping（valueregister，methodRequestMethod。POST）ResponseBodypublicCommonResultUmsAdminregister（RequestBodyUmsAdminParamumsAdminParam）｛UmsAdminumsAdminadminService。register（umsAdminParam）；if（umsAdminnull）｛returnCommonResult。failed（）；｝returnCommonResult。success（umsAdmin）；｝RequestMapping（valuelist，methodRequestMethod。GET）ResponseBodypublicCommonResultCommonPageUmsAdminlist（RequestParam（valuekeyword，requiredfalse）Stringkeyword，RequestParam（valuepageSize，defaultValue5）IntegerpageSize，RequestParam（valuepageNum，defaultValue1）IntegerpageNum）｛ListUmsAdminadminListadminService。list（keyword，pageSize，pageNum）；returnCommonResult。success（CommonPage。restPage（adminList））；｝RequestMapping（value｛id｝，methodRequestMethod。GET）ResponseBodypublicCommonResultUmsAdmingetItem（PathVariableLongid）｛UmsAdminadminadminService。getItem（id）；returnCommonResult。success（admin）；｝｝RestController
　　用于表示controller层的组件，与Controller注解的不同在于，相当于在每个请求处理方法上都添加了ResponseBody注解，这些方法都将返回JSON格式数据。GetMapping
　　用于表示GET请求方法，等价于RequestMapping（methodRequestMethod。GET）。PostMapping
　　用于表示POST请求方法，等价于RequestMapping（methodRequestMethod。POST）。REST风格注解示例authermacrozhengdescription后台用户管理Controllerdate2018426githubhttps：github。commacrozhengRestControllerRequestMapping（admin）publicclassUmsAdminController｛PostMapping（register）publicCommonResultUmsAdminregister（RequestBodyUmsAdminParamumsAdminParam）｛UmsAdminumsAdminadminService。register（umsAdminParam）；if（umsAdminnull）｛returnCommonResult。failed（）；｝returnCommonResult。success（umsAdmin）；｝GetMapping（list）publicCommonResultCommonPageUmsAdminlist（RequestParam（valuekeyword，requiredfalse）Stringkeyword，RequestParam（valuepageSize，defaultValue5）IntegerpageSize，RequestParam（valuepageNum，defaultValue1）IntegerpageNum）｛ListUmsAdminadminListadminService。list（keyword，pageSize，pageNum）；returnCommonResult。success（CommonPage。restPage（adminList））；｝｝配置相关注解Configuration
　　用于声明一个Java形式的配置类，SpringBoot推荐使用Java配置，在该类中声明的Bean等配置将被SpringBoot的组件扫描功能扫描到。authermacrozhengdescriptionMyBatis相关配置date201948githubhttps：github。commacrozhengConfigurationMapperScan（｛com。macro。mall。mapper，com。macro。mall。dao｝）publicclassMyBatisConfig｛｝EnableAutoConfiguration
　　启用SpringBoot的自动化配置，会根据你在pom。xml添加的依赖和applicationdev。yml中的配置自动创建你需要的配置。ConfigurationEnableAutoConfigurationpublicclassAppConfig｛｝ComponentScan
　　启用SpringBoot的组件扫描功能，将自动装配和注入指定包下的Bean实例。ConfigurationComponentScan（｛xyz。erupt，com。macro。mall。tiny｝）publicclassEruptConfig｛｝SpringBootApplication
　　用于表示SpringBoot应用中的启动类，相当于EnableAutoConfiguration、EnableAutoConfiguration和ComponentScan三个注解的结合体。SpringBootApplicationpublicclassMallTinyApplication｛publicstaticvoidmain（String〔〕args）｛SpringApplication。run（MallTinyApplication。class，args）；｝｝EnableCaching
　　当添加SpringDataRedis依赖之后，可用该注解开启Spring基于注解的缓存管理功能。authermacrozhengdescriptionRedis配置类date202032githubhttps：github。commacrozhengEnableCachingConfigurationpublicclassRedisConfigextendsBaseRedisConfig｛｝value
　　用于注入在配置文件中配置好的属性，例如我们可以在application。yml配置如下属性：jwt：tokenHeader：AuthorizationJWT存储的请求头secret：malladminsecretJWT加解密使用的密钥expiration：604800JWT的超期限时间（6060247）tokenHead：BearerJWT负载中拿到开头
　　然后在Java类中就可以使用Value注入并进行使用了。publicclassJwtTokenUtil｛Value（｛jwt。secret｝）privateStringsecret；Value（｛jwt。expiration｝）privateLongexpiration；Value（｛jwt。tokenHead｝）privateStringtokenHead；｝ConfigurationProperties
　　用于批量注入外部配置，以对象的形式来导入指定前缀的配置，比如这里我们在application。yml中指定了secure。ignored为前缀的属性：secure：ignored：urls：安全路径白名单swaggeruiswaggerresourcesv2apidocs。html。js。css。png。mapfavicon。icoactuatordruid
　　然后在Java类中定义一个urls属性就可以导入配置文件中的属性了。authermacrozhengdescriptionSpringSecurity白名单资源路径配置date2018115githubhttps：github。commacrozhengGetterSetterConfigurationConfigurationProperties（prefixsecure。ignored）publicclassIgnoreUrlsConfig｛privateListStringurlsnewArrayList（）；｝Conditional
　　用于表示当某个条件满足时，该组件或Bean将被Spring容器创建，下面是几个常用的条件注解。ConditionalOnBean：当某个Bean存在时，配置生效。ConditionalOnMissingBean：当某个Bean不存在时，配置生效。ConditionalOnClass：当某个类在Classpath存在时，配置生效。ConditionalOnMissingClass：当某个类在Classpath不存在时，配置生效。authermacrozhengdescriptionJackson相关配置，配置json不返回null的字段date201882githubhttps：github。commacrozhengConfigurationpublicclassJacksonConfig｛BeanPrimaryConditionalOnMissingBean（ObjectMapper。class）publicObjectMapperjacksonObjectMapper（Jackson2ObjectMapperBuilderbuilder）｛ObjectMapperobjectMapperbuilder。createXmlMapper（false）。build（）；objectMapper。setSerializationInclusion（JsonInclude。Include。NONNULL）；returnobjectMapper；｝｝数据库事务相关注解EnableTransactionManagement
　　启用Spring基于注解的事务管理功能，需要和Configuration注解一起使用。authermacrozhengdescriptionMyBatis相关配置date201948githubhttps：github。commacrozhengConfigurationEnableTransactionManagementMapperScan（｛com。macro。mall。mapper，com。macro。mall。dao｝）publicclassMyBatisConfig｛｝Transactional
　　表示方法和类需要开启事务，当作用与类上时，类中所有方法均会开启事务，当作用于方法上时，方法开启事务，方法上的注解无法被子类所继承。authermacrozhengdescription前台订单管理Servicedate2018830githubhttps：github。commacrozhengpublicinterfaceOmsPortalOrderService｛根据提交信息生成订单TransactionalMapString，ObjectgenerateOrder（OrderParamorderParam）；｝SpringSecurity相关注解EnableWebSecurity
　　启用SpringSecurity的Web功能。EnableGlobalMethodSecurity
　　启用SpringSecurity基于方法的安全功能，当我们使用PreAuthorize修饰接口方法时，需要有对应权限的用户才能访问。SpringSecurity配置示例authermacrozhengdescriptionSpringSecurity配置date2019108githubhttps：github。commacrozhengConfigurationEnableWebSecurityEnableGlobalMethodSecurity（prePostEnabledtrue）publicclassSecurityConfig｛｝全局异常处理注解ControllerAdvice
　　常与ExceptionHandler注解一起使用，用于捕获全局异常，能作用于所有controller中。ExceptionHandler
　　修饰方法时，表示该方法为处理全局异常的方法。全局异常处理示例authermacrozhengdescription全局异常处理date2020227githubhttps：github。commacrozhengControllerAdvicepublicclassGlobalExceptionHandler｛ResponseBodyExceptionHandler（valueApiException。class）publicCommonResulthandle（ApiExceptione）｛if（e。getErrorCode（）！null）｛returnCommonResult。failed（e。getErrorCode（））；｝returnCommonResult。failed（e。getMessage（））；｝｝AOP相关注解Aspect
　　用于定义切面，切面是通知和切点的结合，定义了何时、何地应用通知功能。Before
　　表示前置通知（Before），通知方法会在目标方法调用之前执行，通知描述了切面要完成的工作以及何时执行。After
　　表示后置通知（After），通知方法会在目标方法返回或抛出异常后执行。AfterReturning
　　表示返回通知（AfterReturning），通知方法会在目标方法返回后执行。AfterThrowing
　　表示异常通知（AfterThrowing），通知方法会在目标方法返回后执行。Around
　　表示环绕通知（Around），通知方法会将目标方法封装起来，在目标方法调用之前和之后执行自定义的行为。Pointcut
　　定义切点表达式，定义了通知功能被应用的范围。Order
　　用于定义组件的执行顺序，在AOP中指的是切面的执行顺序，value属性越低优先级越高。AOP相关示例authermacrozhengdescription统一日志处理切面date2018426githubhttps：github。commacrozhengAspectComponentOrder（1）publicclassWebLogAspect｛privatestaticfinalLoggerLOGGERLoggerFactory。getLogger（WebLogAspect。class）；Pointcut（execution（publiccom。macro。mall。tiny。controller。。（。。）））publicvoidwebLog（）｛｝Before（webLog（））publicvoiddoBefore（JoinPointjoinPoint）throwsThrowable｛｝AfterReturning（valuewebLog（），returningret）publicvoiddoAfterReturning（Objectret）throwsThrowable｛｝Around（webLog（））publicObjectdoAround（ProceedingJoinPointjoinPoint）throwsThrowable｛WebLogwebLognewWebLog（）；省略日志处理操作。。。ObjectresultjoinPoint。proceed（）；LOGGER。info（｛｝，JSONUtil。parse（webLog））；returnresult；｝｝测试相关注解SpringBootTest
　　用于指定测试类启用SpringBootTest功能，默认会提供Mock环境。Test
　　指定方法为测试方法。测试示例authermacrozhengdescriptionJUnit基本测试date20221011githubhttps：github。commacrozhengSpringBootTestpublicclassFirstTest｛Testpublicvoidtest（）｛inta1；Assertions。assertEquals（1，a）；｝｝总结
　　这些SpringBoot注解基本都是我平时做项目常用的注解，在我的电商实战项目mall中基本都用到了，这里做了一番整理归纳，希望对大家有所帮助！