Spring Boot 的核心注解

🕗 发布于 2024-11-11 21:58 spring boot java c

一、引言

Spring Boot 作为一种流行的 Java 开发框架，以其简洁高效的开发方式受到广泛关注。其中，核心注解在 Spring Boot 应用的开发中起着至关重要的作用。理解这些注解的含义和用法，对于充分发挥 Spring Boot 的优势至关重要。本文将深入剖析 Spring Boot 的核心注解。

二、@SpringBootApplication 注解

（一）功能概述

组合注解
- @SpringBootApplication 是一个组合注解，它包含了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan 三个注解的功能。
配置应用
- 该注解用于标识一个 Spring Boot 应用的主配置类，告诉 Spring Boot 框架如何进行自动配置和组件扫描。

（二）用法详解

定义主类
- 在 Spring Boot 应用中，通常会创建一个主类，并使用 @SpringBootApplication 注解进行标识。这个主类通常包含一个 main 方法，用于启动应用程序。

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

@SpringBootApplication
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

自动配置
- @SpringBootApplication 注解会触发 Spring Boot 的自动配置机制。Spring Boot 会根据项目中引入的依赖和类路径中的内容，自动配置应用程序所需的各种组件和配置。
组件扫描
- 该注解还会启动组件扫描功能，自动扫描主类所在的包及其子包中的所有带有 @Component、@Service、@Repository、@Controller 等注解的类，并将它们注册为 Spring 容器中的 Bean。

三、@Configuration 注解

（一）功能介绍

定义配置类
- @Configuration 注解用于标识一个类为 Spring 的配置类。在配置类中，可以使用 @Bean 注解定义 Bean，并进行各种配置。
替代 XML 配置
- 随着 Spring 的发展，越来越多的开发者倾向于使用基于 Java 的配置方式，而 @Configuration 注解就是实现这种配置方式的关键。

（二）用法示例

定义 Bean
- 在配置类中，可以使用 @Bean 注解定义 Bean。例如，定义一个名为 myService 的 Bean：

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

@Configuration
public class AppConfig {

    @Bean
    public MyService myService() {
        return new MyServiceImpl();
    }
}

导入其他配置类
- 可以使用 @Import 注解导入其他配置类，实现配置的模块化。例如：

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

@Configuration
@Import(AnotherConfig.class)
public class MainConfig {
}

四、@EnableAutoConfiguration 注解

（一）自动配置原理

依赖分析
- @EnableAutoConfiguration 注解会根据项目中引入的依赖，自动配置应用程序所需的各种组件。例如，如果项目中引入了 Spring Data JPA 的依赖，Spring Boot 会自动配置数据库连接和 JPA 相关的组件。
排除特定自动配置
- 有时候，可能需要排除某些自动配置。可以使用 @SpringBootApplication 的 exclude 属性来排除特定的自动配置类。例如：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

（二）使用场景

快速开发
- 在快速开发过程中，@EnableAutoConfiguration 注解可以大大减少配置的工作量，提高开发效率。
集成第三方库
- 当集成第三方库时，Spring Boot 的自动配置功能可以自动配置与该库相关的组件，使得集成更加简单快捷。

五、@ComponentScan 注解

（一）扫描机制

包扫描
- @ComponentScan 注解用于指定 Spring 容器进行组件扫描的包路径。默认情况下，它会扫描主类所在的包及其子包中的所有带有 @Component、@Service、@Repository、@Controller 等注解的类，并将它们注册为 Spring 容器中的 Bean。
自定义扫描路径
- 可以通过 basePackages 属性指定自定义的扫描路径。例如：

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

@Configuration
@ComponentScan(basePackages = {"com.example.myapp.service", "com.example.myapp.repository"})
public class AppConfig {
}

（二）与其他注解的配合

