教程

Spring Boot 3.4 中的结构化日志

日志记录是应用故障排除的重要组成部分,也是可观测性的三大支柱之一,另外两个是指标和追踪(Trace)。没有人喜欢在生产环境中瞎操作,当事故发生时,开发者会很乐意看到日志文件。日志通常以人类可读的格式输出。 结构化日志是一种技术,其中日志输出以定义良好的格式编写,通常是机器可读的。这种格式可以输入到日志管理系统中,从而实现强大的搜索和分析功能。结构化日志最常用的格式之一是 JSON。 Spring Boot 3.4 开箱即支持结构化日志。它支持 Elastic Common Schema(ECS)和 Logstash 格式,也可以使用自己的格式进行扩展。 结构化日志的 Hello World 在 start.springboot.io 上创建一个新项目,不需要添加任何依赖,但至少要选择 Spring Boot 3.4.0-M2。 要在控制台上启用结构化日志记录,请将如下配置添加到 application.properties 中: logging.structured.format.console=ecs 这将指示 Spring Boot 以 Elastic Common Schema(ECS) 格式输出日志。 启动应用,你就会看到日志是 JSON 格式的: {"@timestamp":"2024-07-30T08:41:10.561295200Z","log.level":"INFO","process.pid":67455,"process.thread.name":"main","service.name":"structured-logging-demo","log.logger":"com.example.structured_logging_demo.StructuredLoggingDemoApplication","message":"Started StructuredLoggingDemoApplication in 0.329 seconds (process running for 0.486)","ecs.version":"8.11"} 将结构化日志记录到文件 你还可以将结构化日志写入文件。例如,这可以用于在控制台上打印人类可读的日志,同时将结构化日志写入文件以供机器读取。 要启用此功能,请将如下配置添加到 application.properties 中,并确保删除 logging.structured.format.console=ecs 设置: logging.structured.format.file=ecs logging.file.name=log.json 现在启动应用,你会看到控制台上有人类可读的日志,而 log.json 文件则包含机器可读的 JSON 内容。 添加额外字段 结构化日志的一个强大功能是,开发人员可以以结构化的方式在日志事件中添加信息。例如,你可以在每个日志事件中添加用户 ID,然后根据该 ID 进行过滤,查看这个特定用户做了什么。 Elastic Common Schema 和 Logstash 都在 JSON 中包含了 Mapped Diagnostic Context 的内容。

Spring Cloud Gateway 整合 OpenAPI

