Spring Boot 全面指南

╰つ゛木槿2024-10-26 15:51

Spring Boot 是一个用于简化 Spring 应用程序开发的框架，它通过自动配置和约定优于配置的方式，使得开发者能够更快速地构建生产级别的应用。以下是对 Spring Boot 各个知识点的详细阐述。

1. 什么是 Spring Boot

Spring Boot 是一个开源 Java 框架，旨在简化使用 Spring Framework 开发独立、生产级应用的过程。它通过自动配置、约定优于配置的理念，以及内嵌的服务器等特性，让开发者能够快速上手和部署应用。

1.1 主要特性

  • 自动配置：根据添加的依赖自动配置 Spring 应用，减少手动配置。
  • 内嵌服务器：默认支持 Tomcat、Jetty 和 Undertow，无需额外的应用服务器。
  • 起步依赖：使用起步依赖（Starters）简化依赖管理，减少版本冲突。
  • Actuator：用于监控和管理 Spring Boot 应用，提供多种内置监控功能。

2. 项目结构

2.1 Maven 项目结构

一个标准的 Spring Boot 项目通常遵循以下结构：

my-spring-boot-app/
│
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/example/demo/
│   │   │       ├── DemoApplication.java
│   │   │       └── controller/
│   │   │       └── service/
│   │   │       └── repository/
│   │   └── resources/
│   │       ├── application.properties
│   │       └── static/
│   └── test/
│       └── java/
│           └── com/example/demo/
├── pom.xml

2.2 关键文件

  • DemoApplication.java ：主应用类，包含 @SpringBootApplication 注解，作为应用的入口点。
  • application.properties：应用的配置文件，用于定义各类属性。
  • controller/、service/、repository/：分别用于放置控制器、服务层和数据访问层的类。

3. 创建 Spring Boot 应用

3.1 使用 Spring Initializr

Spring Initializr 是一个便捷的工具，用于生成 Spring Boot 项目骨架。

  1. 访问 Spring Initializr
  2. 填写项目元数据（如 Group、Artifact 等）。
  3. 选择项目类型（Maven/Gradle）。
  4. 选择 Java 版本。
  5. 添加所需依赖（如 Spring Web、Spring Data JPA 等）。
  6. 点击 "Generate" 下载 ZIP 文件，解压后在 IDE 中打开。

3.2 使用 IDE 创建

在 IDE（如 IntelliJ IDEA 或 Eclipse）中，你也可以通过向导创建 Spring Boot 项目。通常会提供选择依赖和配置的选项。

4. 配置 Spring Boot

4.1 application.properties 和 application.yml

Spring Boot 支持两种主要的配置文件格式：.properties 和 .yml。你可以根据自己的习惯选择。

示例：application.properties
properties 复制代码 
server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=secret
logging.level.org.springframework=DEBUG
示例：application.yml
yaml 复制代码 
server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: secret

logging:
  level:
    org.springframework: DEBUG

4.2 轮廓配置文件

Spring Boot 允许使用不同的配置文件来支持不同的环境。你可以创建多个配置文件，如 application-dev.properties 和 application-prod.properties，通过 spring.profiles.active 属性来选择当前环境：

properties 复制代码 
spring.profiles.active=dev

4.3 自定义配置属性

你可以自定义属性，并通过 @ConfigurationProperties 注解进行绑定。

示例
java 复制代码 
@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    private String name;
    private String version;

    // getters and setters
}

4.4 访问配置属性

通过 @Value 注解或者 @ConfigurationProperties 类来访问配置属性。

java 复制代码 
@Service
public class MyService {
    @Value("${app.name}")
    private String appName;

    public void printAppName() {
        System.out.println("Application Name: " + appName);
    }
}

5. 自动装配

5.1 了解自动装配

通过 @EnableAutoConfiguration 注解，Spring Boot 会根据应用的依赖自动配置所需的 Beans。这大大减少了开发者的手动配置工作。

5.2 条件注解

Spring Boot 提供了一些条件注解来控制自动装配的行为：

  • @ConditionalOnClass：只有在类路径下存在特定类时，才会装配 Bean。
  • @ConditionalOnMissingClass：只有在类路径下不存在特定类时，才会装配 Bean。
  • @ConditionalOnBean：只有在容器中存在特定 Bean 时，才会装配 Bean。
  • @ConditionalOnProperty：根据配置文件中的属性值来决定是否装配 Bean。
