Swagger 生成代码中委托设计模式的重要性?

如何解决Swagger 生成代码中委托设计模式的重要性?

当我从我的 swagger yaml 生成 Spring 的代码时,通常控制器层是使用 delegate 模式生成的,这样对于单个模型会生成三个文件。例如,如果我在我的 swagger/open API yaml 文件中定义了一个名为 Person 的模型,则会生成三个文件:

  1. PersonApi(包含所有人员操作/方法签名的接口)
  2. PersonApiDelegate(提供所有 PersonApi 方法的默认实现的接口。打算被覆盖)
  3. PersonApiController(它引用了 PersonApiDelegate,以便任何实现都可以覆盖并提供自定义实现)

我的问题是对于任何熟悉构建 swagger/openapi 生成的基于代码的 api 的人来说,拥有这样的模式有什么意义,而不仅仅是使用 PersonController 类公开您的服务端点,而不是通过 PersonApi 接口然后到 PersonApiDelegate 并最终通过 PersonApiController 公开服务?

我们通过这种模式获得的有价值的设计可扩展性是什么?我试图从互联网上的其他资源中查找信息,但在 swagger first API development approach 的上下文中找不到好的答案。对此的任何见解都会非常有帮助。

解决方法

首先澄清一下:正如评论中已经提到的,您不会被迫使用委托。相反,Spring 生成器的默认行为是不使用委托模式,因为您可以轻松检查 docs。在这种情况下,它将只生成 PersonApi 接口和 PersonApiController。

回到您的问题,为什么要使用委托?

这允许您编写一个实现 PersonApiDelegate 的类,该类可以轻松地注入到生成的代码中,而无需手动接触生成的源,并确保实现不受未来代码生成中可能发生的更改的影响。

让我们想想如果没有授权会发生什么。

一种简单的方法是生成源代码,然后直接在生成的 PersonController 中编写实现。当然下次有需要运行生成器的时候,就麻烦大了。所有的实现都将丢失...

一个稍微好一点但并不完美的方案是编写一个扩展 PersonController 的类。这将使实现在生成期间不会被覆盖,但不会保护它免受生成引擎未来更改的影响:作为最低限度,实现类将需要实现 PersonController 构造函数。现在生成的控制器的构造函数具有以下签名PersonApiController(ObjectMapper objectMapper,HttpServletRequest request),但生成器的开发人员将来可能需要更改它。所以实现也需要改变。

第三种方法是完全忘记生成的 PersonApiController,只编写一个实现 PersonApi 接口的类。那很好,但是每次生成代码时,您都需要删除 PersonApiController,否则 Spring 路由器会抱怨。还是手工...

但是有了委托,实现代码是完全安全的。无需手动删除内容,无需在未来更改时进行调整。此外,实现 PersonApiDelegate 的类可以被视为一个独立的服务,因此您可以根据需要将其注入/自动装配。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


使用本地python环境可以成功执行 import pandas as pd import matplotlib.pyplot as plt # 设置字体 plt.rcParams['font.sans-serif'] = ['SimHei'] # 能正确显示负号 p
错误1:Request method ‘DELETE‘ not supported 错误还原:controller层有一个接口,访问该接口时报错:Request method ‘DELETE‘ not supported 错误原因:没有接收到前端传入的参数,修改为如下 参考 错误2:cannot r
错误1:启动docker镜像时报错:Error response from daemon: driver failed programming external connectivity on endpoint quirky_allen 解决方法:重启docker -> systemctl r
错误1:private field ‘xxx‘ is never assigned 按Altʾnter快捷键,选择第2项 参考:https://blog.csdn.net/shi_hong_fei_hei/article/details/88814070 错误2:启动时报错,不能找到主启动类 #
报错如下,通过源不能下载,最后警告pip需升级版本 Requirement already satisfied: pip in c:\users\ychen\appdata\local\programs\python\python310\lib\site-packages (22.0.4) Coll
错误1:maven打包报错 错误还原:使用maven打包项目时报错如下 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources (default-resources)
错误1:服务调用时报错 服务消费者模块assess通过openFeign调用服务提供者模块hires 如下为服务提供者模块hires的控制层接口 @RestController @RequestMapping("/hires") public class FeignControl
错误1:运行项目后报如下错误 解决方案 报错2:Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.1:compile (default-compile) on project sb 解决方案:在pom.
参考 错误原因 过滤器或拦截器在生效时,redisTemplate还没有注入 解决方案:在注入容器时就生效 @Component //项目运行时就注入Spring容器 public class RedisBean { @Resource private RedisTemplate<String
使用vite构建项目报错 C:\Users\ychen\work>npm init @vitejs/app @vitejs/create-app is deprecated, use npm init vite instead C:\Users\ychen\AppData\Local\npm-
参考1 参考2 解决方案 # 点击安装源 协议选择 http:// 路径填写 mirrors.aliyun.com/centos/8.3.2011/BaseOS/x86_64/os URL类型 软件库URL 其他路径 # 版本 7 mirrors.aliyun.com/centos/7/os/x86
报错1 [root@slave1 data_mocker]# kafka-console-consumer.sh --bootstrap-server slave1:9092 --topic topic_db [2023-12-19 18:31:12,770] WARN [Consumer clie
错误1 # 重写数据 hive (edu)> insert overwrite table dwd_trade_cart_add_inc > select data.id, > data.user_id, > data.course_id, > date_format(
错误1 hive (edu)> insert into huanhuan values(1,'haoge'); Query ID = root_20240110071417_fe1517ad-3607-41f4-bdcf-d00b98ac443e Total jobs = 1
报错1:执行到如下就不执行了,没有显示Successfully registered new MBean. [root@slave1 bin]# /usr/local/software/flume-1.9.0/bin/flume-ng agent -n a1 -c /usr/local/softwa
虚拟及没有启动任何服务器查看jps会显示jps,如果没有显示任何东西 [root@slave2 ~]# jps 9647 Jps 解决方案 # 进入/tmp查看 [root@slave1 dfs]# cd /tmp [root@slave1 tmp]# ll 总用量 48 drwxr-xr-x. 2
报错1 hive> show databases; OK Failed with exception java.io.IOException:java.lang.RuntimeException: Error in configuring object Time taken: 0.474 se
报错1 [root@localhost ~]# vim -bash: vim: 未找到命令 安装vim yum -y install vim* # 查看是否安装成功 [root@hadoop01 hadoop]# rpm -qa |grep vim vim-X11-7.4.629-8.el7_9.x
修改hadoop配置 vi /usr/local/software/hadoop-2.9.2/etc/hadoop/yarn-site.xml # 添加如下 <configuration> <property> <name>yarn.nodemanager.res