与 @Controller、@Service、@Repository 等注解配合
- @ComponentScan 注解与这些注解配合使用，可以实现自动注册 Bean 的功能。例如，当一个类被标注为 @Service 时，@ComponentScan 注解会将其扫描并注册为 Spring 容器中的一个服务 Bean。
与 @Configuration 注解配合
- 在配置类中，通常会使用 @ComponentScan 注解来指定组件扫描的范围，以便将其他带有注解的类注册为 Bean。

六、@Autowired 注解

（一）依赖注入原理

自动装配
- @Autowired 注解用于实现依赖注入。当一个类的字段、构造函数或方法被标注为 @Autowired 时，Spring 容器会自动将匹配的 Bean 注入到该字段、构造函数或方法中。
按类型匹配
- Spring 容器会根据 Bean 的类型进行匹配。如果有多个相同类型的 Bean，还可以使用 @Qualifier 注解指定具体要注入的 Bean 的名称。

（二）用法示例

字段注入
- 在类的字段上使用 @Autowired 注解，实现字段的自动注入。例如：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    @Autowired
    private MyRepository myRepository;

    public void doSomething() {
        // 使用 myRepository
    }
}

构造函数注入
- 在构造函数上使用 @Autowired 注解，实现构造函数的自动注入。例如：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    private final MyRepository myRepository;

    @Autowired
    public MyService(MyRepository myRepository) {
        this.myRepository = myRepository;
    }

    public void doSomething() {
        // 使用 myRepository
    }
}

方法注入
- 在方法上使用 @Autowired 注解，实现方法的自动注入。例如：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    private MyRepository myRepository;

    @Autowired
    public void setMyRepository(MyRepository myRepository) {
        this.myRepository = myRepository;
    }

    public void doSomething() {
        // 使用 myRepository
    }
}

七、@Value 注解

（一）属性注入

从配置文件中获取值
- @Value 注解可以用于从配置文件（如 application.properties 或 application.yml）中获取属性值，并注入到字段、构造函数参数或方法参数中。
表达式支持
- 还可以使用 SpEL（Spring Expression Language）表达式来获取更复杂的值。例如：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    @Value("${my.property}")
    private String myProperty;

    @Value("#{T(java.lang.Math).random() * 100}")
    private int randomNumber;

    public void doSomething() {
        // 使用 myProperty 和 randomNumber
    }
}

（二）使用场景

动态配置
- 在需要根据不同环境进行动态配置的情况下，@Value 注解非常有用。可以将配置文件中的属性值注入到 Bean 中，实现灵活的配置。
参数化构造函数
- 可以在构造函数参数上使用 @Value 注解，实现参数化的构造函数，根据配置文件中的值来创建 Bean。

八、@RequestMapping 注解

（一）处理 HTTP 请求

映射请求路径
- @RequestMapping 注解用于将一个方法映射到特定的 HTTP 请求路径上。它可以用在类级别和方法级别上，用于定义控制器类和方法的请求映射。
支持多种 HTTP 方法
- 可以通过 value 属性指定请求路径，通过 method 属性指定支持的 HTTP 方法（如 GET、POST、PUT、DELETE 等）。

（二）用法示例

类级别映射
- 在控制器类上使用 @RequestMapping 注解，定义类级别的请求映射。例如：

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

@RestController
@RequestMapping("/api")
public class MyController {

    // 方法级别的请求映射将在此基础上进行
}

方法级别映射
- 在控制器方法上使用 @RequestMapping 注解，定义具体的请求映射。例如：

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class MyController {

    @RequestMapping(value = "/users", method = RequestMethod.GET)
    public List<User> getUsers() {
        // 返回用户列表
    }
}

九、@RestController 注解

（一）构建 RESTful API

标识控制器
- @RestController 注解是 @Controller 和 @ResponseBody 的组合注解。它用于标识一个控制器类，该类中的方法将返回 JSON、XML 或其他格式的响应数据，用于构建 RESTful API。
自动序列化响应数据
- 当一个方法被标注为 @RestController 注解的类中的方法返回一个对象时，Spring Boot 会自动将该对象序列化为 JSON 或其他格式的响应数据，并返回给客户端。

