1.springcloud服务启动后怎么知道接口调用路径?
2.Java21 + SpringBoot3整合springdoc-openapi,自动生成在线接口文档,支持SpringSecurity和JWT认证方式
3.SpringCloud微服务实战——搭建企业级开发框架(十九):Gateway使用knife4j聚合微服务文档
4.全面升级!一套基于Spring Boot 3+JDK17的实战项目!
5.idea中使用maven的常用命令详解
6.Knife4j @ApiModelProperty position不生效--避坑
springcloud服务启动后怎么知道接口调用路径?
在Spring Cloud服务启动后,可以使用Swagger UI工具查看服务的目录分类网源码接口调用路径。Swagger是一种开放源代码软件框架,可以生成、描述、调用和可视化RESTful Web服务。要使用Swagger UI工具,需要在Spring Cloud项目中引入相应的依赖,然后配置相应的Swagger配置类,如下所示:
引入Swagger2和Swagger UI的依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
编写Swagger配置类,用于配置Swagger相关信息:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
}
启动Spring Cloud服务,然后在浏览器中访问Swagger UI,可以查看API文档。
默认情况下,Swagger UI的访问路径为 /wmz/GitEg...的chapter-分支中。
GitEgg-Cloud是基于SpringCloud整合搭建的企业级微服务应用开发框架,旨在提供一站式解决方案,帮助开发者高效构建微服务应用。项目开源地址如下: Gitee: / GitHub: /全面升级!一套基于Spring Boot 3+JDK的源码上传以后实战项目!
最近对mall项目进行了全面升级,支持了Spring Boot 3和JDK。以下是mall项目的升级内容,包括依赖升级、框架用法升级以及运行部署的改动。Spring Boot 3版本的代码位于mall项目的dev-v3分支。
mall项目简介:mall项目是一个基于SpringBoot、Vue和uni-app实现的电商系统(Github标星K),采用Docker容器化部署。项目包括前台商城项目和后台管理系统,支持完整的订单流程,涵盖商品、订单、购物车、权限、优惠券、会员、支付等功能。
项目演示:
升级版本:项目中的依赖已经升级到最新主流版本,具体版本可参考下表。
升级用法:在mall项目升级Spring Boot 3的过程中,部分框架的用法发生了变化。例如,发卡分站源码生成API文档的库已从SpringFox迁移到SpringDoc,Spring Data Elasticsearch和Spring Security的用法也有所不同。以下将重点讲解这些升级的新用法。
从SpringFox迁移到SpringDoc:由于之前使用的Swagger库为SpringFox,目前已不支持Spring Boot 3,因此已迁移到SpringDoc。
Spring Data Elasticsearch新用法:Spring Data ES中基于ElasticsearchRepository的简单查询用法保持不变,但对于复杂查询,由于ElasticsearchRestTemplate类已被移除,需要使用ElasticsearchTemplate类来实现。
Spring Security新用法:升级Spring Boot 3版本后,Spring Security的用法也有所变化。例如,某些实现动态权限的类已被弃用,Security配置改用函数式编程的方式。
其他运行部署:由于Spring Boot 3最低要求是JDK,在Windows下运行项目时需要配置好项目的JDK版本,其他操作与之前版本相同。
Linux:在打包应用的Docker镜像时,需要配置项目使用openjdk:。这可以在项目根目录下的pom.xml中修改docker-maven-plugin插件配置完成。
由于镜像使用了openjdk:,在打包镜像之前需要提前下载好openjdk的半对数源码镜像。可以使用以下命令下载,其他操作与之前版本部署相同。
总结:今天主要讲解了mall项目升级Spring Boot 3版本的一些注意点。项目源码地址:github.com/macrozheng/m...
idea中使用maven的常用命令详解
Maven 常用命令详解 使用 Maven 命令,可以高效地对项目进行清理、编译、测试、打包、安装,并部署到本地仓库或远程仓库。其中,几个常用的 Maven 命令包括:maven clean、maven compile、maven test、maven packet、maven install 和 maven deploy。 一、Maven 常用命令及其作用 1、maven clean:清理项目,删除 target 目录下的编译内容。 2、maven compile:编译项目源代码。 3、多例模式源码maven test:运行项目测试。 4、maven packet:打包文件并存放到项目的 target 目录下,生成编译后的 class 文件。 5、maven install:在本地仓库生成安装包,供其他项目引用,同时将打包后的文件存放到项目的 target 目录下。 二、常用命令使用场景举例 1、执行 mvn clean package 命令,依次执行了 clean、resources、compile、testResources、testCompile、test、jar(打包)等七个阶段。 2、执行 mvn clean install 命令,依次执行了 clean、resources、compile、testResources、testCompile、test、jar(打包)、install 等八个阶段,完成项目编译、单元测试、打包,同时将 jar 包部署到本地 maven 仓库,但未部署到远程 maven 私服仓库。 3、执行 mvn clean deploy 命令,依次执行了 clean、resources、compile、testResources、testCompile、test、jar(打包)、install、deploy 等九个阶段,完成项目编译、单元测试、打包,并将 jar 包部署到本地 maven 仓库和远程 maven 私服仓库。 三、常见问题解答 1、mvn clean install 和 mvn install 的区别:mvn install 可能得到的 jar 包为最新版本,除非手动修改 jar 包内容而不修改源代码;mvn clean install 生成最新 jar 包最保险。 2、maven 跳过单元测试的方法:mvn package -Dmaven.test.skip=true 跳过单元测试及测试代码编译;mvn package -DskipTests 跳过单元测试但会继续编译,建议避免使用。 3、测试环境部署脚本:mvn clean install -U -Dmaven.test.skip=true 跳过单元测试和测试代码编译;mvn clean install -U -DskipTests 跳过单元测试但会继续编译。 4、查找 jar 包的引入配置:使用 mvn dependency:tree -Dverbose -Dincludes=要查询的内容,例如 mvn dependency:tree -Dverbose -Dincludes=io.springfox:jakarta.springfox-swagger2。 Maven 命令提供了一种高效、灵活的方式来管理项目构建和依赖关系,适用于各种规模的项目开发。通过掌握这些命令及其应用场景,开发者可以显著提高项目构建和部署的效率。Knife4j @ApiModelProperty position不生效--避坑
在项目中应用Knife4j-3.0.3,尽管官方文档说明基于swagger2-2..5,实际上应引用swagger2-3.0.0。
在DTO上使用@ApiModelProperty注解时,UI默认会按照字段名的字母顺序展示。若需将关键字段前置,可尝试设定position属性。
不料,发现position参数并未起效,查看官方GitHub的issue发现,此问题在版本2.4.9中已被修复,但仍有人反映此bug依旧存在。
遍寻资料无果后,深入研究源码,在springfox.documentation.swagger2.mappers.CompatibilityModelMapper类中找到了问题所在。
该类中的useModelV3配置默认为true,执行的排序逻辑使用了Comparator::naturalOrder,即按照字母顺序排列。而正确的排序逻辑应在后续分支的ModelMapper中,使用position与name的组合进行排序。
修改配置
在application.properties或application.yml文件中调整相关配置,确保Knife4j正确地应用排序规则,实现自定义展示顺序。
神器 SpringDoc 横空出世!最适合 SpringBoot 的API文档工具来了
之前在SpringBoot项目中,我一直在使用SpringFox提供的Swagger库。然而,当我浏览其官网时,发现已经有将近两年没有出新版本了。最近,当我升级到SpringBoot 2.6.x版本时,发现这个库的兼容性也越来越差,有些常用注解属性甚至被废弃了,而库中并没有提供替代方案。偶然间,我发现了一款名为SpringDoc的Swagger库,试用后发现效果非常不错,因此推荐给大家。
SpringDoc是一款基于OpenAPI 3的API文档生成工具,可以与SpringBoot结合使用。在Github上,它已经获得了超过1.7K个Star,更新发布也相当频繁,可以说是一款比Swagger库更好用的工具。值得一提的是,SpringDoc不仅支持Spring WebMvc项目,还可以支持Spring WebFlux项目,甚至Spring Rest和Spring Native项目,功能非常强大。下面是一张SpringDoc的架构图。
接下来,我将介绍SpringDoc的使用方法。我将以之前集成SpringFox的mall-tiny-swagger项目为例,将其改造为使用SpringDoc。
首先,我们需要集成SpringDoc。在pom.xml中添加它的依赖即可,开箱即用,无需任何配置。
从SpringFox迁移结合SpringSecurity使用测试常用配置
SpringDoc还有一些常用的配置可以了解,更多配置可以参考官方文档。
总结
在SpringFox的Swagger库好久不出新版的情况下,迁移到SpringDoc确实是一个更好的选择。今天我体验了一把SpringDoc,确实很好用,与之前熟悉的用法相似,学习成本极低。而且SpringDoc能支持WebFlux之类的项目,功能也更加强大,对于使用SpringFox觉得有些卡手的朋友来说,迁移到SpringDoc是一个不错的选择!
参考资料项目源码地址:github.com/macrozheng/m...
来源:mp.weixin.qq.com/s/scit...