SpringBoot 常用注解总结超详细（面试）

ops/2025/1/13 6:15:49/

目录

一、组件相关🎁

@Controller

@Service

@Repository

@Component

二、依赖注入相关🍉

@Autowired

@Resource

根据类型注入（By Type）

根据名称注入（By Name）

区别

@Qualifier

@Resource 和 @Qualifier 的区别

@Resource

@Qualifier

三、实例与生命周期相关🌟

@Bean

@Scope

@Primary

@PostConstruct

@PreDestroy

@PostConstruct、@PreDestroy示例

 四、SpringMVC相关🍊

@RequestMapping

@RequestBody

@ResponseBody

@RequestParam

@PathVariable

@RequestPart

SpringMVC注解示例

@RestController

@GetMapping

@PostMapping

REST风格注解示例

五、配置相关🍍

@Configuration

@EnableAutoConfiguration

@ComponentScan

@SpringBootApplication

@EnableCaching

@value

@ConfigurationProperties

@Conditional

 六、数据库事务相关🌻

@EnableTransactionManagement

@Transactional

七、SpringSecurity相关🌸

@EnableWebSecurity

@EnableGloableMethodSecurity

SpringSecurity配置示例

八、全局异常处理🎹

@ControllerAdvice

@ExceptionHandler

全局异常处理示例

九、AOP相关🐝

@Aspect

@Before

@After

@AfterReturning

@AfterThrowing

@Around

@Pointcut

@Order

AOP相关示例

十、测试相关🐠

@SpringBootTest

@Test

测试示例

一、组件相关🎁

@Controller

       用于修饰 MVC 中 controller 层的组件，SpringBoot 中的组件扫描功能会识别到该注解，并为修饰的类实例化对象，通常与 @RequestMapping 联用，当 SpringMVC 获取到请求时会转发到指定路径的方法进行处理。

java">/*** @description 后台用户管理Controller*/
@Controller
@RequestMapping("/admin")
public class UmsAdminController {}

@Service

        用于修饰 service 层的组件，service 层组件专注于系统业务逻辑的处理，同样会被组件扫描并生成实例化对象。

java">/*** @description 后台用户管理Service实现类*/
@Service
public class UmsAdminServiceImpl implements UmsAdminService {}

@Repository

        用于修饰 dao 层的组件，dao 层组件专注于系统数据的处理，例如数据库中的数据，同样会被组件扫描并生成实例化对象。

java">/*** @description 后台用户与角色关系管理自定义Dao*/
@Repository
public interface UmsAdminRoleRelationDao {}

@Component

        用于修饰 SpringBoot 中的组件，会被组件扫描并生成实例化对象。@Controller、@Service、@Repository 都是特殊的组件注解。

java">/*** @description 取消订单消息的生产者组件*/
@Component
public class CancelOrderSender {}

二、依赖注入相关🍉

@Autowired

        会根据对象的类型自动注入依赖对象，默认要求注入对象实例必须存在，可以配置required=false 来注入不一定存在的对象。

java">/*** @description 后台用户管理Controller*/
@Controller
@RequestMapping("/admin")
public class UmsAdminController {@Autowiredprivate UmsAdminService adminService;
}

@Resource

        默认会根据对象的名称自动注入依赖对象，如果想要根据类型进行注入，可以设置属性为type = UmsAdminService.class。

java">/*** @description 后台用户管理Controller*/
@Controller
@RequestMapping("/admin")
public class UmsAdminController {@Autowired@Resource(name = "umsAdminServiceImpl")private UmsAdminService adminService;
}

        在Java中，特别是在使用Spring框架时，自动注入是一种依赖注入的方式，它允许Spring容器自动将依赖项注入到组件中。根据类型和名称注入是自动注入的两种不同策略。

根据类型注入（By Type）

        根据类型注入是指Spring容器根据需要注入的组件的类型来查找并注入相应的Bean。这种方式非常适合于只有一个实现类的接口，或者当所有需要的Bean都是唯一的情况。Spring容器会在IOC容器中查找与需要注入的字段或方法参数类型相匹配的Bean，并将其注入。