示例
java 复制代码 
@Bean
@ConditionalOnProperty(name = "my.feature.enabled", havingValue = "true")
public MyFeature myFeature() {
    return new MyFeature();
}

6. 依赖管理

6.1 使用 Starter 依赖

Spring Boot 提供了众多 Starter 依赖，简化了 Maven 项目的依赖管理。

常见的 Starter 依赖
  • spring-boot-starter-web：用于构建 Web 应用，包括 Spring MVC 和嵌入式 Tomcat。
  • spring-boot-starter-data-jpa：用于 Spring Data JPA 支持。
  • spring-boot-starter-security：用于安全功能。
  • spring-boot-starter-actuator：用于监控和管理 Spring Boot 应用。
示例：Maven 依赖
xml 复制代码 
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

6.2 管理版本

在 pom.xml 中使用 dependencyManagement 元素来管理依赖版本。

xml 复制代码 
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>3.0.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

7. 创建 RESTful API

7.1 使用 Controller

创建 RESTful API 主要通过 @RestController 注解来定义控制器类。

示例：基本 REST Controller
java 复制代码 
@RestController
@RequestMapping("/api")
public class MyController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}

7.2 请求参数和路径变量

使用 @RequestParam 和 @PathVariable 注解来接收请求参数和路径变量。

示例：路径变量和请求参数
java 复制代码 
@GetMapping("/greet/{name}")
public String greet(@PathVariable String name, @RequestParam(required = false) String message) {
    return "Hello, " + name + "!" + (message != null ? " " + message : "");
}

7.3 处理 POST 请求

java 复制代码 
@PostMapping("/users")
public User createUser(@RequestBody User user) {
    return userService.createUser(user);
}

7.4 处理错误

使用 @ControllerAdvice 和 @ExceptionHandler 处理全局异常。

java 复制代码 
@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<String> handleUserNotFound(UserNotFoundException e) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(e.getMessage());
    }
}

8. 数据访问

8.1 Spring Data JPA

8.1.1 创建实体类
java 复制代码 
@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String username;
    private String email;

    // Getters and Setters
}
8.1.2 创建 Repository 接口

创建一个接口，继承 JpaRepository 或 CrudRepository，以获得基本的 CRUD 操作。

java 复制代码 
import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository<User, Long> {
    // 可以自定义查询方法
    User findByUsername(String username);
}

8.2 服务层

服务层用于封装业务逻辑，并与数据访问层进行交互。

示例：UserService 类
java 复制代码 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

    public User createUser(User user) {
        return userRepository.save(user);
    }

    public List<User> getAllUsers() {
        return userRepository.findAll();
    }

    public User getUserById(Long id) {
        return userRepository.findById(id)
                .orElseThrow(() -> new UserNotFoundException("User not found with id: " + id));
    }

    public void deleteUser(Long id) {
        userRepository.deleteById(id);
    }
}

8.3 事务管理

Spring Boot 提供了简易的事务管理功能。可以在服务层使用 @Transactional 注解来管理事务。

示例
java 复制代码 
import org.springframework.transaction.annotation.Transactional;

@Service
public class UserService {

    // ...

    @Transactional
    public User updateUser(Long id, User userDetails) {
        User user = getUserById(id);
        user.setUsername(userDetails.getUsername());
        user.setEmail(userDetails.getEmail());
        return userRepository.save(user);
    }
}

9. 安全管理

9.1 Spring Security 集成

Spring Boot 可以与 Spring Security 集成，以保护应用和管理用户认证。

9.1.1 添加依赖

在 pom.xml 中添加 Spring Security 依赖：

xml 复制代码 
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>
9.1.2 基本安全配置

创建一个配置类来定义安全策略。

java 复制代码 
import org.springframework.context.annotation.Bean;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .antMatchers("/api/public/**").permitAll()  // 公开 API
            .anyRequest().authenticated()  // 其他请求需要认证
            .and()
            .httpBasic();  // 使用基本认证
    }
}

9.2 自定义用户细节服务

实现 UserDetailsService 接口来加载用户的详细信息。

java 复制代码 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.stereotype.Service;

@Service
public class CustomUserDetailsService implements UserDetailsService {

    @Autowired
    private UserRepository userRepository;

    @Override
    public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
        User user = userRepository.findByUsername(username);
        if (user == null) {
            throw new UsernameNotFoundException("User not found: " + username);
        }
        return new org.springframework.security.core.userdetails.User(user.getUsername(), user.getPassword(), new ArrayList<>());
    }
}

10. 监控与管理

