SpringBoot常用注解详解含使用示例（值得珍藏）

需积分: 3 164 浏览量 2024-02-01 13:40:22 上传评论 1 收藏 522KB PDF 举报

资源推荐

资源详情

资源评论

1. 启动注解

1.1 @SpringBootApplication

@SpringBootApplication 是一个组合注解，它结合了 @SpringBootConfiguration、

@EnableAutoConfiguration 和 @ComponentScan。这个注解用于简化 Spring Boot 应用的初始化和开发

过程。

具体来说，@SpringBootConfiguration 表明该类是一个 Spring Boot 配置类，用于定义和注册 Spring

Beans。@EnableAutoConfiguration 启用了 Spring Boot 的自动配置功能，根据项目中的依赖关系自动配

置应用程序。@ComponentScan 则指示 Spring Boot 在指定的包及其子包中查找组件、配置和服务。

使用 @SpringBootApplication 注解可以简化 Spring Boot 应用的开发过程，使得开发人员能够快速构建独

立、生产级别的 Spring 应用。同时，它还提供了一些便利的特性，如嵌入式容器、自动化配置、简化

Maven 配置等，使得应用更加易于部署和管理。

以下是一个简单的 Spring Boot 应用程序示例，其中使用了 @SpringBootApplication 注解：

在上面的示例中， @SpringBootApplication 注解将 MySpringBootApplication 类标记为一个 Spring

Boot 应用程序的入口点。当运行该应用程序时，Spring Boot 会自动配置和启动应用程序。

你可以在 MySpringBootApplication 类中添加更多的组件和配置，以满足你的应用程序需求。例如，你可

以添加控制器、服务、数据访问对象等，并使用 Spring Boot 的自动配置功能来简化配置过程。



1.2 @SpringBootConfiguration

@SpringBootConfiguration 是 Spring Boot 框架提供的注解，用于将普通的 Java 类标记为配置类。该注解

的作用是将类作为一个 Spring 配置类，从而使其能够定义和注册 Spring Beans。

与传统的 XML 配置方式相比，使用 @SpringBootConfiguration 注解可以将配置信息直接写在 Java 类中，

使得代码更加简洁、易于维护。同时，该注解还提供了自动配置和组件扫描等功能，进一步简化了 Spring

Boot 应用的初始化和开发过程。

import org.springframework.boot.SpringApplication; 

import org.springframework.boot.autoconfigure.SpringBootApplication; 



@SpringBootApplication 

public class MySpringBootApplication { 



 public static void main(String[] args) { 

   SpringApplication.run(MySpringBootApplication.class, args); 

 } 



}

使用 @SpringBootConfiguration 注解的类通常包含一些用于定义 Spring Beans 的方法，这些方法上可以

标注其他注解（如 @Bean、@Component、@Service 等），以便于创建和注册不同的 Spring 组件。通过

在主类上使用 @SpringBootApplication 注解，可以将多个配置类组合在一起，从而实现更加灵活和复杂的

配置功能。

它继承@Configuration注解，主要用于加载配置文件，二者功能一致，标注当前类为配置类，将当前类内

声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中，且实例名为方法名。



1.3 @EnableAutoConfiguration

@EnableAutoConfiguration 是 Spring Boot 的一个核心特性，它根据项目中的依赖关系自动配置应用程

序。通过 @EnableAutoConfiguration 注解，Spring Boot 能够根据添加的 jar 依赖自动配置 Spring 应用程

序的 IOC 容器。

在 Spring Boot 项目中，只需要在主类上添加 @EnableAutoConfiguration 注解，就可以开启自动配置功

能。Spring Boot 会根据项目中的依赖项，自动扫描并配置相应的 Bean。这个过程是自动完成的，不需要手

动编写大量的配置文件和注解。

@EnableAutoConfiguration 通过读取 classpath 中的 jar 依赖，判断需要创建哪些 Bean，并自动注册到

Spring 容器中。这样可以大大简化 Spring 应用的初始化和配置过程，提高开发效率。



1.4 @ComponentScan

@ComponentScan 是 Spring 框架中的一个注解，用于指定 Spring 容器扫描组件的路径。通过使用

@ComponentScan，可以将 Spring 容器中的组件注册到指定的路径下。

具体来说，@ComponentScan 注解可以定义在类或接口上，用于指定扫描路径。Spring 容器会将指定路径

下带有指定注解的类注册到 IOC 容器中。默认情况下，@ComponentScan 会扫描带有 @Component、

@Service、@Repository 和 @Controller 等注解的类。

使用 @ComponentScan 可以简化 Spring 应用的初始化和配置过程。通过指定扫描路径，可以自动将相关

的组件注册到 Spring 容器中，而不需要手动创建和配置每个 Bean。这使得代码更加简洁、易于维护，并且

减少了出错的可能性。

需要注意的是，在使用 @ComponentScan 时，需要确保扫描路径的正确性。如果扫描路径不正确，可能会

