皮皮网

1.Knife4j @ApiModelProperty position不生效--避坑
2.springcloud服务启动后怎么知道接口调用路径？
3.idea中使用maven的常用命令详解
4.Java21 + SpringBoot3整合springdoc-openapi，自动生成在线接口文档，支持SpringSecurity和JWT认证方式
5.全面升级！一套基于Spring Boot 3+JDK17的实战项目！
6.SpringCloud微服务实战——搭建企业级开发框架（十九）：Gateway使用knife4j聚合微服务文档

Knife4j @ApiModelProperty position不生效--避坑

       在项目中应用Knife4j-3.0.3，尽管官方文档说明基于swagger2-2..5，iphone电影源码实际上应引用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正确地应用排序规则，实现自定义展示顺序。

springcloud服务启动后怎么知道接口调用路径？

       在Spring Cloud服务启动后，可以使用Swagger UI工具查看服务的接口调用路径。Swagger是一种开放源代码软件框架，可以生成、描述、pygame 游戏源码调用和可视化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的访问路径为 pile、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 命令，mfc时钟源码依次执行了 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（打包）、ntp 源码 下载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 命令提供了一种高效、灵活的方式来管理项目构建和依赖关系，适用于各种规模的项目开发。通过掌握这些命令及其应用场景，开发者可以显著提高项目构建和部署的效率。

Java + SpringBoot3整合springdoc-openapi，自动生成在线接口文档，支持SpringSecurity和JWT认证方式

       在Java 2.1与SpringBoot 3的项目开发中，我探索了一种方法，即通过整合springdoc-openapi来实现在线接口文档的自动生成，支持Spring Security和JWT认证。我的目标是打造一个适应多端且功能丰富的开发模板，方便开发者快速构建和扩展。ceph源码编译

       本项目采用前后端分离模式，后端基于Java 2.1和SpringBoot 3，利用Spring Security、JWT、Spring Data JPA等技术进行开发，前端则提供了vue、angular、react、uniapp和微信小程序等多种技术栈。重点在于，如何利用OpenAPI规范来定义和展示API，这使得开发者无需深入了解源代码，就能理解API的功能和用法，极大地提高了开发效率。

       OpenAPI规范，即OAS，定义了RESTful API的通用标准，让开发者和工具能够理解和操作API。遵循OpenAPI，可以使用文档生成工具展示API，代码生成工具自动生成代码，甚至进行自动化测试。中国的OpenAPI规范中文版文档可参考这里。

       Swagger作为OpenAPI的实现工具，提供了组件如描述文件的维护，有助于更新文档和生成客户端和服务器端代码。Swagger的官方文档可在这里找到。

       Springfox是基于Swagger 2.x的API文档生成工具，它简化了Java开发者的工作，提供了注解支持和自动生成文档的功能。Springfox官方文档位于这里。

       然而，随着技术的发展，SpringDoc基于OpenAPI 3.0规范应运而生，成为了Spring Boot 2.4及以上版本的首选。相比Springfox，SpringDoc提供了更强大的扩展性和更好的社区支持。在SpringBoot 3中，推荐使用springdoc-openapi-ui进行集成。SpringDoc的官方文档可在这里查阅。

       在实践中，要实现这个功能，首先在pom.xml中引入springdoc-openapi-starter-webmvc-ui等相关依赖，然后配置application.yml，设定api-docs和swagger-ui的访问路径。如果项目有权限控制，需适当设置访问权限，如允许匿名访问api-docs和swagger-ui。在Controller类和实体类中，使用@Operation注解配合之前定义的security配置来指定认证方式。

       通过上述步骤，你可以生成符合规范的接口文档，方便团队协作和API的使用。后续我会不断更新学习心得，期待与大家一起进步。

全面升级！一套基于Spring Boot 3+JDK的实战项目！

       最近将mall项目升级为基于Spring Boot 3+JDK的版本，本文将详细介绍此次升级的主要内容。升级包括依赖更新、框架用法调整以及运行部署的改动。目前，Spring Boot 3版本的代码位于mall项目dev-v3分支下，希望能为各位开发人员提供参考。

       mall项目是一套基于SpringBoot、Vue和uni-app构建的电商系统，拥有GitHub上K星标，支持前后台商城与管理系统，涵盖商品、订单、购物车、权限、优惠券、会员和支付等全面功能。

       为了升级至Spring Boot 3，项目依赖已更新至最新主流版本，具体版本信息请参照相关文档。升级过程中，部分框架用法有所调整，如API文档生成库由SpringFox升级为SpringDoc，Spring Data Elasticsearch和Spring Security的使用方式也有所变化。

       从SpringFox迁移到SpringDoc，以适应Spring Boot 3的需求。Spring Data Elasticsearch的查询方式保持不变，但对于复杂查询，ElasticsearchRestTemplate已被移除，需要使用ElasticsearchTemplate类进行实现。Spring Security的配置也转向函数式编程方式，以适应新版Spring Boot的特性。

       在Windows环境下运行项目时，需确保JDK版本为，操作与以往版本基本相同。对于Linux环境，打包应用的Docker镜像需配置使用openjdk:，通过修改项目根目录下的pom.xml中的docker-maven-plugin插件配置即可完成。此外，在打包镜像前，应提前下载openjdk镜像，使用相应命令执行。

       总结升级要点，强调Spring Boot 3版本的代码位于dev-v3分支中。项目源码地址已提供，以供参考和进一步探索。

SpringCloud微服务实战——搭建企业级开发框架（十九）：Gateway使用knife4j聚合微服务文档

       本篇内容聚焦于Spring Cloud Gateway网关如何集成knife4j，实现对所有Swagger微服务文档的聚合。首先，在gitegg-gateway项目中引入knife4j依赖，若无后端编码需求，仅引入swagger前端ui模块即可。随后，对配置文件进行修改，增加knife4j与Swagger2的配置。接下来，我们将重点介绍如何在微服务架构下，通过网关动态发现并聚合所有微服务文档的业务编码。

       在使用Spring Boot等单体架构集成swagger时，通常通过包路径进行业务分组，并在前端展示不同模块。然而，在微服务架构中，每个服务相当于一个独立的业务组。在Spring Cloud微服务架构下，通过重写提供分组接口的代码（如springfox-swagger提供的swagger-resource接口），可实现通过网关动态发现并聚合所有微服务的文档信息。具体实现代码如下：

       通过访问gitegg-gateway服务地址（/wmz/GitEg...的chapter-分支中。

       GitEgg-Cloud是基于SpringCloud整合搭建的企业级微服务应用开发框架，旨在提供一站式解决方案，帮助开发者高效构建微服务应用。项目开源地址如下：

       Gitee: /

       GitHub: /

神器 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...