（二）与其他注解的配合

与 @RequestMapping 注解配合
- @RestController 注解通常与 @RequestMapping 注解一起使用，用于定义 RESTful API 的请求映射和响应数据。
与 @Service、@Repository 等注解配合
- 在构建复杂的应用程序时，@RestController 注解可以与其他注解（如 @Service、@Repository）配合使用，实现业务逻辑和数据访问的分离。

十、实际案例分析

（一）案例背景

假设有一个简单的博客应用，需要实现文章的管理功能，包括创建、读取、更新和删除文章。

（二）技术选型

使用 Spring Boot 构建应用
- 选择 Spring Boot 作为开发框架，利用其快速开发、自动配置等优势。
数据库选择
- 选择一个关系型数据库（如 MySQL）来存储文章数据。
前端框架选择
- 可以选择一个前端框架（如 Vue.js 或 React）来构建用户界面，与后端的 Spring Boot 应用进行交互。

（三）核心注解的应用

@SpringBootApplication 注解
- 在主类上使用 @SpringBootApplication 注解，标识这是一个 Spring Boot 应用的主配置类。

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

@SpringBootApplication
public class BlogApplication {

    public static void main(String[] args) {
        SpringApplication.run(BlogApplication.class, args);
    }
}

@Configuration 注解
- 创建一个配置类，使用 @Configuration 注解标识。在这个配置类中，可以定义 Bean 和进行其他配置。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.datasource.DriverManagerDataSource;

@Configuration
public class AppConfig {

    @Bean
    public JdbcTemplate jdbcTemplate() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/blogdb");
        dataSource.setUsername("root");
        dataSource.setPassword("password");
        return new JdbcTemplate(dataSource);
    }
}

@Autowired 注解
- 在服务类和控制器类中，使用 @Autowired 注解进行依赖注入。例如，在文章服务类中注入 JdbcTemplate：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class ArticleService {

    private final JdbcTemplate jdbcTemplate;

    @Autowired
    public ArticleService(JdbcTemplate jdbcTemplate) {
        this.jdbcTemplate = jdbcTemplate;
    }

    public void createArticle(Article article) {
        // 使用 jdbcTemplate 执行数据库插入操作
    }

    public Article getArticleById(int id) {
        // 使用 jdbcTemplate 执行数据库查询操作
    }

    // 其他方法
}

@RequestMapping 注解和 @RestController 注解
- 在控制器类中，使用 @RequestMapping 注解和 @RestController 注解定义 RESTful API 的请求映射。例如：

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/articles")
public class ArticleController {

    private final ArticleService articleService;

    @Autowired
    public ArticleController(ArticleService articleService) {
        this.articleService = articleService;
    }

    @RequestMapping(method = RequestMethod.POST)
    public void createArticle(Article article) {
        articleService.createArticle(article);
    }

    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    public Article getArticleById(@PathVariable int id) {
        return articleService.getArticleById(id);
    }

    // 其他方法
}

（四）效果评估

开发效率
- 通过使用 Spring Boot 的核心注解，大大提高了开发效率。自动配置和依赖注入功能减少了手动配置的工作量，使得开发过程更加快捷。
代码可读性和可维护性
- 注解的使用使得代码更加清晰易读，易于理解和维护。例如，通过 @RequestMapping 注解和 @RestController 注解，可以很容易地看出控制器类的作用和请求映射关系。
功能实现
- 成功实现了博客应用的文章管理功能，包括创建、读取、更新和删除文章。通过 RESTful API 的方式，使得前端可以方便地与后端进行交互。

十一、总结

