AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

Spring Boot 开发离不开这些注解，快来学习啦！

2023-06-06 248
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
应用型负载均衡 ALB，每月750个小时 15LCU
网络型负载均衡 NLB，每月750个小时 15LCU
传统型负载均衡 CLB，每月750个小时 15LCU
简介： Spring Boot 是一款非常流行的 Java 框架，其注解用法复杂而丰富。 在介绍 Spring Boot 的注解之前，我们需要先了解 Spring 框架中的 AOP（面向切面编程）概念。

Spring Boot 是一款非常流行的 Java 框架，其注解用法复杂而丰富。 在介绍 Spring Boot 的注解之前，我们需要先了解 Spring 框架中的 AOP（面向切面编程）概念。 Spring 的 AOP 可以帮助开发者实现一些非业务功能的代码，如日志记录、性能监控等。这些功能可以通过定义一个 Aspect（切面） 类来实现。
在 Spring Boot 中，除了常规的 AOP 注解外，还有以下几类注解，这也是我看到一个脑图后的一点点收获，想要自己也能够总结总结所用到的注解，常记定能有所感悟。

核心注解
原型注解
SpringBoot注解
SpringCloud注解
缓存注解
测试注解
数据库访问注解
JPA注解
SpringMVC跟REST注解
全局异常处理注解

接下来我们将分别介绍这几类注解及其使用方法。
一、核心注解
@Configuration
@Configuration 注解可以被用来标记一个类，表示这个类是一个 Bean 配置类。在配置类中，我们可以使用其他 Bean 的定义和依赖，甚至可以使用 @Autowired 和 @Value 注解将其他 Bean 注入到当前的 Bean 中。下面是一个简单的例子：
java复制代码@Configuration
public class AppConfig {
@Bean
public MyService myService() {
return new MyServiceImpl();
}
}

@Autowired
@Autowired 注解可以将一个 Bean 自动注入到当前类中。默认情况下，@Autowired 的匹配规则是根据类型进行匹配。如果有多个类型相同的 Bean，可以使用 @Qualifier 进行限定。
java复制代码@Component
public class MyController {
private final MyService myService;

@Autowired
public MyController(MyService myService) {
    this.myService = myService;
}

}

@Value
@Value 注解用于从配置文件或环境变量中获取值，可以注入 String、int、long、double、boolean 等类型。使用 ${} 可以引用配置文件中的属性，使用 $() 可以引用系统环境变量。
例如：
java复制代码@Component
public class MyComponent {
@Value("${my.config.property}")
private String configProperty;

@Value("$MY_ENV_VAR")
private String envVar;

}

@Bean
@Bean 注解用于定义一个 Bean，将其加入到 Spring 容器中。通常在 @Configuration 类中使用。可以指定该 Bean 的名称、作用域、相关依赖等。
java复制代码@Configuration
public class AppConfig {
@Bean(name = "myService", scope = ConfigurableBeanFactory.SCOPE_PROTOTYPE)
public MyService myService() {
return new MyServiceImpl();
}
}

@ComponentScan
@ComponentScan 注解用于扫描包中的组件（包括 Bean、Controller 等），将这些组件加入到 Spring 容器中。
java复制代码@Configuration
@ComponentScan(basePackages = { "com.example" })
public class AppConfig {
}

@EnableAutoConfiguration
@EnableAutoConfiguration 注解可以自动配置 Spring Boot 应用程序。在启用该注解时，Spring Boot 将根据类路径和配置文件中的信息来尝试猜测并配置应用程序。
java复制代码@SpringBootApplication
public class MyApp {
public static void main(String[] args) {
SpringApplication.run(MyApp.class, args);
}
}

二、原型注解
@Scope
@Scope 注解用于设置 Bean 的作用域，包括 Singleton、Prototype、Request、Session 等。默认情况下，Bean 是 Singleton 的。
java复制代码@Configuration
public class AppConfig {
@Bean(name = "myService")
@Scope( ConfigurableBeanFactory.SCOPE_PROTOTYPE )
public MyService myService() {
return new MyServiceImpl();
}
}