根据名称注入（By Name）

        根据名称注入则是指Spring容器根据Bean的名称来进行注入。这种方式适用于当有多个相同类型的Bean，且需要根据特定的名称来选择特定的Bean时。在这种情况下，你需要使用@Qualifier注解来指定需要注入的Bean的确切名称。

区别

  • 默认行为：@Autowired默认按照byType方式进行Bean匹配，而@Resource默认按照byName方式进行Bean匹配。
  • 注解来源：@Autowired是Spring框架特有的注解，而@Resource是Java EE标准的一部分，也被Spring支持。
  • 灵活性：当存在多个相同类型的Bean时，@Autowired可能会导致歧义，这时需要配合@Qualifier来指定Bean的名称。而@Resource本身就支持通过name属性来进行精确匹配，如果找不到name匹配的Bean，才会尝试按类型匹配。

        在实际开发中，你可以根据具体的需求和偏好来选择使用哪种注入方式。如果你确定一个类型只对应一个Bean，那么使用按类型注入可能更简单快捷；如果你需要在多个相同类型的Bean中选择一个特定的Bean，那么使用按名称注入会更加明确和灵活。

@Qualifier

        当同一个对象有多个实例可以注入时，使用 @Autowired 注解无法进行注入，这时可以使用@Qualifier 注解指定实例的名称进行精确注入。

java">/*** @description 后台用户管理Controller*/
@Controller
@RequestMapping("/admin")
public class UmsAdminController {@Autowired@Qualifier("umsAdminServiceImpl")private UmsAdminService adminService;
}

@Resource 和 @Qualifier 的区别

        在Spring框架中，@Resource 和 @Qualifier 都是用于依赖注入的注解，但它们在使用场景和默认行为上有所区别。

@Resource
  • @Resource 是Java EE标准的一部分，也被Spring框架所支持。
  • 它默认按照名称进行装配，如果没有指定name属性，当注解写在字段上时，默认取字段名进行按照名称查找，如果注解写在setter方法上默认取属性名进行装配。
  • 当找不到与名称匹配的bean时才按照类型进行装配。
  • 如果name属性一旦指定，就只会按照名称进行装配。
  • @Resource 仅支持字段和setter注入。
@Qualifier
  • @Qualifier 是Spring框架特有的注解，用于在多个同类型的Bean中进一步指定需要注入的确切Bean。
  • 它默认按名称装配，value属性默认为空字符串。
  • 当与 @Autowired 注解一起使用时，可以指定需要注入的Bean的名称。
  • @Qualifier 可以修饰字段、方法、参数、类型和注解类型。

        总结来说，@Resource 和 @Qualifier 都可以用于根据名称进行依赖注入，但 @Resource 是Java EE标准的一部分，而 @Qualifier 是Spring框架特有的。在Spring中，通常推荐使用 @Autowired 配合 @Qualifier 来进行精确的依赖注入，以避免在多个同类型Bean存在时的歧义

三、实例与生命周期相关🌟

@Bean

        用于修饰方法，标识该方法会创建一个Bean实例，并交给Spring容器来管理。

java">/*** @description RestTemplate相关配置*/
@Configuration
public class RestTemplateConfig {@Beanpublic RestTemplate restTemplate(){return new RestTemplate();}
}

@Scope

        用于声明一个SpringBean实例的作用域，作用域的范围有以下几种：

  • singleton：单例模式，在Spring容器中该实例唯一，Spring默认的实例模式。
  • prototype：原型模式，每次使用实例都将重新创建。
  • request：在同一请求中使用相同的实例，不同请求重新创建。
  • session：在同一会话中使用相同的实例，不同会话重新创建。
java">/*** @description RestTemplate相关配置*/
@Configuration
public class RestTemplateConfig {@Bean@Scope("singleton")public RestTemplate restTemplate(){return new RestTemplate();}
}

@Primary

        当同一个对象有多个实例时，优先选择该实例。

