在线教育_Day02-_项目环境搭建和讲师管理接口开发

Posted 2023-03-13 编程指南针

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了在线教育_Day02-_项目环境搭建和讲师管理接口开发相关的知识，希望对你有一定的参考价值。

一、数据库设计

1.1 创建数据库

创建数据库：自定义数据库名

1.2 创建数据表

导入资料中的 gl_edu.sql文件，创建表

1.3 数据库设计规约

以下规约只针对本模块，更全面的文档参考《阿里巴巴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、不得使用外键与级联，一切外键概念必须在应用层解决。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。

二、工程创建

2.1 工程结构介绍

2.1.1 工程结构

2.1.2 模块说明

edu_parent：在线教学根目录（父工程），管理四个子模块：
- common：公共模块父节点
  - common-utils：工具类模块，所有模块都可以依赖于它
  - 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接口服务

2.2 创建父工程

2.2.1 创建sprigboot工程edu-parent

在idea开发工具中，使用 Spring Initializr 快速初始化一个 Spring Boot 模块，版本使用：2.2.1.RELEASE

groupId：com.itfxp artifactId：edu_parent 最后一直下一步到完成

2.2.2 删除 src 目录

2.2.3 配置 pom.xml

修改版本为：2.2.1.RELEASE

2.2.4 添加相关依赖的版本

删除pom.xml中的<dependencies>内容

<!-- 以下内容删除 -->
<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>
</dependencies>

添加 <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.5.1</aliyun-java-sdk-core.version>
        <aliyun-sdk-oss.version>3.10.2</aliyun-sdk-oss.version>
        <aliyun-java-sdk-vod.version>2.15.11</aliyun-java-sdk-vod.version>
        <aliyun-java-vod-upload.version>1.4.14</aliyun-java-vod-upload.version>
        <aliyun-sdk-vod-upload.version>1.4.14</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>

2.2.5 修改打包方式

<artifactId> 节点后面添加 pom类型

<artifactId>edu_parent</artifactId>
<packaging>pom</packaging>

三、搭建子模块

3.1 在父工程edu-parent创建模块service

选择 maven类型，点击下一步，输入模块名称 service，下一步完成创建

3.2 添加项目需要的依赖

注意：由于刚开始没有使用相关springcloud业务功能，所以现在我们把springcloud相关依赖给注释掉，否则项目启动时会报错。

 <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>
        </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>
    </dependencies>

3.3 添加模块类型是pom

<artifactId> 节点后面添加pom类型

<artifactId>service</artifactId>
<packaging>pom</packaging>

注意事项

如果刚一开始添加依赖时，出现maven报错，这个时候先不要修改maven的打包方式为POM类型。

先将该工程clean一下，然后再install ,没有错误信息最后再修改为POM类型即可！

3.4 搭建service_edu模块

在父工程service模块下面创建子模块输入模块名称 service_edu，下一步完成创建

四、讲师管理模块配置

4.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.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/gl_edu?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root

# 配置mapper扫描路径
mybatis-plus.mapper-locations= classpath*:/mapper/**/*.xml

#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

或者在resources目录下创建文件 application.yml

#### application.yml
spring:
  application:
    name: service-edu
profiles:
    active: dev
####  application-dev.yml
server:
  port: 8001
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
mapper-locations: classpath:/mapper/*.xml
global-config:
    db-config:
      logic-delete-value: 1
logic-not-delete-value: 0
spring:
datasource:
    type: com.zaxxer.hikari.HikariDataSource
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/guli?serverTimezone=GMT%2B8
username: root
password: root
hikari:
      connection-test-query: SELECT 1
connection-timeout: 60000
idle-timeout: 500000
max-lifetime: 540000
maximum-pool-size: 12
minimum-idle: 10
pool-name: GuliHikariPool
jackson:
    date-format: yyyy-MM-dd HH:mm:ss
time-zone: GMT+8

4.2 创建MP代码生成器

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

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;
/**
 * @author
 * @since 2018/12/13
 */
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("D:\\\\ideaworkspace\\\\myedu2\\\\edu_parent\\\\service\\\\edu-service" + "/src/main/java");
        gc.setAuthor("zjl");
        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/gl_edu?serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);
        // 4、包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("eduservice"); //模块名
        pc.setParent("com.itfxp");
        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();

4.3 编写后台管理api接口

4.3.1 编写controller代码

@Autowired
private TeacherService teacherService;
@GetMapping("/findAll")
public List<Teacher> list()
    return teacherService.list(null);

4.3.2 创建SpringBoot配置类

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

@Configuration
@MapperScan("com.itfxp.eduservice.mapper")
public class MyBatisPlusConfig

4.3.3 配置SQL执行性能分析插件[可忽略]

/**
     * 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.3.4 创建SpringBoot启动类

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

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

4.3.5 运行启动类

访问http://localhost:8001/eduservice/teacher/findAll

4.3.6 统一返回的json时间格式

默认情况下json时间格式带有时区，并且是世界标准时间，和我们的时间差了八个小时

在application.properties中设置

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

五、讲师逻辑删除功能

5.1 EduTeacherController添加删除方法

@DeleteMapping("/id")
public boolean removeById(@PathVariable String id)
    return teacherService.removeById(id);

5.2 配置逻辑删除插件

在MyBatisPlusConfig中配置

/**
* 逻辑删除插件
*/
@Bean
public ISqlInjector sqlInjector() 
    return new LogicSqlInjector();

5.3 在Teacher实体类中添加@TableLogic

@ApiModelProperty(value = "逻辑删除 1（true）已删除， 0（false）未删除")
@TableLogic
private Boolean isDeleted;

5.4 使用postman测试删除

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

六、跨域配置

6.1 什么是跨域

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

6.2 配置

在Controller类上添加注解

@CrossOrigin //跨域

七、Swagger2

7.1 什么是Swagger

前后端分离开发模式中，api文档是最好的沟通方式。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

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

7.2 配置Swagger2

7.2.1 创建common模块

在edu-parent下创建模块common groupId：com.itfxp artifactId：common

7.2.2 在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>

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

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

创建包com.itfxp.servicebase.config，创建类SwaggerConfig

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;
@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("Helen", "http://itfxp.com", "459380074@qq.com"))
                .build();

7.2.5 在service模块中引入service-base

<dependency>
    <groupId>com.itfxp</groupId>
    <artifactId>service-base</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

7.2.6 在service-edu启动类上添加注解，进行测试

7.3 API模型

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

定义样例数据

