配置knife4j时出现问题 TypeError: n.forEach is not a function

小咪咪 2024-03-26 19:46 24阅读 0赞

#### 配置knife4j时出现问题 TypeError: n.forEach is not a function ####

*  问题
 *  锁定原因
 *  解决方法

## 问题 ##

在集成Knife4j文档的时候弹出该异常,效果图如下:  
![在这里插入图片描述][921e1c3c6cd44273834cde89b8e60899.png]

## 锁定原因 ##

经过多方面原因的排查后，锁定错误原因在于`后端做了一个统一返回格式的封装，增加了一个ResponseBodyAdvice的配置`，改变了swagger相关接口的返回结果；  
![在这里插入图片描述][b14b9a4ae3f54f088e633619a3040f7d.png]

Swagger的分组接口`/swagger-resources`接口正确的响应格式：  
![在这里插入图片描述][fd118aaeb6c8402b9d9f37c4d13ae1e5.png]  
是一个没有经过包装处理的纯数组对象；

Swagger的响应实例接口/v2/api-docs正确的响应结构：  
![在这里插入图片描述][62422f97b61d467790d6e411505a16dc.png]

实际得到的相应结果：  
![在这里插入图片描述][eaa86d8eb0834ed286ae430512781ce2.png]

可以看到进行了数据的封装，导致Knife4j组件不能正确处理返回结果，渲染页面；

## 解决方法 ##

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wxypU6wE-1678345700442)(03Java.assets/image-20230309145505310.png)\]][img-wxypU6wE-1678345700442_03Java.assets_image-20230309145505310.png]  
原本使用的是@RestControllerAdvice注解，他表示全局的一个配置，就把swagger接口也进行了封装；  
在这里限定了所访问的包，对所访问的包中的接口进行返回结果的封装【指定作用域】，成功解决问题；  
![在这里插入图片描述][941a48acb4f242149b129ddea9d8cbac.png]

如果Spring MVC控制器有统一的父类控制器的话，

@RestController
    @RequestMapping("/ip")
    public class IpController extends BaseController {
        
     //todo 省略
    }

也可以这样：

@RestControllerAdvice(assignableTypes = BaseController.class)

分析：  
swagger的接口是自己所写包外的接口，因此可以通过这种方式限定返回结果封装的范围；  
如果是针对自己所写的controller层的某一个接口进行排除处理，也可以通过注解形式实现；

实现方法如下：

boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType);

这个方法如果返回false就表示不执行统一返回体的封装逻辑；因此可以通过定义一个注解，类似于`白名单`的机制来绕过统一返回体控制器通知类；

注解：

@Documented
    @Inherited
    @Target({
        ElementType.ANNOTATION_TYPE, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface IgnoreHandleResBody {
        
    }

然后在上面的supports方法中:

@Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        
        return !returnType.hasMethodAnnotation(IgnoreHandleResBody.class);
    }

如果某个Controller下所有的方法都绕过，就把这个注解标记在控制器类上；  
如果只想忽略某个方法上就把它标记在该方法上;

还出现过这种错误：

1.  nested exception is java.lang.IllegalArgumentException: Unresolvable class definition for class \[springfox.documentation.spring.web.OnServletBasedWebApplication\]
2.  springfox.documentation.common.ClassPresentInClassPathCondition

![在这里插入图片描述][769e40d67ef645b0b4428e15980f023a.png]

解决方法见： [https://blog.csdn.net/qq\_45722699/article/details/129424391][https_blog.csdn.net_qq_45722699_article_details_129424391]

[921e1c3c6cd44273834cde89b8e60899.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/9de89c18a0824c66a9e0c91c90e6903d.png
[b14b9a4ae3f54f088e633619a3040f7d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d3635ed6c4b94be6a0682bda54a9b7d2.png
[fd118aaeb6c8402b9d9f37c4d13ae1e5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/87d3456eb87546649b6410e7f9abbf8a.png
[62422f97b61d467790d6e411505a16dc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d20458c3eeb348659a03081f004753b2.png
[eaa86d8eb0834ed286ae430512781ce2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/923bdef19bcf4c71a69f571ab72460bf.png
[img-wxypU6wE-1678345700442_03Java.assets_image-20230309145505310.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/ef58aeb5cd0443aea8772ea31da8fae1.png
[941a48acb4f242149b129ddea9d8cbac.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/e62c6f0a3c0d463bba8271c13add218a.png
[769e40d67ef645b0b4428e15980f023a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/98caca0251c84a4bb8d7eb927c31cf77.png
[https_blog.csdn.net_qq_45722699_article_details_129424391]: https://blog.csdn.net/qq_45722699/article/details/129424391