10.1 使用 Spring Boot Actuator

Spring Boot Actuator 提供了用于监控和管理应用的功能。

10.1.1 添加依赖

在 pom.xml 中添加 Actuator 依赖：

xml 复制代码 
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
10.1.2 配置 Actuator

可以在 application.properties 中配置 Actuator 的端点：

properties 复制代码 
management.endpoints.web.exposure.include=*
management.endpoint.health.show-details=always

10.2 访问 Actuator 端点

在默认情况下，Actuator 端点在 /actuator 下可访问。常用的端点包括：

  • /actuator/health：查看应用的健康状况。
  • /actuator/info：查看应用的信息，如版本、描述等。

11. 测试

11.1 单元测试

Spring Boot 提供了很好的测试支持，可以使用 @SpringBootTest 进行集成测试。

示例：UserService 测试
java 复制代码 
import static org.mockito.Mockito.*;
import static org.junit.jupiter.api.Assertions.*;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

public class UserServiceTest {

    @InjectMocks
    private UserService userService;

    @Mock
    private UserRepository userRepository;

    private User user;

    @BeforeEach
    public void setUp() {
        MockitoAnnotations.openMocks(this);
        user = new User();
        user.setId(1L);
        user.setUsername("testuser");
        user.setEmail("test@example.com");
    }

    @Test
    public void testCreateUser() {
        when(userRepository.save(any(User.class))).thenReturn(user);

        User createdUser = userService.createUser(user);

        assertEquals("testuser", createdUser.getUsername());
        verify(userRepository, times(1)).save(user);
    }
}

11.2 MockMvc 进行 API 测试

可以使用 MockMvc 对 Controller 进行测试。

示例
java 复制代码 
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

@SpringBootTest
@AutoConfigureMockMvc
public class MyControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testHelloEndpoint() throws Exception {
        mockMvc.perform(get("/api/hello"))
                .andExpect(status().isOk())
                .andExpect(content().string("Hello, World!"));
    }
}

12. 部署

12.1 打包应用

使用 Maven 打包应用：

bash 复制代码 
mvn clean package

会在 target 目录下生成一个可执行的 JAR 文件。

12.2 运行应用

通过命令行运行生成的 JAR 文件：

bash 复制代码 
java -jar target/my-spring-boot-app-0.0.1-SNAPSHOT.jar

12.3 部署到云平台

Spring Boot 应用可以轻松部署到各种云平台，如 AWS、Heroku、Azure 等。大多数云平台提供简便的流程来支持 Spring Boot 应用的部署。

总结

Spring Boot 是一个强大的工具，极大地简化了 Java 应用的开发和部署过程。通过上述概述，你应该能理解其基本概念、创建和配置应用的步骤、以及如何实现常见功能。建议深入阅读官方文档，以获得更全面的了解和最新的信息。

相关推荐
ProtonBase几秒前
如何从 0 到 1 ，打造全新一代分布式数据架构
java·网络·数据库·数据仓库·分布式·云原生·架构
乐之者v7 分钟前
leetCode43.字符串相乘
java·数据结构·算法
suweijie7683 小时前
SpringCloudAlibaba | Sentinel从基础到进阶
java·大数据·sentinel
公贵买其鹿4 小时前
List深拷贝后,数据还是被串改
java
向前看-7 小时前
验证码机制
前端·后端
xlsw_7 小时前
java全栈day20--Web后端实战(Mybatis基础2)
java·开发语言·mybatis
神仙别闹8 小时前
基于java的改良版超级玛丽小游戏
java
黄油饼卷咖喱鸡就味增汤拌孜然羊肉炒饭8 小时前
SpringBoot如何实现缓存预热？
java·spring boot·spring·缓存·程序员
暮湫9 小时前
泛型（2）
java
超爱吃士力架9 小时前
邀请逻辑
java·linux·后端
热门推荐
01〔AI 绘画〕Stable Diffusion 之 解决绘制多人或面部很小的人物时面部崩坏问题 篇02ARM学习（31）编译器对overlay方式的支持03玄机平台应急响应—webshell查杀04DisplayPort AltMode On Type-c协议_Ver2.0(学习笔记)05校验 GPT-4 真实性的三个经典问题：快速区分 GPT-3.5 与 GPT-4，并提供免费测试网站06Docker 夺命连环 15 问076个主流的工业3D管道设计软件08基于大语言模型（LLM）的合成数据生成、策展和评估的综述09(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明10树莓派 5 AI 套件（Hailo-8L）使用教程