前后端分离概念:
开发讲师管理模块后端
一、数据库设计
-
数据库
guli
-
数据表
CREATE TABLE `edu_teacher` (
`id` char(19) NOT NULL COMMENT '讲师ID',
`name` varchar(20) NOT NULL COMMENT '讲师姓名',
`intro` varchar(500) NOT NULL DEFAULT '' COMMENT '讲师简介',
`career` varchar(500) DEFAULT NULL COMMENT '讲师资历,一句话说明讲师',
`level` int(10) unsigned NOT NULL COMMENT '头衔 1高级讲师 2首席讲师',
`avatar` varchar(255) DEFAULT NULL COMMENT '讲师头像',
`sort` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '排序',
`is_deleted` tinyint(1) unsigned NOT NULL DEFAULT '0' COMMENT '逻辑删除 1(true)已删除, 0(false)未删除',
`gmt_create` datetime NOT NULL COMMENT '创建时间',
`gmt_modified` datetime NOT NULL COMMENT '更新时间',
PRIMARY KEY (`id`),
UNIQUE KEY `uk_name` (`name`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='讲师';
- 插入数据
INSERT INTO `edu_teacher` VALUES ('1','张三','近年主持国家自然科学基金(6项)、江苏省重大科技成果转化项目(5项)、江苏省产学研前瞻性联合研究项目(3项)、省工业科技支撑、省高技术、省自然科学基金等省部级及其企业的主要科研项目40多个,多个项目在企业成功转化,产生了较好的经济、社会和环境效益。积极开展产学研科技合作,并与省内16家企业建立了江苏省研究生工作站,其中6家为江苏省优秀研究生工作站','高级',1,'https://guli-file-190513.oss-cn-beijing.aliyuncs.com/avatar/default.jpg',0,0,'2019-10-30 14:18:46','2019-11-12 13:36:36'),('1189389726308478977','晴天','高级讲师简介','高级讲师资历',2,'https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/10/30/de47ee9b-7fec-43c5-8173-13c5f7f689b2.png',1,0,'2019-10-30 11:53:03','2019-10-30 11:53:03'),('1189390295668469762','李刚','高级讲师简介','高级讲师',2,'https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/10/30/b8aa36a2-db50-4eca-a6e3-cc6e608355e0.png',2,0,'2019-10-30 11:55:19','2019-11-12 13:37:52'),('1189426437876985857','王二','高级讲师简介','高级讲师',1,'https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/11/08/e44a2e92-2421-4ea3-bb49-46f2ec96ef88.png',0,0,'2019-10-30 14:18:56','2019-11-12 13:37:35'),('1189426464967995393','王五','高级讲师简介','高级讲师',1,'https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/10/30/65423f14-49a9-4092-baf5-6d0ef9686a85.png',0,0,'2019-10-30 14:19:02','2019-11-12 13:37:18'),('1192249914833055746','李四','高级讲师简介','高级讲师',1,'https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/11/07/91871e25-fd83-4af6-845f-ea8d471d825d.png',0,0,'2019-11-07 09:18:25','2019-11-12 13:37:01'),('1192327476087115778','1222-12-12','1111','11',1,'https://online-teach-file.oss-cn-beijing.aliyuncs.com/teacher/2019/11/08/5805c6cd-c8ad-4a77-aafd-d2e083bfd8a4.png',0,1,'2019-11-07 14:26:37','2019-11-11 16:26:26'),('1195337453429129218','test','sdfsdf','sdfdf',1,'https://guli-file-190513.oss-cn-beijing.aliyuncs.com/avatar/default.jpg',0,1,'2019-11-15 21:47:12','2019-11-15 21:47:27');
二、数据库设计规约
以下规约只针对本模块,更全面的文档参考《阿里巴巴 Java
开发手册》:五、MySQL
数据库
1、库名与应用名称尽量一致
2、表名、字段名必须使用小写字母或数字,禁止出现数字开头,
3、表名不使用复数名词
4、表的命名最好是加上“业务名称_表的作用”。如,edu_teacher_
5、表必备三字段:id, gmt_create, gmt_modified
说明:
其中 id 必为主键,类型为 bigint unsigned、单表时自增、步长为 1。
(如果使用分库分表集群部署,则id类型为verchar,非自增,业务中使用分布式id生成器)
gmt_create, gmt_modified 的类型均为 datetime 类型,前者现在时表示主动创建,后者过去分词表示被
动更新。
6、单表行数超过 500 万行或者单表容量超过 2GB,才推荐进行分库分表。 说明:如果预计三年后的数
据量根本达不到这个级别,请不要在创建表时就分库分表。
guli_edu.sql 1
7、表达是与否概念的字段,必须使用 is_xxx 的方式命名,数据类型是 unsigned tinyint (1 表示是,0 表
示否)。
说明:任何字段如果为非负数,必须是 unsigned。
注意:POJO 类中的任何布尔类型的变量,都不要加 is 前缀。数据库表示是与否的值,使用 tinyint 类
型,坚持 is_xxx 的 命名方式是为了明确其取值含义与取值范围。
正例:表达逻辑删除的字段名 is_deleted,1 表示删除,0 表示未删除。
8、小数类型为 decimal,禁止使用 float 和 double。 说明:float 和 double 在存储的时候,存在精度损失
失的问题,很可能在值的比较时,得不到正确的结果。如果存储的数据范围超过 decimal 的范围,建议将数据拆成整数和小数分开存储。
9、如果存储的字符串长度几乎相等,使用 char 定长字符串类型。
10、varchar 是可变长字符串,不预先分配存储空间,长度不要超过 5000,如果存储长度大于此值,定
义字段类型为 text,独立出来一张表,用主键来对应,避免影响其它字段索 引效率。
11、唯一索引名为 uk_字段名;普通索引名则为 idx_字段名。
说明:uk_ 即 unique key;idx_ 即 index 的简称
12、不得使用外键与级联,一切外键概念必须在应用层解决。外键与级联更新适用于单机低并发,不适
合分布式、高并发集群;级联更新是强阻塞,存在数据库更新风暴的风险;外键影响数据库的插入速
度。
三、搭建项目工程(父工程)
1、项目架构
此项目为一体化项目,不是分布式项目。
I、工程结构介绍
II、模块说明
2、创建父工程
I、创建 SprigBoot
工程 guli
在 IDEA
开发工具中,使用 Spring Initializr
快速初始化一个 SpringBoot 模块
,
版本使用:2.2.1.RELEASE
II、配置 pom.xml
修改 SpringBoot
版本为 :2.2.1.RELEASE
<artifactId>
后面添加 pom
类型
<artifactId>guli-parent</artifactId>
<packaging>pom</packaging>
III、在 pom.xml
中添加依赖的版本
删除 pom.xml
中的 <dependencies>
内容
<!--以下为删除的内容-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
添加 <properties>
确定依赖的版本
对这个项目进行 版本控制
<!-- 对依赖版本进行管理 -->
<properties>
<java.version>1.8</java.version>
<guli.version>0.0.1-SNAPSHOT</guli.version>
<mybatis-plus.version>3.0.5</mybatis-plus.version>
<velocity.version>2.0</velocity.version>
<swagger.version>2.7.0</swagger.version>
<aliyun.oss.version>2.8.3</aliyun.oss.version>
<jodatime.version>2.10.1</jodatime.version>
<poi.version>3.17</poi.version>
<commons-fileupload.version>1.3.1</commons-fileupload.version>
<commons-io.version>2.6</commons-io.version>
<httpclient.version>4.5.1</httpclient.version>
<jwt.version>0.7.0</jwt.version>
<aliyun-java-sdk-core.version>4.3.3</aliyun-java-sdk-core.version>
<aliyun-sdk-oss.version>3.1.0</aliyun-sdk-oss.version>
<aliyun-java-sdk-vod.version>2.15.2</aliyun-java-sdk-vod.version>
<aliyun-java-vod-upload.version>1.4.11</aliyun-java-vod-upload.version>
<aliyun-sdk-vod-upload.version>1.4.11</aliyun-sdk-vod-upload.version>
<fastjson.version>1.2.28</fastjson.version>
<gson.version>2.8.2</gson.version>
<json.version>20170516</json.version>
<commons-dbutils.version>1.7</commons-dbutils.version>
<canal.client.version>1.1.0</canal.client.version>
<docker.image.prefix>zx</docker.image.prefix>
<cloud-alibaba.version>0.2.2.RELEASE</cloud-alibaba.version>
</properties>
配置 <dependencyManagement>
锁定依赖的版本
这里不会直接导入,只 会后面项目引入后才导入
<!--
进行依赖管理,
锁定依赖的版本,仅仅是声明版本,不会直接导入对应的依赖,
子模块中就可以不用写版本了,会自动使用这个,
如果子模块中指定了版本,那么这个就不会生效。
-->
<dependencyManagement>
<dependencies>
<!--Spring Cloud-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Hoxton.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>${cloud-alibaba.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!--mybatis-plus 持久层-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<!-- velocity 模板引擎, Mybatis Plus 代码生成器需要 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>${velocity.version}</version>
</dependency>
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger.version}</version>
</dependency>
<!--swagger ui-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger.version}</version>
</dependency>
<!--aliyunOSS-->
<dependency>
<groupId>com.aliyun.oss</groupId>
<artifactId>aliyun-sdk-oss</artifactId>
<version>${aliyun.oss.version}</version>
</dependency>
<!--日期时间工具-->
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
<version>${jodatime.version}</version>
</dependency>
<!--xls-->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>${poi.version}</version>
</dependency>
<!--xlsx-->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>${poi.version}</version>
</dependency>
<!--文件上传-->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>${commons-fileupload.version}</version>
</dependency>
<!--commons-io-->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>${commons-io.version}</version>
</dependency>
<!--httpclient-->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>${httpclient.version}</version>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>${gson.version}</version>
</dependency>
<!-- JWT -->
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt</artifactId>
<version>${jwt.version}</version>
</dependency>
<!--aliyun-->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-core</artifactId>
<version>${aliyun-java-sdk-core.version}</version>
</dependency>
<dependency>
<groupId>com.aliyun.oss</groupId>
<artifactId>aliyun-sdk-oss</artifactId>
<version>${aliyun-sdk-oss.version}</version>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-vod</artifactId>
<version>${aliyun-java-sdk-vod.version}</version>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-vod-upload</artifactId>
<version>${aliyun-java-vod-upload.version}</version>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-sdk-vod-upload</artifactId>
<version>${aliyun-sdk-vod-upload.version}</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>${fastjson.version}</version>
</dependency>
<dependency>
<groupId>org.json</groupId>
<artifactId>json</artifactId>
<version>${json.version}</version>
</dependency>
<dependency>
<groupId>commons-dbutils</groupId>
<artifactId>commons-dbutils</artifactId>
<version>${commons-dbutils.version}</version>
</dependency>
<dependency>
<groupId>com.alibaba.otter</groupId>
<artifactId>canal.client</artifactId>
<version>${canal.client.version}</version>
</dependency>
</dependencies>
</dependencyManagement>
四、搭建 service
模块
1、搭建 service
模块
I、在父工程 guli
下面创建子模块 service
II、添加模块类型是 pom
<artifactId>
节点后面添加 pom
类型
<artifactId>service</artifactId>
<packaging>pom</packaging>
III、添加项目需要的依赖
<dependencies>
<!-- 负载均衡 -->
<!-- <dependency>-->
<!-- <groupId>org.springframework.cloud</groupId>-->
<!-- <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>-->
<!-- </dependency>-->
<!--hystrix依赖,主要是用 @HystrixCommand -->
<!-- <dependency>-->
<!-- <groupId>org.springframework.cloud</groupId>-->
<!-- <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>-->
<!-- </dependency>-->
<!--服务注册-->
<!-- <dependency>-->
<!-- <groupId>org.springframework.cloud</groupId>-->
<!-- <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>-->
<!-- </dependency>-->
<!--服务调用-->
<!-- <dependency>-->
<!-- <groupId>org.springframework.cloud</groupId>-->
<!-- <artifactId>spring-cloud-starter-openfeign</artifactId>-->
<!-- </dependency>-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.22</version>
</dependency>
<!-- velocity 模板引擎, Mybatis Plus 代码生成器需要 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
</dependency>
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>
<!--lombok用来简化实体类:需要安装lombok插件-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--xls-->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
</dependency>
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
</dependency>
<!--httpclient-->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
</dependency>
<!--commons-io-->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
</dependency>
<!--gson-->
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<dependency>
<groupId>com.yanghui</groupId>
<artifactId>service-base</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
</dependencies>
2、搭建 service-edu
模块
I、在父工程service模块下面创建子模块 service-edu
五、讲师管理模块配置
1、service-edu
模块中创建配置文件
resources
目录下创建文件 application.properties
# 服务端口
server.port=8001
# 服务名
spring.application.name=service-edu
# 环境设置:dev、test、prod
spring.profiles.active=dev
# mysql数据库连接
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/guli?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=1234567890
# mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
2、创建 MP 代码生成器
在 test/java
目录下创建包 com.yanghui.eduservice
,创建代码生成器:CodeGenerator.java
package com.yanghui;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.junit.Test;
/**
* @ClassName CodeGenerator
* @Author YH
* @Date 2021/8/3
* @Version 1.0
*/
public class CodeGenerator {
@Test
public void run() {
// 1、创建代码生成器
AutoGenerator mpg = new AutoGenerator();
// 2、全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java"); //输出目录
gc.setAuthor("YH"); //作者名
gc.setOpen(false); //生成后是否打开资源管理器
gc.setFileOverride(false); //重新生成时文件是否覆盖
gc.setServiceName("%sService"); //去掉Service接口的首字母I
gc.setIdType(IdType.ID_WORKER_STR); //主键策略
gc.setDateType(DateType.ONLY_DATE);//定义生成的实体类中日期类型
gc.setSwagger2(true);//开启Swagger2模式
mpg.setGlobalConfig(gc);
// 3、数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/guli?serverTimezone=GMT%2B8");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("1234567890");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
// 4、包配置
PackageConfig pc = new PackageConfig();
//生成包:com.yanghui.eduservice
pc.setModuleName("eduservice"); //模块名
pc.setParent("com.yanghui");
//生成包:com.yanghui.controller
pc.setController("controller");
pc.setEntity("entity");
pc.setService("service");
pc.setMapper("mapper");
mpg.setPackageInfo(pc);
// 5、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("edu_teacher");//根据数据库哪张表生成,有多张表就加逗号继续填写
strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀
strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略
strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作
strategy.setRestControllerStyle(true); //restful api风格控制器
strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符
mpg.setStrategy(strategy);
// 6、执行
mpg.execute();
}
}
六、编写后台管理 api
接口
1、编写 controller
代码
@RestController
@RequestMapping("/eduservice/teacher")
public class EduTeacherController {
@Autowired
private EduTeacherService eduTeacherService;
//查询讲师表所有数据
@GetMapping("/getAllTeacher")
public List<EduTeacher> list(){
return eduTeacherService.list(null);
}
}
2、创建 SpringBoot
配置类
创建 config
包,创建 MyBatisPlusConfig.java
@Configuration
@EnableTransactionManagement
@MapperScan("com.yanghui.eduservice.mapper")
public class MyBatisPlusConfig {
}
3、配置 SQL
执行性能分析插件
在 MyBatisPlusConfig.java
下配置
/**
* SQL 执行性能分析插件
* 开发环境使用,线上不推荐。 maxTime 指的是 sql 最大执行时长
*/
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
// ms,超过此处设置的ms则sql不执行
performanceInterceptor.setMaxTime(1000);
performanceInterceptor.setFormat(true);
return performanceInterceptor;
}
4、创建 SpringBoot
启动类
/**
* @ClassName EduTeacherMain8001
* @Author YH
* @Date 2021/8/3
* @Version 1.0
*/
@SpringBootApplication
@ComponentScan(basePackages = "com.yanghui")
public class EduApplication {
public static void main(String[] args) {
SpringApplication.run(EduApplication.class, args);
}
}
5、运行启动类
访问http://localhost:8001/eduservice/eduteacher/getAllTeacher
6、统一返回的 json
时间格式
默认情况下 json
时间格式带有时区,并且是世界标准时间,和我们的时间差了八个小时
在配置文件 application.properties
中配置
# 返回json的全局时间格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8
七、讲师逻辑删除功能
1、EduTeacherController
添加删除方法
//逻辑删除讲师
@DeleteMapping("/deleteTeacherById/{id}")
public boolean deleteTeacherById(@PathVariable String id){
return eduTeacherService.removeById(id);
}
2、配置逻辑删除插件
EduConfig.java
上配置
/**
* MybatisPlus 逻辑删除插件
* @return
*/
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
3、在实体类上对应属性标注注解
@TableLogic
private Integer isDeleted;
4、测试
八、跨域配置
1、什么是跨域
浏览器从一个域名的网页去请求另一个域名的资源时,域名、端口、协议任一不同,都是跨域 。前后端分离开发中,需要考虑ajax跨域的问题。
这里我们可以从服务端解决这个问题!
2、配置
在 Controller
类上添加注解 @CrossOrigin
@RestController
@CrossOrigin //解决跨域问题
@RequestMapping("/eduservice/teacher")
public class EduTeacherController {
}
九、配置 Swagger2
生成 API
接口文档
1、Swagger2
介绍
前后端分离开发模式中,api文档
是最好的沟通方式。
Swagger
是一个规范和完整的框架,用于生成、描述、调用和可视化 Restful
风格的 Web
服务。
- 生成在线接口文档
- 方便接口测试
- 及时性 (接口变更后,能够及时准确地通知相关前后端开发人员)
- 规范性 (并且保证接口的规范性,如接口的地址,请求方式,参数及响应格式和错误信息)
- 一致性 (接口信息一致,不会出现因开发人员拿到的文档版本不一致,而出现分歧)
- 可测性 (直接在接口文档上进行测试,以方便理解业务)
2、配置 Swagger2
I、在 guli
父工程下创建 common
公共模块,为了让所有模块都可使用
II、在 common
模块中引入相关依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<scope>provided </scope>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<scope>provided </scope>
</dependency>
<!--lombok用来简化实体类:需要安装lombok插件-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided </scope>
</dependency>
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<scope>provided </scope>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<scope>provided </scope>
</dependency>
<!-- redis -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- spring2.X集成redis所需common-pool2
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
<version>2.6.0</version>
</dependency>-->
</dependencies>
III、在 common
模块下面创建子模块 service-base
IV、在模块 service-base
中,创建 swagger
的配置类
package com.yanghui.servicebase.config;
import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* @ClassName SwaggerConfig
* @Author YH
* @Date 2021/8/3
* @Version 1.0
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket webApiConfig(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.paths(Predicates.not(PathSelectors.regex("/admin/.*")))
.paths(Predicates.not(PathSelectors.regex("/error.*")))
.build();
}
private ApiInfo webApiInfo(){
return new ApiInfoBuilder()
.title("网站-课程中心API文档")
.description("本文档描述了课程中心微服务接口定义")
.version("1.0")
.contact(new Contact("yanghui", "http://yanghui.com",
"yanghui@qq.com"))
.build();
}
}
V、在模块 service
模块中引入 service-base
模块
<dependencies>
<dependency>
<artifactId>service-base</artifactId>
<groupId>com.achang</groupId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
</dependencies>
VI、在 service-edu
模块的启动类上添加注解
@ComponentScan(basePackages = "com.yanghui")
来扫描 SwaggerConfig.java
这个类
@SpringBootApplication
@ComponentScan(basePackages = "com.yanghui")
public class EduApplication {
public static void main(String[] args) {
SpringApplication.run(EduApplication.class, args);
}
}
VII、测试
访问:http://localhost:8001/swagger-ui.html
VIII、API
模型,让 Swagger
有更多提示
@ApiModelProperty(value = "创建时间")
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;
@ApiModelProperty(value = "更新时间")
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;
IX、定义接口说明和参数说明
-
定义在类上:
@Api
-
定义在方法上:
@ApiOperation
-
定义在参数上:
@ApiParam
@Api(description = "讲师管理")
@RestController
@RequestMapping("/eduservice/teacher")
public class EduTeacherController {
@Autowired
private EduTeacherService eduTeacherService;
/**
* 返回所有讲师信息
* @return
*/
@ApiOperation("返回所有讲师信息")
@GetMapping("/getAllTeacher")
public Result getAllTeacher() {
List<EduTeacher> teacherList = eduTeacherService.list(null);
Map<String, Object> result = new HashMap<>();
result.put("item", teacherList);
return Result.ok().data(result);
}
/**
* 按照 id 删除讲师,逻辑删除
* @param id
* @return
*/
@ApiOperation("删除讲师")
@DeleteMapping("/deleteTeacherById/{id}")
public Result deleteTeacherById(@ApiParam("讲师 id") @PathVariable("id") String id) {
boolean remove = eduTeacherService.removeById(id);
if (remove) {
return Result.ok();
} else {
return Result.error();
}
}
}
十、统一返回结果对象
1、统一返回数据格式 json
项目中我们会将响应封装成json返回,一般我们会将所有接口的数据格式统一, 使前端(iOS Android,Web)对数据的操作更一致、轻松。
一般情况下,统一返回数据格式没有固定的格式,只要能描述清楚返回的数据状态以及要返回的具体数据就可以。
但是一般会包含状态码、返回消息、数据这几部分内容
我们的定义统一结果:
{
"success": 布尔, //响应是否成功
"code": 数字, //响应码
"message": 字符串, //返回消息
"data": HashMap //返回数据,放在键值对中
}
2、创建统一结果返回类
(1)在 common
模块下创建子模块 common-utils
(2)创建接口定义返回码
package com.yanghui.commonutils;
/**
* 状态码
* @InterfaceName ResultCode
* @Author YH
* @Date 2021/8/5
* @Version 1.0
*/
public interface ResultCode {
/**
* 成功
*/
public static Integer SUCCESS = 200;
/**
* 失败
*/
public static Integer ERROR = 500;
}
(3)创建结果类
@Data
public class Result<T> {
@ApiModelProperty(value = "是否成功")
private Boolean success;
@ApiModelProperty(value = "返回状态码")
private Integer code;
@ApiModelProperty(value = "返回消息")
private String message;
@ApiModelProperty(value = "返回数据")
private T data;
/**
* 构造方法私有
*/
private Result() {
}
/**
* 成功 静态方法
*/
public static Result ok() {
Result result = new Result();
result.setSuccess(true);
result.setCode(ResultCode.SUCCESS);
result.setMessage("成功");
return result;
}
/**
* 失败 静态方法
*/
public static Result error() {
Result result = new Result();
result.setSuccess(false);
result.setCode(ResultCode.ERROR);
result.setMessage("失败");
return result;
}
/**
* 编写设置各个属性的方法,方便我们链式编程。
* 例如:Result.ok().success(false).code(200).message("成功").data(new HashMap<String, Object>());
*/
public Result success(Boolean success) {
this.setSuccess(success);
return this;
}
public Result code(Integer code) {
this.setCode(code);
return this;
}
public Result message(String message) {
this.setMessage(message);
return this;
}
public Result data(T data) {
this.setData(data);
return this;
}
}
3、统一返回结果使用
1)、在service模块中添加依赖
<dependency>
<groupId>com.achang</groupId>
<artifactId>common-utils</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
2)、修改Controller中的返回结果
/**
* 返回所有讲师信息
* @return
*/
@ApiOperation("返回所有讲师信息")
@GetMapping("/getAllTeacher")
public Result getAllTeacher() {
List<EduTeacher> teacherList = eduTeacherService.list(null);
Map<String, Object> result = new HashMap<>();
result.put("item", teacherList);
return Result.ok().data(result);
}
/**
* 按照 id 删除讲师,逻辑删除
* @param id
* @return
*/
@ApiOperation("删除讲师")
@DeleteMapping("/deleteTeacherById/{id}")
public Result deleteTeacherById(@ApiParam("讲师 id") @PathVariable("id") String id) {
boolean remove = eduTeacherService.removeById(id);
if (remove) {
return Result.ok();
} else {
return Result.error();
}
}
十一、分页和多条件查询接口开发
1、分页
1)、配置分页插件
/**
* 分页插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
2)、分页Controller方法
/**
* 分页查询讲师
* @param page 当前页码
* @param pageSize 每页大小
* @return
*/
@ApiOperation("分页查询讲师")
@GetMapping("/pageTeacher/{page}/{pageSize}")
public Result pageTeacher(@ApiParam("当前页码") @PathVariable("page")long page,
@ApiParam("每页大小") @PathVariable("pageSize") long pageSize) {
// 创建 Page 对象
Page<EduTeacher> eduTeacherPage = new Page<>(page, pageSize);
// 调用分页方法
eduTeacherService.page(eduTeacherPage, null);
// Map<String, Object> result = new HashMap<>();
// 总记录数
// long total = eduTeacherPage.getTotal();
// 数据
// List<EduTeacher> records = eduTeacherPage.getRecords();
// result.put("total", total);
// result.put("records", records);
// 直接返回 eduTeacherPage 也可以或者是 result
return Result.ok().data(eduTeacherPage);
}
3)、Swagger
中测试
2、多条件组合查询带分页
根据讲师名称 name
,讲师头衔 level
、讲师入驻时间 gmt_create
(时间段)查询
1)、创建查询对象
package com.yanghui.eduservice.vo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.io.Serializable;
/**
* @ClassName TeacherQuery
* @Author YH
* @Date 2021/8/5
* @Version 1.0
*/
@ApiModel(value = "Teacher查询对象", description = "讲师查询对象封装")
@Data
public class TeacherQuery implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty(value = "教师名称,模糊查询")
private String name;
@ApiModelProperty(value = "头衔 1 高级讲师 2 首席讲师")
private Integer level;
@ApiModelProperty(value = "查询开始时间", example = "2019-01-01 10:10:10")
// 注意,这里使用的是String类型,前端传过来的数据无需进行类型转换
private String begin;
@ApiModelProperty(value = "查询结束时间", example = "2019-12-01 10:10:10")
private String end;
}
2)、controller
中添加方法
/**
* 带条件分页查询讲师
* @param page 当前页码
* @param pageSize 每页大小
* @param teacherQuery 查询条件
* @return
* @RequestBody:以 json 的方式提交数据,必须要使用 post 提交方式
* required = false 表示这个值可以没有,参数值为空
*/
@ApiOperation("带条件分页查询讲师")
@PostMapping("/pageTeacherCondition/{page}/{pageSize}")
public Result pageTeacherCondition(@ApiParam("当前页码") @PathVariable("page")long page,
@ApiParam("每页大小") @PathVariable("pageSize") long pageSize,
@ApiParam("查询条件") @RequestBody(required = false) TeacherQuery teacherQuery) {
Page<EduTeacher> eduTeacherPage = new Page<>(page, pageSize);
QueryWrapper<EduTeacher> queryWrapper = new QueryWrapper<>();
// 判断是否为空,如果不为空则拼接条件
if (!StringUtils.isEmpty(teacherQuery.getName())) {
queryWrapper.like("name", teacherQuery.getName());
}
if (!StringUtils.isEmpty(teacherQuery.getLevel())) {
queryWrapper.eq("name", teacherQuery.getLevel());
}
if (!StringUtils.isEmpty(teacherQuery.getBegin())) {
queryWrapper.gt("gmt_date", teacherQuery.getBegin());
}
if (!StringUtils.isEmpty(teacherQuery.getEnd())){
queryWrapper.lt("gmt_date", teacherQuery.getEnd());
}
eduTeacherService.page(eduTeacherPage, queryWrapper);
return Result.ok().data(eduTeacherPage);
}
十二、新增和修改讲师接口开发
1、自动填充封装
给新增数据和修改数据,添加新建时间和修改时间的自动填充封装功能
**1)、在 service-base
模块中添加 MyMetaObjectHandler.java
**
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
// 第一个参数对应实体类中的属性名称
this.setFieldValByName("gmtCreate", new Date(), metaObject);
this.setFieldValByName("gmtModified", new Date(), metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("gmtModified", new Date(), metaObject);
}
}
2)、在实体类添加自动填充注解
@TableField(fill = FieldFill.INSERT)
@ApiModelProperty(value = "创建时间")
private Date gmtCreate;
@TableField(fill = FieldFill.INSERT_UPDATE)
@ApiModelProperty(value = "更新时间")
private Date gmtModified;
2、controller
方法定义
1)、新增
/**
* 添加讲师
* @param eduTeacher 讲师信息
* @return
*/
@ApiOperation("添加讲师")
@PostMapping("/addTeacher")
public Result addTeacher(@ApiParam("讲师信息") @RequestBody EduTeacher eduTeacher) {
boolean save = eduTeacherService.save(eduTeacher);
if (save == true) {
return Result.ok();
} else {
return Result.error();
}
}
2)、根据 id
查询
/**
* 根据 id 查询讲师
* @param id
* @return
*/
@ApiOperation("根据 id 查询讲师")
@GetMapping("/getTeacherById/{id}")
public Result getTeacherById(@ApiParam("讲师 id") @PathVariable("id") Long id) {
EduTeacher teacher = eduTeacherService.getById(id);
return Result.ok().data(teacher);
}
3)、修改讲师
/**
* 根据 id 修改讲师
* @param eduTeacher
* @return
* 这里不用 @PutMapping 原因是
* 这里用到了 @RequestBody 注解,必须要和 @PostMapping 配合使用
* 否则会出现取不到值
*/
@ApiOperation("根据 id 修改讲师")
@PostMapping("/updateTeacherById")
public Result updateTeacherById(@ApiParam("讲师信息") @RequestBody EduTeacher eduTeacher) {
boolean update = eduTeacherService.updateById(eduTeacher);
if (update == true) {
return Result.ok();
} else {
return Result.error();
}
}
十三、统一异常处理
1、统一异常处理
1)、创建统一异常处理器
引入依赖
<dependencies>
<dependency>
<groupId>com.yanghui</groupId>
<artifactId>common-utils</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
</dependencies>
在 service-base
模块中创建统一异常处理类: GlobalExceptionHandler.java
:
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
/**
* 出现异常时执行的方法
* @ExceptionHandler 指定出现什么异常才执行这个方法
* @ResponseBody 为了能够返回数据
* @param e
* @return
*/
@ExceptionHandler(Exception.class)
@ResponseBody
public Result error(Exception e) {
e.printStackTrace();
return Result.error().message("执行了全局异常处理!");
}
}
2、处理特定异常
在 GlobalExceptionHandler.java
中添加方法:
/**
* 特定异常处理
* 这个执行了,全局异常处理就不会执行了
* @param e
* @return
*/
@ExceptionHandler(ArithmeticException.class)
@ResponseBody
public Result error(ArithmeticException e) {
e.printStackTrace();
return Result.error().message("除数为零异常!");
}
3、自定义异常
1)、创建自定义异常类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class GuliException extends RuntimeException{
@ApiModelProperty(value = "状态码")
private Integer code;
private String msg;
}
2)、添加自定义异常处理方法
在 GlobalExceptionHandler.java
中添加方法:
/**
* 自定义异常处理
* 这个执行了,全局异常处理就不会执行了
* 因为这个异常类是我们自己定义的,系统不会帮我们捕获,
* 所以需要我们自己捕获异常。
* @param e
* @return
*/
@ExceptionHandler(GuliException.class)
@ResponseBody
public Result error(GuliException e) {
e.printStackTrace();
log.error(e.getMsg());
return Result.error().code(e.getCode()).message(e.getMsg());
}