前后端分离如何维护接口文档 ?
在 Spring Boot 中,这个问题常见的解决方案是 Swagger ,使用 Swagger 我们可以快速生成一个在线接口文档,控制器的内容一旦发生变化,文档就会自动更新,所有开发工程师访问这一个在线网站就可以获取到最新的接口文档,非常方便
什么是 Swagger?
Swagger 是一个可视化 RESTful 风格的 Web 服务框架,支持 API 自动生成同步的在线文档:使用 Swagger 后可以直接通过代码生成文档,不再需要自己手动编写接口文档了,Swagger 生成的文档还支持在线测试;参数和格式都定好了,直接在界面上输入参数对应的值即可在线测试接口
@Api:用在请求的类上,表示对类的说明
tags="说明该类的作用,可以在UI界面上看到的注解"
value="该参数没什么意义,在UI界面上也看到,所以不需要配置"
@ApiOperation:用在请求的方法上,说明方法的用途、作用
value="说明方法的用途、作用"
notes="方法的备注说明"
@ApiImplicitParams:用在请求的方法上,表示一组参数说明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)--> 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值
@ApiResponses:用在请求的方法上,表示一组响应
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类
@ApiModel:用于响应类上,表示一个返回响应数据的信息
(这种一般用在post创建的时候,使用@RequestBody这样的场景,
请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModelProperty:用在属性上,描述响应类的属性
如何重新加载 Spring Boot 上的更改,而无需重新启动服务器?(热部署)
方法一: 以使用 DEV 工具来实现;通过这种依赖关系,您可以节省任何更改,嵌入式tomcat 将重新启动;Spring Boot 有一个开发工具(DevTools)模块,它有助于提高开发人员的生产力;Java 开发人员面临的一个主要挑战是将文件更改自动部署到服务器并自动重启服务器。开发人员可以重新加载 Spring Boot 上的更改,而无需重新启动服务器。这将消除每次手动部署更改的需要;Spring Boot 在发布它的第一个版本时没有这个功能。这是开发人员最需要的功能。DevTools 模块完全满足开发人员的需求;该模块将在生产环境中被禁用;它还提供 H2 数据库控制台以更好地测试应用程序
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
</dependency>
方法二:JRebel的热部署http://t.csdnimg.cn/B94kP
常用的Spring Boot Starter Maven依赖项有哪些?
spring-boot-starter-web | 用于构建Web应用程序,包括Spring MVC、Tomcat等 |
---|---|
spring-boot-starter-data-jpa | 用于使用JPA(Java Persistence API)访问和操作数据库 |
spring-boot-starter-data-mongodb | 用于使用MongoDB数据库 |
spring-boot-starter-data-redis | 用于使用Redis数据库 |
spring-boot-starter-security | 用于集成Spring Security,实现身份验证和授权功能 |
spring-boot-starter-test | 用于编写单元测试和集成测试 |
spring-boot-starter-actuator | 用于监控和管理应用程序的运行时行为 |
spring-boot-starter-amqp | 用于使用AMQP(Advanced Message Queuing Protocol)进行消息传递 |
spring-boot-starter-cache | 用于启用应用程序级缓存功能 |
spring-boot-starter-mail | 用于发送电子邮件 |
spring-boot-starter-oauth2-client | 用于集成OAuth2客户端功能 |
spring-boot-starter-websocket | 用于启用WebSocket功能 |
mybatis-spring-boot-starter | 用于mybatis |
Spring Boot 中的 starter 到底是什么 ?
在Spring Boot中,starter是一种特殊的Maven依赖项,它用于简化项目的配置和依赖管理;Starter依赖项是预定义的、可重用的依赖项集合,它们封装了一组相关的依赖项,用于快速集成和启动特定的功能或技术;当你添加一个特定的starter依赖项时,它会自动引入所需的相关依赖项,并进行默认的配置。这样,你可以快速启动并集成各种功能和技术,而无需手动处理复杂的依赖项和配置
Spring Boot的starter依赖项遵循一种命名约定,通常以`spring-boot-starter-`开头,后面跟着特定功能或技术的名称。例如,`spring-boot-starter-web`是用于构建Web应用程序的starter依赖项,`spring-boot-starter-data-jpa`是用于集成JPA的starter依赖项
使用starter依赖项的好处是,它们自动处理了依赖项的版本管理和配置,简化了项目的构建和配置过程。另外,Spring Boot还提供了一些其他类型的starter依赖项,例如`spring-boot-starter-test`用于编写测试,`spring-boot-starter-actuator`用于监控和管理应用程序的运行时行为。这些starter依赖项使得在Spring Boot项目中集成常用的功能和技术变得更加简单和便捷
spring-boot-starter-parent 有什么用 ?
统一的版本管理 | spring-boot-starter-parent 中定义了Spring Boot及其相关依赖项的版本号,在项目中引入其他的Spring Boot Starter依赖项时,无需手动指定版本号,而是继承自spring-boot-starter-parent |
---|---|
默认的插件配置 | spring-boot-starter-parent 中配置了一些常用的Maven插件,并定义了一些默认的插件配置,可以简化项目的构建过程,例如自动执行测试、打包可执行的JAR文件等 |
通用的属性定义 | spring-boot-starter-parent 中定义了一些通用的属性,例如编译器版本、编码规范、资源过滤等,可以在项目中直接使用,提供了一致的配置和约定 |
Spring Boot 打成的 jar 和普通的 jar 有什么区别 ?
-
Spring Boot 中默认打包成的 jar 叫做可执行 jar,这种 jar 不可以被其他项目依赖,即使强制依赖,也无法获取里边的类;但是普通的 jar 主要是被其他应用依赖,但是可执行 jar 并不是 Spring Boot 独有的,Java工程本身就可以打包成可执行 jar
-
普通的 jar 不可以通过 java -jar xxx.jar 命令执行,Spring Boot 打成的 jar 可以通过 java -jar xxx.jar 命令执行执行
-
主要是两者的结构不同;普通的 jar 包,解压后直接就是包名,包里就是我们的代码,而 Spring Boot 打包成的可执行 jar 解压后,在 \BOOT-INF\classes 目录下才是我们的代码,因此无法被直接引用;如果非要引用,可以在 pom.xml 文件中增加配置,将 Spring Boot 项目打包成两个 jar ,一个可执行, 一个可引用