Spring-Boot

Spring Boot 整合 Freemarker 模板引擎

在前后端分离架构大行其道的今天,模板引擎依然有着重要的地位和不可代替性。 Freemarker 是一款界开源的老牌模板引擎,使用 Java 开发,Spring 官方对 Freemarker 提供了支持。本文将会带你学习如何在 Spring Boot 中整合 Freemarker。 创建项目 在 pom.xml 添加 spring-boot-starter-web 和 spring-boot-starter-freemarker 依赖。 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-freemarker</artifactId> </dependency> 编写模板 根据 Spring Boot 约定,模板文件应该放在 src/main/resources 目录下的 templates 目录中。 在 templates 目录中,创建 index 文件夹,用于存放渲染主页的 index.ftl 模板视图,如下: 其中 index.ftl 内容如下: <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>Freemarker</title> </head> <body> Hello ${title}! </body> </html> 如上,模板只是简单地输出了 Model 中的 title 属性。 配置属性 Spring Boot 提供了很多配置属性,可用于在 application.yaml | properties 中定制 Freemarker。 这些属性都以 spring.

Spring Boot 中 SSL Bundle 的用法

1、简介 以前在 Spring Boot 中配置 SSL 非常复杂,主要是证书有很多类型,如:JKS、PKCS #12 或 PEM。每种类型的配置方式又不一样。 幸运的是,Spring Boot 3.1 引入了 SSL Bundle,旨在简化 Spring Boot 中的 SSL 配置。在本教程中,我们将了解什么是 SSL Bundle,以及如何用它简化 Spring Boot 应用中的 SSL 配置。 2、Spring Boot SSL Bundle 通常,我们需要把 SSL 证书转换为可用的 Java 对象。 java.security.KeyStore 对象用于存储证书。 javax.net.ssl.KeyManager 对象用于管理密钥。 javax.net.ssl.SSLContext 对象用于创建安全的套接字连接(Socket Connection)。 每个类都需要更深入的理解和配置,使得整个过程变得繁琐且容易出错。各种 Spring Boot 组件可能还需要深入到不同的抽象层来应用这些设置,给任务增加了另一个难度层级。 SSL Bundle 将所有 SSL 的配置(如 Keystore、证书和私钥)封装成一个易于管理的单元。可以应用于一个或多个网络连接,无论它们是传入连接(嵌入式服务器)还是传出连接(HTTP 客户端)。 SSL Bundle 在 application.yaml 或 application.properties 中,配置属性前缀是 spring.ssl.bundle。 首先从 JKS Bundle 开始,使用 spring.ssl.bundle.jks 来配置 Java Keystore 证书:

在 Spring Boot 中快速处理 CORS 跨域

跨域问题每个人都会遇到,特别是在前后端分离的系统中。 如果你正在使用 Spring Boot 开发后端应用,并且浏览器中遇到了跨域问题。类似于如下: Access to fetch at 'http://127.0.0.1/demo' from origin 'https://springdoc.cn' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled. 但是你又不想去了解跨域、CORS 这些到底是个啥,你只想快速地解决这个问题。 那你可以把如下配置类,添加到你的 Spring Boot 应用中,它可以解决 99% 以上的跨域问题: // TODO package 声明 import java.time.Duration; import java.util.Arrays; import java.util.stream.Stream; import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import org.

获取 Spring Boot 应用的 PID

PID 是进程标识符(Process Identifier)的缩写。在操作系统中,每个运行的进程都被分配一个唯一的 PID,用于标识进程。PID 通常是一个整数值,可以用来跟踪和管理进程的状态、资源分配以及进程间的通信。 本文将会介绍几种获取 Spring Boot 应用 PID 的方法。 ApplicationPidFileWriter ApplicationPidFileWriter 是 Spring Boot 提供的一个 Listener,它可以在应用启动后把 PID 写入到指定的文件。 它需要在启动前,通过编程式配置到应用中,并且需要在配置文件中指定要写入 PID 的文件。 application.yaml 配置如下: spring: pid: # 写入 PID 的文件,可以是相对路径或绝对路径 file: app.pid # 如果 PID 无法写入,是否抛出异常 fail-on-write-error: true 在启动前,配置 ApplicationPidFileWriter 监听器: import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.boot.context.ApplicationPidFileWriter; @SpringBootApplication public class DemoApplication { public static void main(String[] args) { SpringApplication springApplication = new SpringApplicationBuilder() .listeners(new ApplicationPidFileWriter()) // PID 监听 .

在 Spring Boot 中使用 SSL Bundle 配置 SSL

安全套接字层(SSL)和传输层安全(TLS)是在分层或面向服务的架构中保护系统之间通信的关键组件。在这样的架构中,Spring Boot 应用程序通常接受传入的网络连接或创建传出连接,开发人员的任务是配置应用程序以在这样的安全环境中工作。 如果你曾经使用过 Java 的 Security 和 SSL API,你可能意识到这不是一项特别简单的任务。你可能会在网上复制各种代码片段。有几个因素使得与 SSL 工作变得痛苦。 首先,你可能会收到用于生产环境的 SSL 资源文件,如证书和私钥。你可能需要为预生产测试生成不同的证书(通常使用自签名证书颁发机构)。这些证书通常以 Java Keystore 文件的形式存在,可以是 JKS 或 PKCS #12 格式,或者它们可能是 PEM 编码的文本文件。每种文件类型都需要不同的处理方式。 一旦你有了证书,你需要将其转换为可以传递给 Java Connection API 的形式。麻烦点就在这里,因为 Connection API 可以以多种方式进行配置: 有的要你提供 java.security.KeyStore(Keystore 和 Truststore) 实例。 有的要你提供 javax.net.ssl.KeyManager 和 javax.net.ssl.TrustManager 实例。 有的要你提供 javax.net.ssl.SSLContext 实例。 SSL 也是相当底层的,因此通常需要逐层解除抽象,以使用 java.security 或 java.net.ssl 包中的对象进行配置。例如,如果你想在 Spring RestTemplate 上配置SSL,你需要深入到支持它的 ClientHttpRequestFactory。对于典型的 Spring Boot 应用程序,可能是一个 HttpComponentsClientHttpRequestFactory、OkHttp3ClientHttpRequestFactory 或 SimpleClientHttpRequestFactory。每个 Factory 都提供了不同的配置API。 Spring Boot 配置 SSL 或 TLS 并不是什么新鲜事,但团队决定全面审视当前对 SSL 的支持,寻找改进和扩展支持的机会。我们希望 Spring Boot 3.

Spring Boot 在运行时启用和禁用端点

1、概览 在 Spring Boot 运行时,出于一些维护目的,我们可能需要动态地启用、禁用某些端点。 在本教程中,我们将学习如何使用 Spring Cloud、Spring Actuator 和 Apache 的 Commons Configuration 等几个常用库在运行时启用和禁用 Spring Boot 端点。 2、项目设置 以下是 Spring Boot 项目的关键设置。 2.1、Maven 依赖 首先,在 pom.xml 文件中添加 spring-boot-starter-actuator 依赖,用于暴露 /refresh 端点: <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> <version>2.7.5</version> </dependency> 接下来,添加 spring-cloud-starter 依赖,因为稍后需要使用其 @RefreshScope 注解来重载 Environment 中的属性源: <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter</artifactId> <version>3.1.5</version> </dependency> 还必须在项目 pom.xml 文件的 <dependencyManagement> 中添加 Spring Cloud 的 BOM,以便 Maven 使用兼容版本的 spring-cloud-starter: <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>2021.0.5</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> 最后,由于我们需要在运行时重新加载文件的功能,所以还要添加 commons-configuration 依赖:

在 Spring Boot 中使用 Gson 替换 Jackson

GSON 是由谷歌开源的一款 Java JSON 库。特点是轻量,只有一个 JAR,无任何其他依赖。高性能,支持以流式进行序列化/反序列化。并且抽象了基本的 JsonElement、JsonObject、JsonArray、JsonPrimitive 和 JsonNull,可以在无自定义 Java 对象的情况下构建、解析 JSON 对象。 本文将会指导你如何在 Spring Boot 中使用 Gson 代替默认的 Jackson 作为 JSON 序列化/反序列化框架。 添加依赖 在 pom.xml 中添加依赖。 gson 的版本已经被 Spring Boot 管理,所以不需要声明版本号。 <dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> </dependency> 由于 Spring Boot 默认使用 Jackson,所以很多 Spring Boot 的组件、框架默认也会选择用 Jackson 作为 JSON 库。如果你确认项目中,没有其他地方使用到了 Jackson,那么可以从依赖中排除它。 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-json</artifactId> </exclusion> </exclusions> </dependency> 并且,在 @SpringBootApplication 注解中,排除掉 Jackson 的自动装配。 @SpringBootApplication(exclude = { JacksonAutoConfiguration.class }) 配置属性 在 application.