@Lazy
@Lazy 注解用于标记一个 Bean 延迟初始化。当容器从 XML 文件、Java 配置类或其他方式加载时，不会创建这个 Bean。
java复制代码@Configuration
public class AppConfig {
@Bean(name = "myService")
@Lazy
public MyService myService() {
return new MyServiceImpl();
}
}

@DependsOn
@DependsOn 注解用于标识 Bean 之间的依赖关系。在容器启动时，先创建 @DependsOn 注解中指定的 Bean，再创建当前 Bean。
java复制代码@Configuration
public class AppConfig {
@Bean(name = "myService")
public MyService myService() {
return new MyServiceImpl();
}

@Bean(name = "myController")
@DependsOn("myService")
public MyController myController() {
    return new MyController(myService());
}

}

三、SpringBoot注解
@SpringBootApplication
@SpringBootApplication 注解是一个组合注解，等价于同时使用 @Configuration、@EnableAutoConfiguration 和 @ComponentScan 注解。它用于标记主类，并告诉 Spring Boot 启动该应用程序。
java复制代码@SpringBootApplication
public class MyApp {
public static void main(String[] args) {
SpringApplication.run(MyApp.class, args);
}
}

@RestController
@RestController 注解表示控制器中所有方法都返回 JSON 格式数据。它是 Spring MVC 中 @Controller 注解的扩展。下面是一个简单的例子：
java复制代码@RestController
public class MyController {
@GetMapping("/greeting")
public String greeting() {
return "Hello, world!";
}
}

@RequestMapping
@RequestMapping 注解用于映射 HTTP 请求。可以使用 value 属性指定 URL 映射，使用 method 属性指定请求方法。
java复制代码@RestController
@RequestMapping("/api")
public class MyController {
@GetMapping("/greeting")
public String greeting() {
return "Hello, world!";
}
}

@GetMapping
@GetMapping 注解等同于 @RequestMapping(method = RequestMethod.GET)，用于映射 HTTP GET 请求。
java复制代码@RestController
@RequestMapping("/api")
public class MyController {
@GetMapping("/greeting")
public String greeting() {
return "Hello, world!";
}
}

@PostMapping
@PostMapping 注解等同于 @RequestMapping(method = RequestMethod.POST)，用于映射 HTTP POST 请求。
java复制代码@RestController
@RequestMapping("/api")
public class MyController {
@PostMapping("/greeting")
public String greeting() {
return "Hello, world!";
}
}

@PutMapping
@PutMapping 注解等同于 @RequestMapping(method = RequestMethod.PUT)，用于映射 HTTP PUT 请求。
java复制代码@RestController
@RequestMapping("/api")
public class MyController {
@PutMapping("/greeting")
public String greeting() {
return "Hello, world!";
}
}

@DeleteMapping
@DeleteMapping 注解等同于 @RequestMapping(method = RequestMethod.DELETE)，用于映射 HTTP DELETE 请求。
java复制代码@RestController
@RequestMapping("/api")
public class MyController {
@DeleteMapping("/greeting")
public String greeting() {
return "Hello, world!";
}
}

@RequestParam
@RequestParam 注解用于将请求参数映射到方法的参数中。可以使用 value 属性指定参数名，使用 required 属性指定是否必填，使用 defaultValue 属性指定默认值。
java复制代码@RestController
@RequestMapping("/api")
public class MyController {
@GetMapping("/greeting")
public String greeting(@RequestParam("name") String name) {
return "Hello, " + name + "!";
}
}

@PathVariable
@PathVariable 注解用于将 URL 中的占位符映射到方法的参数中。可以使用 value 属性指定占位符名称。
java复制代码@RestController
@RequestMapping("/api")
public class MyController {
@GetMapping("/{name}")
public String greeting(@PathVariable("name") String name) {
return "Hello, " + name + "!";
}
}

@RequestBody
@RequestBody 注解用于从请求体中获取数据。通常用于处理 POST、PUT 请求。
java复制代码@RestController
@RequestMapping("/api")
public class MyController {
@PostMapping("/greeting")
public String greeting(@RequestBody GreetingRequest request) {
return "Hello, " + request.getName() + "!";
}
}

public class GreetingRequest {
private String name;

// getters and setters

}

@ResponseBody
@ResponseBody 注解表示该方法返回的结果直接输出到响应体中。
java复制代码@RestController
@RequestMapping("/api")
public class MyController {
@GetMapping("/greeting")
@ResponseBody
public String greeting() {
return "Hello, world!";
}
}

@ResponseStatus
@ResponseStatus 注解用于指定请求处理完成后的状态码。
java复制代码@RestController
@RequestMapping("/api")
public class MyController {
@GetMapping("/greeting")
@ResponseStatus(HttpStatus.OK)
public String greeting() {
return "Hello, world!";
}
}

@ExceptionHandler
@ExceptionHandler 注解用于处理请求抛出的异常。
java复制代码@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(IllegalArgumentException.class)
@ResponseStatus(HttpStatus.BAD_REQUEST)
public ErrorResult handleIllegalArgumentException(IllegalArgumentException ex) {
return new ErrorResult(ex.getMessage());
}
}

public class ErrorResult {
private String message;

public ErrorResult(String message) {
    this.message = message;
}

// getters and setters

}

四、SpringCloud注解
@EnableDiscoveryClient
@EnableDiscoveryClient 注解用于启用服务发现功能。使用该注解后，应用程序能够将自己注册到 Eureka 服务器，并从中获取其他实例的信息。
java复制代码@SpringBootApplication
@EnableDiscoveryClient
public class MyApp {
public static void main(String[] args) {
SpringApplication.run(MyApp.class, args);
}
}

@LoadBalanced
@LoadBalanced 注解用于标记 RestTemplate Bean，以启用负载均衡功能。在使用 REST 请求时，RestTemplate 将根据服务名自动选择一个可用的实例。
java复制代码@Configuration
public class AppConfig {
@Bean
@LoadBalanced
public RestTemplate restTemplate() {
return new RestTemplate();
}
}

@FeignClient
@FeignClient 注解用于定义一个 Feign 客户端。Feign 是一款用于简化 HTTP API 客户端的工具，它支持声明式 REST 客户端。使用 @FeignClient 注解后，我们可以通过接口来调用具有相同功能的微服务。
java复制代码@FeignClient(name = "my-service")
public interface MyServiceClient {
@GetMapping("/greeting")
String greeting();
}

五、缓存注解
@Cacheable
@Cacheable 注解表示方法的结果应该被缓存起来，下次调用该方法时，如果参数和之前相同，则返回缓存结果。
java复制代码@Service
public class MyService {
@Cacheable("greetingCache")
public String greeting(String name) {
return "Hello, " + name + "!";
}
}

@CachePut
@CachePut 注解表示方法的结果应该被缓存起来，下次调用该方法时，不会返回缓存结果，而是重新计算结果并缓存起来。
java复制代码@Service
public class MyService {
@CachePut("greetingCache")
public String greeting(String name) {
return "Hello, " + name + "!";
}
}

@CacheEvict
@CacheEvict 注解表示方法执行后从缓存中删除指定项。
java复制代码@Service
public class MyService {
@CacheEvict("greetingCache")
public void clearGreetingCache() {
}
}

六、测试注解
@SpringBootTest
@SpringBootTest 注解用于测试 Spring Boot 应用程序。它会创建一个完整的 Spring 应用程序上下文，并在测试期间使用它。
java复制代码@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
public class MyControllerTest {
@Autowired
private TestRestTemplate restTemplate;

@Test
public void testGreeting() {
    ResponseEntity<String> responseEntity = restTemplate.getForEntity("/api/greeting", String.class);
    assertThat(responseEntity.getStatusCode()).isEqualTo(HttpStatus.OK);
    assertThat(responseEntity.getBody()).isEqualTo("Hello, world!");
}

}

@MockBean
@MockBean 注解用于模拟一个 Bean 的实现。在测试过程中，可以使用 Mockito.when() 等方法来指定一些行为。
java复制代码@SpringBootTest
public class MyServiceTest {
@Autowired
private MyService myService;

@MockBean
private MyRepository myRepository;

@Test
public void testFindById() {
    Mockito.when(myRepository.findById(1L)).thenReturn(Optional.of(new MyEntity()));
    MyEntity entity = myService.findById(1L);
    assertThat(entity).isNotNull();
    Mockito.verify(myRepository).findById(1L);
}

}

七、数据库访问注解
@Transactional
@Transactional 注解用于指定一个方法需要在事务中执行。默认情况下，只有 RuntimeException 会触发事务回滚。
java复制代码@Service
public class MyService {
@Autowired
private MyRepository myRepository;

@Transactional
public void save(MyEntity entity) {
    myRepository.save(entity);
}

}

@Repository
@Repository 注解用于标记数据访问层，表示这个类是一个数据仓库。
java复制代码@Repository
public interface MyRepository extends JpaRepository {
}

@Entity
@Entity 注解用于标记实体类，表示这个类是一个 JPA 实体。它与数据库中的表相对应。
java复制代码@Entity
@Table(name = "my_entity")
public class MyEntity {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

// getters and setters

}

@Id
@Id 注解用于标记主键字段。
java复制代码@Entity
@Table(name = "my_entity")
public class MyEntity {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

// getters and setters

}

@GeneratedValue
@GeneratedValue 注解用于指定主键的生成策略。
java复制代码@Entity
@Table(name = "my_entity")
public class MyEntity {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

// getters and setters

}

@Column
@Column 注解用于指定实体属性与数据库表列之间的映射关系。
java复制代码@Entity
@Table(name = "my_entity")
public class MyEntity {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

@Column(name = "name")
private String name;

// getters and setters

}

八、JPA注解
@EnableJpaRepositories
@EnableJpaRepositories 注解用于启用 Spring Data JPA 功能。它会自动配置 Spring Data JPA 相关的 Bean。
java复制代码@SpringBootApplication
@EnableJpaRepositories
public class MyApp {
public static void main(String[] args) {
SpringApplication.run(MyApp.class, args);
}
}

@Query
@Query 注解用于自定义查询语句。
java复制代码@Repository
public interface MyRepository extends JpaRepository {
@Query("select e from MyEntity e where e.name = :name")
List findByName(@Param("name") String name);
}

九、全局异常处理注解
@ControllerAdvice
@ControllerAdvice 注解用于定义一个全局异常处理类，用于捕获所有控制器中抛出的异常，进行统一处理。
java复制代码@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
public ModelAndView handleException(HttpServletRequest request, Exception ex) {
ModelAndView mav = new ModelAndView();
mav.addObject("exception", ex);
mav.addObject("url", request.getRequestURI());
mav.setViewName("error");
return mav;
}
}

以上是 Spring Boot 中常见的注解和使用方法，终于干完了，虽然相关注解还有很多，以后一点一点充实这篇文章吧。

