大家好，今日琪琪来为大家解答以上的问题。springboot文档，springboot文档预览很多人还不知道，现在让我们一起来看看吧！

springboot文档 springboot文档预览

springboot文档 springboot文档预览

springboot文档 springboot文档预览

1、二、基于SpringBoot的服务框架设计本文将基于SpringBoot，从框架约束、自研中间件集成、强类型客户端、接口文档等多个方面介绍服务框架的设计与实践。

2、一、背景介绍结合公司上下文环境、业务规模，综合考虑技术栈统一、服务治理、使用成本等多方面的因素，经过多部 商议，确定将“基于SpringBoot开发HTTP服务”作为主要开发模式。

3、公司每天都有一些新的微服务产生，很多自研组件服务和中间件系统，需要服务开发者单独接入，为了规范和简化后端服务开发者集成应用，一套规范、集成的开发框架就变得非常有必要。

4、统一规范可以通过默认约定、强制校验、自动内嵌等多种方式来实现，导出时给表头下方增加数据重复校验下面将分别举例说明。

5、统一管理依赖包(默认约定)基于Men的依赖包管理，通过Partent统一定义依赖包及版本，默认引入必须的依赖包和插件。

6、创建工程自动生成代码时，默认约定继承Parent，开发者只需引入必要的Starter即可，开发者可以修改继承关系，但不。

7、依赖包的统一管理，可以避免不同版本包冲突的麻烦，也方便后期公司统一升级依赖包和版本。

8、统一参数格式(强制校验)返回参数都继承BaseResponse，请求参数都继承BaseRequest。

9、强制校验接口服务来保证参数规范性，在工程启动时自动检测，不遵循规范的工程将无常启动，绕过校验的工程不纳入公司后端体系，很多核心能力均无常使用。

10、统一参数格式，不仅可以同时支持HTTP调用、强类型客户端，同时规避了HTTP接口的滥用，简化规范了错误处理。

11、通过Spring的RestControllerA可以对全局异常统一捕获，并对异常统一处理。

12、异常处理自动内嵌到核心包中，只要使用该框架，就自动生效。

13、统一异常处理，不仅规范了异常返回格式，兼容了强类型客户端，日志统一记录，并对返回的异常信息进行脱敏处理。

14、2、如何简化自研中间件组件和系统的集成?所有中间件依赖包都在Parent中统一管理，对于自研的通用类组件(比如日志组件、线程池组件、web安全组件、自研的工具类组件等)，默认在Parent中已引入，开发者可以直接使用。

15、使用Starter方式，简化了依赖、简化了配置、简化了接入代码。

16、作为后端服务，核心能力是对外提供服务，或者调用其他服务。

17、如果使用REST方式访问远程HTTP接口，难以将接口管理起来，当接口变动的时候可能需要修改多处。

18、在技术调研过程中，我们发现SpringCloud提供了OpenFeign来解决这个问题。

19、但OpenFeign和我们公司技术环境不一致，加上太多 历史 项目也无法支持OpenFeign，于是我们借鉴OpenFeign思想，基于开源Fegin开发了适合公司环境的ZbjFeign，支持在SpringBoot和普通Spring环境中使用。

20、4、如何实现文档的统一管理?公司所有文档都是基于Confluence进行管理的，接口文档也不例外，于是我们也实现了在发布阶段，一键发布接口文档。

21、后台实现也是自动扫描Controller接口元数据，通过模版生成HTML片段，并提交到Confluence。

22、接口文档中提供了Ja强类型客户端调用、HTTP调用两种方式的参考。

23、和文档都有了，接下来我们通过案例看一下如何使用。

本文到这结束，希望上面文章对大家有所帮助。