给 RestTemplate 配置 SSL 证书来访问 HTTPS REST 服务

1、概览 在本教程中,我们将学习如何给 RestTemplate 配置 SSL 证书来访问 HTTPS 加密的 REST 服务。 2、设置 要确保 REST 服务的安全,我们需要使用证书和由证书生成的 Keystore。 证书可以从 CA 获取,在本文的示例中,使用的是自签名证书。 我们将使用 Spring 的 RestTemplate 来访问 HTTPS REST 服务。 首先,让我们创建一个 Controller 类 WelcomeController 和一个 /welcome 端点(返回一个简单的字符串响应): @RestController public class WelcomeController { @GetMapping(value = "/welcome") public String welcome() { return "Welcome To Secured REST Service"; } } 然后,在 src/main/resources 文件夹中添加我们的 keystore: src/main/resources |-keystore |-baeldung.p12 接下来,在 application.properties 文件中添加与 Keystore 相关的属性: server.port=8443 server.servlet.context-path=/ # keystore 的格式 server.

Spring Boot 中的枚举(Enum)映射

1、概览 在本教程中,我们将学习如何在 Spring Boot 中实现不区分大小写的枚举映射。 2、Spring 默认的枚举映射 在处理请求参数时,Spring 依靠几个内置 Converter 来处理字符串转换。 通常情况下,将枚举作为请求参数时,默认会使用 StringToEnumConverterFactory 将传递的字符串转换为枚举。 该 Converter 会调用 Enum.valueOf(Class, String),这意味着给定的字符串必须要完全匹配枚举中的常量实例。 例如,让我们来看看 Level 枚举: public enum Level { LOW, MEDIUM, HIGH } 接下来,创建一个使用枚举作为参数的 Handler Method: @RestController @RequestMapping("enummapping") public class EnumMappingController { @GetMapping("/get") public String getByLevel(@RequestParam(required = false) Level level){ return level.name(); } } 使用 CURL 向 http://localhost:8080/enummapping/get?level=MEDIUM 发送一个请求: curl http://localhost:8080/enummapping/get?level=MEDIUM Handler Method 会返回 MEDIUM,即枚举实例 MEDIUM 的名称(name())。 现在,让我们传递 medium,看看会发生什么: curl http://localhost:8080/enummapping/get?level=medium {"timestamp":"2022-11-18T18:41:11.440+00:00","status":400,"error":"Bad Request","path":"/enummapping/get"} 如你所见,返回了无效请求异常:

Spring 中的 FeignClient 与 WebClient

1、概览 在本教程中,我们将对 Spring Feign(声明式 REST 客户端)和 Spring WebClient(Spring 5 中引入的响应式 Web 客户端)的优缺点进行比较。 2、阻塞式和非阻塞式客户端 在微服务系统中,服务之间的通常通过 RESTful API 进行通信。因此,需要一个 Web 客户端来执行请求。 接下来,我们将了解阻塞式 Feign 客户端与非阻塞式 WebClient 之间的区别。 2.1、阻塞式 Feign 客户端 Feign 客户端是一种声明式 REST 客户端,能快速、简单地开发 Web 客户端。使用 Feign 时,只需定义接口并对其进行相应注解。然后,Spring 会在运行时生成实际的 Web 客户端实现。 @FeignClient 的实现使用 “每个请求一个线程” 的同步模型。因此,对于每个请求,当前线程会阻塞,直到收到响应为止。如果同时发起多个请求,就要使用大量的线程,每个打开的线程都会占用内存和CPU。 2.2、非阻塞式 WebClient 客户端 WebClient 是 Spring WebFlux 的一部分。它是 Spring Reactive Framework 提供的一种非阻塞解决方案,用于解决 Feign 客户端等同步实现的性能瓶颈。 Feign 客户端会为每个请求创建一个线程并阻塞它,直到收到响应为止,而 WebClient 会执行 HTTP 请求并将 “等待响应” 任务添加到队列中。随后,在收到响应后,从队列中执行 “等待响应” 任务,最后将响应发送给 Subscriber (订阅者)函数。 Reactive 框架实现了由 Reactive Streams API 支持的事件驱动架构。正如我们所看到的,这使我们能够编写只需要最少数量的阻塞线程就能执行 HTTP 请求的服务。