java">/*** @description Jackson相关配置，配置json不返回null的字段*/
@Configuration
public class JacksonConfig {@Bean@Primary@ConditionalOnMissingBean(ObjectMapper.class)public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {ObjectMapper objectMapper = builder.createXmlMapper(false).build();objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);return objectMapper;}
}

@PostConstruct

        用于修饰方法，当对象实例被创建并且依赖注入完成后执行，可用于对象实例的初始化操作。

@PreDestroy

        用于修饰方法，当对象实例将被Spring容器移除时执行，可用于对象实例持有资源的释放。

@PostConstruct、@PreDestroy示例

java">/*** @description 动态权限数据源，用于获取动态权限规则*/
public class DynamicSecurityMetadataSource implements FilterInvocationSecurityMetadataSource {private static Map<String, ConfigAttribute> configAttributeMap = null;@Autowiredprivate DynamicSecurityService dynamicSecurityService;@PostConstructpublic void loadDataSource() {configAttributeMap = dynamicSecurityService.loadDataSource();}@PreDestroypublic void clearDataSource() {configAttributeMap.clear();configAttributeMap = null;}
}

 四、SpringMVC相关🍊

@RequestMapping

        可用于将Web请求路径映射到处理类的方法上，当作用于类上时，可以统一类中所有方法的路由路径，当作用于方法上时，可单独指定方法的路由路径。

method属性可以指定请求的方式，如GET、POST、PUT、DELETE等。

@RequestBody

        表示方法的请求参数为JSON格式，从Body中传入，将自动绑定到方法参数对象中。

@ResponseBody

        表示方法将返回JSON格式的数据，会自动将返回的对象转化为JSON数据。

@RequestParam

用于接收请求参数，可以是如下三种形式：

  • query param：GET请求拼接在地址里的参数。
  • form data：POST表单提交的参数。
  • multipart：文件上传请求的部分参数。

@PathVariable

        用于接收请求路径中的参数，常用于REST风格的API。

@RequestPart

        用于接收文件上传中的文件参数，通常是 multipart/form-data 形式传入的参数。

java">/*** @description MinIO对象存储管理Controller*/
@Controller
@RequestMapping("/minio")
public class MinioController {@RequestMapping(value = "/upload", method = RequestMethod.POST)@ResponseBodypublic CommonResult upload(@RequestPart("file") MultipartFile file) {//省略文件上传操作...return CommonResult.success(minioUploadDto);}
}

SpringMVC注解示例

java">/*** @description 后台用户管理Controller*/
@Controller
@RequestMapping("/admin")
public class UmsAdminController {@RequestMapping(value = "/register", method = RequestMethod.POST)@ResponseBodypublic CommonResult<UmsAdmin> register(@RequestBody UmsAdminParam umsAdminParam) {UmsAdmin umsAdmin = adminService.register(umsAdminParam);if (umsAdmin == null) {return CommonResult.failed();}return CommonResult.success(umsAdmin);}@RequestMapping(value = "/list", method = RequestMethod.GET)@ResponseBodypublic CommonResult<CommonPage<UmsAdmin>> list(@RequestParam(value = "keyword", required = false) String keyword,@RequestParam(value = "pageSize", defaultValue = "5") Integer pageSize,@RequestParam(value = "pageNum", defaultValue = "1") Integer pageNum) {List<UmsAdmin> adminList = adminService.list(keyword, pageSize, pageNum);return CommonResult.success(CommonPage.restPage(adminList));}@RequestMapping(value = "/{id}", method = RequestMethod.GET)@ResponseBodypublic CommonResult<UmsAdmin> getItem(@PathVariable Long id) {UmsAdmin admin = adminService.getItem(id);return CommonResult.success(admin);}
}

@RestController

        用于表示controller层的组件，与@Controller注解的不同在于，相当于在每个请求处理方法上都添加了@ResponseBody注解，这些方法都将返回JSON格式数据。

@GetMapping

        用于表示GET请求方法，等价于@RequestMapping(method = RequestMethod.GET)。

@PostMapping

