单体开发进阶
SpringBoot的Web开发之路
众所周知,CRUD是每个程序员的必经之路。作为一个初级程序员,只要能够独立开发出一个简单的CRUD系统即可,例如OA系统、CRM管理系统、基于表单的CRUD系统等。
简单来说,分布式开发是后端提供接口,前端接收信息进行渲染;单体开发是后端提供数据,前端获取数据进行渲染。
从开发流程来说,单体开发和分布式开发本质上并没有区别,只是用到的技术和思想上略有不同。
分布式开发的本质:网络是不可靠的,我们需要解决服务之间的通信问题,例如服务崩溃了的解决方案,客户端如何去进行访问,服务的注册和发现等。
Swagger
什么是Swagger?
在前后端分离的项目当中,开发人员的分工大概如下:
- 前端主要专注于控制层和视图层,由专业的前端团队进行开发。
- 后端主要专注于后端控制层、服务层和数据访问层,由专业的后端团队进行开发。
那么问题来了,前后端的交互一般都是通过API来进行的,关于API的约定应该如何处理呢?
在早期的时候,一般由后端编写协同文档,前端根据文档解析接口然后渲染视图。但问题也很明显,前端和后端之间无法做到及时协商,最终可能导致问题集中爆发或者项目延时。
为了解决这些问题,Swagger应运而生。
什么是Swagger?
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
Swagger的作用主要有两点:接口的文档在线自动生成和功能测试。
现在的开源项目中,都会集成Swagger。
Swagger的主要特点
- 号称世界上最流行的API框架。
- Restful API自动生成文档,和代码对应。
- 直接运行测试接口,不需要下载postman了。
- 支持多种语言,如Java、Php等。
Swagger官网地址::https://swagger.io/
集成Swagger
基础集成
1、导入Swagger2依赖。
<!--swaggger2依赖-->
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2、编写Swagger配置类,注册Docket到Spring容器中,在主启动类上添加@EnableSwagger2
开启配置使Swagger生效。
//Swagger配置类
@Configuration
public class SwaggerConfig {
// 注册bean Docket
@Bean
public Docket docket(){
return new Docket(DocumentationType.SWAGGER_2);
}
}
//主启动类
@SpringBootApplication
@EnableSwagger2 //使swagger生效,默认不开启
public class SpringbootPlusApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootPlusApplication.class, args);
}
}
3、启动项目进行测试,Swagger API文档默认访问地址:http://localhost:8080/swagger-ui.html
注意在Controller的方法请求路径映射不要使用@RequestMapping
来配置,应该直接使用具体请求方法的注解,如@GetMapping
、@PostMapping
等。因为使用@RequestMapping
配置在API文档上一个方法默认会生成七种请求的API文档信息,如下图所示。
配置Swagger
1、在SwaggerConfig类中配置文档信息,构造ApiInfo对象。
@Bean
public Do