@ApiModelProperty(value = "创建时间", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;
@ApiModelProperty(value = "更新时间", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;

7.4 定义接口说明和参数说明

7.4.1 相关注解

位置	注解
定义在类上	@Api 设置该模块的中文提示
定义在方法上	@ApiOperation 描述该方法信息
定义在参数上	@ApiParam 描述方法中的参数信息

@Api(description="讲师管理")
@RestController
@RequestMapping("/admin/edu/teacher")
public class TeacherAdminController 
    @Autowired
    private TeacherService teacherService;
    
    @ApiOperation(value = "所有讲师列表")
    @GetMapping
    public List<Teacher> list()
        return teacherService.list(null);
    
    @ApiOperation(value = "根据ID删除讲师")
    @DeleteMapping("id")
    public boolean removeById(
            @ApiParam(name = "id", value = "讲师ID", required = true)
            @PathVariable String id)
        return teacherService.removeById(id);

八、统一返回数据格式

8.1 数据格式分析

项目中我们会将响应封装成json返回，一般我们会将所有接口的数据格式统一，使前端(ios android, Web)对数据的操作更一致、轻松。

一般情况下，统一返回数据格式没有固定的格式，只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是一般会包含状态码、返回消息、数据这几部分内容

例如，我们的系统要求返回的基本数据格式如下：

8.1.1 情况一列表

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

8.1.2 情况二分页

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

8.1.3 情况三无返回数据

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

8.1.4 情况四失败

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

8.1.5 总结

因此，我们定义统一结果

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

8.2 实现结果返回类

8.2.1 在common模块下创建子模块common-utils

8.2.2 创建接口定义返回码

创建包com.itfxp.commonutils，创建接口 ResultCode.java

public interface ResultCode 
    public static Integer SUCCESS = 20000;
    public static Integer ERROR = 20001;

8.2.3 创建结果类

创建类 R.java

package com.itfxp.commonutils;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.util.HashMap;
import java.util.Map;
@Data
public class R 
    @ApiModelProperty(value = "是否成功")
    private Boolean success;
    @ApiModelProperty(value = "返回码")
    private Integer code;
    @ApiModelProperty(value = "返回消息")
    private String message;
    @ApiModelProperty(value = "返回数据")
    private Map<String, Object> data = new HashMap<String, Object>();
    //把构造方法私有
    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 message(String message)
        this.setMessage(message);
        return this;
    
    public R code(Integer code)
        this.setCode(code);
        return this;
    
    public R data(String key, Object value)
        this.data.put(key, value);
        return this;
    
    public R data(Map<String, Object> map)
        this.setData(map);
        return this;

8.3 使用统一返回结果

8.3.1 在service模块中添加依赖

<dependency>
    <groupId>com.itfxp</groupId>
    <artifactId>common_utils</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

8.3.2 修改Controller中的返回结果

查询所有老师列表

@ApiOperation(value = "所有讲师列表")
@GetMapping
public R list()
    List<Teacher> list = teacherService.list(null);
    return R.ok().data("items", list);

根据老师ID删除

@ApiOperation(value = "根据ID删除讲师")
@DeleteMapping("id")
public R removeById(
    @ApiParam(name = "id", value = "讲师ID", required = true)
    @PathVariable String id)
    teacherService.removeById(id);
    return R.ok();

九、讲师接口开发

9.1 分页查询

9.1.1 MyBatisPlusConfig中配置分页插件

/**
 * 分页插件
 */
@Bean
public PaginationInterceptor paginationInterceptor() 
    return new PaginationInterceptor();

9.1.2 分页Controller方法

EduTeacherController中添加分页方法

@GetMapping("/pageTeacher/page/limit")
public R pageListTeacher(@PathVariable Long page, @PathVariable Long limit)
    Page<EduTeacher> teacherPage = new Page<>(page,limit);
    IPage<EduTeacher> teacherIPage = eduTeacherService.page(teacherPage, null);
    return R.ok().data("total",teacherIPage.getTotal()).data("rows",teacherIPage.getRecords());

9.1.3 Swagger中测试

9.2 条件查询

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

9.2.1 创建查询对象

创建com.itfxp.eduservice.entity.vo.query包，创建TeacherQuery.java查询对象

@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;

9.2.2 编写条件查询service

编写接口

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.itfxp.eduservice.entity.EduTeacher;
import com.baomidou.mybatisplus.extension.service.IService;
import com.itfxp.eduservice.entity.vo.query.TeacherQuery;
/**
 * <p>
 * 讲师 服务类
 * </p>
 *
 * @author zjl
 * @since 2022-06-26
 */
public interface EduTeacherService extends IService<EduTeacher> 
    IPage<EduTeacher> pageTeacherCondition(Page<EduTeacher> teacherPage, TeacherQuery teacherQuery);

编写接口实现

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.itfxp.eduservice.entity.EduTeacher;
import com.itfxp.eduservice.entity.vo.query.TeacherQuery;
import com.itfxp.eduservice.mapper.EduTeacherMapper;
import com.itfxp.eduservice.service.EduTeacherService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
import org.springframework.util.StringUtils;
/**
 * <p>
 * 讲师 服务实现类
 * </p>
 *
 * @author zjl
 * @since 2022-06-26
 */
@Service
public class EduTeacherServiceImpl extends ServiceImpl<EduTeacherMapper, EduTeacher> implements EduTeacherService 
    @Override
    public IPage<EduTeacher> pageTeacherCondition(Page<EduTeacher> teacherPage, TeacherQuery teacherQuery) 
        QueryWrapper<EduTeacher> queryWrapper = new QueryWrapper<>();
        // 多条件组合查询
        // 判断条件值是否为空，不为空则拼接条件
        if (!StringUtils.isEmpty(teacherQuery.getName()))
            queryWrapper.like("name", teacherQuery.getName());
        
        if (!StringUtils.isEmpty(teacherQuery.getLevel()))
            queryWrapper.eq("level", teacherQuery.getLevel());
        
        if (!StringUtils.isEmpty(teacherQuery.getBegin()))
            queryWrapper.ge("gmt_create", teacherQuery.getBegin());
        
        if (!StringUtils.isEmpty(teacherQuery.getEnd()))
            queryWrapper.le("gmt_create", teacherQuery.getEnd());
        
        IPage<EduTeacher> eduTeacherIPage = this.baseMapper.selectPage(teacherPage, queryWrapper);
        return eduTeacherIPage;

9.2.3 编写条件查询controller

EduTeacherController中添加 pageTeacherCondition方法：

增加参数TeacherQuery teacherQuery，非必选

/*
条件查询带分页
 */
@PostMapping("/pageTeacherCondition/page/limit")
public R pageTeacherCondition(@PathVariable Long page,
                              @PathVariable Long limit,
                              @RequestBody(required = false) TeacherQuery teacherQuery)
    Page<EduTeacher> teacherPage = new Page<>(page,limit);
    IPage<EduTeacher> teacherIPage = eduTeacherService.pageTeacherCondition(teacherPage, teacherQuery);
    return R.ok().data("total",teacherIPage.getTotal()).data("rows",teacherIPage.getRecords());

9.2.4 Swagger中测试

9.3 添加讲师

9.3.1 自动填充封装

1、在service-base模块中添加

创建包handler，创建自动填充类 MyMetaObjectHandler

@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、在实体类添加自动填充注解

9.3.2 添加讲师

编写controller

@ApiOperation(value = "新增讲师")
@PostMapping("/addTeacher")
public R save(
    @ApiParam(name = "teacher", value = "讲师对象", required = true)
    @RequestBody EduTeacher teacher) 
    boolean save = eduTeacherService.save(teacher);
    if (save) 
        return R.ok();
     else 
        return R.error();

9.4 修改讲师

9.4.1 根据id查询

@ApiOperation(value = "根据ID查询讲师")
@GetMapping("id")
public R getById(
    @ApiParam(name = "id", value = "讲师ID", required = true)
    @PathVariable String id)
    EduTeacher teacher = eduTeacherService.getById(id);
    return R.ok().data("item", teacher);

9.4.2 根据id修改讲师

@ApiOperation(value = "根据ID修改讲师")
@PutMapping("id")
public R updateById(
    @ApiParam(name = "id", value = "讲师ID", required = true)
    @PathVariable String id,
    @ApiParam(name = "teacher", value = "讲师对象", required = true)
    @RequestBody EduTeacher teacher)
    teacher.setId(id);
    eduTeacherService.updateById(teacher);
    return R.ok();




@ApiOperation(value = "根据ID修改讲师")
@PostMapping("/updateTeacherById")
public R updateTeacherById( @RequestBody EduTeacher teacher)
    eduTeacherService.updateById(teacher);
    return R.ok();

十、统一异常处理

10.1 什么是统一异常处理

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

10.2 统一异常处理方式

10.2.1 创建统一异常处理器

在service-base中创建统一异常处理类GlobalExceptionHandler.java：

/**
 * 统一异常处理类
 */
@ControllerAdvice
public class GlobalExceptionHandler 
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e)
        e.printStackTrace();
        return R.error();

10.2.2 处理特定异常

GlobalExceptionHandler.java中添加

@ExceptionHandler(ArithmeticException.class)
@ResponseBody
public R error(ArithmeticException e)
    e.printStackTrace();
    return R.error().message("执行了ArithmeticException自定义异常");

10.2.3 自定义异常

1、创建自定义异常类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class EduException extends RuntimeException 
    @ApiModelProperty(value = "状态码")
    private Integer code;
    private String msg;

2、业务中需要的位置抛出EduException

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

3、添加异常处理方法