        用于表示POST请求方法，等价于@RequestMapping(method = RequestMethod.POST)。

REST风格注解示例

java">/*** @description 后台用户管理Controller*/
@RestController
@RequestMapping("/admin")
public class UmsAdminController {@PostMapping("/register")public CommonResult<UmsAdmin> register(@RequestBody UmsAdminParam umsAdminParam) {UmsAdmin umsAdmin = adminService.register(umsAdminParam);if (umsAdmin == null) {return CommonResult.failed();}return CommonResult.success(umsAdmin);}@GetMapping("/list")public CommonResult<CommonPage<UmsAdmin>> list(@RequestParam(value = "keyword", required = false) String keyword,@RequestParam(value = "pageSize", defaultValue = "5") Integer pageSize,@RequestParam(value = "pageNum", defaultValue = "1") Integer pageNum) {List<UmsAdmin> adminList = adminService.list(keyword, pageSize, pageNum);return CommonResult.success(CommonPage.restPage(adminList));}
}

五、配置相关🍍

@Configuration

        用于声明一个Java形式的配置类，SpringBoot推荐使用Java配置，在该类中声明的Bean等配置将被SpringBoot的组件扫描功能扫描到。 

java">/*** @description MyBatis相关配置*/
@Configuration
@MapperScan({"com.macro.mall.mapper","com.macro.mall.dao"})
public class MyBatisConfig {}

@EnableAutoConfiguration

        启用SpringBoot的自动化配置，会根据你在pom.xml添加的依赖和application-dev.yml中的配置自动创建你需要的配置。

java">@Configuration
@EnableAutoConfiguration
public class AppConfig {
}

@ComponentScan

        启用SpringBoot的组件扫描功能，将自动装配和注入指定包下的Bean实例。

java">@Configuration
@ComponentScan({"xyz.erupt","com.macro.mall.tiny"})
public class EruptConfig {
}

@SpringBootApplication

        用于表示SpringBoot应用中的启动类，相当于@Configuration、@EnableAutoConfiguration和@ComponentScan三个注解的结合体。

@EnableCaching

        当添加Spring Data Redis依赖之后，可用该注解开启Spring基于注解的缓存管理功能。

java">/*** @description Redis配置类*/
@EnableCaching
@Configuration
public class RedisConfig extends BaseRedisConfig {}

@value

        用于注入在配置文件中配置好的属性，例如我们可以在application.yml配置如下属性：

java">jwt:tokenHeader: Authorization #JWT存储的请求头secret: mall-admin-secret #JWT加解密使用的密钥expiration: 604800 #JWT的超期限时间(60*60*24*7)tokenHead: 'Bearer '  #JWT负载中拿到开头

        然后在Java类中就可以使用@Value注入并进行使用了。

java">public class JwtTokenUtil {@Value("${jwt.secret}")private String secret;@Value("${jwt.expiration}")private Long expiration;@Value("${jwt.tokenHead}")private String tokenHead;
}

@ConfigurationProperties

        用于批量注入外部配置，以对象的形式来导入指定前缀的配置，比如这里我们在application.yml中指定了secure.ignored为前缀的属性： 

java">secure:ignored:urls: #安全路径白名单- /swagger-ui/- /swagger-resources/**- /**/v2/api-docs- /**/*.html- /**/*.js- /**/*.css- /**/*.png- /**/*.map- /favicon.ico- /actuator/**- /druid/**

然后在Java类中定义一个urls属性就可以导入配置文件中的属性了。

java">/*** @description SpringSecurity白名单资源路径配置*/
@Getter
@Setter
@Configuration
@ConfigurationProperties(prefix = "secure.ignored")
public class IgnoreUrlsConfig {private List<String> urls = new ArrayList<>();}

@Conditional

用于表示当某个条件满足时，该组件或Bean将被Spring容器创建，下面是几个常用的条件注解。

  • @ConditionalOnBean：当某个Bean存在时，配置生效。
  • @ConditionalOnMissingBean：当某个Bean不存在时，配置生效。
  • @ConditionalOnClass：当某个类在Classpath存在时，配置生效。
  • @ConditionalOnMissingClass：当某个类在Classpath不存在时，配置生效。
java">/*** @description Jackson相关配置，配置json不返回null的字段*/
@Configuration
public class JacksonConfig {@Bean@Primary@ConditionalOnMissingBean(ObjectMapper.class)public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {ObjectMapper objectMapper = builder.createXmlMapper(false).build();objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);return objectMapper;}
}

 六、数据库事务相关🌻

@EnableTransactionManagement

启用Spring基于注解的事务管理功能，需要和@Configuration注解一起使用。

java">/*** @description MyBatis相关配置*/
@Configuration
@EnableTransactionManagement
@MapperScan({"com.macro.mall.mapper","com.macro.mall.dao"})
public class MyBatisConfig {
}

@Transactional

        表示方法和类需要开启事务，当作用与类上时，类中所有方法均会开启事务，当作用于方法上时，方法开启事务，方法上的注解无法被子类所继承。(建议该注解标注在具体的实现类或实现类的方法上)

java">/*** @description 前台订单管理Service*/
public interface OmsPortalOrderService {/*** 根据提交信息生成订单*/@TransactionalMap<String, Object> generateOrder(OrderParam orderParam);
}

七、SpringSecurity相关🌸

@EnableWebSecurity

        启用SpringSecurity的Web功能。

@EnableGloableMethodSecurity

        启用SpringSecurity基于方法的安全功能，当我们使用@PreAuthorize修饰接口方法时，需要有对应权限的用户才能访问。

SpringSecurity配置示例

java">/*** @description SpringSecurity配置*/
@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class SecurityConfig{}

八、全局异常处理🎹

@ControllerAdvice

常与@ExceptionHandler注解一起使用，用于捕获全局异常，能作用于所有controller中。

@ExceptionHandler

修饰方法时，表示该方法为处理全局异常的方法。

全局异常处理示例

java">/*** @description 全局异常处理*/
@ControllerAdvice
public class GlobalExceptionHandler {@ResponseBody@ExceptionHandler(value = ApiException.class)public CommonResult handle(ApiException e) {if (e.getErrorCode() != null) {return CommonResult.failed(e.getErrorCode());}return CommonResult.failed(e.getMessage());}
}

九、AOP相关🐝

@Aspect

用于定义切面，切面是通知和切点的结合，定义了何时、何地应用通知功能。

@Before

表示前置通知（Before），通知方法会在目标方法调用之前执行，通知描述了切面要完成的工作以及何时执行。

@After

表示后置通知（After），通知方法会在目标方法返回或抛出异常后执行。

@AfterReturning

表示返回通知（AfterReturning），通知方法会在目标方法返回后执行。

@AfterThrowing

表示异常通知（AfterThrowing），通知方法会在目标方法返回后执行。

@Around

表示环绕通知（Around），通知方法会将目标方法封装起来，在目标方法调用之前和之后执行自定义的行为。

@Pointcut

定义切点表达式，定义了通知功能被应用的范围。

@Order

用于定义组件的执行顺序，在AOP中指的是切面的执行顺序，value属性越低优先级越高。

AOP相关示例

java">/*** @description 统一日志处理切面*/
@Aspect
@Component
@Order(1)
public class WebLogAspect {private static final Logger LOGGER = LoggerFactory.getLogger(WebLogAspect.class);@Pointcut("execution(public * com.macro.mall.tiny.controller.*.*(..))")public void webLog() {}@Before("webLog()")public void doBefore(JoinPoint joinPoint) throws Throwable {}@AfterReturning(value = "webLog()", returning = "ret")public void doAfterReturning(Object ret) throws Throwable {}@Around("webLog()")public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {WebLog webLog = new WebLog();//省略日志处理操作...Object result = joinPoint.proceed();LOGGER.info("{}", JSONUtil.parse(webLog));return result;}}

十、测试相关🐠

@SpringBootTest

        用于指定测试类启用Spring Boot Test功能，默认会提供Mock环境。

@Test

