Spring Boot应用开发实战:从入门到精通
一、Spring Boot 简介
1.1 什么是 Spring Boot?
Spring Boot 是一个开源框架,旨在简化新 Spring 应用的初始搭建以及开发过程。它构建在 Spring 框架之上,利用了 Spring 的核心特性,如依赖注入(Dependency Injection)、面向切面编程(Aspect Oriented Programming)、数据访问(Data Access)等,并通过自动化配置(Auto-configuration)和约定优于配置(Convention over Configuration)的方式,为开发者提供了一种简单、快速、高效的方式来构建 Java 应用程序。
1.2 Spring Boot 的特点和优势
内嵌服务器:Spring Boot 内置了 Tomcat、Jetty、Undertow 等服务器,开发者无需单独安装和配置外部服务器,即可将应用程序打包成可执行的 JAR 文件直接运行,这极大地简化了部署流程,方便在不同环境中快速启动应用。
快速启动:自动配置了大部分的常规应用程序配置,减少了开发人员手动配置的工作量,使得应用能够快速启动和运行,提高开发效率,让开发者可以迅速看到代码的运行效果,加快开发迭代速度。
自动装配:Spring Boot 能够根据项目中添加的 jar 依赖自动配置 Spring 应用。例如,当添加了 Spring Web MVC 依赖时,它会自动配置模板引擎、静态资源支持等,大大简化了应用开发过程,减少了开发人员的工作量,同时也降低了配置出错的概率。
大量 “Starters”:提供了一系列的起步依赖(starter),这些依赖是预定义的一组库,可以简化项目的构建过程。开发者只需在 pom.xml 中添加相应的起步依赖,即可快速引入常见的第三方库和框架,无需手动管理复杂的依赖关系,避免了版本冲突等问题。
提供监控和安全功能:Spring Boot Actuator 模块提供了生产级的服务,如健康检查、审计、统计和 HTTP 追踪等功能,方便运维人员对应用进行监控和管理,及时发现和解决问题;同时,也提供了基本的安全特性,保障应用的安全性,开发者可以方便地进行安全配置,防止常见的安全漏洞。
1.3 Spring Boot 的应用场景
微服务架构:Spring Boot 适用于构建和部署微服务,它可以快速创建独立的、可独立部署的微服务应用程序,每个微服务都可以有自己独立的运行环境和资源,便于团队进行开发、维护和扩展,通过与 Spring Cloud 等工具的结合,能够轻松实现服务注册与发现、负载均衡、断路器等微服务架构中的关键功能。
Web 应用开发:支持开发各种 Web 应用程序,无论是传统的多页应用程序、单页应用程序,还是网站等,都能提供很好的支持。其简洁的配置和强大的功能,使得开发 Web 应用变得更加高效,例如可以方便地处理 HTTP 请求、响应,进行数据的绑定和验证等,并且可以与前端框架(如 Vue.js、React 等)无缝集成,共同构建完整的 Web 应用系统。
任务调度:在一些需要定时执行任务的场景中,如数据备份、报表生成、定时清理缓存等,Spring Boot 提供了简单易用的任务调度功能。通过注解和配置,可以轻松地实现任务的定时触发,并且可以灵活地设置任务的执行时间、频率等参数,确保任务按时准确地执行,提高系统的自动化程度和管理效率。
数据处理:简化了与数据库和其他数据源的集成,通过自动配置和起步依赖简化了数据访问层的开发。无论是关系型数据库(如 MySQL、Oracle 等)还是非关系型数据库(如 MongoDB、Redis 等),都可以方便地进行连接和操作,提供了统一的编程模型,使得数据的读写变得更加便捷,提高了数据处理的效率,满足不同应用场景对数据存储和查询的需求。
二、开发环境准备
2.1 JDK 安装与配置
JDK(Java Development Kit)是开发 Java 应用程序的基础。你可以从 Oracle 官网(https://www.oracle.com/java/technologies/downloads/)或 OpenJDK 网站(https://jdk.java.net/)下载适合你操作系统的 JDK 版本,建议选择长期支持(LTS)版本,如 JDK 8 或 JDK 11。
安装过程通常是简单的双击安装程序,按照提示完成安装即可。安装完成后,需要配置环境变量:
新建系统环境变量:JAVA_HOME,其值为 JDK 的安装路径,例如在 Windows 系统中,如果 JDK 安装在C:\Program Files\Java\jdk1.8.0_301,则JAVA_HOME的值应为C:\Program Files\Java\jdk1.8.0_301。
编辑系统环境变量:Path,在其中添加%JAVA_HOME%\bin和%JAVA_HOME%\jre\bin(确保bin目录在Path中存在,以便在命令行中能直接使用java和javac等命令)。
配置完成后,打开命令提示符(Windows)或终端(Mac/Linux),输入java -version和javac -version,如果能正确显示 JDK 的版本信息,则说明 JDK 安装和配置成功。
2.2 集成开发环境(IDE)选择与配置
在开发 Spring Boot 应用时,常用的 IDE 有 Eclipse、IntelliJ IDEA 等。其中,IntelliJ IDEA 对 Spring Boot 有更好的支持,提供了丰富的插件和智能提示功能,能极大地提高开发效率,因此推荐使用。
你可以从 JetBrains 官网(https://www.jetbrains.com/idea/download/)下载 IntelliJ IDEA 的 Community(社区版)或 Ultimate(旗舰版)版本,社区版对于大多数 Spring Boot 开发场景已经足够使用。安装过程同样是按照安装向导的提示完成即可。
安装完成后,打开 IntelliJ IDEA,创建一个新的 Spring Boot 项目:
选择File -> New -> Project,在弹出的窗口中选择Spring Initializr。
填写项目的基本信息,如Group(通常为公司域名的反写)、Artifact(项目名称)、Version(项目版本)等。
在Dependencies中选择项目所需的依赖项,例如Spring Web(用于开发 Web 应用)、Spring Data JPA(用于数据库访问)、MySQL Driver(如果使用 MySQL 数据库)等。选择完成后,点击Finish,IntelliJ IDEA 会自动下载所需的依赖并构建项目结构。
一个典型的 Spring Boot 项目结构如下:
src/main/java:存放项目的 Java 源代码。
src/main/resources:存放项目的配置文件、静态资源文件等,如application.properties或application.yml用于配置应用的各种属性。
src/test/java:存放项目的测试代码。
pom.xml(如果使用 Maven 构建项目):用于管理项目的依赖关系和构建配置。
2.3 Maven 或 Gradle 安装与配置
Maven 和 Gradle 都是常用的项目构建工具,用于管理项目的依赖、编译、测试和打包等过程。
Maven:
在项目中,Maven 使用pom.xml文件来管理依赖和构建配置。以下是一个简单的pom.xml示例:
从 Apache Maven 官网(https://maven.apache.org/download.cgi)下载 Maven 的二进制压缩包,解压到你选择的目录,例如C:\apache-maven-3.8.6(Windows)或/usr/local/apache-maven-3.8.6(Linux/Mac)。
配置环境变量:新建MAVEN_HOME,其值为 Maven 的解压目录;编辑Path,添加%MAVEN_HOME%\bin。
在命令行中输入mvn -v,如果能正确显示 Maven 的版本信息,则说明安装成功。
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.example</groupId> <artifactId>my-spring-boot-app</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>My Spring Boot App</name> <description>Demo project for Spring Boot</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.7.4</version> <relativePath/> <!-- lookup parent from repository --> </parent> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project> |
Gradle:
在项目中,Gradle 使用build.gradle文件来管理依赖和构建配置。以下是一个简单的build.gradle示例:
从 Gradle 官网(Gradle | Releases)下载 Gradle 的二进制压缩包,解压到合适的目录,例如C:\gradle-7.5.1(Windows)或/usr/local/gradle-7.5.1(Linux/Mac)。
配置环境变量:新建GRADLE_HOME,其值为 Gradle 的解压目录;编辑Path,添加%GRADLE_HOME%\bin。
在命令行中输入gradle -v,如果能正确显示 Gradle 的版本信息,则说明安装成功。
plugins { id 'org.springframework.boot' version '2.7.4' id 'io.spring.dependency-management' version '1.0.15.RELEASE' id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '1.8' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-web' } test { useJUnitPlatform() } |
无论是使用 Maven 还是 Gradle,它们都能帮助你更方便地管理项目的依赖和构建过程,确保项目的可重复性和稳定性。在实际开发中,你可以根据团队的喜好和项目的需求选择使用其中一种构建工具。
三、项目创建与结构解析
3.1 使用 Spring Initializr 快速生成项目
Spring Initializr 是一个强大的工具,能帮助我们快速搭建 Spring Boot 项目的基础框架。
你可以通过访问官网(https://start.spring.io/)来创建项目。在网页上,你需要填写一些关键信息:
Group:通常是公司域名的反写,例如com.example,它是项目的组织标识,用于区分不同的项目组或公司的项目,在 Maven 或 Gradle 构建项目时,会作为项目的组 ID,用于管理项目的依赖和资源。
Artifact:这是项目的名称,比如my-spring-boot-app,它在项目构建后会作为生成的 JAR 或 WAR 文件的名称,也是项目在代码仓库中的目录名称,同时也是项目的主要标识之一。
Version:项目的版本号,如0.0.1-SNAPSHOT,遵循语义化版本规范,用于标识项目的不同版本,方便团队协作开发和版本管理,SNAPSHOT 表示这是一个开发中的版本,不稳定,后续可以发布正式版本如0.0.1、0.1.0等。
Packaging:可以选择Jar或War,一般来说,如果是独立的应用程序,选择Jar打包方式,方便在任何支持 Java 的环境中运行;如果是要部署到 Web 容器中,则可以选择War。
Java Version:根据项目需求选择合适的 Java 版本,如8、11、17等,建议选择与团队技术栈和项目运行环境兼容的版本,以确保项目的稳定性和性能。
在 “Dependencies” 部分,你可以选择项目所需的依赖项。例如:
Spring Web:如果要开发 Web 应用程序,这是必备的依赖。它提供了构建 RESTful 应用程序的能力,包括处理 HTTP 请求、响应,支持多种数据格式(如 JSON、XML)的解析和返回,使用 Spring MVC 框架,并默认使用 Apache Tomcat 作为嵌入式容器,方便开发者快速搭建 Web 服务,无需复杂的配置即可处理各种 HTTP 操作,如@GetMapping、@PostMapping等注解用于定义 RESTful 接口。
Spring Data JPA:用于简化数据库访问层的开发,尤其是在使用关系型数据库时。它基于 JPA(Java Persistence API)规范,提供了一种统一的方式来操作数据库,支持各种常见的数据库操作,如查询、插入、更新、删除等,通过简单的接口定义和方法命名约定,就能自动生成相应的 SQL 语句,大大减少了编写 SQL 的工作量,并且与 Spring Boot 的自动配置机制无缝集成,方便连接和操作数据库,如JpaRepository接口可以快速实现数据访问层的基本功能。
MySQL Driver:如果项目使用 MySQL 数据库,就需要添加这个依赖,它提供了 Java 应用程序与 MySQL 数据库进行通信的驱动程序,使得应用能够连接到 MySQL 数据库服务器,执行各种数据库操作,如com.mysql.cj.jdbc.Driver是 MySQL 驱动的主要类,在配置数据库连接时需要指定。
填写完这些信息后,点击 “Generate” 按钮,Spring Initializr 会生成一个包含项目基础结构的压缩包,你可以将其下载并解压到本地目录。
另外,许多 IDE(如 IntelliJ IDEA、Eclipse 等)也集成了 Spring Initializr 插件,以 IntelliJ IDEA 为例:
选择File -> New -> Project,在弹出的窗口中选择Spring Initializr。
接下来的步骤与在官网创建项目类似,填写项目的基本信息和选择依赖项。
完成后,点击Finish,IntelliJ IDEA 会自动下载所需的依赖并构建项目结构,你可以直接在 IDE 中开始开发,无需手动导入项目,方便快捷,提高开发效率。
3.2 项目结构解析
生成的 Spring Boot 项目具有清晰的目录结构,有助于组织和管理代码。
src/main/java:这是项目的源代码目录,存放所有的 Java 类文件。通常,会按照功能模块进行包的划分,例如com.example.controller用于存放控制器类,处理 HTTP 请求并返回响应;com.example.service用于存放业务逻辑类,实现具体的业务功能,调用数据访问层获取和处理数据;com.example.entity用于存放实体类,与数据库表一一对应,用于数据的持久化和传输;com.example.repository用于存放数据访问接口,通过继承JpaRepository等接口,实现对数据库的基本操作。
src/main/resources:这是配置文件和资源文件的目录。
application.properties或application.yml:这是 Spring Boot 应用的主要配置文件,可以配置各种属性,如服务器端口(server.port=8080)、数据库连接信息(spring.datasource.url=jdbc:mysql://localhost:3306/mydb,spring.datasource.username=root,spring.datasource.password=123456等)、日志级别(logging.level.com.example=DEBUG)等。.properties文件使用键值对的形式进行配置,简单直观;.yml文件则使用缩进和冒号的方式,具有更好的层次性和可读性,适用于复杂的配置场景。
static:用于存放静态资源文件,如图片、CSS、JavaScript 文件等,这些文件可以直接被浏览器访问,用于构建 Web 应用的前端界面,例如static/css/style.css可以用于定义页面的样式,static/js/script.js可以用于实现前端的交互逻辑。
templates:如果使用模板引擎(如 Thymeleaf、FreeMarker 等),则存放模板文件,用于生成动态的 HTML 页面,例如templates/index.html可以是一个 Thymeleaf 模板,通过在模板中使用表达式和标签,结合后端传递的数据,生成最终呈现给用户的 HTML 页面,实现页面的动态展示和数据填充。
src/test/java:这是测试代码的目录,用于存放单元测试和集成测试类。可以使用 JUnit、TestNG 等测试框架编写测试方法,对业务逻辑、数据访问层等进行测试,确保代码的正确性和稳定性。例如,com.example.controller.TestController类可以使用@Test注解编写测试方法,模拟 HTTP 请求,验证控制器的行为是否符合预期,如测试GET请求是否返回正确的数据,POST请求是否成功保存数据等,通过自动化测试,可以及时发现代码中的问题,提高代码质量,减少潜在的缺陷。
此外,项目根目录下还可能存在其他文件:
pom.xml(如果使用 Maven 构建项目):这是 Maven 的项目对象模型文件,用于管理项目的依赖关系、构建配置、插件等信息。在dependencies标签中可以添加项目所需的各种依赖,如<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency>表示引入 Spring Web 依赖;在build标签中可以配置项目的构建方式,如<plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins>用于将项目打包成可执行的 JAR 文件,并支持在命令行中运行项目,通过修改pom.xml文件,可以灵活地管理项目的构建和依赖,确保项目的正常运行和开发过程的顺利进行。
.gitignore:用于指定哪些文件或目录应该被 Git 版本控制系统忽略,例如target/目录(存放编译后的文件)、.idea/目录(IntelliJ IDEA 的配置文件)等,避免将不必要的文件提交到版本库中,保持版本库的整洁和清晰,方便团队协作开发,同时也减少了版本冲突的可能性。
README.md:这是项目的说明文件,通常用于介绍项目的功能、使用方法、依赖关系、部署步骤等信息,方便其他开发者了解和使用项目,是项目开源或团队协作开发中非常重要的文档,有助于提高项目的可读性和可维护性,例如可以在README.md中详细说明如何启动项目、如何配置数据库连接、项目的主要功能模块和接口等内容,让其他开发者能够快速上手项目的开发和部署。
四、配置管理
4.1 配置文件的使用
在 Spring Boot 中,常见的配置文件有application.properties和application.yml(或application.yaml),它们用于配置应用程序的各种属性。
application.properties:采用简单的键值对格式,每个属性以key=value的形式定义,适合配置简单或扁平化的属性。例如:
server.port=8080 spring.datasource.url=jdbc:mysql://localhost:3306/mydb spring.datasource.username=root spring.datasource.password=123456 logging.level.com.example=DEBUG |
application.yml:使用 YAML(YAML Ain't Markup Language)格式,支持嵌套和层次化的配置,更适合处理复杂或有层级结构的配置,通过换行和缩进来递进,使用:来进行赋值(冒号后要空一格),格式要求比较严格,有明显的层次感。例如:
server: port: 8080 spring: datasource: url: jdbc:mysql://localhost:3306/mydb username: root password: 123456 logging: level: com.example: DEBUG |
在代码中读取配置属性有多种方式,常用的注解有@Value和@ConfigurationProperties:
@Value注解:用于将配置文件中的单个属性值注入到一个 bean 中。例如,如果在配置文件中有my.property=hello,可以在 bean 中这样使用:
@Component public class MyBean { @Value("${my.property}") private String myProperty; // getter and setter } |
@ConfigurationProperties注解:可用于将配置文件中的一组相关属性值注入到一个 bean 中,通过prefix指定配置文件中的前缀,将该前缀下的所有属性值绑定到对应的 bean 属性上。例如,对于以下配置:
my: property1: value1 property2: value2 |
可以创建一个 bean 来接收这些属性:
@Component @ConfigurationProperties(prefix = "my") public class MyConfig { private String property1; private String property2; // getters and setters } |
4.2 多环境配置支持
Spring Boot 可以通过配置文件实现多环境支持,方便在开发、测试、生产等不同环境中使用不同的配置。
一种常见的方式是创建基于环境的配置文件,格式为application-{profile}.properties或application-{profile}.yml,例如application-dev.yml用于开发环境,application-prod.yml用于生产环境,application-test.yml用于测试环境等。
在启动应用程序时,通过指定spring.profiles.active属性来选择加载对应的配置文件。可以在命令行中使用--spring.profiles.active=dev来激活开发环境配置,或者在application.properties(或application.yml)中设置spring.profiles.active=dev。
例如,在application-dev.yml中可以配置开发环境下的数据库连接信息、日志级别等:
spring: datasource: url: jdbc:mysql://localhost:3306/dev_mydb username: dev_user password: dev_password logging: level: com.example: DEBUG |
在application-prod.yml中可以配置生产环境下的相关属性:
spring: datasource: url: jdbc:mysql://prod_host:3306/prod_mydb username: prod_user password: prod_password logging: level: com.example: INFO |
除了使用配置文件,还可以在代码中通过@Profile注解来区分不同环境下的 bean 加载。例如:
@Configuration @Profile("dev") public class DevConfig { // 开发环境下的 bean 配置 } @Configuration @Profile("prod") public class ProdConfig { // 生产环境下的 bean 配置 } |
当激活特定环境时,相应环境下带有@Profile注解的配置类才会被加载,从而实现根据不同环境加载不同的 bean 定义,方便在不同环境中使用不同的数据源、缓存配置、日志配置等,提高应用程序的灵活性和可维护性。
4.3 配置属性的优先级
Spring Boot 中配置属性的加载优先级顺序如下:
命令行参数:使用--参数指定的配置,例如--server.port=8081,优先级最高,会覆盖其他位置相同属性的配置。
系统属性:通过-D参数指定的系统属性,例如-Dspring.datasource.url=jdbc:mysql://localhost:3306/sys_mydb,优先级次之。
环境变量:操作系统的环境变量,例如SPRING_DATASOURCE_URL=jdbc:mysql://localhost:3306/env_mydb,优先级再次之。
JNDI 属性:Java Naming and Directory Interface(JNDI)中定义的属性,优先级较低。
应用程序属性文件:
首先是外部配置文件,例如项目根目录下的config/目录、当前目录、类路径下的config/目录等位置的application.properties或application.yml文件,按照加载顺序,后加载的配置会覆盖前面加载的配置。
然后是内嵌在应用程序中的默认配置文件application.properties或application.yml,优先级相对较低。
如果在不同位置设置了相同的属性,最终生效的值取决于加载顺序,后加载的属性值会覆盖先加载的属性值。例如,如果在命令行中设置了--server.port=8081,在application.properties中设置了server.port=8080,那么最终应用程序将使用8081作为服务器端口。
利用这种优先级机制,可以实现灵活的配置覆盖策略。在开发过程中,可以通过命令行参数快速调整某些关键配置,而在生产环境中,可以通过系统属性或环境变量来设置敏感信息,同时保留应用程序属性文件中的默认配置作为兜底,确保应用程序在不同环境中都能正确运行,并且方便根据具体需求进行配置的调整和优化。
五、核心功能开发
5.1 Web 应用开发
5.1.1 构建 RESTful API
在 Spring Boot 中,使用 Spring MVC 注解可以轻松创建 RESTful 风格的 API 接口。首先,在控制器类上使用@RestController注解,表明该类是一个处理 RESTful 请求的控制器,它结合了@Controller和@ResponseBody的功能,使得方法的返回值会自动转换为 JSON 等格式并返回给客户端。
例如,创建一个UserController来处理用户相关的 API 请求:
@RestController @RequestMapping("/users") public class UserController { // 模拟一个用户列表,实际应用中应该从数据库获取 private static List<User> userList = new ArrayList<>(); // 使用@GetMapping注解处理GET请求,用于获取用户列表 @GetMapping public List<User> getUsers() { return userList; } // 使用@PostMapping注解处理POST请求,用于创建新用户 @PostMapping public User createUser(@RequestBody User user) { userList.add(user); return user; } // 使用@PutMapping注解处理PUT请求,用于更新用户信息 @PutMapping("/{id}") public User updateUser(@PathVariable Long id, @RequestBody User user) { // 根据id找到对应的用户并更新信息 for (User u : userList) { if (u.getId().equals(id)) { u.setName(user.getName()); u.setAge(user.getAge()); return u; } } return null; } // 使用@DeleteMapping注解处理DELETE请求,用于删除用户 @DeleteMapping("/{id}") public void deleteUser(@PathVariable Long id) { // 根据id找到对应的用户并从列表中移除 userList.removeIf(user -> user.getId().equals(id)); } } |
在上述代码中,@RequestMapping注解用于定义请求的基础路径,@GetMapping、@PostMapping、@PutMapping和@DeleteMapping分别对应 HTTP 的 GET、POST、PUT 和 DELETE 方法,通过这些注解可以清晰地定义每个接口的功能和请求路径,使得代码结构更加清晰,易于维护和扩展。
5.1.2 视图模板引擎集成
以 Thymeleaf 为例,它是 Spring Boot 官方推荐的模板引擎之一,具有良好的扩展性和与 Spring 的集成性。
首先,在pom.xml中添加 Thymeleaf 的依赖:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> |
然后,在application.properties或application.yml中配置 Thymeleaf 的相关属性,例如:
# 关闭模板缓存,方便在开发过程中实时看到模板的修改效果 spring.thymeleaf.cache=false # 设置模板文件的前缀,通常为classpath:/templates/,表示模板文件在resources/templates目录下 spring.thymeleaf.prefix=classpath:/templates/ # 设置模板文件的后缀为.html spring.thymeleaf.suffix=.html |
在控制器中,可以这样返回视图并传递数据:
@Controller @RequestMapping("/views") public class ViewController { @GetMapping("/user") public String getUserView(Model model) { // 创建一个用户对象 User user = new User(1L, "John Doe", 30); // 将用户对象添加到模型中,以便在模板中使用 model.addAttribute("user", user); // 返回视图名称,Thymeleaf会自动在templates目录下查找对应的.html文件 return "user"; } } |
在resources/templates目录下创建user.html模板文件,使用 Thymeleaf 的语法来展示数据:
<!DOCTYPE html> <html xmlns:th="http://www.thymeleaf.org"> <head> <meta charset="UTF-8"> <title>User Information</title> </head> <body> <h1>User Details</h1> <p th:text="'ID: ' + ${user.id}"></p> <p th:text="'Name: ' + ${user.name}"></p> <p th:text="'Age: ' + ${user.age}"></p> </body> </html> |
当访问/views/user路径时,控制器会将user对象传递给user.html模板,Thymeleaf 会根据模板中的表达式将数据填充到 HTML 中,然后返回给客户端,实现动态页面展示。
除了 Thymeleaf,Spring Boot 还支持其他视图模板引擎,如 Freemarker 等,其集成方式和使用方法类似,开发者可以根据项目的需求和团队的技术偏好选择合适的模板引擎。
5.1.3 静态资源处理与国际化支持
Spring Boot 对静态资源有默认的处理方式,它会自动在classpath:/static、classpath:/public、classpath:/resources和classpath:/META-INF/resources目录下查找静态资源文件,如 HTML、CSS、JavaScript 文件等。
例如,将一个index.html文件放在src/main/resources/static目录下,当访问应用的根路径时,Spring Boot 会自动返回该文件,无需额外的配置。
对于国际化支持,首先在src/main/resources目录下创建国际化资源文件,如messages.properties(默认语言)、messages_en.properties(英语)、messages_zh_CN.properties(中文简体)等,文件内容以键值对的形式存储需要国际化的文本信息,例如:
# messages.properties greeting=Hello |
# messages_en.properties greeting=Hello |
# messages_zh_CN.properties greeting=你好 |
在application.properties或application.yml中配置国际化相关属性:
# 设置国际化资源文件的基础名称 spring.messages.basename=messages # 设置默认语言 spring.messages.fallback-to-system-locale=false spring.messages.default-encoding=UTF-8 |
在控制器或业务逻辑中,可以使用MessageSource接口来获取国际化后的文本信息,例如:
@RestController public class InternationalizationController { @Autowired private MessageSource messageSource; @GetMapping("/greeting") public String greeting(@RequestHeader("Accept-Language") Locale locale) { // 根据客户端请求的语言获取对应的国际化文本 return messageSource.getMessage("greeting", null, locale); } } |
上述代码中,@RequestHeader("Accept-Language")用于获取客户端请求头中的语言信息,MessageSource根据该语言信息从相应的国际化资源文件中获取greeting对应的文本并返回,从而实现根据用户的语言偏好展示不同语言的内容,提升应用的用户体验。
5.2 数据库操作
5.2.1 数据源配置
以 MySQL 数据库为例,在application.properties中配置数据源连接信息:
# 数据库连接URL spring.datasource.url=jdbc:mysql://localhost:3306/mydb?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC # 数据库用户名 spring.datasource.username=root # 数据库密码 spring.datasource.password=123456 # 数据库驱动类名 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver |
对于连接池的配置,可以使用 Spring Boot 默认的 HikariCP 连接池,也可以配置其他连接池,如 Druid 等。以下是 HikariCP 连接池的一些常见配置参数:
# 最大连接数 spring.datasource.hikari.maximum-pool-size=10 # 最小连接数 spring.datasource.hikari.minimum-idle=5 # 空闲连接超时时间(毫秒) spring.datasource.hikari.idle-timeout=600000 # 连接超时时间(毫秒) spring.datasource.hikari.connection-timeout=30000 # 连接池名称 spring.datasource.hikari.pool-name=MyHikariCP |
通过合理配置数据源和连接池参数,可以提高数据库连接的性能和可靠性,确保应用在高并发情况下能够稳定地访问数据库。
5.2.2 使用 Spring Data JPA 进行数据持久化
首先,在pom.xml中添加 Spring Data JPA 的依赖:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency> |
创建实体类,使用@Entity注解标识该类是一个与数据库表映射的实体:
@Entity @Table(name = "users") public class User { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; private String name; private Integer age; // 省略getter和setter方法 } |
定义 JPA 仓库接口,继承JpaRepository或CrudRepository,可以自动获得基本的 CRUD 操作方法:
public interface UserRepository extends JpaRepository<User, Long> { // 可以在这里定义自定义查询方法 } |
例如,在业务逻辑中使用 JPA 进行数据操作:
@Service public class UserService { @Autowired private UserRepository userRepository; public List<User> getUsers() { return userRepository.findAll(); } public User getUserById(Long id) { return userRepository.findById(id).orElse(null); } public User saveUser(User user) { return userRepository.save(user); } public void deleteUser(Long id) { userRepository.deleteById(id); } } |
还可以使用自定义查询方法满足复杂查询需求,例如:
public interface UserRepository extends JpaRepository<User, Long> { // 根据年龄范围查询用户 List<User> findByAgeBetween(Integer minAge, Integer maxAge); // 使用@Query注解自定义查询语句 @Query("SELECT u FROM User u WHERE u.name LIKE %?1%") List<User> findByNameContaining(String name); } |
通过 Spring Data JPA,可以极大地简化数据库访问层的开发,减少了编写 SQL 语句的工作量,提高了开发效率,同时也保证了数据访问的规范性和安全性。
5.2.3 数据库事务管理
数据库事务是一组不可分割的数据库操作,要么全部成功执行,要么全部回滚,以确保数据的一致性和完整性。
在 Spring Boot 中,使用@Transactional注解实现事务管理。例如,在一个用户注册的业务逻辑中,需要同时插入用户信息和用户的默认配置信息,如果其中一个操作失败,整个注册过程应该回滚,以保证数据的一致性:
@Service public class UserRegistrationService { @Autowired private UserRepository userRepository; @Autowired private UserConfigRepository userConfigRepository; @Transactional public void registerUser(User user, UserConfig userConfig) { // 保存用户信息 User savedUser = userRepository.save(user); // 设置用户配置的用户ID userConfig.setUserId(savedUser.getId()); // 保存用户配置信息 userConfigRepository.save(userConfig); } } |
@Transactional注解可以应用在方法或类级别上。当应用在类上时,类中的所有公共方法都将在事务中执行。可以通过@Transactional的属性来配置事务的传播行为、隔离级别等:
传播行为:例如Propagation.REQUIRED(默认值,如果当前存在事务,则加入该事务;如果不存在事务,则创建一个新的事务)、Propagation.REQUIRES_NEW(无论当前是否存在事务,都创建一个新的事务)等,用于控制事务在多个方法调用中的行为。
隔离级别:如Isolation.DEFAULT(使用底层数据库默认的隔离级别)、Isolation.READ_COMMITTED(已提交读,保证一个事务只能看到已经提交的数据)等,用于控制多个事务并发执行时的隔离程度,防止数据不一致问题。
通过合理配置事务管理,可以确保在复杂的业务场景中,数据库操作的原子性、一致性、隔离性和持久性得到保障,避免出现数据错误或不一致的情况,提高应用的稳定性和可靠性。
5.3 缓存管理
5.3.1 启用缓存功能
在 Spring Boot 中,可以通过在启动类上添加@EnableCaching注解来启用缓存功能:
@SpringBootApplication @EnableCaching public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } |
Spring Boot 支持多种缓存实现,如内存缓存(SimpleCacheManager)、Redis 缓存等。以 Redis 缓存为例,首先在pom.xml中添加 Redis 的相关依赖:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> |
然后在application.properties或application.yml中配置 Redis 连接信息:
# Redis服务器地址 spring.redis.host=localhost # Redis服务器端口 spring.redis.port=6379 # Redis数据库索引(默认为0) spring.redis.database=0 # 连接超时时间(毫秒) spring.redis.timeout=5000 # Redis连接池最大连接数 spring.redis.lettuce.pool.max-active=8 # Redis连接池最大空闲连接数 spring.redis.lettuce.pool.max-idle=8 # Redis连接池最小空闲连接数 spring.redis.lettuce.pool.min-idle=0 |
配置完成后,Spring Boot 会自动配置RedisCacheManager,将其作为缓存管理器,应用可以使用@Cacheable、@CachePut、@CacheEvict等注解来操作缓存。
5.3.2 使用缓存注解
@Cacheable注解用于标记方法的返回值应该被缓存,下次调用相同方法且参数相同时,直接从缓存中获取结果,而不执行方法体:
@Service public class UserService { @Autowired private UserRepository userRepository; @Cacheable(cacheNames = "users", key = "#id") public User getUserById(Long id) { return userRepository.findById(id).orElse(null); } } |
上述代码中,cacheNames指定缓存的名称,key指定缓存的键,这里使用方法参数id作为键,当调用getUserById方法时,会先检查users缓存中是否存在该id对应的用户信息,如果存在则直接返回缓存中的数据,否则执行方法体从数据库查询数据,并将查询结果存入缓存。
@CachePut注解用于更新缓存中的数据,方法执行后会将返回值更新到缓存中:
@CachePut(cacheNames = "users", key = "#user.id") public User updateUser(User user) { return userRepository.save(user); } |
@CacheEvict注解用于清除缓存中的数据,可以根据条件清除特定的缓存项或清除整个缓存:
@CacheEvict(cacheNames = "users", key = "#id") public void deleteUser(Long id) { userRepository.deleteById(id); } |
通过合理使用这些缓存注解,可以有效地减少数据库查询次数,提高数据访问效率,减轻数据库压力,提升应用的性能和响应速度。
5.4 消息服务
5.4.1 集成消息中间件(如 Kafka、RabbitMQ 等)
消息中间件在分布式系统中起着重要的作用,常用于解耦系统组件、实现异步通信和提高系统的可扩展性。
以 Kafka 为例,首先在pom.xml中添加 Kafka 的依赖:
<dependency> <groupId>org.springframework.kafka</groupId> <artifactId>spring-kafka</artifactId> </dependency> |
然后在application.properties或application.yml中配置 Kafka 连接信息:
# Kafka服务器地址 spring.kafka.bootstrap-servers=localhost:9092 # 生产者配置 spring.kafka.producer.key-serializer=org.apache.kafka.common.serialization.StringSerializer spring.kafka.producer.value-serializer=org.springframework.kafka.support.serializer.JsonSerializer # 消费者配置 spring.kafka.consumer.group-id=my-group spring.kafka.consumer.auto-offset-reset=earliest spring.kafka.consumer.key-deserializer=org.apache.kafka.common.serialization.StringDeserializer spring.kafka.consumer.value-deserializer=org.springframework.kafka.support.serializer.JsonDeserializer |
完成配置后,Spring Boot 会自动配置KafkaTemplate和KafkaListenerContainerFactory,以便在应用中发送和接收 Kafka 消息。
如果使用 RabbitMQ,添加相应的依赖:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-amqp</artifactId> </dependency> |
在配置文件中配置 RabbitMQ 连接信息:
# RabbitMQ服务器地址 spring.rabbitmq.host=localhost # RabbitMQ服务器端口 spring.rabbitmq.port=5672 # 用户名 spring.rabbitmq.username=guest # 密码 spring.rabbitmq.password=guest # 虚拟主机 spring.rabbitmq.virtual-host=/ |
Spring Boot 会自动配置RabbitTemplate和SimpleRabbitListenerContainerFactory,用于与 RabbitMQ 进行交互。
5.4.2 发送和接收消息
使用 Kafka 发送消息的示例
六、安全控制
以下是关于在 Spring Boot 中使用 @PreAuthorize 注解进行方法级别的权限控制以及使用 BCrypt 加密算法确保密码安全存储的详细内容:
一、@PreAuthorize 注解进行方法级别的权限控制
使用前提条件:
首先需要在配置类上开启注解支持,通过 @EnableGlobalMethodSecurity(prePostEnabled = true) 注解来实现。这样才能在方法上使用 @PreAuthorize 等相关权限控制注解。
基于默认的 access 表达式:
在登录时,需要实现 UserDetailsService 接口,并在 loadUserByUsername 方法中根据用户名获取用户的权限信息,将这些权限信息封装在 UserDetails 的实现类中返回给 Spring Security。例如:
@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"); } // 假设用户的权限信息存储在 user.getRoles() 中,这里将其转换为 Spring Security 能够识别的 GrantedAuthority 列表 List<GrantedAuthority> authorities = user.getRoles().stream() .map(role -> new SimpleGrantedAuthority(role.getName())) .collect(Collectors.toList()); return new org.springframework.security.core.userdetails.User(user.getUsername(), user.getPassword(), authorities); } } |
然后在需要权限控制的控制器方法上,添加 @PreAuthorize 注解,并在注解中使用 hasRole 或 hasAuthority 等表达式来定义权限要求。例如:
@RestController @RequestMapping("/api") public class UserController { // 只有具有 'ADMIN' 角色的用户才能访问此方法 @PreAuthorize("hasRole('ADMIN')") @GetMapping("/users") public List<User> getUsers() { // 返回用户列表 return userService.getUsers(); } // 只有具有 'USER' 角色的用户才能访问此方法 @PreAuthorize("hasRole('USER')") @GetMapping("/profile") public User getUserProfile() { // 返回用户个人资料 return userService.getUserProfile(); } // 具有 'ADMIN' 或 'USER' 角色的用户才能访问此方法 @PreAuthorize("hasAnyRole('ADMIN', 'USER')") @PostMapping("/users") public User createUser(@RequestBody User user) { // 创建新用户 return userService.createUser(user); } } |
自定义 access 表达式:
可以创建自定义的权限验证服务类,并在其中定义自定义的权限验证逻辑。例如:
@Service public class CustomPermissionService { public boolean hasCustomPermission(String permission) { // 这里可以根据业务逻辑来判断用户是否具有特定的权限 // 例如,从数据库或其他数据源获取用户的权限信息进行验证 return false; } } |
然后在 @PreAuthorize 注解中使用 @ 符号来引用自定义的权限验证方法,例如:
@RestController @RequestMapping("/api") public class SomeController { @Autowired private CustomPermissionService permissionService; // 使用自定义的权限验证方法,只有当用户具有特定的自定义权限时才能访问此方法 @PreAuthorize("@permissionService.hasCustomPermission('custom_permission')") @GetMapping("/someResource") public String getSomeResource() { return "This is a protected resource"; } } |
二、使用 BCrypt 加密算法确保密码安全存储
引入依赖:
在 pom.xml 文件中添加 Spring Security 的依赖,因为 BCryptPasswordEncoder 是 Spring Security 提供的用于密码加密的工具类:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency> |
创建配置类:
创建一个 Spring 配置类,在其中定义 PasswordEncoder Bean,并将其设置为 BCryptPasswordEncoder,同时可以根据服务器性能等因素调整 BCrypt 的工作因子(cost factor),默认值为 10。例如:
@Configuration public class SecurityConfig { @Bean public PasswordEncoder passwordEncoder() { return new BCryptPasswordEncoder(12); // 可以调整 cost factor,这里设置为 12 } } |
使用编码器:
在服务层中,当用户注册或修改密码时,使用 BCryptPasswordEncoder 对用户密码进行编码后再存储到数据库中。例如:
@Service public class UserService { @Autowired private UserRepository userRepository; @Autowired private PasswordEncoder passwordEncoder; public void registerUser(User user) { String hashedPassword = passwordEncoder.encode(user.getPassword()); user.setPassword(hashedPassword); userRepository.save(user); } } |
在用户登录验证时,使用 passwordEncoder.matches 方法来比较输入的密码与存储在数据库中的哈希密码是否匹配,而不是直接比较明文密码,这样可以防止密码泄露风险。例如:
@Service public class UserService { @Autowired private UserRepository userRepository; @Autowired private PasswordEncoder passwordEncoder; public boolean authenticate(String username, String password) { User user = userRepository.findByUsername(username); if (user!= null) { return passwordEncoder.matches(password, user.getPassword()); } return false; } } |
通过以上方式,结合 @PreAuthorize 注解进行方法级别的权限控制和使用 BCrypt 加密算法对密码进行安全存储,可以有效地防止用户信息泄露和非法访问,提高 Spring Boot 应用的安全性。在实际应用中,还应注意遵循安全最佳实践,如定期更新密码加密算法、对用户输入进行严格的验证和过滤、保护好加密密钥等,以确保系统的安全性和稳定性。
七、测试与调试
7.1 单元测试
单元测试是确保代码质量的关键环节,它专注于对单个代码单元(如方法、类)进行测试,以验证其行为是否符合预期。在 Spring Boot 项目中,常用的单元测试框架是 JUnit 和 Mockito。
JUnit 提供了丰富的注解来定义测试方法和测试生命周期。例如,@Test 注解用于标记一个方法为测试方法,@Before 注解标记的方法会在每个测试方法执行前被调用,可用于初始化测试数据或设置测试环境;@After 注解标记的方法则会在每个测试方法执行后被调用,用于清理资源或进行一些后置操作。
以下是一个简单的单元测试示例:
import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.*; public class CalculatorTest { private Calculator calculator; @BeforeEach public void setUp() { calculator = new Calculator(); } @Test public void testAdd() { int result = calculator.add(2, 3); assertEquals(5, result); } @Test public void testSubtract() { int result = calculator.subtract(5, 3); assertEquals(2, result); } } |
在上述示例中,Calculator 是一个简单的计算器类,包含加法和减法方法。通过 @Test 注解定义了两个测试方法,分别测试加法和减法的功能,使用 assertEquals 断言来验证方法的返回值是否与预期值相等。
当测试方法依赖于其他对象时,为了隔离测试环境,避免外部依赖的影响,可以使用 Mockito 框架来模拟这些依赖对象。例如:
import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.*; import static org.mockito.Mockito.*; public class UserServiceTest { @Test public void testGetUserById() { // 创建模拟的 UserRepository UserRepository userRepository = mock(UserRepository.class); // 创建 UserService 并注入模拟的 UserRepository UserService userService = new UserService(userRepository); // 创建一个虚拟的用户对象 User mockUser = new User(1L, "John Doe", 30); // 定义模拟对象的行为,当调用 findById(1L) 时返回虚拟用户对象 when(userRepository.findById(1L)).thenReturn(Optional.of(mockUser)); // 调用需要测试的方法 User user = userService.getUserById(1L); // 验证返回结果 assertEquals("John Doe", user.getName()); // 验证 findById(1L) 方法被调用了一次 verify(userRepository).findById(1L); } } |
在这个示例中,UserService 依赖于 UserRepository 来获取用户信息。通过 Mockito 的 mock 方法创建了一个模拟的 UserRepository,使用 when().thenReturn() 方法设置了模拟对象的行为,即当调用 findById(1L) 时返回一个预定义的虚拟用户对象。然后调用 UserService 的 getUserById 方法,并使用断言验证返回的用户信息是否正确,同时使用 verify 方法验证 UserRepository 的 findById 方法是否按预期被调用。
通过编写单元测试,可以在开发过程中及时发现代码中的逻辑错误、边界情况处理不当等问题,提高代码的稳定性和可维护性,为后续的集成测试和系统测试奠定坚实的基础。
7.2 集成测试
集成测试侧重于验证不同组件之间的交互是否正常工作,它模拟了真实环境下各个模块的协作情况,确保整个系统的功能完整性。
在 Spring Boot 中,@SpringBootTest 注解是进行集成测试的关键。它会加载整个 Spring 应用上下文,使得测试环境尽可能接近实际运行环境,这样可以测试到各个组件之间的集成情况,包括数据库操作、服务调用、接口交互等。
例如,对于一个简单的用户管理系统,可能有 UserController、UserService 和 UserRepository 等组件。以下是一个集成测试的示例:
import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.test.web.servlet.MockMvc; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*; import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*; @SpringBootTest @AutoConfigureMockMvc public class UserControllerIntegrationTest { @Autowired private MockMvc mockMvc; @Test public void testGetUserById() throws Exception { mockMvc.perform(get("/users/{id}", 1)) .andExpect(status().isOk()) .andExpect(jsonPath("$.name").value("John Doe")) .andExpect(jsonPath("$.age").value(30)); } } |
在上述示例中,@SpringBootTest 注解加载了整个应用上下文,@AutoConfigureMockMvc 注解用于配置 MockMvc,它可以模拟 HTTP 请求,方便对 Web API 进行测试。通过 mockMvc.perform 方法发送一个 GET 请求到 /users/{id} 接口,并使用 andExpect 方法对响应的状态码、返回的 JSON 数据中的字段值进行断言,验证接口是否能正确返回预期的用户信息。
除了使用 MockMvc,还可以使用其他测试工具,如 RestAssured,它提供了更简洁的语法来测试 RESTful API。例如:
import io.restassured.RestAssured; import io.restassured.response.Response; import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.*; public class UserControllerRestAssuredTest { @Test public void testGetUserById() { Response response = RestAssured.get("http://localhost:8080/users/{id}", 1); assertEquals(200, response.getStatusCode()); assertEquals("John Doe", response.jsonPath().getString("name")); assertEquals(30, response.jsonPath().getInt("age")); } } |
在这个示例中,使用 RestAssured 发送 HTTP 请求,并通过断言验证响应的状态码和返回的 JSON 数据是否符合预期。
集成测试能够发现组件之间集成时可能出现的问题,如接口不匹配、数据传递错误、事务管理问题等,确保整个系统在各个组件协同工作时的正确性和稳定性,为系统的上线提供有力保障。
7.3 调试技巧
在 Spring Boot 开发过程中,难免会遇到各种问题,如启动失败、依赖冲突、配置错误等。以下是一些常见问题的排查思路和解决方法,以及使用 IDE 进行调试的技巧。
当应用启动失败时,首先查看控制台输出的错误信息,这通常会提供关键线索。例如,如果是依赖冲突导致的启动失败,错误信息可能会显示某个类存在多个版本,或者某个依赖无法满足。此时,可以使用 Maven 或 Gradle 的依赖树分析工具(如 mvn dependency:tree 或 gradle dependencies)来查看依赖关系,找出冲突的依赖,并通过在项目的构建文件中显式指定依赖版本来解决冲突。
对于配置错误,仔细检查 application.properties 或 application.yml 文件中的配置项是否正确。例如,如果数据库连接配置错误,可能会导致应用无法连接到数据库,此时应检查数据库的 URL、用户名、密码等配置是否准确无误。
在使用 IDE 进行调试时,设置断点是常用的技巧之一。可以在代码的关键位置设置断点,例如在方法的入口、可能出现问题的代码行等。当程序运行到断点处时,会暂停执行,此时可以查看变量的值、执行流程等信息,帮助定位问题。例如,在调试一个数据查询方法时,可以在查询语句执行前设置断点,查看传入的参数是否正确,以及在执行查询后查看返回的结果是否符合预期。
对于多线程程序的调试,IDE 也提供了相应的支持。可以在调试视图中查看各个线程的状态、堆栈信息等,以便发现线程同步、死锁等问题。例如,如果多个线程同时访问共享资源导致数据不一致,可以通过调试线程来查看每个线程的执行顺序和对共享资源的操作情况,找出问题所在并进行修复。
此外,合理利用日志信息也是调试的重要手段。可以在代码中添加适当的日志输出语句,记录关键变量的值、方法的执行流程等信息。通过调整日志级别(如在 application.properties 中设置 logging.level.com.example=DEBUG),可以控制日志的输出详细程度,在开发过程中使用较低的日志级别(如 DEBUG)来获取更多的调试信息,在生产环境中使用较高的日志级别(如 INFO 或 ERROR)以减少日志输出量,提高性能。
通过掌握这些调试技巧,可以更快速地定位和解决开发过程中遇到的问题,提高开发效率,减少开发周期,确保项目的顺利进行。
八、项目部署与运维
八、应用监控与运维
8.1 Spring Boot Actuator 简介
Spring Boot Actuator 是 Spring Boot 提供的一个用于监控和管理应用程序的模块,它提供了一系列的端点(endpoints),这些端点可以通过 HTTP 或 JMX 等方式暴露应用的内部状态信息,帮助开发者和运维人员更好地了解应用的运行情况,以便及时发现和解决问题。
Actuator 的核心功能包括:
健康检查:通过 /health 端点可以检查应用程序的整体健康状况,包括数据库连接、缓存、消息队列等依赖组件的状态,返回 UP 或 DOWN 等状态信息,帮助快速判断应用是否正常运行,对于确保应用的可用性至关重要。
度量指标收集:/metrics 端点提供了各种应用程序的性能指标,如内存使用量、线程池活跃度、HTTP 请求的计数和响应时间等,这些指标对于性能调优和资源优化非常有价值,能够帮助开发者定位性能瓶颈,做出合理的优化决策。
信息展示:/info 端点可以展示应用的自定义信息,例如应用的版本号、构建时间、作者信息等,方便了解应用的基本情况和版本信息,有助于版本管理和应用的维护。
配置属性查看与修改:某些端点允许查看和修改应用的配置属性,虽然在生产环境中需要谨慎使用,但在开发和测试阶段,对于调试配置问题非常方便,可以快速验证配置的修改效果,而无需重新启动应用程序。
通过这些功能,Actuator 为 Spring Boot 应用提供了强大的监控和管理能力,使得应用在生产环境中的可维护性和可观察性大大增强,有助于及时发现潜在的问题,保障应用的稳定运行,并为性能优化提供数据支持。
8.2 启用 Actuator 端点
在 Spring Boot 项目中启用 Actuator 端点非常简单,通常只需要在项目的依赖管理文件(如 Maven 的 pom.xml 或 Gradle 的 build.gradle)中添加 spring-boot-starter-actuator 依赖即可。
对于 Maven 项目,在 pom.xml 中添加以下依赖:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> |
对于 Gradle 项目,在 build.gradle 中添加以下依赖:
implementation 'org.springframework.boot:spring-boot-starter-actuator' |
添加依赖后,Spring Boot 会自动配置 Actuator,并默认启用一些端点,如 /health 和 /info 端点。
如果需要启用其他端点,可以在 application.properties 或 application.yml 配置文件中进行配置。例如,要启用 /metrics 端点,可以添加以下配置:
management.endpoints.web.exposure.include=health,info,metrics |
或者在 application.yml 中配置为:
management: endpoints: web: exposure: include: health,info,metrics |
此外,还可以通过 management.endpoints.web.base-path 属性来修改 Actuator 端点的基础路径。例如,将基础路径修改为 /manage:
management.endpoints.web.base-path=/manage |
此时,所有 Actuator 端点的访问路径都将以 /manage 开头,如 /manage/health、/manage/metrics 等。
需要注意的是,在生产环境中,对于一些敏感信息的端点(如 /env 端点可能会暴露环境变量信息),需要谨慎配置其访问权限,防止信息泄露。可以通过 Spring Security 等安全框架来限制对这些端点的访问,确保只有授权的用户或角色能够访问敏感的 Actuator 端点,保障应用的安全性。
8.3 应用监控与运维
8.3.1 Actuator 端点详解
/health 端点:
作用:用于检查应用程序的整体健康状况,包括各个依赖组件(如数据库连接、缓存、消息队列等)的健康状态,是判断应用是否正常运行的重要依据,有助于快速发现潜在的故障点,保障应用的可用性。
使用方法:可以通过发送 HTTP GET 请求到 /health 端点来获取健康信息。在默认情况下,它会返回一个简单的 JSON 格式数据,例如:
{ "status": "UP" } |
表示应用处于健康状态。如果某个依赖组件出现问题,可能会返回更详细的信息,如:
{ "status": "DOWN", "components": { "db": { "status": "DOWN", "details": { "error": "org.hibernate.exception.JDBCConnectionException: Unable to open JDBC Connection for DDL execution" } }, "diskSpace": { "status": "UP", "details": { "total": 250685575168, "free": 118964342784, "threshold": 10485760 } } } } |
这里表明数据库连接出现问题(status 为 DOWN),同时提供了磁盘空间的详细信息(diskSpace 部分),可以帮助运维人员快速定位问题根源,及时采取措施进行修复,确保应用的稳定运行。
/metrics 端点:
作用:提供了应用程序的各种性能指标,包括系统资源的使用情况(如内存、CPU 等)、应用内部的业务指标(如特定业务操作的执行次数、成功率等)以及 HTTP 请求的相关指标(如请求计数、响应时间等),这些指标对于性能调优和资源优化至关重要,能够帮助开发者深入了解应用的运行性能,发现潜在的性能瓶颈,从而有针对性地进行优化。
使用方法:发送 HTTP GET 请求到 /metrics 端点,将返回一个包含多个指标的 JSON 数据,例如:
{ "http.server.requests": 100, "system.cpu.usage": 0.65, "jvm.memory.used": 52428800, "myapp.sales.total": 10000 } |
其中,http.server.requests 表示 HTTP 请求的总数,system.cpu.usage 是 CPU 的使用率,jvm.memory.used 是 JVM 已使用的内存量,myapp.sales.total 是自定义的业务指标(假设应用是一个销售系统,统计销售总额)。可以使用工具(如 curl 命令或编程语言中的 HTTP 客户端库)来定期获取这些指标数据,并进行分析和可视化展示,以便更好地监控应用的性能趋势,及时发现性能异常情况,并做出相应的优化决策,例如调整服务器资源配置、优化代码逻辑以降低 CPU 使用率或内存占用等。
/info 端点:
作用:主要用于展示应用的自定义信息,这些信息可以包括应用的版本号、构建时间、作者信息、版权声明等,有助于了解应用的基本情况和版本信息,对于应用的维护和管理具有重要意义,方便在出现问题时快速确定应用的版本和相关背景信息,便于进行问题排查和修复,同时也有助于团队内部的协作和沟通,使不同成员能够快速了解应用的基本概况。
使用方法:访问 /info 端点,返回的 JSON 数据包含自定义的信息,例如:
{ "app": { "version": "1.0.0", "buildTime": "2024-01-01T00:00:00", "author": "John Doe", "copyright": "Copyright © 2024 Company Name" |
相关文章:
Spring Boot应用开发实战:从入门到精通
一、Spring Boot 简介 1.1 什么是 Spring Boot? Spring Boot 是一个开源框架,旨在简化新 Spring 应用的初始搭建以及开发过程。它构建在 Spring 框架之上,利用了 Spring 的核心特性,如依赖注入(Dependency Injection&…...
salesforce Controlled by Parent 的对象如何实现部分情况 Parent可见,但是 该对象不可见
在 Salesforce 中,设置对象的访问控制为“Controlled by Parent”时,该对象的可见性通常由其主对象(Parent)的共享规则或权限决定。如果主对象可见,子对象也会自动继承可见性。然而,有时候我们希望实现一些…...
React 第二十节 useRef 用途使用技巧注意事项详解
简述 useRef 用于操作不需要在视图上渲染的属性数据,用于访问真实的DOM节点,或者React组件的实例对象,允许直接操作DOM元素或者是组件; 写法 const inpRef useRef(params)参数: useRef(params),接收的 …...
TCP/IP 邮件
TCP/IP邮件是互联网通信中非常重要的应用之一。当我们发送电子邮件时,我们实际上并没有直接使用TCP/IP协议,而是通过电子邮件程序,例如微软的Outlook、莲花软件的Notes或Netscape Communicator等来实现。这些电子邮件程序背后使用了不同的TCP…...
前缀和与差分
目录 前缀和 一维前缀和 二维前缀和 差分 一维差分 二维差分 进阶练习NOIP普及组与提高组 前缀和 前缀和是一种思想,代码短小精悍是它的特点。相比于数据较大时的从头至尾遍历和优化过的双指针方法来求区间和,前缀和在对于数据进行处理的速度上有…...
2024国赛A问题5
问题五 龙头最大速度优化模型的建立 问题五在问题四的曲线的基础上对速度进行了约束,即在逐步改变龙头速度的情况下,各个龙身的速度也会依次改变,给出龙头的最大行进速度,使得舞龙队各把手的速度均不超过 2 m/s。即可依此构建一个龙头速度的…...
香橙派5Plus启动报错bug: spinlock bad magic on cpu#6, systemd-udevd/443
一、问题 如图: 接上调试串口,每次启动都会报错。不过使用过程中没有发现有什么影响。 百度查阅,有一位博主提到,但是没有细说解决方案: spinlock变量没有初始化_spinlock bad magic on-CSDN博客https://blog.csdn.n…...
MySQL 常用程序介绍
以下是一些常用的MySQL程序: 程序名作⽤mysqldMySQL的守护进程即 MySQL 服务器,要使⽤MySQL 服务器 mysqld必须正在运⾏状态mysql MySQL客⼾端程序,⽤于交互式输⼊ SQL 语句或以批处理模式从⽂件执⾏SQL的命令⾏⼯具 mysqlcheck⽤于检查、修…...
DevOps实战:用Kubernetes和Argo打造自动化CI/CD流程(1)
DevOps实战:用Kubernetes和Argo打造自动化CI/CD流程(1) 架构 架构图 本设计方案的目标是在一台阿里云ECS服务器上搭建一个轻量级的Kubernetes服务k3s节点,并基于Argo搭建一套完整的DevOps CI/CD服务平台,包括Argo CD…...
RBAC模型
RBAC模型 1.概念 RBAC:role based access control,基于角色的权限控制 三个主体 - 用户 - 角色 - 权限 授权的本质是对用户授权角色,假设系统的用户数量特别多的话可以对用户设置用户组。 2.RBAC表基本设计 用户表 角色表 权限表 …...
CultureLLM 与 CulturePark:增强大语言模型对多元文化的理解
本文介绍团队刚刚在加拿大温哥华召开的顶会NeurIPS 2024上发表的两篇系列工作:CultureLLM 和CulturePark。此项研究以生成文化数据并训练文化专有模型为主要手段,旨在提升已有基础模型的多文化理解能力,使得其在认知、偏见、价值观、在线教育…...
sentinel学习笔记6-限流降级(上)
本文属于sentinel学习笔记系列。网上看到吴就业老师的专栏,写的好值得推荐,我整理的有所删减,推荐看原文。 https://blog.csdn.net/baidu_28523317/category_10400605.html sentinel 实现限流降级、熔断降级、黑白名单限流降级、系统自适应…...
redis cluster集群
华子目录 什么是redis集群redis cluster的体系架构什么是数据sharding?什么是hash tag集群中删除或新增节点,数据如何迁移?redis集群如何使用gossip通信?定义meet信息ping消息pong消息fail消息(不是用gossip协议实现的࿰…...
设计模式从入门到精通之(二)抽象工厂模式
抽象工厂模式:不同工厂背后的协作秘密 在上一期中,我们聊到了工厂模式,讲述了如何用一家咖啡店来帮我们制作不同类型的咖啡。那么,如果你不仅需要咖啡,还需要配套的甜品,比如蛋糕或饼干,这时应该…...
LeetCode:404.左叶子之和
跟着carl学算法,本系列博客仅做个人记录,建议大家都去看carl本人的博客,写的真的很好的! 代码随想录 LeetCode:404.左叶子之和 给定二叉树的根节点 root ,返回所有左叶子之和。 示例 1: 输入: …...
Java包装类型的缓存
Java 基本数据类型的包装类型的大部分都用到了缓存机制来提升性能。 Byte,Short,Integer,Long 这 4 种包装类默认创建了数值 [-128,127] 的相应类型的缓存数据,Character 创建了数值在 [0,127] 范围的缓存数据,Boolean 直接返回 True or Fal…...
2024网络安全学习路线 非常详细 推荐学习
关键词:网络安全入门、渗透测试学习、零基础学安全、网络安全学习路线 首先咱们聊聊,学习网络安全方向通常会有哪些问题 1、打基础时间太长 学基础花费很长时间,光语言都有几门,有些人会倒在学习 linux 系统及命令的路上ÿ…...
【ES6复习笔记】数值扩展(16)
介绍 在 JavaScript 中,数值扩展提供了一些额外的功能,使得处理数值变得更加方便。本教程将介绍一些常用的数值扩展方法和属性。 1. Number.EPSILON Number.EPSILON 是 JavaScript 表示的最小精度。它的值接近于 2.2204460492503130808472633361816E-…...
【mybatis】详解 # 和 $ 的区别,两者分别适用于哪种场景,使用 $ 不当会造成什么影响
# 和 $ 的区别 在MyBatis中,# 和 $ 是用来处理参数的两种不同方式,它们之间有一些重要的区别: # 符号: # 是用来进行参数占位符的,它会进行 SQL 注入防护。使用 # 时,MyBatis 会将参数值进行预处理&…...
【MySQL】索引 面试题
文章目录 适合创建索引的情况创建索引的注意事项MySQL中不适合创建索引的情况索引失效的常见情况 索引定义与作用 索引是帮助MySQL高效获取数据的有序数据结构,通过维护特定查找算法的数据结构(如B树),以某种方式引用数据…...
QT调用Sqlite数据库
QT设计UI界面,后台访问数据库,实现数据库数据的增删改查。 零售商店系统 数据库表: 分别是顾客表,订单详情表,订单表,商品表 表内字段详情如下: 在QT的Pro文件中添加sql,然后添加头…...
Flutter富文本实现学习
Flutter 代码如何实现一个带有富文本显示和交互的页面。 前置知识点学习 RealRichText RealRichText 和 ImageSpan 不是 Flutter 框架中内置的组件,而是自定义的组件或来自第三方库。这些组件的实现可以提供比标准 RichText 更丰富的功能,比如在富文本…...
实现某海外大型车企(T)Cabin Wi-Fi 需求的概述 - 4
大家好,我是Q,邮箱:1042484520qq.com。 今天我们在上几讲的基础上再扩展下 Cabin Wi-Fi 的功能需求,讲讲如何使能 5G TCU Wi-Fi STA Bridge 模式。 参考: 实现某海外大型车企(T)Cabin Wi-Fi 需求…...
【GeekBand】C++设计模式笔记15_Proxy_代理模式
1. “接口隔离” 模式 在组件构建过程中,某些接口之间直接的依赖常常会带来很多问题,甚至根本无法实现。采用添加一层间接(稳定)接口,来隔离本来互相紧密关联的接口是一种常见的解决方案。典型模式 FacadeProxyAdapte…...
项目练习:若依系统的svg-icon功能实现
文章目录 一、svg图片准备二、自定义Svg组件三、svg插件开发四、Svg组件使用 一、svg图片准备 src/assets/icons/svg 其中svg目录里,存放了所需要的图片 index.js import Vue from vue import SvgIcon from /components/SvgIcon// svg component// register glob…...
【踩坑/Linux】Vmware中的Ubuntu虚拟机无法访问互联网
Vmware中的Ubuntu虚拟机无法访问互联网 首先前提是我的系统是Ubuntu 16.04系统,vmware workstation选择的是NAT模式,虚拟机内连不上网络 ping www.baidu.com ping: unknown host www.baidu.com首先检查 DNS 解析服务:在虚拟机中打开命令提示…...
深入了解SpringIoc(续篇)
目录 注入 Bean 的方式有哪些? 构造函数注入还是 Setter 注入? Bean 的作用域有哪些? Bean 是线程安全的吗? Bean 的生命周期了解么? 注入 Bean 的方式有哪些? 依赖注入 (Dependency Injection, DI) 的常见方式: 构造函数注入:通过类的构造函…...
嵌入式硬件面试题
1、请问什么是通孔、盲孔和埋孔?孔径多大可以做机械孔,孔径多小必须做激光孔?请问激光微型孔可以直接打在元件焊盘上吗,为什么? 通孔是贯穿整个PCB的过孔,盲孔是从PCB表层连接到内层的过孔,埋孔…...
散斑/横向剪切/迈克尔逊/干涉条纹仿真技术分析
摘要 本博文提供了多种数据类型的干涉条纹仿真,并展示了它们对应的散斑干涉条纹。还分别给出了横向剪切干涉以及剪切散斑干涉条纹的仿真。 一、迈克尔逊干涉与散斑干涉仿真 下图为干涉条纹与对应的散斑干涉条纹的仿真示意图。其中,干涉条纹可认为是源…...
ViiTor实时翻译 2.2.1 | 完全免费的高识别率同声传译软件
ViiTor实时翻译是一款完全免费的实时语音翻译和同声传译软件,支持即时翻译、对话翻译、语音转文字、文本语音合成和AR翻译等功能。它的语音识别和翻译准确率特别高,速度非常快,音质高,并支持6种音色切换。该软件简单易用ÿ…...
uniapp实现为微信小程序扫一扫的功能
引言 随着微信小程序的快速发展,越来越多的开发者开始关注和学习微信小程序的开发。其中,微信小程序的扫一扫功能是非常常用且实用的功能之一。通过扫描二维码,用户可以获取到相关的信息或者实现特定的功能。 正文 在过去,开发者需要使用微信开发者工具以及相关的开发文档…...
ospf 的 状态机详解
OSPF(开放最短路径优先,Open Shortest Path First)协议的状态机是其核心部分之一,用于确保路由器之间的邻接关系(neighbor relationship)建立和路由信息的交换。OSPF的状态机模型由多个状态组成,…...
ElementPlus 自定义封装 el-date-picker 的快捷功能
文章目录 需求分析 需求 分析 我们看到官网上给出的案例如下,但是不太满足我们用户想要的快捷功能,因为不太多,因此需要我们自己封装一些,方法如下 外部自定义该组件的快捷内容 export const getPickerOptions () > {cons…...
【面试系列】深入浅出 Spring Boot
熟悉SpringBoot,对常用注解、自动装配原理、Jar启动流程、自定义Starter有一定的理解; 面试题 Spring Boot 的核心注解是哪个?它主要由哪几个注解组成的?Spring Boot的自动配置原理是什么?你如何理解 Spring Boot 配置…...
太阳能LED路灯智能控制系统(论文+源码)
1系统的功能及方案设计 本次课题为太阳能LED路灯智能控制系统,其系统整体架构如图2.1所示,太阳能板通过TP4056充电模块给锂电池进行充电,电池通过HX3001升压模块进行升压到5V给整个控制系统进行供电,控制系统由AT89C52单片机作为…...
使用 PyQt5 构建高效的文件分类与管理工具
当我们处理大量图片或文件时,经常会需要一款方便、高效的工具来快速分类、整理和管理它们。今天,我将分享一个用 PyQt5 构建的实用项目,涵盖图片分类、文件夹管理、撤销功能,以及动态界面操作的实现。从设计到代码细节,…...
谷歌浏览器 Chrome 提示:此扩展程序可能很快将不再受支持
问题现象 在Chrome 高版本上的扩展管理页面(地址栏输入chrome://extensions/或者从界面进入): , 可以查看到扩展的情况。 问题现象大致如图: 问题原因 出现此问题的根本原因在于:谷歌浏览器本身的扩展机制发生了…...
肿瘤电场仪疗法原理:科技之光,照亮抗癌之路
在医疗科技日新月异的今天,肿瘤电场仪疗法作为一种创新的无创治疗手段,正以其独特的物理机制和生物效应,为患者带来了新的治疗选择和希望。本文将深入探讨肿瘤电场仪疗法的原理,揭示其如何在不伤害正常组织的前提下,精…...
scala基础学习_运算符
文章目录 scala运算符算术运算符关系运算符逻辑运算符位运算符其他运算符赋值运算符 scala运算符 在 Scala 中,运算符通常被定义为方法。这意味着你可以将运算符视为对象上的方法调用。以下是一些常用的运算符及其对应的操作: 算术运算符 :…...
人工智能与区块链的碰撞:双剑合璧的创新前景
引言 人工智能(AI)与区块链技术,这两项曾经各自独立发展的前沿科技,如今正逐步走向融合。人工智能通过强大的数据处理能力和智能决策能力,在各个领域掀起了革命性的变革;而区块链凭借其去中心化、不可篡改的…...
信创数据防泄漏中信创沙箱是什么样的安全方案
在信息化与工业化融合创新(信创)的快速发展中,企业面临着日益复杂的数据安全挑战。SDC沙盒技术以其独特的安全机制和先进的设计理念,为信创环境提供了强有力的数据保护支持。以下是SDC沙盒在信创领域支持能力的几个关键侧重点&…...
在不同操作系统上安装 PostgreSQL
title: 在不同操作系统上安装 PostgreSQL date: 2024/12/26 updated: 2024/12/26 author: cmdragon excerpt: PostgreSQL 是当今最受欢迎的开源关系数据库管理系统之一,由于其强大的功能和灵活性,广泛应用于不同的行业和应用场景。在开始使用 PostgreSQL 之前,用户需要了…...
Linux下编译 libwebsockets简介和使用示例
目录 1:简单介绍: 2:项目地址 3:编译 3.1:集成介绍 3.2:编译 4:客户端服务端示例: 4.1 客户端示例 4.2 服务端示例: 1:简单介绍: Linux下…...
5G CPE接口扩展之轻量型多口千兆路由器小板选型
多口千兆路由器小板选型 方案一: 集成式5口千兆WIFI路由器小板方案二:交换板 + USBwifiUSB WIFI选型一USBwifi选型二:四口千兆选型一四口千兆选型二:四口千兆选型三:部分5G CPE主板不支持Wifi,并且网口数量较少,可采用堆叠方式进行网口和wifi功能 扩展,本文推荐一些路由…...
青少年编程与数学 02-005 移动Web编程基础 02课题、视口与像素
青少年编程与数学 02-005 移动Web编程基础 02课题、视口与像素 一、视口二、布局视口(Layout Viewport)三、视觉视口(Visual Viewport)四、理想视口(Ideal Viewport)五、视口设置关键属性示例代码示例1&…...
深度学习blog-Transformer-注意力机制和编码器解码器
注意力机制:当我们看一个图像或者听一段音频时,会根据自己的需求,集中注意力在关键元素上,以获取相关信息。 同样地,注意力机制中的模型也会根据输入的不同部分,给它们不同的权重,并集中注意力在…...
【论文投稿】Python 网络爬虫:探秘网页数据抓取的奇妙世界
【IEEE出版|广东工业大学主办】第五届神经网络、信息与通信工程国际学术会议(NNICE 2025)_艾思科蓝_学术一站式服务平台 目录 前言 一、Python—— 网络爬虫的绝佳拍档 二、网络爬虫基础:揭开神秘面纱 (一)工作原…...
【总结整理】 神经网络与深度学习 邱锡鹏 课后习题答案 扩展阅读链接
本文主要针对神经网络神经网络邱锡鹏 2~8 章的课后习题进行理解的过程中,搜索到的讲的会比较透彻的链接整理。适合有一定基础但是想了解更细的人阅读。 主要参考书籍 首先是本书pdf可在神经网络与深度学习获取; 主要参考的课后习题答案为nndl/solution…...
华为手机建议使用adb卸载的app
按需求自行卸载 echo 卸载智慧搜索 adb shell pm uninstall -k --user 0 com.huawei.search echo 卸载智慧助手 adb shell pm uninstall -k --user 0 com.huawei.intelligent echo 卸载讯飞语音引擎 adb shell pm uninstall -k --user 0 com.iflytek.speechsuite echo 卸载快应…...
找到一个linux静态库动态库的好资料.2
# 正文 继续整理从这个页面学到的东西:https://tldp.org/HOWTO/Program-Library-HOWTO 这一篇主要参考这俩: https://tldp.org/HOWTO/Program-Library-HOWTO/introduction.html https://tldp.org/HOWTO/Program-Library-HOWTO/static-libraries.html 这…...