1、概览 文档是构建任何健壮的 REST API 的重要部分。我们可以基于 OpenAPI 规范实现 API 文档,并在 Spring 应用中使用 Swagger UI 进行可视化展示。 此外,由于 API 端点可以通过 API 网关公开,我们还需要将后端服务的 OpenAPI 文档与网关服务集成。网关服务将提供所有 API 文档的汇总视图。 本文将带你了解如何在 Spring 应用中集成 OpenAPI,以及如何使用 Spring Cloud Gateway 服务公开后端服务的 API 文档。 2、示例应用 假设我们需要构建一个简单的微服务来获取一些数据。 2.1、Maven 依赖 首先,添加 spring-boot-starter-web 依赖: <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>3.3.2</version> </dependency> 2.2、实现 REST API 我们的后端应用有一个端点返回 Product 数据。 首先,创建 Product 类: public class Product { private long id; private String name; // 标准 Getter / Setter } 接下来,在 ProductController 中实现 getProduct 端点:

在 Spring Authorization Server 中动态注册客户端

1、简介 Spring Authorization Server(授权服务器)自带一系列合理的默认设置,开箱即用。 但是,它还有一个功能,默认下没有启动:态客户端注册。本文将带你了解如何在客户端应用中启用和使用它。 2、为什么使用动态注册? 当基于 OAuth2 的客户端应用(在 OIDC 术语中称为依赖方)启动认证流程时,它将自己的客户端标识符发送给身份提供者(Provider)。 一般情况下,这个标识符是通过外部流程(如邮件发送等其他手段)发放给客户端的,客户端随后将其添加到配置中,并在需要时使用。 例如,在使用 Azure 的 EntraID 或 Auth0 等流行的身份提供商(Identity Provider)解决方案时,我们可以使用管理控制台或 API 来配置新客户端。在此过程中,我们需要告知应用名称、授权回调 URL、支持的作用域等信息。 提供所需信息后,我们会得到一个新的客户端标识符,对于所谓的 “secret” 客户端,还将得到一个 client secret。然后,我们将这些信息添加到应用的配置中,就可以开始部署了。 现在,当我们应用不多,或者总是使用单一的一个身份供应商时(Identity Provider),这种方式就能正常工作。但对于更复杂的情况,注册过程需要是动态的,这就是 OpenID Connect 动态客户端注册规范 的用武之地。 在现实世界中,英国的 OpenBanking 标准就是一个很好的例子,该标准将动态客户注册作为其核心协议之一。 3、动态注册是如何实现的? OpenID Connect 标准使用一个注册 URL,客户端使用该 URL 注册自己。注册是通过 POST 请求完成的,该请求包含一个 JSON 对象,其中有执行注册所需的客户端元数据。 重要的是,访问注册端点需要身份认证,通常是一个 Bearer Token。当然,这就引出了一个问题:想成为客户端的人如何获得用于此操作的 Token? 遗憾的是,答案并不明确。一方面,规范指出端点是受保护的资源,因此需要某种形式的身份认证。另一方面,它也提到了开放注册端点的可能性。 对于 Spring 授权服务器来说,注册需要一个具有 client.create scope 的 Bearer Token。要创建该令牌,我们需要使用常规 OAuth2 的 Token 端点和基本凭证。 动态注册的流程如下: 客户端注册成功后,就可以使用返回的客户端 ID 和 secret secret 执行任何标准授权流程。

在 JDBC PreparedStatement 中使用 IN 语句

1、简介 在数据库 SQL 查询中,我们经常使用 IN 语句来一次性检索匹配多个值的记录,本文将带你了解如何在 JDBC PreparedStatement 中使用 IN 子句。 2、设置 创建一个 CUSTOMER 表,并添加一些记录,以便使用 IN 子句进行查询: void populateDB() throws SQLException { String createTable = "CREATE TABLE CUSTOMER (id INT, first_name VARCHAR(50), last_name VARCHAR(50))"; connection.createStatement().execute(createTable); String load = "INSERT INTO CUSTOMER (id, first_name, last_name) VALUES(?,?,?)"; IntStream.rangeClosed(1, 100) .forEach(i -> { PreparedStatement preparedStatement1 = null; try { preparedStatement1 = connection.prepareStatement(load); preparedStatement1.setInt(1, i); preparedStatement1.setString(2, "firstname" + i); preparedStatement1.setString(3, "lastname" + i); preparedStatement1.execute(); } catch (SQLException e) { throw new RuntimeException(e); } }); } 3、PreparedStatement PreparedStatement 表示一个已经预编译的 SQL 语句,可以高效地多次使用,每次使用可以填充不同的参数。

Maven 环境变量:M2_HOME、MAVEN_HOME 和 PATH

1、概览 在 Apache Maven 安装的过程中,我们需要配置各种环境变量,以确保 Maven 能正常运行。本文将带你了解与之相关的三个变量:M2_HOME、MAVEN_HOME 和 PATH。 先来看看如何配置最早版本的 Maven。 注意:Apache Maven 1.x 和 Maven 2.x 已停止使用。第 2 节和第 3 节展示的配置仅供参考,不提倡使用。 2、Maven 1.x 下载并解压 Maven 压缩文件,进入到解压目录的 bin 文件夹。在这个目录中,你可以尝试执行一下 maven 命令,看看它是否能正常工作: $ maven -v 该命令输出如下,表示我们缺少一个必需的环境变量: MAVEN_HOME must be set MAVEN_HOME 环境变量指定了 Maven 目录(解压后的)的位置,而且该环境变量是必须的。 在系统中添加这个环境变量后,再次运行之前的命令(需要新的终端中运行): $ maven -v 结果如下: __ __ | \/ |__ _Apache__ ___ | |\/| / _` \ V / -_) ' \ ~ intelligent projects ~ |_| |_\__,_|\_/\___|_||_| v.

使用 poi-tl 模板生成 MS Word 文档

1、概览 poi-tl 是一个基于 Apache POI 的开源 Java 库,用于简化使用模板生成 Word 文档的过程。它是一个 Word 模板引擎,可根据 Word 模板和数据创建新文档。 我们可以在模板中指定样式。从模板生成的文档将保留指定的样式。模板是声明式的,纯粹基于标签,图片、文本、表格等都有不同的标签模式。poi-tl 库还支持自定义插件,以根据需要构建文档。 本文将带你了解模板中可以使用的不同标签,以及模板中自定义插件的用法。 2、依赖 要使用 poi-tl 库,我们需要在项目中添加其 maven 依赖: <dependency> <groupId>com.deepoove</groupId> <artifactId>poi-tl</artifactId> <version>1.12.2</version> </dependency> 你在 Maven Central 中找到最新版本的 poi-tl 库。 3、配置 使用 ConfigureBuilder 类来构建配置: ConfigureBuilder builder = Configure.builder(); ... XWPFTemplate template = XWPFTemplate.compile(...).render(templateData); template.writeAndClose(...); 模板文件是以 Word .docx 文件格式保存的。首先,我们使用 XWPFTemplate 类的 compile 方法对模板进行编译。模板引擎编译模板,并根据 templateData 在新的 docx 文件中进行渲染。在这里,writeAndClose 创建一个新文件,并按照模板中指定的格式写入指定的数据。templateData 是一个 HashMap 的实例,其中 Key 为 String,值为 Object。 我们可以根据自己的需要配置模板引擎。 3.1、标签前缀和后缀 模板引擎使用大括号 {{}} 表示标签。我们可以将其设置为 ${} 或其他任何形式:

Hibernate 中 INSERT 查询的 ON CONFLICT 子句

1、概览 本文将带你了解 Hibernate 6.5 中引入的用于 INSERT 查询的 ON CONFLICT 子句。 我们使用 ON CONFLICT 子句来处理使用 HQL 或 Criteria 查询插入数据时违反表约束的情况。ON CONFLICT 子句也可以用于处理 upsert 查询。 2、ON CONFLICT 子句 使用 ON CONFLICT 子句进行 insert 的语法如下: "INSERT" "INTO"? targetEntity targetFields (queryExpression | valuesList) conflictClause? conflictClause 的写法为: "on conflict" conflictTarget? conflictAction conflictAction(冲突操作)可以是 DO NOTHING 或者 DO UPDATE。 现在,来看一个例子。假设实体类 Student 的属性有 studentId 和 name: @Entity public class Student { @Id private long studentId; private String name; } studentId 属性是 Student 实体的唯一键。我们可以在 INSERT VALUES 查询中手动插入 @Id 值,或者使用 @GeneratedValue 注解来指定 ID 的生成策略。

Quarkus 整合 Mongodb

1、简介 Quarkus 是一个流行的 Java 框架,经过优化,可用于创建内存占用小、启动速度极快的应用。 与流行的 NoSQL 数据库 MongoDB 搭配使用时,Quarkus 为开发高性能、可扩展的应用提供了强大的工具包。 本文将带你了解如何使用 Quarkus 配置 MongoDB、实现基本的 CRUD 操作,以及如何使用 Quarkus 的 Panache(Object Document Mapper,ODM)来简化这些操作。 2、配置 2.1、Maven 依赖 要在 Quarkus 中使用 MongoDB,需要添加 quarkus-mongodb-client 依赖: <dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-mongodb-client</artifactId> <version>3.13.0</version> </dependency> 该依赖提供了使用 MongoDB Java 客户端与 MongoDB 数据库交互的必要工具。 2.2、运行 MongoDB 数据库 本文采用 Docker 的方式运行 MongoDB,这种方式非常便捷,无需在机器上直接安装 MongoDB。 从 Docker Hub 拉取 MongoDB 镜像: docker pull mongo:latest 启动一个新的容器: docker run --name mongodb -d -p 27017:27017 mongo:latest 2.3、配置 MongoDB 数据库 要配置的主要属性是访问 MongoDB 的 URL。我们可以在 connection 字符串中包含几乎所有的配置。

通过 CLI 命令行发送 Key/Value 消息到 Kafka

1、概览 本文将带你了解从 Kafka 命令行(CLI)发送 Key/Value 消息的两种方法。 在处理金融交易、预订、在线购物等实时事件驱动系统中,确保特定 Topic 上消息的有序性是一个常见需求。在这种情况下,我们应该为发送到这些 Topic 的事件使用 Kafka Message Key。 2、先决条件 首先,需要一个正在运行的 Kafka 实例。如果没有,可以使用 Kafka Docker 或根据 Kafka 快速入门指南 建立一个环境。下面的章节将假定我们已经有一个运行中的 Kafka 实例,且可以通过 kafka-server:9092 访问。 接下来,假设我们开发的是一个 “支付系统”,而且需要从命令行发送消息。 以下是对应的 Model 类: // 支付事件 public class PaymentEvent { private String reference; private BigDecimal amount; private Currency currency; // 标准的 Getter / Setter 方法 } 另一个前提条件是要有访问 Kafka CLI 工具的权限,这很简单。首先,下载 Kafka 发行版,然后解压下载的文件,并进入解压后的文件夹中。在 bin 文件夹下就可以找到 Kafka CLI 工具。 本文后面内容中的所有 CLI 命令,都假设是在 Kafka 解码文件夹下执行的。

Spring AI 与 NVIDIA LLM API

Spring AI 现在支持 NVIDIA®(英伟达™)的 大型语言模型 API,可与各种 模型 集成。通过利用 NVIDIA 的 OpenAI 兼容 API,Spring AI 允许开发人员通过熟悉的 Spring AI API 使用 NVIDIA LLM。 本文将带你了解如何配置和使用 Spring AI OpenAI 聊天客户端来连接 NVIDIA LLM API。 完整的示例代码可从 nvidia-llm GitHub 仓库获取。 SpringAI / NVIDIA 整合文档。 先决条件 创建 NVIDIA 帐户并获得足够的积分。 从 NVIDIA 提供的 LLM 模型 中选择自己喜欢的模型。如下面截图中的 meta/llama-3.1-70b-instruct。 从模型页面获取所选模型的 API Key。 依赖 首先,将 Spring AI OpenAI Starter 添加到 Maven pom.xml 中: <dependency> <groupId>org.springframework.ai</groupId> <artifactId>spring-ai-openai-spring-boot-starter</artifactId> </dependency> 对于 Gradle 来说,需要在 build.gradle 添加如下依赖: