（十一）springboot实战——springboot3下关于WebFlux项目的一些常用功能整合

news2024/12/24 21:43:59

前言

本节内容主要是对webflux项目一些常用功能的介绍，例如系统集成swagger接口文档，方便接口测试以及前后端项目联调测试；使用actuator完成系统各种指标的监控功能；系统使用logback日志框架完成项目日志的收集；使用过滤器WebFilter完成一些初始化验证；使用CorsWebFilter解决系统的跨域问题；使用AOP切面实现功能方法操作日志的打印等。

正文

swagger接口文档集成

①引入webflux的springdoc文档的pom依赖

<!-- https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webflux-ui -->
<dependency>
	<groupId>org.springdoc</groupId>
	<artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
	<version>2.3.0</version>
</dependency>

②在资源文件application.yaml中配置接口文档访问地址，并开启接口文档访问权限enabled: true，生产环境可以关闭

springdoc:
  api-docs:
    enabled: true
    path: /api-docs
  swagger-ui:
    enabled: true
    path: /swagger-ui/index.html
  show-actuator: true

③访问swagger文档地址，查看集成效果

④更高级的用法， 通过配置GroupedOpenApi分组，定义不同的分组匹配规则，配置更细粒度的接口分组文档

package com.yundi.atp.config;

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


@Configuration
public class SpringDocConfig {
    @Bean
    public GroupedOpenApi sysOpenApi() {
        return GroupedOpenApi.builder()
                .group("SpringWebflux-系统管理")
                .pathsToMatch("/user/**", "/role/**")
                .build();
    }

    @Bean
    public GroupedOpenApi actuatorOpenApi() {
        return GroupedOpenApi.builder()
                .group("SpringWebflux-系统监控")
                .pathsToMatch("/actuator/**")
                .build();
    }

    @Bean
    public OpenAPI springDocOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("SpringWebflux API")
                        .description("SpringWebflux 案例")
                        .version("v1.0.0")
                        .license(new License().name("Apache 2.0").url("http://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .description("SpringWebflux Wiki Documentation")
                        .url("https://springshop.wiki.github.org/docs"));
    }

}

⑤接口文档分组效果，可根据Select a definition切换到不同的文档分组下

actuator监控配置

①引入actuator监控启动器的pom依赖

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

②在资源配置文件application.yaml中配置actuator监控的web访问

management:
  endpoints:
    enabled-by-default: true #暴露所有端点信息
    web:
      exposure:
        include: '*'  #以web方式暴露

③通过swagger接口文档，查看actuator监控的web指标接口

logback日志配置

①在resources资源目录下创建一个logback.xml日志文件，定义日志文件的打印格式及规则等

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--设置存储路径变量-->
    <property name="LOG_HOME" value="ht-webflux"/>

    <!--控制台输出appender-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--设置输出格式-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度，%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <!--设置编码-->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--文件输出,时间窗口滚动-->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志名,指定最新的文件名，其他文件名使用FileNamePattern -->
        <File>${LOG_HOME}/ht.log</File>
        <!--文件滚动模式-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名,可设置文件类型为gz,开启文件压缩-->
            <FileNamePattern>${LOG_HOME}/%d{yyyy-MM-dd}_%i.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
            <!--按大小分割同一天的-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>20MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!--输出格式-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <!--设置编码-->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--根据环境配置日志-->
    <springProfile name="dev">
        <!-- 打印 日志级别 -->
        <root level="INFO">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="FILE"/>
            <!--            <appender-ref ref="LOGSTASH"/>-->
        </root>
    </springProfile>
    <springProfile name="test">
        <!-- 打印 日志级别 -->
        <root level="INFO">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="FILE"/>
        </root>
    </springProfile>
    <springProfile name="prod">
        <!--指定基础的日志输出级别-->
        <root level="INFO">
            <!--appender将会添加到这个logger-->
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="FILE"/>
<!--            <appender-ref ref="LOGSTASH"/>-->
        </root>
    </springProfile>
</configuration>

②启动项目，查看日志输出

过滤器WebFilter整合

①通过实现WebFilter接口，定义一个自定义的web过滤器MyWebFilter，并加入spring容器中

package com.yundi.atp.filter;

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.WebFilter;
import org.springframework.web.server.WebFilterChain;
import reactor.core.publisher.Mono;


@Component
@Slf4j
public class MyWebFilter implements WebFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
        //可以获取请求域
        ServerHttpRequest request = exchange.getRequest();
        log.info("url:", request.getURI());
        //可以获取响应域
        ServerHttpResponse response = exchange.getResponse();
        log.info("--------------请求处理放行到目标方法之前的过滤器业务处理------------");
        Mono<Void> filter = chain.filter(exchange);

        //流一旦经过某个操作就会变成新流
        Mono<Void> mono = filter.doOnError(error -> {
            log.info("---------------目标方法异常以后--------------");
            log.info("error:" + error);
        }).doFinally(signalType -> {
            log.info("---------------目标方法执行完成以后--------------");
        });
        return mono;
    }
}

②访问任意一个接口，查看web过滤器是否生效

CorsWebFilter跨域配置

①配置CorsWebFilter过滤器，解决接口请求跨域问题

package com.yundi.atp.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.reactive.CorsWebFilter;
import org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource;


@Configuration
public class MyCorsConfig {
    @Bean
    public CorsWebFilter corsWebFilter() {
        CorsConfiguration corsConfig = new CorsConfiguration();
        // 允许所有来源
        corsConfig.addAllowedOrigin("*");
        // 允许所有HTTP方法
        corsConfig.addAllowedMethod("*");
        // 允许所有请求头
        corsConfig.addAllowedHeader("*");
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", corsConfig);
        return new CorsWebFilter(source);
    }
}

②查看浏览器响应头中是否包含跨域配置

 

AOP切面

①创建一个操作日志的OperateLogAspect切面，记录请求方法执行过程日志

package com.yundi.atp.aop;

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import reactor.core.publisher.Mono;


@Slf4j
@Aspect
@Component
public class OperateLogAspect {

    /**
     * 切点
     */
    @Pointcut("execution(* com.yundi.atp.controller.*.*(..))")
    public void logPointCut() {

    }

    @Around("logPointCut()")
    public Mono<Object> aroundAdvice(ProceedingJoinPoint joinPoint) throws Throwable {
        // 在方法执行前的逻辑
        log.info("************************目标方法执行前************************");
        log.info("args:{}",joinPoint.getArgs());
        // 执行被切入的方法
        Mono<Object> result = (Mono<Object>) joinPoint.proceed();

        // 在方法执行后的逻辑
        Mono<Object> mono = result.doOnError(error -> {
            log.info("************************目标方法异常以后************************");
            log.info("error:" + error);
        }).doFinally(signalType -> {
            log.info("************************目标方法执行完成以后************************");
        });
        return mono;
    }
}

② 访问接口，验证操作日志切面是否生效

结语

关于springboot3下WebFlux项目的一些常用功能整合的内容到这里就结束了，我们下期见。。。。。。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1424675.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

reactnative 调用原生ui组件

reactnative 调用原生ui组件