        指定方法为测试方法。

测试示例

java">/*** @description JUnit基本测试*/
@SpringBootTest
public class FirstTest {@Testpublic void test() {int a=1;Assertions.assertEquals(1,a);}
}


http://www.ppmy.cn/ops/20570.html

相关文章

app渗透测试

app渗透测试

1.夜神模拟器搭建流程 直接自定义安装 就可以了 如果是androd7本 修改为低于7版本的 调整夜神版本 2.burp设置代理 可以自己指定电脑ip windows cmd ifconfig 设置-添加-指定地址端口 然后导出证书或者在夜神模拟器使用指定的ip加端口访问下载 3.安装证书 如果是导出的…
阅读更多...
android 内部序列化对象

android 内部序列化对象

在Android中&#xff0c;内部序列化对象通常指的是将对象的状态转换为字节流&#xff0c;以便可以将对象保存到文件、通过网络发送&#xff0c;或者在应用的不同部分之间传递。在Java中&#xff0c;序列化是通过实现java.io.Serializable接口来完成的。Android继承了Java的序列…
阅读更多...
力扣每日一题-查询网格图中每一列的宽度-2024.4.27

力扣每日一题-查询网格图中每一列的宽度-2024.4.27

力扣题目&#xff1a;查询网格图中每一列的宽度 题目链接: 2639.查询网格图中每一列的宽度 题目描述 代码思路 双层for循环遍历整个矩阵容易想到&#xff0c;只要能想到使用整数转字符串的技巧&#xff08;“” 字符串&#xff09;&#xff0c;即可完成题目 代码纯享版 c…
阅读更多...
链游：未来游戏发展的新风向

链游：未来游戏发展的新风向

链游&#xff0c;即区块链游戏的一种&#xff0c;是一种将区块链技术与游戏玩法相结合的创新型游戏。它利用区块链技术的特性&#xff0c;如去中心化、可追溯性和安全性&#xff0c;为玩家提供了一种全新的游戏体验。链游通常采用智能合约来实现游戏的规则和交易系统&#xff0…
阅读更多...
PotatoPie 4.0 实验教程(41) —— FPGA实现RISC-V 扩展 GPIO UART Timer功能

PotatoPie 4.0 实验教程(41) —— FPGA实现RISC-V 扩展 GPIO UART Timer功能

TD工程介绍 我们提供的TD工程里的RISC-V核默认就开启了GPIO UART扩展&#xff0c;可以看到还有SPI和I2C扩展。因此后面的实验中TD的工程我们基本不怎么修改TD的内容&#xff0c;只需要修改TD工具中Soc_Top.v文件中的TCM0_INITFILE为FD生成的固件名称即可&#xff0c;主要修我以…
阅读更多...
springboot 启动系统任务

springboot 启动系统任务

有一些特殊的任务需要在系统启动时执行&#xff0c;例如配置文件加载、数据库初始化等操作。如果没有使用 Spring Boot&#xff0c;这些问题可以在 Listener 中解决。Spring Boot 对此提供了两种解决方案:CommandLineRunner 和 ApplicationRunner。CommandLineRunner 和 Applic…
阅读更多...
SpringCloud中网关-详解、案例（代码）

SpringCloud中网关-详解、案例（代码）

简介&#xff1a;在Spring Cloud中&#xff0c;网关的角色是非常重要的&#xff0c;它负责整个系统的入口流量&#xff0c;并且可以处理路由、过滤、协议转换等操作 目录 1、网关的技术实现 1.1 网关功能 1.2 网关的形式 2、网关实现步骤 2.1 添加相关依赖 2.2 创建此mod…
阅读更多...
微信小程序的常用API②

微信小程序的常用API②

一、动画API &#xff08;1&#xff09;作用&#xff1a;用于在微信小程序中完成动画效果的制作 &#xff08;2&#xff09;使用&#xff1a;创建实例 wx.createAnimation() &#xff08;3&#xff09;常用属性&#xff1a; duration 【number型】 动画持续时间&…
阅读更多...
最新文章

Copyright @ 2022~2023