spring boot 扫描指定类

原创

mob64ca12ea8117 2024-12-19 10:18:04 ©著作权

文章标签 spring java ci 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12ea8117的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot 扫描指定类的机制

Spring Boot 是一个用于简化 Spring 应用开发的框架，它内置了很多方便的功能来快速构建生产级别的应用。在 Spring Boot 应用中，类的扫描是一项至关重要的功能，尤其是控制器、服务和存储库等组件的自动装配。

什么是类扫描？

类扫描是指框架在应用程序启动时自动搜索和识别指定的组件类。在 Spring 的上下文中，一个类如果被标记为特定的注解（比如 @Controller、@Service、@Repository 或 @Component），Spring 将会自动扫描这些类并将它们注册为 Spring 容器中的 Bean。

Spring Boot 中的类扫描

在 Spring Boot 中，类扫描是通过 @SpringBootApplication 注解实现的。这个注解实际上是一个组合注解，包含了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan。其中，@ComponentScan 负责扫描组件。

默认情况下，@ComponentScan 会从当前类所在的包及其子包中扫描所有被标注的组件类。但是有时我们希望扫描特定的包或类，这时就需要进行额外的配置。

自定义类扫描范围

我们可以在 @SpringBootApplication 注解中指定扫描的包，如下例所示：

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

@SpringBootApplication(scanBasePackages = {"com.example.service", "com.example.controller"})
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

在这个示例中，scanBasePackages 属性被用来指定 Spring Boot 应用所要扫描的包。我们将 com.example.service 和 com.example.controller 包添加到扫描范围内，从而确保这两个包中的组件会被 Spring 注册到容器中。

示例代码

下面是一个完整的 Spring Boot 应用示例，其中包括了一个控制器和一个服务类的定义：

package com.example.controller;

import com.example.service.MyService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @Autowired
    private MyService myService;

    @GetMapping("/hello")
    public String hello() {
        return myService.greet();
    }
}

package com.example.service;

import org.springframework.stereotype.Service;

@Service
public class MyService {

    public String greet() {
        return "Hello, Spring Boot!";
    }
}

应用结构

下面是应用的基本结构：

my-spring-boot-app
│
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── example
│   │   │           ├── controller
│   │   │           │   └── MyController.java
│   │   │           └── service
│   │   │               └── MyService.java
│   │   └── resources
│   │       └── application.properties
│   └── test
└── pom.xml

流程图

为了更好地理解 Spring Boot 的类扫描过程，我们可以用序列图表示，从启动应用到组件注册的过程：

sequenceDiagram
    participant User
    participant SpringApplication
    participant Context
    participant ComponentScanner

    User->>SpringApplication: 启动应用
    SpringApplication->>Context: 创建ApplicationContext
    Context->>ComponentScanner: 执行组件扫描
    ComponentScanner->>ComponentScanner: 查找包含注解的类
    ComponentScanner->>Context: 注册组件到容器
    Context->>SpringApplication: 完成初始化
    SpringApplication->>User: 应用启动成功