文章标签：
负载均衡
Java
容器
微服务
负载均衡
网络架构
Spring
API
数据格式
数据库
缓存
关键词：
Spring开发
Spring boot学习
Spring boot注解
Spring注解
Spring学习
相关实践学习
每个IT人都想学的“Web应用上云经典架构”实战
本实验从Web应用上云这个最基本的、最普遍的需求出发，帮助IT从业者们通过“阿里云Web应用上云解决方案”，了解一个企业级Web应用上云的常见架构，了解如何构建一个高可用、可扩展的企业级应用架构。
运营研究坊
目录
相关文章
计算机程序设计Y2013070224
|
14天前
|
搜索推荐 JavaScript Java
基于springboot的儿童家长教育能力提升学习系统
本系统聚焦儿童家长教育能力提升，针对家庭教育中理念混乱、时间不足、个性化服务缺失等问题，构建科学、系统、个性化的在线学习平台。融合Spring Boot、Vue等先进技术，整合优质教育资源，提供高效便捷的学习路径，助力家长掌握科学育儿方法，促进儿童全面健康发展，推动家庭和谐与社会进步。
计算机程序设计Y2013070224
72 5
varin
|
1月前
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行，支持固定间隔、延迟或Cron表达式触发，基于Spring Task，适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`，注意线程阻塞与分布式重复问题，推荐结合`@Async`异步处理，提升任务调度效率。
varin
403 128
阿里云云原生
|
4天前
|
人工智能 运维 Java
Spring AI Alibaba Admin 开源！以数据为中心的 Agent 开发平台
Spring AI Alibaba Admin 正式发布！一站式实现 Prompt 管理、动态热更新、评测集构建、自动化评估与全链路可观测，助力企业高效构建可信赖的 AI Agent 应用。开源共建，现已上线！
阿里云云原生
430 8
一枚后端工程狮
|
7天前
|
安全 前端开发 Java
《深入理解Spring》：现代Java开发的核心框架
Spring自2003年诞生以来，已成为Java企业级开发的基石，凭借IoC、AOP、声明式编程等核心特性，极大简化了开发复杂度。本系列将深入解析Spring框架核心原理及Spring Boot、Cloud、Security等生态组件，助力开发者构建高效、可扩展的应用体系。（238字）
一枚后端工程狮
160 1
凉凉心.
|
15天前
|
XML Java 应用服务中间件
【SpringBoot（一）】Spring的认知、容器功能讲解与自动装配原理的入门，带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章，讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门，还有其他常用的Springboot注解！如果想要了解SpringBoot，那么就进来看看吧！
凉凉心.
159 2
蓝易云
|
1月前
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础，通过它们，可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求，运用这些注解来优化代码结构和服务逻辑。
蓝易云
204 12
HELLO程序员
|
1月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载，提升应用的灵活性与可配置性。本文深入解析其用法与优势，并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
HELLO程序员
118 0
探索Spring Boot的@Conditional注解的上下文配置
疯狂的猿
|
Java API Spring
Spring容器如何使用一个注解来指定一个类型为配置类型
Spring容器如何使用一个注解来指定一个类型为配置类型
疯狂的猿
184 0
Cyan_RA9
|
8月前
|
XML Java 测试技术
Spring IOC—基于注解配置和管理Bean 万字详解（通俗易懂）
Spring 第三节 IOC——基于注解配置和管理Bean 万字详解！
Cyan_RA9
562 26
三三是该溜子
|
10月前
|
Java Spring
【Spring】方法注解@Bean，配置类扫描路径
@Bean方法注解，如何在同一个类下面定义多个Bean对象，配置扫描路径
三三是该溜子
347 73

热门文章

最新文章

  • 1
    构建基于Java的AI智能体：使用LangChain4j与Spring AI实现RAG应用
  • 2
    零代码改造 + 全链路追踪！Spring AI 最新可观测性详细解读
  • 3
    从零学 Dropwizard：手把手搭轻量 Java 微服务，告别 Spring 臃肿
  • 4
    Spring框架优化：提高Java应用的性能与适应性
  • 5
    Spring Boot 整合Nacos 版本兼容适配 史上最详细文档
  • 6
    SpringBoot @Scheduled 注解详解
  • 7
    Spring Boot 3.x 微服务架构实战指南
  • 8
    SpringBoot接口安全：限流、重放攻击、签名机制分析
  • 9
    【SpringBoot（四）】还不懂文件上传？JUnit使用？本文带你了解SpringBoot的文件上传、异常处理、组件注入等知识！并且带你领悟JUnit单元测试的使用！
  • 10
    基于springboot的美食文化和旅游推广系统
  • 1
    基于Java 17 + Spring Boot 3.2 + Flink 1.18的智慧实验室管理系统核心代码
    279
  • 2
    Spring boot 使用mybatis generator 自动生成代码插件
    746
  • 3
    较为完整的SpringBoot项目结构
    2714
  • 4
    Java 21 与 Spring Boot 3.2 微服务开发从入门到精通实操指南
    485
  • 5
    📨 Spring Boot 3 整合 MQ 构建聊天消息存储系统
    457
  • 6
    SpringBoot之异步调用@Ansyc
    347
  • 7
    SpringBoot2.3.1集成Knife4j接口文档
    508
  • 8
    springboot+redis互联网医院智能导诊系统源码，基于医疗大模型、知识图谱、人机交互方式实现
    309
  • 9
    JPA简介：Spring Boot环境下的实践指南
    173
  • 10
    Spring Boot 可视化监控
    778

    • 相关课程

    更多
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Java Web开发系列课程 - Spring框架入门
  • Spring Boot 2.5.x开发实战
  • Springboot项目云开发快速迁移
  • Spring Cloud微服务架构设计与开发实战

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库
    • 下一篇
    阿里云oss简介和如何对接使用