reactnative 调用原生ui组件 ![组件对应关系](https://img-blog.csdnimg.cn/direct/c4351ad7bd38411e9c13087f1059a4b0.png)1.该样例已textView，介绍。 新建MyTextViewManager 文件，继承SimpleViewManager。import android.graphics.Color; import android.widget.TextView;…
阅读更多...
redis设计与实践的总结

redis设计与实践的总结

Redis是一款高性能的Key-Value存储系统&#xff0c;它可以用作缓存、消息队列、计数器、排行榜等多种应用场景。在实际应用中&#xff0c;如何设计和使用Redis是非常关键的。本文将介绍Redis的设计原则和最佳实践&#xff0c;帮助您更好地利用Redis提高应用性能和可靠性。 ###…
阅读更多...
【Linux】文件基础、文件系统调用接口、文件描述符

【Linux】文件基础、文件系统调用接口、文件描述符

目录 文件基础 系统调用接口 open close write 实现文件写入 实现文件内容追加 read 实现文件读取 文件描述符fd 文件基础 1.空文件&#xff0c;也要在磁盘占用空间。 2.文件内容属性 3.文件操作&#xff1a;是单独对于内容或属性、或者内容和属性 4.文件路径文件名&…
阅读更多...
C++ 菱形继承和虚拟菱形继承

C++ 菱形继承和虚拟菱形继承

菱形继承和虚拟菱形继承 菱形继承1. 概念2. 产生的问题 虚拟菱形继承1.1 使用1.2 原理 菱形继承 1. 概念 菱形继承是多继承的一个特殊情况&#xff0c;多继承是指一个子类类继承了两个或以上的直接父类&#xff0c;而菱形继承问题的产生是因为该子类的父类&#xff0c;继承了…
阅读更多...
MTK8365安卓核心板_联发科MT8365(Genio 350)核心板规格参数

MTK8365安卓核心板_联发科MT8365(Genio 350)核心板规格参数

MTK8365安卓核心板是一款高性能的嵌入式处理器产品&#xff0c;基于联发科领先的SoC架构和先进的12纳米工艺。它集成了四核ARM Cortex-A53处理器&#xff0c;每个核心频率高达2.0 GHz&#xff0c;搭载强大的多标准视频加速器&#xff0c;支持高达1080p 60fps的视频解码。此外&a…
阅读更多...
SpringBoot使用当前类代理类(内部事务)解决方案

SpringBoot使用当前类代理类(内部事务)解决方案

文章目录 一、场景描述二、解决方案1. 使用 Lazy&#xff08;推荐&#xff09;2. 使用方法注入3. 使用 ApplicationContext4. 分离服务层5. AspectJ 代理模式 在 Spring Boot 开发中&#xff0c;我们时常遇到需要在一个类的内部调用自己的其他方法&#xff0c;并且这些方法可能…
阅读更多...
一步步教大家在windows环境下搭建SkyWalking，百分百成功（内附spring boot demo工程源码）

一步步教大家在windows环境下搭建SkyWalking，百分百成功（内附spring boot demo工程源码）

本文详细的介绍了skywalking在Win10上的环境安装过程&#xff0c;es 、oap 和应用jar包都在一台机器上运行。其中文章中提供了es、oap、agent、以及springboot demo工程的下载链接。相信刚接触Skywalking的同学&#xff0c;只需要按照本文内容一步步操作就会完成skywalking的环…
阅读更多...
Kotlin 协程：深入理解 ‘async { }‘

Kotlin 协程：深入理解 ‘async { }‘

Kotlin 协程&#xff1a;深入理解 ‘async { }’ Kotlin 协程是一种强大的异步编程工具&#xff0c;它提供了一种简洁、易读的方式来处理并发和异步操作。在 Kotlin 协程库中&#xff0c;async {} 是一个关键的函数&#xff0c;它允许我们启动一个新的协程&#xff0c;并返回一…
阅读更多...
[Python-闫式DP]

[Python-闫式DP]

闫式DP分析法 闫老师是将DP问题归结为了有限集合中的最值问题。 动态规划有两个阶段&#xff0c;一是状态表示&#xff0c;二是状态计算。 状态表示 f(i,j) 状态表示是一个化零为整的过程&#xff0c;动态规划的做题思路不是暴力法的每一个物品都去枚举&#xff0c;而是将相…
阅读更多...
二叉树-堆应用（1）

二叉树-堆应用（1）

目录 堆排序 整体思路 代码实现 Q1建大堆/小堆 Q2数据个数和下标 TopK问题 整体思路 代码实现 Q1造数据CreateData Q2建大堆/小堆 建堆的两种方法这里会用到前面的向上/向下调整/交换函数。向上调整&向下调整算法-CSDN博客 堆排序 整体思路 建堆&#xff08;直…
阅读更多...
安全通道堵塞识别摄像机

安全通道堵塞识别摄像机

当建筑物的安全通道发生堵塞时&#xff0c;可能会给人员疏散和救援带来重大隐患。为了及时识别和解决安全通道堵塞问题&#xff0c;专门设计了安全通道堵塞识别摄像机&#xff0c;它具有监测、识别和报警功能&#xff0c;可在第一时间发现通道堵塞情况。这种摄像机通常安装在通…
阅读更多...
LeetCode--171

LeetCode--171

171. Excel 表列序号 给你一个字符串 columnTitle &#xff0c;表示 Excel 表格中的列名称。返回 该列名称对应的列序号 。 例如&#xff1a; A -> 1 B -> 2 C -> 3 ... Z -> 26 AA -> 27 AB -> 28 ... 示例 1: 输入: columnTitle "A" 输出:…
阅读更多...
WebGL技术开发框架

WebGL技术开发框架

WebGL技术框架是一些提供了便捷API和工具的库&#xff0c;用于简化和加速在Web浏览器中使用WebGL进行3D图形开发。以下是一些常用的WebGL技术框架&#xff0c;希望对大家有所帮助。北京木奇移动技术有限公司&#xff0c;专业的软件外包开发公司&#xff0c;欢迎交流合作。 1.Th…
阅读更多...
ElementUI 组件：Layout布局（el-row、el-col）

ElementUI 组件：Layout布局（el-row、el-col）

ElementUI安装与使用指南 Layout布局 点击下载learnelementuispringboot项目源码 效果图 el-row_el-col.vue页面效果图 项目里el-row_el-col.vue代码 <script> export default {name:el-row_el-col 布局 }</script><template><div class"roo…
阅读更多...
Python代码重构库之rope使用详解

Python代码重构库之rope使用详解

概要 Python是一门强大的编程语言，但在大型项目中，维护和重构代码可能会变得复杂和困难。为了提高开发人员的效率和准确性，有许多工具可用于辅助代码重构和智能代码补全。其中之一是Python Rope。 Python Rope是一个用于Python编程语言的强大工具，它提供了丰富的功能，包…
阅读更多...
STM32低功耗模式

STM32低功耗模式

一、低功耗模式介绍 STM32 的低功耗模式有 3 种&#xff1a; 1)睡眠模式&#xff08;CM3 内核停止&#xff0c;外设仍然运行&#xff09; 2)停止模式&#xff08;所有时钟都停止&#xff09; 3)待机模式&#xff08;1.8V 内核电源关闭&#xff09; 在这三种低功耗模式中&#…
阅读更多...
[机器学习]简单线性回归——最小二乘法

[机器学习]简单线性回归——最小二乘法

一.线性回归及最小二乘法概念 2.代码实现 # 0.引入依赖 import numpy as np import matplotlib.pyplot as plt# 1.导入数据 points np.genfromtxt(data.csv, delimiter,) # points[0,0]# 提取points中的两列数据&#xff0c;分别作为x&#xff0c;y x points[:, 0] y poi…
阅读更多...
TSINGSEE青犀智能分析网关V4如何利用AI智能算法保障安全生产、监管，掀开安全管理新篇章

TSINGSEE青犀智能分析网关V4如何利用AI智能算法保障安全生产、监管，掀开安全管理新篇章

旭帆科技的智能分析网关V4内含近40种智能分析算法&#xff0c;包括人体、车辆、消防、环境卫生、异常检测等等&#xff0c;在消防安全、生产安全、行为检测等场景应用十分广泛。如常见的智慧工地、智慧校园、智慧景区、智慧城管等等&#xff0c;还支持抓拍、记录、告警、语音对…
阅读更多...
数据库运维工作量直接减少 50%，基于大模型构建智能问答系统的技术分享

数据库运维工作量直接减少 50%，基于大模型构建智能问答系统的技术分享

本文源自百度智能云数据库运维团队的实践&#xff0c;深入探讨了基于大模型构建「知识库智能问答系统」的设计过程和应用。 全文包括了总体的技术方案选型、各个模块的设计实现、重点难点问题的突破、以及目前的落地场景应用等。 该系统自从内部上线以来&#xff0c;整体的回…
阅读更多...
【Vue】vue项目中使用tinymce富文本组件（@tinymce/tinymce-vue）

【Vue】vue项目中使用tinymce富文本组件（@tinymce/tinymce-vue）

【Vue】vue项目中使用tinymce富文本组件&#xff08;tinymce/tinymce-vue&#xff09; 一、安装二、前期准备工作1、去[官网](https://www.tiny.cloud/get-tiny/language-packages/)下载语言包&#xff1b;2、将下载的语言包复制到项目中的assets&#xff08;存放路径您随意&am…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023