Spring Boot 的核心注解在开发过程中起着至关重要的作用。@SpringBootApplication、@Configuration、@EnableAutoConfiguration、@ComponentScan、@Autowired、@Value、@RequestMapping 和 @RestController 等注解分别在应用的配置、自动配置、组件扫描、依赖注入、属性注入、请求映射和构建 RESTful API 等方面发挥着重要作用。通过深入理解这些注解的功能和用法，并结合实际案例进行应用，可以提高开发效率，增强代码的可读性和可维护性，实现高效的 Java 开发。

原文地址：https://blog.csdn.net/jam_yin/article/details/143666933

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：Java 上机实践2（基础数据类型与数组）
下一篇：「QT」几何数据类之 QSize 尺寸类

【软件工程】耦合
耦合性指软件结构中模块相互紧密连接的紧密程度。耦合性由高到低分别为：内容耦合、公共耦合、外部耦合、控制耦合、标记耦合、数据耦合、非直接耦合。
阅读更多2024-11-13
【How AI Works】读书笔记1 前言
开头部分说明:本书没有从复杂的数学上讲解AI其次介绍了AI的发展历史,以1980s为节点,经过中间的几十年,定义出了人工智能的目标:用机器模仿智能行为机器学习的分支学科:深度学习暂且可以认为深度学习,
阅读更多2024-11-13
第八章利用css制作导航菜单
nav>标签是HIML5新增文档结构标签，用于标记导航栏，以便后续与网站的其他内容整合，所以<nav>标签在页面上创建导航栏菜单区域。
阅读更多2024-11-13
PostgreSql - 字符串函数
PostgreSql - 字符串函数
阅读更多2024-11-13
[241108] AMD 开源首批 10 亿参数语言模型：AMD OLMo | Xfce 4.20 Pre1发布
- AMD 开源首批 10 亿参数语言模型：AMD OLMo- Xfce 4.20 Pre1发布
阅读更多2024-11-13
利用滑动窗口解题
本篇文章还是以先介绍题目意思，然后再解释以下算法原理，最后再是给出代码的实现。但是与上篇文章不同的是，这篇文章回给出为什么要用滑动窗口解题，怎么想到的，以及滑动窗口的原理到底是什么。所以前两题会以最详
阅读更多2024-11-13
【OceanBase 诊断调优】—— OceanBase 数据库统计信息被禁用，状态为 broken 的原因和解决方法
因为人为因素导致部分统计信息函数未安装，自动统计信息触发执行长期失败。重新安装统计信息相关函数后，发现仍然无法正常自动统计信息收集，统计信息状态为 broken。
阅读更多2024-11-13
hbase集成phoenix
hbase集成phoenix
阅读更多2024-11-13
./mysqld: error while loading shared libraries: libaio.so.1: cannot open sha
使用离线方式安装：rpm -ivh --nodeps mysql* ，执行 systemctl start mysqld.service发现启动不了，通过vi /var/log/mysql.log看到
阅读更多2024-11-13
Jtti：服务器为什么要做raid？原因是什么？
不同的RAID级别(如RAID 1、RAID 5、RAID 6等)通过将数据复制或分布到多个硬盘上，当其中一个硬盘发生故障时，系统仍然能够从其他硬盘上恢复数据，从而避免数据丢失。RAID 10(镜像+
阅读更多2024-11-13

Spring Boot 的核心注解

一、引言

二、@SpringBootApplication 注解

（一）功能概述

（二）用法详解

三、@Configuration 注解

（一）功能介绍

（二）用法示例

四、@EnableAutoConfiguration 注解

（一）自动配置原理

（二）使用场景

五、@ComponentScan 注解

（一）扫描机制

（二）与其他注解的配合

六、@Autowired 注解

（一）依赖注入原理

（二）用法示例

七、@Value 注解

（一）属性注入

（二）使用场景

八、@RequestMapping 注解

（一）处理 HTTP 请求

（二）用法示例

九、@RestController 注解

（一）构建 RESTful API

（二）与其他注解的配合

十、实际案例分析

（一）案例背景

（二）技术选型

（三）核心注解的应用

（四）效果评估

十一、总结

相关文章