前后端分离概念

1. 传统单体结构
   
2. 前后端分离结构
   

前后端分离就是将一个单体应用拆分成两个独立的应用：前端应用和后端应用，以JSON格式进行数据交互。

后台讲师管理模块环境搭建

一、数据库设计

1. 数据库
   guli_edu

2. 数据库
   guli_edu.sql

#
# Structure for table "edu_teacher"
#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='讲师';#
# Data for table "edu_teacher"
#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，才推荐进行分库分表。 说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

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. 工程结构
   
    

2. 模块说明
   guli-parent：在线教学根目录（父工程），管理四个子模块：

   • canal-client：canal数据库表同步模块（统计同步数据）

   • common：公共模块父节点

     • common-util：工具类模块，所有模块都可以依赖于它

     • service-base：service 服务的base包，包含service服务的公共配置类，所有service模块依赖于它

     • spring-security：认证与授权模块，需要认证授权的service服务依赖于它

   • infrastructure：基础服务模块父节点

     • api-gateway：api 网关服务

   • service：api 接口服务父节点

     • service-acl：用户权限管理api接口服务（用户管理、角色管理和权限管理等）

     • service-cms：cms api接口服务

     • service-edu：教学相关api接口服务

     • service-msm：短信api接口服务

     • service-order：订单相关api接口服务

     • service-oss：阿里云oss api接口服务

     • service-statistics：统计报表api接口服务

     • service-ucenter：会员api接口服务

     • service-vod：视频点播api接口服务
        

二、创建父工程

1. 创建 springboot 工程 guli_parent
   
   

2. 删除 src 目录
   

3. 配置 pom.xml

guli-parent
pom

4. 在pom.xml中添加依赖的版本
   删除pom.xml中原先的内容：

org.springframework.bootspring-boot-starter
org.springframework.bootspring-boot-starter-testtest

添加 确定依赖的版本:

1.80.0.1-SNAPSHOT3.0.52.02.7.02.8.32.10.13.171.3.12.64.5.10.7.04.3.33.1.02.15.21.4.111.4.111.2.282.8.2201705161.71.1.0zx0.2.2.RELEASE

配置 锁定依赖的版本:

    org.springframework.cloudspring-cloud-dependenciesHoxton.RELEASEpomimportorg.springframework.cloudspring-cloud-alibaba-dependencies${cloud-alibaba.version}pomimportcom.baomidoumybatis-plus-boot-starter${mybatis-plus.version}org.apache.velocityvelocity-engine-core${velocity.version}io.springfoxspringfox-swagger2${swagger.version}io.springfoxspringfox-swagger-ui${swagger.version}com.aliyun.ossaliyun-sdk-oss${aliyun.oss.version}joda-timejoda-time${jodatime.version}org.apache.poipoi${poi.version}org.apache.poipoi-ooxml${poi.version}commons-fileuploadcommons-fileupload${commons-fileupload.version}commons-iocommons-io${commons-io.version}org.apache.httpcomponentshttpclient${httpclient.version}com.google.code.gsongson${gson.version}io.jsonwebtokenjjwt${jwt.version}com.aliyunaliyun-java-sdk-core${aliyun-java-sdk-core.version}com.aliyun.ossaliyun-sdk-oss${aliyun-sdk-oss.version}com.aliyunaliyun-java-sdk-vod${aliyun-java-sdk-vod.version}com.aliyunaliyun-java-vod-upload${aliyun-java-vod-upload.version}com.aliyunaliyun-sdk-vod-upload${aliyun-sdk-vod-upload.version}com.alibabafastjson${fastjson.version}org.jsonjson${json.version}commons-dbutilscommons-dbutils${commons-dbutils.version}com.alibaba.ottercanal.client${canal.client.version}

四、搭建service模块

一、搭建service模块

1. 在父工程guli-parent下面创建模块service
   
2. 删除service模块的src目录
3. 添加模块类型是pom

service
pom

4. 添加项目需要的依赖

org.springframework.cloudspring-cloud-starter-netflix-ribbon


org.springframework.cloudspring-cloud-starter-netflix-hystrix


org.springframework.cloudspring-cloud-starter-alibaba-nacos-discovery


org.springframework.cloudspring-cloud-starter-openfeign