导致组件无法被注册到 Spring 容器中，从而导致异常或错误。因此，在实际开发中，需要根据具体情况选择

合适的扫描路径，并进行充分的测试和验证。



2. 配置文件相关注解

2.1 @Configuration

@Configuration 是 Spring 框架中的一个注解，用于将普通的 Java 类标记为配置类。当一个类上标注了

@Configuration 注解时，这个类就被视为一个配置类，用于替代传统的 XML 配置方式。

在配置类中，可以使用 @Bean 注解来定义 Spring Beans。这些 Beans 可以是普通的 Java 类，也可以是其

他配置类。通过使用 @Configuration 和 @Bean 注解，可以将配置信息直接写在 Java 类中，使得代码更加

简洁、易于维护。

与传统的 XML 配置方式相比，使用 @Configuration 和 @Bean 注解可以提供更加灵活和强大的配置功能。

例如，可以在配置类中使用 Java 表达式来定义 Beans 的属性和依赖关系，还可以通过继承和组合配置类来

实现更加复杂的配置逻辑。

此外，@Configuration 注解的类本身也是一个普通的 Java 类，可以包含普通的属性和方法。这使得配置类

更加易于测试和维护。

需要注意的是，虽然使用 @Configuration 和 @Bean 注解可以简化 Spring 的配置过程，但并不是所有的配

置都需要使用这种方式。在一些简单的情况下，使用传统的 XML 配置方式可能更加方便和直观。因此，在实

际开发中，需要根据具体情况选择合适的配置方式。

以下是一个使用 @Configuration 注解的示例：

在上面的示例中， @Configuration 注解将 AppConfig 类标记为一个 Spring 配置类。在该类中，我们使

用 @Bean 注解定义了一个名为 myBean 的 Bean，该 Bean 返回一个 MyBean 实例。

通过在配置类中使用 @Bean 注解，我们可以将对象实例化并将其注册为 Spring 容器中的 Bean。这样，在

应用程序的其他部分中，我们可以使用 @Autowired 或 @Inject 注解来注入这些 Bean，以便使用它们的

功能。



3. Controller 相关注解

3.1 @Controller

@Controller 是一个用于标识一个 Java 类为 Spring MVC 控制器的注解。使用 @Controller 注解的类将负责

处理请求并返回响应。在 Spring MVC 中，控制器是与视图层进行交互的重要组件，负责处理用户请求并返

回相应的视图或数据。

当一个类上标注了 @Controller 注解，Spring MVC 会自动扫描该类，并将其注册为一个控制器。这意味着

该类的方法将用于处理请求，并返回响应。方法的返回值可以是一个视图页面、数据对象或模型。

import org.springframework.context.annotation.Bean; 

import org.springframework.context.annotation.Configuration; 



@Configuration 

public class AppConfig { 



 @Bean 

 public MyBean myBean() { 

   return new MyBean(); 

 } 



}

@Controller 注解的作用是将一个类标记为控制器，使 Spring MVC 能够自动扫描和注册该类。与

@Component 注解类似，@Controller 注解也是将一个类标记为 Spring 的组件。但是，@Controller 注解

还有以下特性：

1. 自动映射 URL：@Controller 注解可以将请求映射到控制器的方法上。这意味着当用户访问特定的 URL

时，Spring MVC 会自动调用相应的控制器方法来处理请求。

2. 解析返回值：@Controller 注解可以将方法的返回值解析为视图，并将其渲染到客户端。这意味着方法

的返回值可以是一个视图页面的路径、一个模型对象或一个数据集合等。

需要注意的是，在实际开发中，使用 @Controller 注解时需要结合其他注解（如 @RequestMapping）来指

定请求的 URL 映射和请求方法（如 GET、POST）。此外，根据实际需求选择合适的控制器注解（如

@Controller、@RestController）也是很重要的。

以下是一个使用 @Controller 注解的示例：

在上面的示例中， @Controller 注解将 HelloController 类标记为一个 Spring MVC 控制器。

@RequestMapping("/hello") 注解指定了该控制器处理的基础 URL 路径为 /hello 。

在控制器类中，我们定义了一个名为 sayHello 的方法，该方法使用 @GetMapping 注解指定处理 GET 请

求。当用户访问 /hello URL 时，Spring MVC 会自动调用 sayHello 方法，并返回一个名为 "Hello,

World!" 的字符串作为响应。

注意， @Controller 注解通常与 @RequestMapping 或 @GetMapping 等注解一起使用，以定义控制器类

和控制器方法的映射关系。



3.2 @RestController

@RestController 是一个 Spring Framework 中的注解，用于标识一个类是一个控制器，并且该控制器中的

方法返回的数据不是视图页面，而是直接作为响应内容发送到客户端，通常是以 JSON 格式返回数据。

与 @Controller 注解相比，@RestController 注解更加适合创建 RESTful 风格的控制器。使用

@RestController 注解的类通常处理 HTTP 请求并返回 JSON 或其他格式的响应数据，而不是视图页面。

@RestController 注解的主要特点包括：

import org.springframework.stereotype.Controller; 

import org.springframework.web.bind.annotation.GetMapping; 

import org.springframework.web.bind.annotation.RequestMapping; 



@Controller 

@RequestMapping("/hello") 

public class HelloController { 



 @GetMapping 

 public String sayHello() { 

   return "Hello, World!"; 

 } 



}

1. 自动转换为 JSON 或其他格式：使用 @RestController 注解的控制器方法可以直接返回数据对象，不需

要手动将其转换为 JSON 或其他格式。Spring 会自动将返回值转换为相应的格式，并将其作为响应内容

发送给客户端。

2. 简化代码：使用 @RestController 注解可以大大简化 RESTful Web 服务的开发，减少代码量和冗余操

作。开发者只需要关注数据模型和业务逻辑，而不需要关心请求映射和响应格式转换等细节。

3. 自动映射 URL：与 @Controller 注解类似，@RestController 注解也可以将请求映射到控制器的方法

上。开发者可以使用 @RequestMapping 或其他相关注解来指定请求的 URL 映射和请求方法。

需要注意的是，@RestController 注解通常用于创建 API 或 Web 服务，而不是用于构建完整的 Web 应用程

序。在这些场景下，使用 @RestController 可以简化开发过程，提高开发效率。

以下是一个使用 @RestController 注解的示例：

在上面的示例中， @RestController 注解将 UserController 类标记为一个 RESTful 控制器。

@RequestMapping("/api/users") 注解指定了该控制器处理的基础 URL 路径为 /api/users 。

在控制器类中，我们定义了一个名为 getUserById 的方法，该方法使用 @GetMapping("/{id}") 注解指

定处理 GET 请求，并使用 @PathVariable 注解将 URL 中的 {id} 参数绑定到方法的参数上。当用户访问

/api/users/{id} URL 时，Spring MVC 会自动调用 getUserById 方法，并返回一个字符串作为响应。

由于 @RestController 注解会自动将方法的返回值转换为 JSON 或其他适当的响应格式，因此我们只需要

返回一个简单的字符串作为响应。在这个示例中，我们返回了一个包含用户 ID 的字符串。



3.3 @RequestBody

@RequestBody 是 Spring 框架中的一个注解，主要用于将 HTTP 请求的内容（如 JSON、XML 等）绑定到

方法的参数上。具体来说，当一个方法参数上标注了 @RequestBody 注解时，Spring 会自动将请求体中的

数据解析为对应类型的对象，并将其传递给方法参数。这个过程是自动完成的，不需要手动解析请求体中的

数据。

@RequestBody主要特点包括：

import org.springframework.web.bind.annotation.GetMapping; 

import org.springframework.web.bind.annotation.RequestMapping; 

import org.springframework.web.bind.annotation.RestController; 



@RestController 

@RequestMapping("/api/users") 

public class UserController { 



 @GetMapping("/{id}") 

 public String getUserById(@PathVariable String id) { 

   // 在这里实现获取用户信息的逻辑... 

   return "User ID: " + id; 

 } 



}

剩余23页未读，继续阅读

评论收藏

内容反馈

孤蓬&听雨

粉丝: 6782
资源: 301

SpringBoot常用注解详解含使用示例（值得珍藏）

SpringBoot 中常用注解及各种注解作用

Spring Boot Mybatis使用详解含示例（值得珍藏）

springboot常用注解说明

springboot集成dubbo注解版的示例代码

springboot注解详解.pdf

Java第十五届蓝桥杯大赛软件JavaB组真题

SwitchHosts

安卓期末大作业（AndroidStudio开发），垃圾分类助手app，分为前台后台，代码有注释，均能正常运行

Notepad++安装包

2024北森能力测评题库.7z

微信小程序源码-合集1.rar

Java面试八股文2023最新版

Linux Centos7 升级最新版OpenSSH-9.6p1 有脚本（支持离线）

JDK1.8 windows 64位

ruoyi-vue-pro 芋道源码项目的表结构

ruoyi-vue-pro开发指南PDF下载

myeclipse 10.7.1 windows 安装包

ja-netfilter-all

2024最强Java面试八股文

教务管理系统——数据库课程设计mysql+java

Javaweb程序设计任务教程课后习题及答案 黑马程序员传智播客

jdk-11-windows-x64.zip

基于spring boot的小区物业管理系统源码+论文+答辩ppt

图书管理系统(Java实现）[附完整代码]

Postman9.12.2中文版

Java面试题大全（备战2021）

JimuReport v1.5.4版本发布(Windows免安装版)

ide-eval-resetter-2.3.5.jar,重新定义idea使用时间

80个java开发项目经验.pdf

基于springboot+vue实现的在线考试系统+源代码+文档

最新资源

Javaweb程序设计任务教程课后习题及答案黑马程序员传智播客