org.springframework.bootspring-boot-starter-web


com.baomidoumybatis-plus-boot-starter


mysqlmysql-connector-java


org.apache.velocityvelocity-engine-core


io.springfoxspringfox-swagger2

io.springfoxspringfox-swagger-ui


org.projectlomboklombok


org.apache.poipoi

org.apache.poipoi-ooxml

commons-fileuploadcommons-fileupload


org.apache.httpcomponentshttpclient


commons-iocommons-io


com.google.code.gsongson

junitjunit4.12

二、搭建service-edu模块

1. 在父工程service模块下面创建子模块service-edu
   
   输入模块名称 service-edu，下一步完成创建：
   
    

后台讲师管理模块开发

一、讲师管理模块配置和生成代码

一、讲师管理模块配置

1. 在service下面service-edu模块中创建配置文件

resources目录下创建文件 application.properties：

# 服务端口
server.port=8001# 服务名
spring.application.name=service-edu# 环境设置：dev、test、prod
spring.profiles.active=dev# mysql数据库连接
spring.datasource.url=jdbc:mysql://localhost:3306/guli?useUnicode=true&characterEncoding=UTF-8&serverTimeZone=UTC
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver# mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

2. 创建MP代码生成器

在 test/java 目录下创建包com.atguigu.eduservice，创建代码生成器：CodeGenerator.java:

public class CodeGenerator {@Testpublic void run() {// 1、创建代码生成器AutoGenerator mpg = new AutoGenerator();// 2、全局配置GlobalConfig gc = new GlobalConfig();String projectPath = System.getProperty("user.dir");gc.setOutputDir("D:\\IDEA\\guli_parent\\service\\service_edu" + "/src/main/java"); //输出目录gc.setAuthor("jyu_zwy"); //作者名gc.setOpen(false); //生成后是否打开资源管理器gc.setFileOverride(false); //重新生成时文件是否覆盖gc.setServiceName("%sService");	//去掉Service接口的首字母Igc.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?useUnicode=true&characterEncoding=UTF-8&serverTimeZone=UTC");dsc.setDriverName("com.mysql.cj.jdbc.Driver");dsc.setUsername("root");dsc.setPassword("123456");dsc.setDbType(DbType.MYSQL);mpg.setDataSource(dsc);// 4、包配置PackageConfig pc = new PackageConfig();//生成包：com.atguigu.eduservicepc.setModuleName("eduservice"); //模块名pc.setParent("com.atguigu");//生成包：com.atguigu.controllerpc.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();}
}

执行 CodeGenerator方法，将会在 java 包下自动创建代码：

 

二、编写后台管理api接口

1. 编写controller代码

@RestController
@RequestMapping("/eduservice/edu-teacher")
public class EduTeacherController {@Autowiredprivate EduTeacherService eduTeacherService;// 查询讲师表所有数据// 访问地址： http://localhost:8001/eduservice/edu-teacher/findAll@GetMapping("/findAll")public List list() {return eduTeacherService.list(null);}}

2. 创建SpringBoot配置类

在 eduservice 包下创建 config 包，创建MyBatisPlusConfig.java

@Configuration
@EnableTransactionManagement
@MapperScan("com.atguigu.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();performanceInterceptor.setMaxTime(1000);//ms，超过此处设置的ms则sql不执行performanceInterceptor.setFormat(true);return performanceInterceptor;}

4. 创建SpringBoot启动类

创建启动类 EduApplication.java，注意启动类的创建位置。

@SpringBootApplication
public class EduApplication {public static void main(String[] args) {SpringApplication.run(EduApplication.class, args);}
}

5. 运行启动类

运行启动类后，在浏览器地址栏中访问 http://localhost:8001/eduservice/edu-teacher/findAll, 将会返回 JSON 数据：

6. 统一返回的json时间格式

默认情况下 json 时间格式带有时区，并且是世界标准时间，和我们的时间差了八个小时。
在 application.properties中添加以下配置：

#返回json的全局时间格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8

三、讲师逻辑删除功能

1. EduTeacherController添加删除方法

@RestController
@RequestMapping("/eduservice/edu-teacher")
public class EduTeacherController {@Autowiredprivate EduTeacherService eduTeacherService;// 查询讲师表所有数据// 访问地址： http://localhost:8001/eduservice/edu-teacher/findAll@GetMapping("/findAll")public List list() {return eduTeacherService.list(null);}// 逻辑删除讲师// 访问地址：http://localhost:8001/eduservice/edu-teacher/deleteTeacherById/id@DeleteMapping("deleteTeacherById/{id}")public boolean deleteTeacherById(@PathVariable String id) {return eduTeacherService.removeById(id);}}

2. 配置逻辑删除插件

在 MyBatisPlusConfig 中添加配置：

@Configuration
@EnableTransactionManagement
@MapperScan("com.atguigu.eduservice.mapper")
public class MyBatisPlusConfig {/*** SQL 执行性能分析插件* 开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长*/@Bean@Profile({"dev","test"})// 设置 dev test 环境开启public PerformanceInterceptor performanceInterceptor() {PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();performanceInterceptor.setMaxTime(1000);//ms，超过此处设置的ms则sql不执行performanceInterceptor.setFormat(true);return performanceInterceptor;}/*** 逻辑删除插件* @return*/@Beanpublic ISqlInjector sqlInjector() {return new LogicSqlInjector();}}

3. 在实体类上对应字段标注注解

@TableLogic
private Boolean isDeleted;

4. 使用postman测试删除

测试结果： 数据库中的 is_deleted 字段被修改为1。

四、跨域配置

1. 什么是跨域

浏览器从一个域名的网页去请求另一个域名的资源时，域名、端口、协议任一不同，都是跨域 。前后端分离开发中，需要考虑 ajax 跨域的问题。
这里我们可以从服务端解决这个问题。

2. 配置

在 controller 类上添加注解：

@RestController
@CrossOrigin //解决跨域问题
@RequestMapping("/eduservice/edu-teacher")
public class EduTeacherController {
}

二、配置Swagger2生成API接口文档

一、Swagger2介绍

前后端分离开发模式中，api文档是最好的沟通方式。
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。简单来说，Swagger 是一个功能强大的接口管理工具，并且提供了多种编程语言的前后端分离解决方案。

1. 及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
2. 规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
3. 一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
4. 可测性 (直接在接口文档上进行测试，以方便理解业务)

二、配置Swagger2

1. 创建 common 模块

在 guli-parent 下创建模块 common:

 

2. 在common中引入相关依赖

 org.springframework.bootspring-boot-starter-webprovided com.baomidoumybatis-plus-boot-starterprovided org.projectlomboklombokprovided io.springfoxspringfox-swagger2provided io.springfoxspringfox-swagger-uiprovided org.springframework.bootspring-boot-starter-data-redis

3. 在common下面创建子模块service-base

4. 在模块service-base中，创建swagger的配置类

创建 com.atguigu.servicebase.config 包，在此包下创建 SwaggerConfig 类：

@Configuration
@EnableSwagger2
public class SwaggerConfig {@Beanpublic 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("guli_edu", "http://guli_edu.com","995931576@qq.com")).build();}
}

5. 在模块service模块中引入service-base

service_basecom.atguigu0.0.1-SNAPSHOT

6. 在service-edu启动类上添加注解

在启动类上添加 @ComponentScan(basePackages = {"com.atguigu"}) 来扫描 SwaggerConfig 这个类。

@SpringBootApplication
@ComponentScan(basePackages = {"com.atguigu"})
public class EduApplication {public static void main(String[] args) {SpringApplication.run(EduApplication.class, args);}
}

7. 测试

运行启动类，访问 http://localhost:8001/swagger-ui.html：

8. API模型

可以添加一些自定义设置，例如：
定义样例数据

@ApiModelProperty(value = "创建时间")@TableField(fill = FieldFill.INSERT)private Date gmtCreate;@ApiModelProperty(value = "更新时间")@TableField(fill = FieldFill.INSERT_UPDATE)private Date gmtModified;

9. 定义接口说明和参数说明

定义在类上：@Api
定义在方法上：@ApiOperation
定义在参数上：@ApiParam

@Api(description = "讲师管理")
@RestController
@CrossOrigin //解决跨域问题
@RequestMapping("/eduservice/edu-teacher")
public class EduTeacherController {@Autowiredprivate EduTeacherService eduTeacherService;// 查询讲师表所有数据// 访问地址： http://localhost:8001/eduservice/edu-teacher/findAll@ApiOperation(value = "所有讲师列表")@GetMapping("/findAll")public List list() {return eduTeacherService.list(null);}// 逻辑删除讲师// 访问地址：http://localhost:8001/eduservice/edu-teacher/deleteTeacherById/id@ApiOperation(value = "根据ID删除讲师")@DeleteMapping("deleteTeacherById/{id}")public boolean deleteTeacherById(@ApiParam(name = "id", value = "讲师ID", required = true)@PathVariable String id) {return eduTeacherService.removeById(id);}
}

三、统一返回结果对象

一、统一返回数据格式

项目中我们会将响应封装成 json 返回，一般我们会将所有接口的数据格式统一， 使前端 (iOS Android, Web) 对数据的操作更一致、轻松。
一般情况下，统一返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是一般会包含状态码、返回消息、数据这几部分内容。
例如，我们的系统要求返回的基本数据格式如下：

列表：

{"success": true,"code": 20000,"message": "成功","data": {"items": [{"id": "1","name": "刘德华","intro": "毕业于师范大学数学系，热爱教育事业，执教数学思维6年有余"}]}
}

分页：

{"success": true,"code": 20000,"message": "成功","data": {"total": 17,"rows": [{"id": "1","name": "刘德华","intro": "毕业于师范大学数学系，热爱教育事业，执教数学思维6年有余"}]}
}

没有返回数据：

{"success": true,"code": 20000,"message": "成功","data": {}
}

失败：

{"success": false,"code": 20001,"message": "失败","data": {}
}

因此，我们定义统一结果：

{"success": 布尔, //响应是否成功"code": 数字, //响应码"message": 字符串, //返回消息"data": HashMap //返回数据，放在键值对中
}

二、创建统一结果返回类

1. 在common模块下创建子模块common-utils
   
2. 创建接口定义返回码
   创建包 com.atguigu.commonutils，创建接口 ResultCode.java:

public interface ResultCode {//状态码：成功public static Integer SUCCESS = 20000;//状态码：失败public static Integer ERROR = 20001;}

3. 创建结果类
   创建类 R.java

@Data
public class R {@ApiModelProperty("是否成功")private boolean success;@ApiModelProperty("响应码")private Integer code;@ApiModelProperty("返回信息")private String message;@ApiModelProperty("返回数据")private Map data = new HashMap();//无参构造方法私有private R() {}//成功 静态方法public static R ok(){R r = new R();r.setSuccess(true);r.setCode(ResultCode.SUCCESS);r.setMessage("成功");return r;}//失败 静态方法public static R error(){R r = new R();r.setSuccess(false);r.setCode(ResultCode.ERROR);r.setMessage("失败");return r;}public R success(Boolean success){this.setSuccess(success);return this;}public R code(Integer code){this.setCode(code);return this;}public R message(String message){this.setMessage(message);return this;}public R data(String key,Object value){this.data.put(key,value);return this;}public R data(Map map){this.setData(map);return this;}

三、统一返回结果使用

1. 在service模块中添加依赖

 common_utilscom.atguigu0.0.1-SNAPSHOT

2. 修改Controller中的返回结果

@Api(description = "讲师管理")
@RestController
@CrossOrigin //解决跨域问题
@RequestMapping("/eduservice/edu-teacher")
public class EduTeacherController {@Autowiredprivate EduTeacherService eduTeacherService;// 查询讲师表所有数据// 访问地址： http://localhost:8001/eduservice/edu-teacher/findAll@ApiOperation(value = "所有讲师列表")@GetMapping("/findAll")public R findAllTeacher() {List list = eduTeacherService.list(null);return R.ok().data("items", list);}// 逻辑删除讲师// 访问地址：http://localhost:8001/eduservice/edu-teacher/deleteTeacherById/id@ApiOperation(value = "根据ID删除讲师")@DeleteMapping("deleteTeacherById/{id}")public R removeTeacher(@ApiParam(name = "id", value = "讲师ID", required = true)@PathVariable String id) {boolean flag = eduTeacherService.removeById(id);if (flag) {return R.ok();} else {return R.error();}}}

四、分页和条件查询接口开发

一、分页

1. MyBatisPlusConfig中配置分页插件

   /*** 分页插件*/@Beanpublic PaginationInterceptor paginationInterceptor() {return new PaginationInterceptor();}

2. 分页Controller方法
   在 EduTeacherController 类中添加分页的方法：

// 分页查询讲师的方法@ApiOperation(value = "分页讲师列表")@GetMapping("/pageList/{page}/{limit}")public R pageList(@ApiParam(name = "page", value = "当前页码", required = true)@PathVariable Long page,@ApiParam(name = "limit", value = "每页记录数", required = true)@PathVariable Long limit) {// 创建page对象Page pagePram = new Page<>(page, limit);// 调用方法实现分页// 调用方法时，底层封装，把分页所有数据封装到pageParam对象里面eduTeacherService.page(pagePram, null);// 获取查询到的数据List records = pagePram.getRecords();// 获取总记录数long total = pagePram.getTotal();return R.ok().data("total", total).data("rows", records);}

3. Swagger 中测试
   
   

二、多条件组合查询带分页

根据讲师名称 name、讲师头衔 level、讲师入驻时间 gmt_create（时间段）查询。

1. 创建查询对象
   在 entity 包下创建 vo包，并且创建 TeacherQuery 查询对象：

@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")private String begin;//注意，这里使用的是String类型，前端传过来的数据无需进行类型转换@ApiModelProperty(value = "查询结束时间", example = "2019-12-01 10:10:10")private String end;}

2. service
   接口：

public interface EduTeacherService extends IService {// 多条件查询讲师带分页void pageQuery(Page pageParam, TeacherQuery teacherQuery);
}

实现：

@Service
public class EduTeacherServiceImpl extends ServiceImpl implements EduTeacherService {@Overridepublic void pageQuery(Page pageParam, TeacherQuery teacherQuery) {//构建条件QueryWrapper wrapper = new QueryWrapper<>();//取出值，判断他们是否有值String name = teacherQuery.getName();Integer level = teacherQuery.getLevel();String begin = teacherQuery.getBegin();String end = teacherQuery.getEnd();//判断条件值是否为空，如果不为空，拼接条件//判断是否有传入教师名if (!StringUtils.isEmpty(name)){//构建条件wrapper.like("name",name);  //参数1：数据库字段名； 参数2：模糊查询的值}//判断是否传入教师头衔if (!StringUtils.isEmpty(String.valueOf(level))){//构造条件wrapper.eq("level",level);}if (!StringUtils.isEmpty(begin)){//构造条件wrapper.ge("gmt_create",begin);  //ge：大于等于}if (!StringUtils.isEmpty(begin)){//构造条件wrapper.le("gmt_modified",end);  //le: 小于等于}baseMapper.selectPage(pageParam, wrapper);}}

3. controller
   在 EduTeacherController 类中添加 pageTeacherCondition 方法，代码如下：

// 多条件查询讲师带分页@ApiOperation(value = "多条件查询讲师带分页")@PostMapping("pageTeacherCondition/{page}/{limit}")public R pageTeacherCondition(@ApiParam(name = "page", value = "当前页码", required = true)@PathVariable Long page,@ApiParam(name = "limit", value = "每页记录数", required = true)@PathVariable Long limit,@RequestBody(required = false) TeacherQuery teacherQuery) {// 创建分页page对象Page pageParam = new Page<>(page, limit);// 调用方法实现多条件分页查询eduTeacherService.pageQuery(pageParam, teacherQuery);// 获取查询到的数据List records = pageParam.getRecords();// 获取总记录数long total = pageParam.getTotal();return R.ok().data("total", total).data("rows", records);}

4. Swagger 中测试
   
    

五、新增和修改讲师接口开发

一、自动填充封装

1. 在service-base模块中添加
   创建包 handler， 在此包下创建 MyMetaObjectHandler 自动填充类：

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {//参数1：对应类中的属性名称this.setFieldValByName("gmtCreate", new Date(), metaObject);this.setFieldValByName("gmtModified", new Date(), metaObject);}@Overridepublic void updateFill(MetaObject metaObject) {this.setFieldValByName("gmtModified", new Date(), metaObject);}}

2. 在实体类添加自动填充注解

   @ApiModelProperty(value = "创建时间")@TableField(fill = FieldFill.INSERT)private Date gmtCreate;@ApiModelProperty(value = "更新时间")@TableField(fill = FieldFill.INSERT_UPDATE)private Date gmtModified;

二、controller方法定义

1. 添加讲师

// 添加讲师@ApiOperation(value = "添加讲师")@PostMapping("addTeacher")public R addTeacher(@RequestBody EduTeacher eduTeacher) {boolean save = eduTeacherService.save(eduTeacher);if (save) {return R.ok();} else {return R.error();}}

2. 根据id查询

 // 根据讲师id进行查询@ApiOperation(value = "根据id查询")@GetMapping("/getTeacher/{if}")public R getTeacher(@PathVariable String id) {EduTeacher eduTeacher = eduTeacherService.getById(id);return R.ok().data("teacher", eduTeacher);}

3. 根据id修改

 // 修改讲师@ApiOperation(value = "修改讲师")@PostMapping("updateTeacher")public R updateTeacher(@RequestBody EduTeacher eduTeacher) {boolean flag = eduTeacherService.updateById(eduTeacher);if (flag) {return R.ok();} else {return R.error();}}

六、统一异常处理

一、什么是统一异常处理

1. 制造异常

int a = 10 / 0

2. 什么是统一异常处理

我们想让异常结果也显示为统一的返回结果对象，并且统一处理系统的异常信息，那么需要统一异常处理。

二、统一异常处理

1. 创建统一异常处理器
   在模块 service-base 中创建 GlobalExceptionHandler 统一异常处理类：

 // 统一异常处理@ExceptionHandler(Exception.class)@ResponseBody //因为不在Controller中。没有@RestController，所以数据不会返回，需要加@ResponeseBody返回数据public R error(Exception e){e.printStackTrace();return R.error().message("执行了全局异常处理");}

2. 测试

三、处理特定异常

1. 添加处理异常方法

// 特定异常@ExceptionHandler(ArithmeticException.class)@ResponseBodypublic R error(ArithmeticException e){e.printStackTrace();return R.error().message("执行了特定异常");}

2. 测试
   

四、自定义异常

1. 创建自定义异常类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class GuliException extends RuntimeException {private Integer code; // 状态码private String msg;  // 异常信息
}

2. 业务中需要的位置抛出GuliException

try {int a = 10/0;
}catch(Exception e) {throw new GuliException(20001,"出现自定义异常");
}

3. 添加异常处理方法

// 自定义异常@ExceptionHandler(GuliException.class)@ResponseBodypublic R error(GuliException e){e.printStackTrace();return R.error().message(e.getMsg()).code(e.getCode());}

4. 测试
   
    

七、统一日志处理

一、日志

1. 配置日志级别
   日志记录器（Logger）的行为是分等级的。分为：OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL
   默认情况下，spring boot 从控制台打印出来的日志级别只有 INFO 及以上级别，可以配置日志级别

# 设置日志级别
logging.level.root=WARN

这种方式只能将日志打印在控制台上.

二、Logback日志

spring boot内部使用 Logback 作为日志实现的框架。
Logback 和 log4j 非常相似，如果你对 log4j 很熟悉，那对 logback 很快就会得心应手。

1. 配置logback日志
   删除 application.properties 中的日志配置:

# mybatis日志
#mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
# 设置日志级别
#logging.level.root=WARN

在安装 idea 彩色日志插件：grep-console
在resources 中创建 logback-spring.xml:

logbackINFO${CONSOLE_LOG_PATTERN}UTF-8${log.path}/log_info.log%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level%logger{50} - %msg%nUTF-8${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log100MB15INFOACCEPTDENY${log.path}/log_warn.log%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level%logger{50} - %msg%nUTF-8 ${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log100MB15warnACCEPTDENY${log.path}/log_error.log%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level%logger{50} - %msg%nUTF-8 ${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log100MB15ERRORACCEPTDENY

2. 将错误日志输出到文件
   在 GlobalExceptionHandler 类中添加 @Slf4j 注解。
   异常语句输出： log.error(e.getMessage());

创作不易，如果有帮助到你，请给文章点个赞和收藏，让更多的人看到！！！
关注博主不迷路，内容持续更新中。