内容管理模块

1. 模块需求分析

1.1 什么是需求分析

在百度百科中对需求分析的定义如下：

• 需求分析也称为软件需求分析、系统需求分析或需求分析工程等，是开发人员经过深入细致的调研和分析，准确理解用户和项目的功能、性能、可靠性等具体要求，将用户非形式的需求表述转化为完整的需求定义，从而确定系统必须做什么的过程。

• 简单理解就是要搞清楚问题域，问题域就是用户的需求，软件要为用户解决什么问题，实现哪些业务功能，满足什么样的性能要求。

1.1.1 如何作需求分析？

第一：首先确认用户需求

• 用户需求即用户的原始需求。

• 通过用户访谈、问卷调查、开会讨论、查阅资料等调研手段梳理用户的原始需求。

• 产品人员根据用户需求会绘制界面原型，通过界面原型再和用户确认需求。

第二：确认关键问题

用户的原始需求可能 是含糊不清的，需求分析要从繁杂的问题中梳理出关键问题。

• 比如：教学机构的老师想要将课程发布到网上，这是原始需求，根据这个用户需求我们需要进行扩展分析，扩展出几下几点：
  1. 课程发布需要发布哪些信息
  2. 如果发布了不良信息怎么办？
  3. 课程发布后用户怎么查看课程？

根据以上几点继续延伸性分析：

1. 课程发布需要发布哪些信息

课程名称、课程介绍、课程价格、课程图片、师资等信息

继续延伸分析：

1. 这么多课程信息进行归类，方便用户编辑，分为课程基本信息、课程营销信息、课程师资等信息。

• 按照这样的思路对用户需求逐项分析，梳理出若干问题，再从中找到关键问题。

• 比如：上边对课程信息分类后，哪些是关键信息，课程名称、课程图片、课程介绍等基本信息为关键信息，所以发布课程的第一步要编写课程基本信息。

找到了关键问题，下一步就可以进行数据建模，创建课程基本信息表，并设计其中的字段。

第三：梳理业务流程

​ 业务流程是由一个或多个用户参与完成为了完成一个目标所进行的一系列的业务操作，不论是整个系统还是一个模块通常首先分析核心的业务流程，比如：内容管理模块的核心业务流程是课程发布，本项目的核心业务流程是学生选课学习流程。

第四：数据建模

​ 数据建模要根据分析的关键问题将其相关的信息全部建模。比如：根据发布课程的用户需求，可创建课程基本信息表、课程营销信息表、课程师资表、课程发布记录表、课程审核记录表等。

第五：编写需求规格说明书

​ 需求分析阶段的成果物是需求分析规格说明书，针对每一个问题编写需求用例，需求用例包括：功能名称、功能描述、参与者、基本事件流程、可选事件流、数据描述、前置条件、后置条件等内容。

比如：添加课程的需求用例如下：

项目	添加课程
功能名称	添加课程
功能描述	添加课程基本信息
参与者	教学机构管理员
前置条件	教学机构管理只允许向自己机构添加课程 拥有添加课程的权限
基本事件流程	1、登录教学机构平台 2、进入课程列表页面 3、点击添加课程按钮进入添加课程界面 4、填写课程基本信息 5、点击提交。
可选事件流程	成功：提示添加成功，跳转到课程营销信息添加界面 失败：提示具体的失败信息，用户根据失败信息进行修改。
数据描述	课程基本信息：课程id、课程名称、课程介绍、课程大分类、课程小分类、课程等级、课程图片、所属机构、课程创建时间、课程修改时间、课程状态
后置条件	向课程基本信息插入一条记录
补充说明

1.2 模块介绍

内容管理这个词存在于很多软件系统，什么是内容管理 ？

通过百度百科查询其意思：https://baike.baidu.com/item/%E5%86%85%E5%AE%B9%E7%AE%A1%E7%90%86%E7%B3%BB%E7%BB%9F/2683135?fromtitle=%E5%86%85%E5%AE%B9%E7%AE%A1%E7%90%86&fromid=9868820&fr=aladdin

内容管理系统（content management system，CMS），是一种位于WEB前端（Web 服务器）和后端办公系统或流程（内容创作、编辑）之间的软件系统。内容的创作人员、编辑人员、发布人员使用内容管理系统来提交、修改、审批、发布内容。这里指的“内容”可能包括文件、表格、图片、数据库中的数据甚至视频等一切你想要发布到Internet、Intranet以及Extranet网站的信息。

本项目作为一个大型的在线教育平台，其内容管理模块主要对课程及相关内容进行管理，包括：课程的基本信息、课程图片、课程师资信息、课程的授课计划、课程视频、课程文档等内容的管理。

1.3 业务流程

内容管理的业务由教学机构人员和平台的运营人员共同完成。

教学机构人员的业务流程如下：

1. 登录教学机构。

2. 维护课程信息，添加一门课程需要编辑课程的基本信息、上传课程图片、课程营销信息、课程计划、上传课程视频、课程师资信息等内容。

3. 课程信息编辑完成，通过课程预览确认无误后提交课程审核。

4. 待运营人员对课程审核通过后方可进行课程发布。

运营人员的业务流程如下：

1. 查询待审核的课程信息。

2. 审核课程信息。

3. 提交审核结果。

下图是课程编辑与发布的整体流程。

1.4 界面模型

产品工程师根据用户需求制作产品界面原型，开发工程师除了根据用户需求进行需求分析以外，还会根据界面原型上的元素信息进行需求分析。

内容管理模块的界面原型如下：

课程列表 ：

点击添加课程：

选择录播课程 ，填写课程信息：

填写课程计划信息：

填写课程师资信息：

课程填写完毕进行课程 发布：

当审核状态为通过时发布按钮点亮，点击发布按钮 即可对该课程进行发布。

1.5 数据模型

内容管理模块的基础表涉及9张，如下：

使用PowerDesigner打开课程资料下的 “数据库\模型\学成在线项目.sws”

2.创建模块工程

2.1 模块工程结构

• 在第一章节创建了项目父工程、项目基础工程，如下图：

• 接下来要创建内容管理模块的工程结构。本项目是一个前后端分离项目，前端与后端开发人员之间主要依据接口进行开发。前后端交互的流程图如下所示：

  1. 前端请求后端服务提供的接口。（通常为http协议 ）

  2. 后端服务的控制层Controller接收前端的请求。

  3. Contorller层调用Service层进行业务处理。

  4. Service层调用Dao持久层对数据持久化。

• 整个流程分为前端、接口层、业务层三部分。所以模块工程的结构如下图所示：

  • xuecheng-plus-content-api：接口工程，为前端提供接口。

  • xuecheng-plus-content-service: 业务工程，为接口工程提供业务支撑。

  • xuecheng-plus-content-model: 数据模型工程，存储数据模型类、数据传输类型等。

结合项目父工程、项目基础工程后，如下图：

• xuecheng-plus-content：内容管理模块工程，负责聚合xuecheng-plus-content-api、xuecheng-plus-content-service、xuecheng-plus-content-model。

2.2 创建模块工程

创建工程时，删除不必要的文件，着重保留 pom.xml 和 src

1. 创建内容管理模块父工程xuecheng-plus-content，修改pom.xml，声明为聚合工程，且有三个子模块

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
       <modelVersion>4.0.0</modelVersion>
       <parent>
           <groupId>com.xuecheng</groupId>
           <artifactId>xuecheng-plus-parent</artifactId>
           <version>0.0.1-SNAPSHOT</version>
           <relativePath>../xuecheng-plus-parent</relativePath>
       </parent>
       <groupId>com.xuecheng</groupId>
       <artifactId>xuecheng-plus-content</artifactId>
       <version>0.0.1-SNAPSHOT</version>
       <name>xuecheng-plus-content</name>
       <description>xuecheng-plus-content</description>
       <packaging>pom</packaging>
       <properties>
           <java.version>1.8</java.version>
       </properties>
       <modules>
           <module>xuecheng-plus-content-api</module>
           <module>xuecheng-plus-content-model</module>
           <module>xuecheng-plus-content-service</module>
       </modules>
   
   </project>

2. 创建xuecheng-plus-content-api工程，设置父工程为 xuecheng-plus-content，按照上图中的依赖关系修改pom文件

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
       <modelVersion>4.0.0</modelVersion>
       <parent>
           <groupId>com.xuecheng</groupId>
           <artifactId>xuecheng-plus-content</artifactId>
           <version>0.0.1-SNAPSHOT</version>
       </parent>
       <artifactId>xuecheng-plus-content-api</artifactId>
       <version>0.0.1-SNAPSHOT</version>
       <name>xuecheng-plus-content-api</name>
       <description>xuecheng-plus-content-api</description>
       <properties>
           <java.version>1.8</java.version>
       </properties>
       <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>
           <dependency>
               <groupId>com.xuecheng</groupId>
               <artifactId>xuecheng-plus-content-service</artifactId>
               <version>0.0.1-SNAPSHOT</version>
           </dependency>
           <dependency>
               <groupId>com.xuecheng</groupId>
               <artifactId>xuecheng-plus-content-model</artifactId>
               <version>0.0.1-SNAPSHOT</version>
           </dependency>
       </dependencies>
   
       <build>
           <plugins>
               <plugin>
                   <groupId>org.springframework.boot</groupId>
                   <artifactId>spring-boot-maven-plugin</artifactId>
               </plugin>
           </plugins>
       </build>
   
   </project>

3. 创建xuecheng-plus-content-model工程，设置父工程为 xuecheng-plus-content

   ，按照上图中的依赖关系修改pom文件

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
       <modelVersion>4.0.0</modelVersion>
       <parent>
           <groupId>com.xuecheng</groupId>
           <artifactId>xuecheng-plus-content</artifactId>
           <version>0.0.1-SNAPSHOT</version>
       </parent>
       <artifactId>xuecheng-plus-content-model</artifactId>
       <version>0.0.1-SNAPSHOT</version>
       <name>xuecheng-plus-content-model</name>
       <description>xuecheng-plus-content-model</description>
       <properties>
           <java.version>1.8</java.version>
       </properties>
       <dependencies>
           <dependency>
               <groupId>com.xuecheng</groupId>
               <artifactId>xuecheng-plus-base</artifactId>
               <version>0.0.1-SNAPSHOT</version>
           </dependency>
       </dependencies>
   
       <build>
           <plugins>
               <plugin>
                   <groupId>org.springframework.boot</groupId>
                   <artifactId>spring-boot-maven-plugin</artifactId>
               </plugin>
           </plugins>
       </build>
   
   </project>

4. 创建xuecheng-plus-content-service工程，设置父工程为xuecheng-plus-content

   ，按照上图中的依赖关系修改pom文件

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
       <modelVersion>4.0.0</modelVersion>
       <parent>
           <groupId>com.xuecheng</groupId>
           <artifactId>xuecheng-plus-content</artifactId>
           <version>0.0.1-SNAPSHOT</version>
       </parent>
       <artifactId>xuecheng-plus-content-service</artifactId>
       <version>0.0.1-SNAPSHOT</version>
       <name>xuecheng-plus-content-service</name>
       <description>xuecheng-plus-content-service</description>
       <properties>
           <java.version>1.8</java.version>
       </properties>
       <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>
           <dependency>
               <groupId>com.xuecheng</groupId>
               <artifactId>xuecheng-plus-content-model</artifactId>
               <version>0.0.1-SNAPSHOT</version>
           </dependency>
       </dependencies>
   
       <build>
           <plugins>
               <plugin>
                   <groupId>org.springframework.boot</groupId>
                   <artifactId>spring-boot-maven-plugin</artifactId>
               </plugin>
           </plugins>
       </build>
   
   </project>

• 创建好的目录结构如下图所示

3. 课程查询

3.1 需求分析

3.1.1 业务流程

课程查询的业务流程如下：

1. 教学机构人员点击课程管理首先进入课程查询界面，如下：

1. 在课程进行列表查询页面输入查询条件查询课程信息
   • 当不输入查询条件时输入全部课程信息。
   • 输入查询条件查询符合条件的课程信息。
   • 约束：本教学机构查询本机构的课程信息。

3.1.2 数据模型

下边从查询条件、查询列表两个方面分析数据模型

1. 查询条件：

   • 包括：课程名称、课程审核状态、课程发布状态
   • 课程名称：可以模糊搜索
   • 课程审核状态：未提交、已提交、审核通过、审核未通过
   • 课程发布状态：未发布、已发布、已下线
   • 因为是分页查询所以查询条件中还要包括当前页码、每页显示记录数。

2. 查询结果：

   • 查询结果中包括：课程id、课程名称、任务数、创建时间、是否付费、审核状态、类型，操作
   • 任务数：该课程所包含的课程计划数，即课程章节数。
   • 是否付费：课程包括免费、收费两种。
   • 类型：录播、直播。
   • 因为是分页查询所以查询结果中还要包括总记录数、当前页、每页显示记录数。

3.2 创建数据库表及PO类型

3.2.1 创建数据库表

1. 创建内容管理数据库
2. 导入数据
   • 选中提供的 sql脚本，执行脚本生成数据表

3.2.2 生成 PO 类

PO 即持久对象 (Persistent Object)，

• 它们是由一组属性和属性的get和set方法组成，PO对应于数据库的表。

• 在开发持久层代码时需要根据数据表编写PO类，在实际开发中通常使用代码生成器（工具）生成PO类的代码。

• 由于在需求分析阶段对数据模型进行分析，PO类对应于数据模型，所以在需求分析阶段即可使用工具生成PO类，为下面的接口定义准备好模型类。

在企业开发中通常使用代码生成工具去自动生成这些文件，

• 本项目使用mybatis-plus的generator工程生成PO类、Mapper接口、Mapper的xml文件，地址在：https://github.com/baomidou/generator

• 将课程资料目录下的xuecheng-plus-generator.zip解压后拷贝至项目工程根目录，

打开IDEA将其导入项目工程 ，打开xuecheng-plus-generator工程的pom.xml，右键 点击“Add as Maven Project” 自动识别maven工程。

本次生成内容管理模块的PO类、Mapper接口和Mapper的xml文件 ，

1. 找到ContentCodeGenerator类

2. 修改ContentCodeGenerator类中的信息，包括：数据库地址、数据库账号、数据库密码、生成的表、生成路径，如下：

3. 修改完成，执行该类的main方法，自动生成content包，如下：

//数据库账号
private static final String DATA_SOURCE_USER_NAME  = "root";
//数据库密码
private static final String DATA_SOURCE_PASSWORD  = "mysql";
//生成的表
private static final String[] TABLE_NAMES = new String[]{
        "course_base",
        "course_market",
        "course_teacher",
        "course_category",
        "teachplan",
        "teachplan_media",
        "course_publish",
        "course_publish_pre"
};
// TODO 默认生成entity，需要生成DTO修改此变量
// 一般情况下要先生成 DTO类 然后修改此参数再生成 PO 类。
private static final Boolean IS_DTO = false;

public static void main(String[] args) {
        ....
        //生成路径
        gc.setOutputDir(System.getProperty("user.dir") + "/xuecheng-plus-generator/src/main/java");
        
....
// 数据库配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setDbType(DbType.MYSQL);
        dsc.setUrl("jdbc:mysql://192.168.101.65:3306/xcplus_" + SERVICE_NAME+"166"
                        + "?serverTimezone=UTC&useUnicode=true&useSSL=false&characterEncoding=utf8");
        ...

1. 在该包下自动生成了内容管理模块的controller、mapper、po及service相关代码，这里我们只需要po类。将po类拷贝到 model 工程

3.3 设计接口

3.3.1 接口设计分析

设计一个接口需要包括以下几个方面：

1. 协议

   • 通常协议采用HTTP，查询类接口通常为 get 或 post，查询条件较少的使用 get，较多的使用 post。
   • 本接口使用 http post。
   • 还要确定 content-type，参数以什么数据格式提交，结果以什么数据格式响应。
   • 一般情况没有特殊情况结果以json 格式响应。

2. 分析请求参数

   • 根据前边对数据模型的分析，请求参数为：课程名称、课程审核状态、当前页码、每页显示记录数。
   • 根据分析的请求参数定义模型类。

3. 分析响应结果

   • 根据前边对数据模型的分析，响应结果为数据列表加一些分页信息（总记录数、当前页、每页显示记录数）。

   • 数据列表中数据的属性包括：课程id、课程名称、任务数、创建时间、审核状态、类型。

   • 注意：查询结果中的审核状态为数据字典中的代码字段，前端会根据审核状态代码 找到对应的名称显示。

根据分析的响应结果定义模型类。

1. 分析完成，使用 SpringBoot 注解开发一个Http接口。

2. 使用接口文档工具查看接口的内容。

3. 接口中调用Service方法完成业务处理。

   接口请求示例

POST /content/course/list?pageNo=2&pageSize=1
Content-Type: application/json

{
  "auditStatus": "202002",
  "courseName": "",
  "publishStatus":""
}
###成功响应结果
{
  "items": [
    {
      "id": 26,
      "companyId": 1232141425,
      "companyName": null,
      "name": "spring cloud实战",
      "users": "所有人",
      "tags": null,
      "mt": "1-3",
      "mtName": null,
      "st": "1-3-2",
      "stName": null,
      "grade": "200003",
      "teachmode": "201001",
      "description": "本课程主要从四个章节进行讲解： 1.微服务架构入门 2.spring cloud 基础入门 3.实战Spring Boot 4.注册中心eureka。",
      "pic": "https://cdn.educba.com/academy/wp-content/uploads/2018/08/Spring-BOOT-Interview-questions.jpg",
      "createDate": "2019-09-04 09:56:19",
      "changeDate": "2021-12-26 22:10:38",
      "createPeople": null,
      "changePeople": null,
      "auditStatus": "202002",
      "auditMind": null,
      "auditNums": 0,
      "auditDate": null,
      "auditPeople": null,
      "status": 1,
      "coursePubId": null,
      "coursePubDate": null
    }
  ],
  "counts": 23,
  "page": 2,
  "pageSize": 1
}

3.3.2 定义模型类

根据接口分析需要定义模型类接收请求的参数，并定义模型类用于响应结果。

1. 分页查询模型类
   • 由于分页查询这一类的接口在项目较多，这里针对分页查询的参数（当前页码、每页显示记录数）单独在xuecheng-plus-base基础工程中定义。

package com.xuecheng.base.model;

import lombok.Data;
import lombok.ToString;

/**
 * @author TaoYaopc
 * @date 2023/5/20
 * @description 分页查询分页参数
 */
@Data
@ToString
public class PageParams {
    //当前页码
    private Long pageNo = 1L;

    //每页记录数默认值
    private Long pageSize = 10L;

    public PageParams() {

    }

    public PageParams(long pageNo, long pageSize) {
        this.pageNo = pageNo;
        this.pageSize = pageSize;
    }
}

1. 查询条件模型类
   • 除了分页查询参数，剩下的就是课程查询的特有参数，此时需要在内容管理的model工程中定义课程查询参数模型类。

package com.xuecheng.content.model.dto;

import lombok.Data;
import lombok.ToString;

/**
 * @author TaoYaopc
 * @description 课程查询条件模型类
 * @date 2023/5/20
 */
@Data
@ToString
public class QueryCourseParamsDto {
    //审核状态
    private String auditStatus;
    //课程名称
    private String courseName;
    //发布状态
    private String publishStatus;
}

1. 响应模型类
   • 根据接口分析，下边定义响应结果模型类。
   • 针对分页查询结果经过分析也存在固定的数据和格式，所以在base工程定义一个基础的模型类。

package com.xuecheng.base.model;

import lombok.Data;
import lombok.ToString;

import java.io.Serializable;
import java.util.List;

/**
 * @author TaoYaopc
 * @description 分页查询结果模型类
 * @date 2023/5/20 11:54
 */
@Data
@ToString
public class PageResult<T> implements Serializable {

    // 数据列表
    private List<T> items;

    //总记录数
    private long counts;

    //当前页码
    private long page;

    //每页记录数
    private long pageSize;

    public PageResult(List<T> items, long counts, long page, long pageSize) {
        this.items = items;
        this.counts = counts;
        this.page = page;
        this.pageSize = pageSize;
    }

}

3.3.3 定义接口

根据分析，此接口提供 HTTP post协议，查询条件以json格式提交，响应结果为json 格式。

可使用SpringBoot注解在Controller类中实现。

1. 在 api 工程下添加依赖

<dependencies>
    <dependency>
        <groupId>com.xuecheng</groupId>
        <artifactId>xuecheng-plus-content-service</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
    <!--cloud的基础环境包-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-context</artifactId>
    </dependency>
    <!-- Spring Boot 的 Spring Web MVC 集成 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    
    <!-- 排除 Spring Boot 依赖的日志包冲突 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>
    <!-- Spring Boot 集成 log4j2 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-log4j2</artifactId>
    </dependency>

    <!-- Spring Boot 集成 swagger -->
    <dependency>
        <groupId>com.spring4all</groupId>
        <artifactId>swagger-spring-boot-starter</artifactId>
        <version>1.9.0.RELEASE</version>
    </dependency>

</dependencies>

1. 定义 Controller 方法

package com.xuecheng.content.api;

import com.xuecheng.base.model.PageParams;
import com.xuecheng.base.model.PageResult;
import com.xuecheng.content.model.dto.QueryCourseParamsDto;
import com.xuecheng.content.model.po.CourseBase;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author TaoYaopc
 * @description TODO
 * @date 2023/5/20 11:58
 */
@RestController
public class CourseBaseInfoController {

    @RequestMapping("/course/list")
    public PageResult<CourseBase> list(PageParams pageParams, @RequestBody(required = false) QueryCourseParamsDto queryCourseParamsDto) {

        return null;
    }
}

说明：pageParams分页参数通过url的key/value传入，

• queryCourseParams通过json数据传入，使用@RequestBody注解将json转成QueryCourseParamsDto对象。

注意：将@RequestBody 其内 required 设为 false，代表此参数为非必要参数，可传可不传

• 默认为 true，表示必要参数，必须要传，否则报错

1. 定义启动类
   • 在 api 工程的 com.xuecheng 包下新建 ContentApplication 类

package com.xuecheng;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author TaoYaopc
 * @description 内容管理服务启动类
 * @date 2023/5/20 12:03
 */
@SpringBootApplication
public class ContentApplication {
    
    public static void main(String[] args) {
        SpringApplication.run(ContentApplication.class, args);
    }
}

1. 添加配置文件
   • 创建 log4j2-dev.xml、bootstrap.yml文件。
   • log4j2-dev.xml: 从课程资料/项目工程 获取.

• bootstrap.yml

server:
  servlet:
    context-path: /content
  port: 63040
#微服务配置
spring:
  application:
    name: content-api
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.101.65:3306/xuechen_content?serverTimezone=UTC&userUnicode=true&useSSL=false&
    username: root
    password: mysql
# 日志文件配置路径
logging:
  config: classpath:log4j2-dev.xml

• log4j2-dev.xml

<?xml version="1.0" encoding="UTF-8"?>
<Configuration monitorInterval="180" packages="">
    <properties>
        <property name="logdir">logs</property>
        <property name="PATTERN">%date{YYYY-MM-dd HH:mm:ss,SSS} %level [%thread][%file:%line] - %msg%n%throwable</property>
    </properties>
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${PATTERN}"/>
        </Console>

        <RollingFile name="ErrorAppender" fileName="${logdir}/error.log"
            filePattern="${logdir}/$${date:yyyy-MM-dd}/error.%d{yyyy-MM-dd-HH}.log" append="true">
            <PatternLayout pattern="${PATTERN}"/>
            <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
            </Policies>
        </RollingFile>

        <RollingFile name="DebugAppender" fileName="${logdir}/info.log"
            filePattern="${logdir}/$${date:yyyy-MM-dd}/info.%d{yyyy-MM-dd-HH}.log" append="true">
            <PatternLayout pattern="${PATTERN}"/>
            <ThresholdFilter level="DEBUG" onMatch="ACCEPT" onMismatch="DENY"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
            </Policies>
        </RollingFile>
        
        <!--异步appender-->
         <Async name="AsyncAppender" includeLocation="true">
            <AppenderRef ref="ErrorAppender"/>
            <AppenderRef ref="DebugAppender"/>
        </Async>
    </Appenders>
    
    <Loggers>
         <!--过滤掉spring和mybatis的一些无用的debug信息
        <logger name="org.springframework" level="INFO">
        </logger>
        <logger name="org.mybatis" level="INFO">
        </logger>-->
        <logger name="cn.itcast.wanxinp2p.consumer.mapper" level="DEBUG">
        </logger>

        <logger name="springfox" level="INFO">
        </logger>
		<logger name="org.apache.http" level="INFO">
        </logger>
        <logger name="com.netflix.discovery" level="INFO">
        </logger>
        
        <logger name="RocketmqCommon"  level="INFO" >
		</logger>
		
		<logger name="RocketmqRemoting" level="INFO"  >
		</logger>
		
		<logger name="RocketmqClient" level="WARN">
		</logger>

        <logger name="org.dromara.hmily" level="WARN">
        </logger>

        <logger name="org.dromara.hmily.lottery" level="WARN">
        </logger>

        <logger name="org.dromara.hmily.bonuspoint" level="WARN">
        </logger>
		
        <!--OFF   0-->
        <!--FATAL   100-->
        <!--ERROR   200-->
        <!--WARN   300-->
        <!--INFO   400-->
        <!--DEBUG   500-->
        <!--TRACE   600-->
        <!--ALL   Integer.MAX_VALUE-->
        <Root level="DEBUG" includeLocation="true">
            <AppenderRef ref="AsyncAppender"/>
            <AppenderRef ref="Console"/>
            <AppenderRef ref="DebugAppender"/>
        </Root>
    </Loggers>
</Configuration>

1. 启动服务，测试接口是否正常运行
   • 在浏览器地址栏输入 http://localhost:63040/content/course/list
   • 测试是否报错

3.3.4 模型类的作用

现在项目中有两类模型类：DTO数据传输对象、PO持久化对象，

• DTO用于接口层向业务层之间传输数据，
• PO用于业务层与持久层之间传输数据，
• 有些项目还会设置VO对象，VO对象用在前端与接口层之间传输数据，如下图：

1️⃣当前端有多个平台且接口存在差异时就需要设置VO对象用于前端和接口层传输数据。

• 比如：课程列表查询接口，根据需求用户在手机端也要查询课程信息，此时课程查询接口是否需要编写手机端和PC端两个接口呢？

• 如果用户要求通过手机和PC的查询条件或查询结果不一样，此时就需要定义两个Controller课程查询接口，每个接口定义VO对象与前端传输数据。

  • 手机查询：根据课程状态查询，查询结果只有课程名称和课程状态。
  • PC查询：可以根据课程名称、课程状态、课程审核状态等条件查询，查询结果也比手机查询结果内容多。

• 此时，Service业务层尽量提供一个业务接口，即使两个前端接口需要的数据不一样，Service可以提供一个最全查询结果，由Controller进行数据整合。如下图：

2️⃣如果前端的接口没有多样性且比较固定，此时可以取消VO，只用DTO即可。如下图：

3.3.5 面试：SpringBoot 接口开发的注解

注解
@Controller	标记此类是一个控制器，可以返回视图解析器指定的 html 页面，通过 @RespongsBody 可以将结果返回 json、xml数据。
@Restcontroller	相当于 @RespongseBody + @Controller，实现 Rest 接口开发，返回 json 数据，不能返回 html 页面
@RequestMapping	定义接口地址，可以标记在类上也可以标记在方法上，支持 http 的 post、put、get 等方法
@GetMapping	定义 post 接口，只能标记在方法上，用于添加记录、复杂条件的查询接口
@PostMapping	定义 post 接口，只能标记在方法上，用于查询接口的定义
@PutMapping	定义 put 接口，只能标记在方法上，用于修改接口的定义
@DeleteMapping	定义 delete 接口，只能标记在方法上，用于删除接口的定义
@RequestBody	定义在方法上，用于将 json 串转成 java 对象
@PathVarible	接收请求路径中占位符的值
@ApiOperation	swagger 注解，对接口方法进行说明
@Api	swagger 注解，对接口类进行说明
@Autowired	基于类型注入
@Resource	基于名称注入，如果名称注入失败转为基于类型注入。

3.3.6 面试：项目的开发流程

1. 产品人员设计产品原型
2. 讨论需求
3. 分模块设计接口
4. 给出接口文档
5. 将接口文档给到前端人员，前后端分离开发
6. 开发完毕进行测试
7. 测试完毕发布项目，由运维人员进行部署开发

3.4 生成接口文档

在前后端分离开发中通常

• 由后端程序员设计接口，完成后需要编写接口文档，

• 最后将文档交给前端工程师，前端工程师参考文档进行开发。

可以通过一些工具快速生成接口文档 ，本项目通过Swagger生成接口在线文档 。

什么是Swagger？

​ OpenAPI规范（OpenAPI Specification 简称OAS）是Linux基金会的一个项目，试图通过定义一种用来描述API格式或API定义的语言，来规范RESTful服务开发过程，目前版本是V3.0，并且已经发布并开源在github上。

（https://github.com/OAI/OpenAPI-Specification）

​ Swagger是全球最大的OpenAPI规范（OAS）API开发工具框架，Swagger是一个在线接口文档的生成工具，前后端开发人员依据接口文档进行开发。 (https://swagger.io/)

3.4.1 Swagger 基本使用

Spring Boot 可以集成Swagger，Swaager根据Controller类中的注解生成接口文档 ，只要添加Swagger的依赖和配置信息即可使用它。

1. 在API工程添加swagger-spring-boot-starter依赖

<!-- Spring Boot 集成 swagger -->
<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
</dependency>

1. 在 bootstrap.yml中配置swagger的扫描包路径及其它信息，base-package为扫描的包路径，扫描Controller类。

swagger:
  title: "学成在线内容管理系统"
  description: "内容系统管理系统对课程相关信息进行管理"
  base-package: com.xuecheng.content
  enabled: true
  version: 1.0.0
  

1. 在启动类中添加@EnableSwagger2Doc注解,
   • 再次启动服务，工程启动起来，访问http://localhost:63040/content/swagger-ui.html查看接口信息, 下图为swagger接口文档的界面：

3.4.2 Swagger 常用注解

在Java类中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下：

@Api：修饰整个类，描述Controller的作用
 @ApiOperation：描述一个类的一个方法，或者说一个接口
 @ApiParam：单个参数描述
 @ApiModel：用对象来接收参数
 @ApiModelProperty：用对象接收参数时，描述对象的一个字段
 @ApiResponse：HTTP响应其中1个描述
 @ApiResponses：HTTP响应整体描述
 @ApiIgnore：使用该注解忽略这个API
 @ApiError ：发生错误返回的信息
 @ApiImplicitParam：一个请求参数
 @ApiImplicitParams：多个请求参数

1️⃣@ApiImplicitParam属性如下：

属性	取值	作用
paramType		查询参数类型
	path	以地址的形式提交数据
	query	直接跟参数完成自动映射赋值
	body	以流的形式提交 仅支持POST
	header	参数在request headers 里边提交
	form	以form表单的形式提交 仅支持POST
dataType		参数的数据类型 只作为标志说明，并没有实际验证
	Long
	String
name		接收参数名
value		接收参数的意义描述
required		参数是否必填
	true	必填
	false	非必填
defaultValue		默认值

3.4.3 使用Swagger可以进行接口测试。

1. 修改接口内容，添加一些测试代码

Java
@ApiOperation("课程查询接口")
@PostMapping("/course/list")
public PageResult<CourseBase> list(PageParams pageParams, @RequestBody(required=false) QueryCourseParamsDto queryCourseParams){

    CourseBase courseBase = new CourseBase();
    courseBase.setName("测试名称");
    courseBase.setCreateDate(LocalDateTime.now());
    List<CourseBase> courseBases = new ArrayList();
    courseBases.add(courseBase);
    PageResult pageResult = new PageResult<CourseBase>(courseBases,10,1,10);
    return pageResult;

}

1. debug方式启动，在 return 处打断点，再用swagger请求接口。通过下图可以看到请求参数已经正常请求至controller方法

1. 放行继续运行，观察swagger界面，结果可以正常返回

• 不过存在一个问题就是LocalDateTime类型的数据转json后数据格式并不是我们要的年月日时分秒

在base工程com.xuecheng.base.config包下加配置LocalDateTimeConfig 类实现转json时字符串与LocalDateTime类型的转换，LocalDateTimeConfig 类可从课程资料下的项目工程目录中直接拷贝

3.5 开发持久层

3.5.1 生成 mapper

本项目使用MyBatis-Plus开发持久层，

• 需要创建PO类、Mapper接口、Mapper的xml文件，
• 每个PO类对应数据库的每张表，每张表需要创建一个Mapper接口和Mapper的xml映射文件 。
• 使用 generator 工程生成的 mapper 接口和 mapper 映射文件拷贝到 service 工程
• service工程即业务层为api接口工程提供业务处理支撑，本项目业务层包括了持久层的代码，
• 一些大型公司的团队职责划分更细，会将持久层和业务层分为两个工程，不过这需要增加成本。

3.5.2 测试 Mapper

1️⃣下边对mapper进行单元测试，测试course_base表的查询接口。

1. 下边在service工程的pom.xml中添加依赖

XML
<dependencies>
    <dependency>
        <groupId>com.xuecheng</groupId>
        <artifactId>xuecheng-plus-content-model</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>

    <!-- MySQL 驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>

    <!-- mybatis plus的依赖 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
    </dependency>
   <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-context</artifactId>
  </dependency>
    <!-- Spring Boot 集成 Junit -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- 排除 Spring Boot 依赖的日志包冲突 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <exclusions>
            <exclusion>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

    <!-- Spring Boot 集成 log4j2 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-log4j2</artifactId>
    </dependency>

</dependencies>

1. 配置扫描mapper及分页插件

package com.xuecheng.content.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.autoconfigure.ConfigurationCustomizer;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * <P>
 *        Mybatis-Plus 配置
 * </p>
 */
@Configuration
@MapperScan("com.xuecheng.content.mapper")
public class MybatisPlusConfig {
   /**
    * 定义分页拦截器
    */
   @Bean
   public MybatisPlusInterceptor mybatisPlusInterceptor() {
      MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
      interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
      return interceptor;
   }
   
}

分页插件的原理：

首先分页参数放到ThreadLocal中，拦截执行的sql，根据数据库类型添加对应的分页语句重写sql，例如：(select from table where a) 转换为 (select count() from table where a)和(select * from table where a limit ,)

计算出了total总条数、pageNum当前第几页、pageSize每页大小和当前页的数据，是否为首页，是否为尾页，总页数等。

1. 单元测试所需要的配置文件
   • 在test/resources下创建 log4j2-dev.xml、bootstrap.yml：
   • log4j2-dev.xml 从资料中获取

bootstap.yml

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/xcplus_content?serverTimezone=UTC&userUnicode=true&useSSL=false&
    username: root
    password: mysql
# 日志文件配置路径
logging:
  config: classpath:log4j2-dev.xml

1. 编写启动类

Java
package com.xuecheng;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

1. 编写测试类

package com.xuecheng.content;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.xuecheng.base.model.PageParams;
import com.xuecheng.base.model.PageResult;
import com.xuecheng.content.mapper.CourseBaseMapper;
import com.xuecheng.content.model.dto.QueryCourseParamsDto;
import com.xuecheng.content.model.po.CourseBase;
import org.apache.commons.lang.StringUtils;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class CourseBaseMapperTests {

    @Autowired
    CourseBaseMapper courseBaseMapper;


    @Test
    void testCourseBaseMapper() {
        CourseBase courseBase = courseBaseMapper.selectById(74L);
        Assertions.assertNotNull(courseBase);

        //测试查询接口
        LambdaQueryWrapper<CourseBase> queryWrapper = new LambdaQueryWrapper<>();
        //查询条件
        QueryCourseParamsDto queryCourseParamsDto = new QueryCourseParamsDto();
        queryCourseParamsDto.setCourseName("java");
        queryCourseParamsDto.setAuditStatus("202004");
        queryCourseParamsDto.setPublishStatus("203001");

        //拼接查询条件
        //根据课程名称模糊查询  name like '%名称%'
        queryWrapper.like(StringUtils.isNotEmpty(queryCourseParamsDto.getCourseName()),CourseBase::getName,queryCourseParamsDto.getCourseName());
        //根据课程审核状态
        queryWrapper.eq(StringUtils.isNotEmpty(queryCourseParamsDto.getAuditStatus()),CourseBase::getAuditStatus,queryCourseParamsDto.getAuditStatus());



        //分页参数
        PageParams pageParams = new PageParams();
        pageParams.setPageNo(1L);//页码
        pageParams.setPageSize(3L);//每页记录数
        Page<CourseBase> page = new Page<>(pageParams.getPageNo(), pageParams.getPageSize());

        //分页查询E page 分页参数, @Param("ew") Wrapper<T> queryWrapper 查询条件
        Page<CourseBase> pageResult = courseBaseMapper.selectPage(page, queryWrapper);

        //数据
        List<CourseBase> items = pageResult.getRecords();
        //总记录数
        long total = pageResult.getTotal();

        //准备返回数据 List<T> items, long counts, long page, long pageSize
        PageResult<CourseBase> courseBasePageResult = new PageResult<>(items, total, pageParams.getPageNo(), pageParams.getPageSize());
        System.out.println(courseBasePageResult);
    }

}

3.5.3 测试 Sql 语句技巧

把 Java 控制台输出的 Sql 语句复制粘贴到数据库编辑软件（Navicat、DataGrip），修改并运行进行测试，查看运行结果。

3.6 开发业务层

3.6.1 创建数据字典表

1️⃣课程基本信息查询的主要数据来源是课程基本信息表，这里有一个点需要注意，就是课程的审核状态、发布状态。

• 审核状态在查询条件和查询结果中都存在，审核状态包括：未审核、审核通过、审核未通过三种，

• 下边思考一个问题：一个课程的审核状态如果是“审核未通过”那么在课程基本信息表记录“审核未通过”三个字合适吗？

  • 如果将“审核未通过”五个字记录在课程基本信息表中，显示出来的审核状态就是“审核未通过”这五个字，看起来没有什么问题，
  • 如果有一天客户想要将审核未通过的记录在显示时改为“未通过”三个字，怎么办？

• 这时你可以需要批量处理数据库中记录了，写一个 update 语句，审核状态等于“审核未通过”的全部更新 为“未通过”。

• 看起来解决了问题，如果有一天客户又让改了呢？

和审核状态同类的有好多这样的信息，

• 比如：课程状态、课程类型、用户类型等等，
• 这一类数据有一个共同点就是它有一些分类项，且这些分类项较为固定。
• 针对这些数据，为了提高系统的可扩展性，专门定义数据字典表去维护。每一项都由代码和名称组成。

[
    {"code":"202001","desc":"审核未通过"},
    {"code":"202002","desc":"未审核"},
    {"code":"202003","desc":"审核通过"}
]

该课程的审核状态为审核未通过，那么我们在课程基本信息表存储202001，也就是审核未通过对应的代码，这样查询出的数据在前端展示时根据代码取出它对应的内容显示给用户。如果用户要修改“审核未通过”的显示内容只需要在数据字典表修改，无法修改课程基本信息表。

2️⃣数据字典表在系统管理数据库中存储，首先导入系统管理数据库，创建系统管理服务的数据库 xuecheng_system

• 创建或导入 directory 表

3.6.2 编写 service

1. 创建 Service 接口

package com.xuecheng.content.service;

import com.xuecheng.base.model.PageParams;
import com.xuecheng.base.model.PageResult;
import com.xuecheng.content.model.dto.QueryCourseParamsDto;
import com.xuecheng.content.model.po.CourseBase;

/**
 * @author TaoYaopc
 * @description 课程信息管理接口
 * @date 2023/5/21 11:05
 */
public interface CourseBaseInfoService {

    /**
     * 课程分页查询
     * @param pageParams 分页查询参数
     * @param courseParamsDto 分页条件
     * @return 分页结果
     */
    PageResult<CourseBase> queryCourseBaseList(PageParams pageParams, QueryCourseParamsDto courseParamsDto);
}

1. 编写 Service 接口实现类

package com.xuecheng.content.service.impl;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.xuecheng.base.model.PageParams;
import com.xuecheng.base.model.PageResult;
import com.xuecheng.content.mapper.CourseBaseMapper;
import com.xuecheng.content.model.dto.QueryCourseParamsDto;
import com.xuecheng.content.model.po.CourseBase;
import com.xuecheng.content.service.CourseBaseInfoService;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import java.util.List;

/**
 * @author TaoYaopc
 * @description TODO
 * @date 2023/5/21 11:08
 */
@Service
@Slf4j
public class CourseBaseInfoServiceImpl implements CourseBaseInfoService {

    @Resource
    public CourseBaseMapper courseBaseMapper;

    @Override
    public PageResult<CourseBase> queryCourseBaseList(PageParams pageParams, QueryCourseParamsDto courseParamsDto) {
        // 拼装查询条件
        LambdaQueryWrapper<CourseBase> queryWrapper = new LambdaQueryWrapper<>();
        // 根据名称模糊查询
        queryWrapper.like(StringUtils.isNotEmpty(courseParamsDto.getCourseName()), CourseBase::getName, courseParamsDto.getCourseName());
        // 根据课程审核状态查询
        queryWrapper.eq(StringUtils.isNotEmpty(courseParamsDto.getAuditStatus()), CourseBase::getAuditStatus, courseParamsDto.getAuditStatus());
        // 根据课程发布状态查询
        queryWrapper.eq(StringUtils.isNotEmpty(courseParamsDto.getPublishStatus()), CourseBase::getStatus, courseParamsDto.getPublishStatus());

        // 创建page分页参数对象，参数：当前页码，每页记录数
        Page<CourseBase> page = new Page<>(pageParams.getPageNo(), pageParams.getPageSize());
        // 开始分页查询
        Page<CourseBase> pageResult = courseBaseMapper.selectPage(page, queryWrapper);
        // 数据列表
        List<CourseBase> items = pageResult.getRecords();
        // 总记录数
        long total = pageResult.getTotal();

        // List<T> items, long counts, long page, long pageSize
        PageResult<CourseBase> courseBasePageResult = new PageResult<>(items, total, pageParams.getPageNo(), pageParams.getPageSize());

        return courseBasePageResult;
    }
}

3.6.3 测试 Service

1. 编写单元测试类

package com.xuecheng.content;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.xuecheng.base.model.PageParams;
import com.xuecheng.base.model.PageResult;
import com.xuecheng.content.mapper.CourseBaseMapper;
import com.xuecheng.content.model.dto.QueryCourseParamsDto;
import com.xuecheng.content.model.po.CourseBase;
import com.xuecheng.content.service.CourseBaseInfoService;
import org.apache.commons.lang3.StringUtils;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

/**
 * @author TaoYaopc
 * @description TODO
 * @date 2023/5/21 10:15
 */
@SpringBootTest
public class CourseBaseInfoServiceTests {

    @Autowired
    CourseBaseInfoService courseBaseInfoService;

    @Test
    public void testCourseBaseMapper() {
        QueryCourseParamsDto courseParamsDto = new QueryCourseParamsDto();
        courseParamsDto.setCourseName("java");
        //courseParamsDto.setAuditStatus("202004");
        courseParamsDto.setPublishStatus("203002"); // 课程已发布

        PageParams pageParams = new PageParams();
        pageParams.setPageNo(1L);
        pageParams.setPageSize(2L);

        PageResult<CourseBase> courseBasePageResult = courseBaseInfoService.queryCourseBaseList(pageParams, courseParamsDto);
        System.out.println(courseBasePageResult);
    }
}

3.6 接口测试

3.7.1 接口完善

控制层、业务层以及持久层三层通常可以面向接口并行开发，

• 比如：业务层开发的同事可以先只编写一个Service接口，接口层的同事即可面向Service接口去开发，
• 待接口层和业务层完成后进行连调。

下边课程查询接口的实现。

@Api(value = "课程信息管理接口", tags = "课程信息管理接口")
@RestController
public class CourseBaseInfoController {

    @Resource
    CourseBaseInfoService courseBaseInfoService;

    @ApiOperation("课程查询接口")
    @PostMapping("/course/list")
    public PageResult<CourseBase> list(PageParams pageParams, @RequestBody(required = false) QueryCourseParamsDto queryCourseParamsDto) {

        PageResult<CourseBase> courseBasePageResult = courseBaseInfoService.queryCourseBaseList(pageParams, queryCourseParamsDto);

        return courseBasePageResult;
    }
}

• 此时进入 swagger 控制台http://localhost:63040/content/swagger-ui.html，输入测试数据，即可快速测试接口

3.7.2 Httpclient 测试

高版本的 Idea 自带的测试工具

### 查询课程信息
POST http://localhost:63040/content/course/list?pageNo=1&pageSize=2
Content-Type: application/json

{
  "auditStatus": "202004",
  "courseName": "java",
  "publishStatus": ""
}

.http文件即测试用例文档 ，它可以随着项目工程一起保存，这样测试的数据就可以保存下来，方便进行测试。

• 为了方便保存.http文件 ，我们单独在项目工程的根目录创建一个目录单独存放它们。
• 为了方便将来和网关集成测试，这里我们把测试主机地址在配置文件http-client.env.json 中配置

注意：文件名称http-client.env.json保持一致，否则无法读取dev环境变量的内容。

http-client.env.json

{
  "dev": {
    "access_token": "",
    "gateway_host": "localhost:63010",
    "content_host": "localhost:63040",
    "system_host": "localhost:63110",
    "media_host": "localhost:63050",
    "search_host": "localhost:63080",
    "auth_host": "localhost:63070",
    "checkcode_host": "localhost:63075",
    "learning_host": "localhost:63020"
  }
}

xc-content-api.http

### 查询课程信息
POST {{content_host}}/content/course/list?pageNo=1&pageSize=2
Content-Type: application/json

{
  "auditStatus": "202004",
  "courseName": "java",
  "publishStatus": ""
}

3.8 前后端联调

3.8.1 准备环境

什么是前后端联调？

通常由后端工程师将接口设计好并编写接口文档，将接口文档交给前端工程师，前后端的工程师就开始并行开发，前端开发人员会使用mock数据（假数据）进行开发，当前后端代码完成后开始进行接口联调，前端工程师将mock数据改为请求后端接口获取，前端代码请求后端服务测试接口是否正常，这个过程是前后端联调。

当前后端联调出现问题需要根据测试环境下接口的请求及响应数据内容去判断是否符合接口文档的要求。查出是前端或后端的问题由具体的工程师负责修改缺陷，修改后再次回归测试。

首先需要安装 node.js，比较简单，点击安装包傻瓜式安装

• 最后可在命令行窗口中输入 node -v 查看版本号
• 若出现则安装成功
• 最后在 idea 中配置 node.js 的路径

注意：此处选择 node.js 版本为18时运行错误，尝试改到16

下边启动前端工程，从前端工程拷贝project-xczx2-portal-vue-ts.zip到代码目录并解压，并使用IDEA或VS Code打开project-xczx2-portal-vue-ts目录，运行项目

• 如果存在问题通过以下命令启动：
  1. cmd进入工程根目录
  2. 运行以下命令

npm install -g cnpm --registry=https://registry.npm.taobao.org

cnpm i

npm run serve

3.8.2 安装系统管理服务

http://localhost:8601/system/dictionary/all 指向的是系统管理服务。

• 在前端讲解内容管理模块的需求时我们提到一个数据字典表，此链接正是在前端请求后端获取数据字典数据的接口地址。

数据字典表中配置了项目用的字典信息，此接口是查询字典中的全部数据 ，在此我们不再开发，按照下边的步骤安装系统管理服务即可。

• 从课程资料/项目工程目录获取xuecheng-plus-system.zip，并解压

• 将xuecheng-plus-system目录拷贝到项目工程根目录，刷新maven，或进入pom.xml右键转为pom工程。

3.8.3 解决跨域请求

1️⃣在浏览器通过http://localhost:8601/地址访问前端工程。

• chrome浏览器报错如下：

Java Access to XMLHttpRequest at 'http://localhost:63110/system/dictionary/all' from origin 'http://localhost:8601' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

• firefox浏览器报错如下：

已拦截跨源请求：同源策略禁止读取位于 http://localhost:63110/system/dictionary/all 的远程资源。（原因：CORS 头缺少 'Access-Control-Allow-Origin'）。状态码：200。

提示：从http://localhost:8601 访问 http://localhost:63110/system/dictionary/all 被CORS policy阻止，因为没有Access-Control-Allow-Origin 头信息。CORS全称是 cross origin resource share 表示跨域资源共享。

出这个提示的原因是基于浏览器的同源策略，去判断是否跨域请求，

• 同源策略是浏览器的一种安全机制，从一个地址请求另一个地址，
• 如果协议、主机、端口三者全部一致则不属于跨域，否则有一个不一致就是跨域请求。

比如：

• 从http://localhost:8601到 http://localhost:8602由于端口不同，是跨域。

• 从http://192.168.101.10:8601到 http://192.168.101.11:8601 由于主机不同，是跨域。

• 从http://192.168.101.10:8601 到 https://192.168.101.10:8601由于协议不同，是跨域。

注意：服务器之间不存在跨域请求。

浏览器判断是跨域请求会在请求头上添加 origin，表示这个请求来源哪里。

比如：

• Plaintext GET / HTTP/1.1 Origin: http://localhost:8601

  • 服务器收到请求判断这个Origin是否允许跨域，如果允许则在响应头中说明允许该来源的跨域请求，如下：

  • Plaintext Access-Control-Allow-Origin：http://localhost:8601

    • 如果允许任何域名来源的跨域请求，则响应如下：

    • Plaintext Access-Control-Allow-Origin：*

2️⃣解决跨域的方法：

1. JSONP

通过script标签的src属性进行跨域请求，如果服务端要响应内容则首先读取请求参数callback的值，callback是一个回调函数的名称，服务端读取callback的值后将响应内容通过调用callback函数的方式告诉请求方。如下图：

1. 添加响应头

服务端在响应头添加 Access-Control-Allow-Origin：*

1. 通过 nginx 代理跨域

由于服务端之间没有跨域，浏览器通过nginx去访问跨域地址。

• 浏览器先访问http://192.168.101.10:8601 nginx提供的地址，进入页面
• 此页面要跨域访问http://192.168.101.11:8601 ，不能直接跨域访问http://www.baidu.com:8601 ，
• 而是访问nginx的一个同源地址，比如：http://192.168.101.11:8601/api ，
  • 通过http://192.168.101.11:8601/api 的代理去访问http://www.baidu.com:8601。

这样就实现了跨域访问。

• 浏览器到http://192.168.101.11:8601/api 没有跨域

• nginx到http://www.baidu.com:8601通过服务端通信，没有跨域。

3️⃣我们准备使用方案2解决跨域问题。

• 在内容管理的api工程config包下编写GlobalCorsConfig.java，
• 此配置类实现了跨域过虑器，在响应头添加Access-Control-Allow-Origin。
• 重启系统管理服务，前端工程可以正常进入http://localhost:8601，观察浏览器记录，成功解决跨域。

package com.xuecheng.system.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;

/**
 * @author TaoYaopc
 * @description TODO
 * @date 2023/5/22 17:16
 */
@Configuration
public class GlobalCorsConfig {

    @Bean
    public CorsFilter corsFilter() {
        CorsConfiguration config = new CorsConfiguration();
        //允许白名单域名进行跨域调用
        config.addAllowedOrigin("*");
        //允许跨越发送cookie
        config.setAllowCredentials(true);
        //放行全部原始头信息
        config.addAllowedHeader("*");
        //允许所有请求方法跨域调用
        config.addAllowedMethod("*");
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", config);
        return new CorsFilter(source);
    }
}

3.8.4 前后端联调

这里进行前后联调的目的是体会前后端联调的流程，测试的功能为课程查询功能。

1. 启动前端工程，再启内容管理服务端。

2. 修改服务端地址

1️⃣前端默认连接的是项目的网关地址，由于现在网关工程还没有创建，这里需要更改前端工程的参数配置文件 ，修改网关地址为内容管理服务的地址。

2️⃣启动前端工程，用前端访问后端接口，观察前端界面的数据是否正确。

• 访问前端首页，进入课程管理：http://localhost:8601/#/organization/course-list

• 更改课程条件及分页参数测试课程查询列表是否正常显示。

  跟踪内容管理服务的输出日志，查看是否正常。

  到此基本完成了前后端连调。

4. 课程分类查询

4.1 需求分析

1️⃣下边根据内容管理模块的业务流程，下一步要实现新增课程，在新增课程界面，有三处信息需要选择，如下图：

课程等级、课程类型来源于数据字典表，此部分的信息前端已从系统管理服务读取。

课程分类信息没有在数据字典表中存储，而是由单独一张课程分类表，存储在内容管理数据库中。

2️⃣下边看下course_category课程分类表的结构

• 这张表是一个树型结构，通过父结点id将各元素组成一个树。
• 现在的需求是需要在内容管理服务中编写一个接口读取该课程分类表的数据，组成一个树型结构返回给前端。

4.2 接口定义

1️⃣我们可以点击新增课程，观察前端的请求记录：

• http://localhost:8601/api/content/course-category/tree-nodes 该地址正是前端获取课程分类的接口地址。

  • 通过上图界面的内容可以看出该接口的协议为：HTTP GET

  • 请求参数为空。

  • 通过查阅接口文档，此接口要返回全部课程分类，以树型结构返回，如下所示。

[
         {
            "childrenTreeNodes" : [
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-1-1",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "HTML/CSS",
                  "name" : "HTML/CSS",
                  "orderby" : 1,
                  "parentid" : "1-1"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-1-2",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "JavaScript",
                  "name" : "JavaScript",
                  "orderby" : 2,
                  "parentid" : "1-1"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-1-3",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "jQuery",
                  "name" : "jQuery",
                  "orderby" : 3,
                  "parentid" : "1-1"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-1-4",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "ExtJS",
                  "name" : "ExtJS",
                  "orderby" : 4,
                  "parentid" : "1-1"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-1-5",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "AngularJS",
                  "name" : "AngularJS",
                  "orderby" : 5,
                  "parentid" : "1-1"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-1-6",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "ReactJS",
                  "name" : "ReactJS",
                  "orderby" : 6,
                  "parentid" : "1-1"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-1-7",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "Bootstrap",
                  "name" : "Bootstrap",
                  "orderby" : 7,
                  "parentid" : "1-1"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-1-8",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "Node.js",
                  "name" : "Node.js",
                  "orderby" : 8,
                  "parentid" : "1-1"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-1-9",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "Vue",
                  "name" : "Vue",
                  "orderby" : 9,
                  "parentid" : "1-1"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-1-10",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "其它",
                  "name" : "其它",
                  "orderby" : 10,
                  "parentid" : "1-1"
               }
            ],
            "id" : "1-1",
            "isLeaf" : null,
            "isShow" : null,
            "label" : "前端开发",
            "name" : "前端开发",
            "orderby" : 1,
            "parentid" : "1"
         },
         {
            "childrenTreeNodes" : [
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-2-1",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "微信开发",
                  "name" : "微信开发",
                  "orderby" : 1,
                  "parentid" : "1-2"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-2-2",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "iOS",
                  "name" : "iOS",
                  "orderby" : 2,
                  "parentid" : "1-2"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-2-3",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "手游开发",
                  "name" : "手游开发",
                  "orderby" : 3,
                  "parentid" : "1-2"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-2-4",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "Swift",
                  "name" : "Swift",
                  "orderby" : 4,
                  "parentid" : "1-2"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-2-5",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "Android",
                  "name" : "Android",
                  "orderby" : 5,
                  "parentid" : "1-2"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-2-6",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "ReactNative",
                  "name" : "ReactNative",
                  "orderby" : 6,
                  "parentid" : "1-2"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-2-7",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "Cordova",
                  "name" : "Cordova",
                  "orderby" : 7,
                  "parentid" : "1-2"
               },
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-2-8",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "其它",
                  "name" : "其它",
                  "orderby" : 8,
                  "parentid" : "1-2"
               }
            ],
            "id" : "1-2",
            "isLeaf" : null,
            "isShow" : null,
            "label" : "移动开发",
            "name" : "移动开发",
            "orderby" : 2,
            "parentid" : "1"
         }
]

上边的数据格式是一个数组结构，数组的元素即为分类信息，分类信息设计两级分类，

• 第一级的分类信息示例如下：

"id" : "1-2",
"isLeaf" : null,
"isShow" : null,
"label" : "移动开发",
"name" : "移动开发",
"orderby" : 2,
"parentid" : "1"

• 第二级的分类是第一级分类中childrenTreeNodes属性，它是一个数组结构：

JSON
{
"id" : "1-2",
"isLeaf" : null,
"isShow" : null,
"label" : "移动开发",
"name" : "移动开发",
"orderby" : 2,
"parentid" : "1",
"childrenTreeNodes" : [
               {
                  "childrenTreeNodes" : null,
                  "id" : "1-2-1",
                  "isLeaf" : null,
                  "isShow" : null,
                  "label" : "微信开发",
                  "name" : "微信开发",
                  "orderby" : 1,
                  "parentid" : "1-2"
               }
 }

2️⃣所以，定义一个DTO类表示分类信息的模型类，如下：

package com.xuecheng.content.model.dto;

import com.xuecheng.content.model.po.CourseCategory;
import lombok.Data;

import java.util.List;

/**
 * @author TaoYaopc
 * @description TODO
 * @date 2023/5/22 17:40
 */
@Data
public class CourseCategoryTreeDto extends CourseCategory implements java.io.Serializable{
    private List<CourseCategoryTreeDto> childrenTreeNodes;
}

3️⃣接口定义如下：

package com.xuecheng.content.api;

import com.xuecheng.content.model.dto.CourseCategoryTreeDto;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author TaoYaopc
 * @description 课程分类相关接口
 * @date 2023/5/22 17:45
 */
@RestController
public class CourseCategoryController {

    @GetMapping("/course-category/tree-nodes")
    public CourseCategoryTreeDto queryTreeNodes() {

        return null;
    }
}

4.3 接口开发

4.3.1 树形表查询

课程分类表是一个树型结构，其中parentid字段为父结点ID，它是树型结构的标志字段。

1️⃣如果树的层级固定可以使用表的自链接去查询，

• 比如：我们只查询两级课程分类，可以用下边的SQL

select
       one.id            one_id,
       one.name          one_name,
       one.parentid      one_parentid,
       one.orderby       one_orderby,
       one.label         one_label,
       two.id            two_id,
       two.name          two_name,
       two.parentid      two_parentid,
       two.orderby       two_orderby,
       two.label         two_label
   from course_category one
            inner join course_category two on one.id = two.parentid
   where one.parentid = 1
     and one.is_show = 1
     and two.is_show = 1
   order by one.orderby,
            two.orderby

2️⃣如果树的层级不确定，

• 此时可以使用MySQL递归实现，使用with语法，如下：

WITH [RECURSIVE]
        cte_name [(col_name [, col_name] ...)] AS (subquery)
        [, cte_name [(col_name [, col_name] ...)] AS (subquery)] ...

• cte_name :公共表达式的名称,可以理解为表名,用来表示as后面跟着的子查询

• col_name :公共表达式包含的列名,可以写也可以不写

下边是一个递归的简单例子：

Java
with RECURSIVE t1  AS
(
  SELECT 1 as n
  UNION ALL
  SELECT n + 1 FROM t1 WHERE n < 5
)
SELECT * FROM t1;

• 输出：

• 说明：
  • t1 相当于一个表名
  • select 1 相当于这个表的初始值，这里使用UNION ALL 不断将每次递归得到的数据加入到表中。
  • n<5为递归执行的条件，当n>=5时结束递归调用。

3️⃣下边我们使用递归实现课程分类的查询

1. 这种方法是向下递归，即找到初始节点的所有下级节点。

Java
with recursive t1 as (
select * from  course_category p where  id= '1'
union all
 select t.* from course_category t inner join t1 on t1.id = t.parentid
)
select *  from t1 order by t1.id, t1.orderby

• 查询结果如下：

• t1表中初始的数据是id等于1的记录，即根结点。

• 通过inner join t1 t2 on t2.id = t.parentid 找到id=’1’的下级节点 。

• 通过这种方法就找到了id=’1’的所有下级节点，下级节点包括了所有层级的节点。

1. 下边的sql实现了向上递归：

Java
with recursive t1 as (
select * from  course_category p where  id= '1-1-1'
union all
 select t.* from course_category t inner join t1 on t1.parentid = t.id
)
select *  from t1 order by t1.id, t1.orderby

• 初始节点为1-1-1，通过递归找到它的父级节点，父级节点包括所有级别的节点。

以上是我们研究了树型表的查询方法，通过递归的方式查询课程分类比较灵活，因为它可以不限制层级。

4️⃣mysql为了避免无限递归默认递归次数为1000，

• 可以通过设置cte_max_recursion_depth参数增加递归深度，
• 还可以通过max_execution_time限制执行时间，超过此时间也会终止递归操作。

mysql递归相当于在存储过程中执行若干次sql语句，java程序仅与数据库建立一次链接执行递归操作，所以只要控制好递归深度，控制好数据量性能就没有问题。

思考：如果java程序在递归操作中连接数据库去查询数据组装数据，这个性能高吗？

4.3.2 开发 mapper

下边我们可自定义mapper方法查询课程分类，最终将查询结果映射到List<CourseCategoryTreeDto>中。

生成课程分类表的mapper文件并拷贝至内容管理模块 的service工程中。

1. 下边 定义一个mapper方法，并定义sql语句。

public interface CourseCategoryMapper extends BaseMapper<CourseCategory> {
    public List<CourseCategoryTreeDto> selectTreeNodes(String id);
}

1. 找到对应 的mapper.xml文件，编写sql语句。

Java
<select id="selectTreeNodes" resultType="com.xuecheng.content.model.dto.CourseCategoryTreeDto" parameterType="string">
    with recursive t1 as (
        select * from  course_category p where  id= #{id}
        union all
        select t.* from course_category t inner join t1 on t1.id = t.parentid
    )
    select *  from t1 order by t1.id, t1.orderby

</select>

4.3.3 开发service

1. 定义service接口，

Java
public interface CourseCategoryService {
    /**
     * 课程分类树形结构查询
     *
     * @return
     */
    public List<CourseCategoryTreeDto> queryTreeNodes(String id);
}

1. 编写service接口实现
   • 调用mapper查询课程分类，遍历数据按照接口要求对数据进行封装

@Slf4j
@Service
public class CourseCategoryServiceImpl implements CourseCategoryService {

    @Autowired
    CourseCategoryMapper courseCategoryMapper;

    public List<CourseCategoryTreeDto> queryTreeNodes(String id) {
       List<CourseCategoryTreeDto> courseCategoryTreeDtos = courseCategoryMapper.selectTreeNodes(id);
    //将list转map,以备使用,排除根节点
    Map<String, CourseCategoryTreeDto> mapTemp = courseCategoryTreeDtos.stream().filter(item->!id.equals(item.getId())).collect(Collectors.toMap(key -> key.getId(), value -> value, (key1, key2) -> key2));
    //最终返回的list
    List<CourseCategoryTreeDto> categoryTreeDtos = new ArrayList<>();
    //依次遍历每个元素,排除根节点
    courseCategoryTreeDtos.stream().filter(item->!id.equals(item.getId())).forEach(item->{
        if(item.getParentid().equals(id)){
            categoryTreeDtos.add(item);
        }
        //找到当前节点的父节点
        CourseCategoryTreeDto courseCategoryTreeDto = mapTemp.get(item.getParentid());
        if(courseCategoryTreeDto!=null){
            if(courseCategoryTreeDto.getChildrenTreeNodes() ==null){
                courseCategoryTreeDto.setChildrenTreeNodes(new ArrayList<CourseCategoryTreeDto>());
            }
            //下边开始往ChildrenTreeNodes属性中放子节点
            courseCategoryTreeDto.getChildrenTreeNodes().add(item);
        }
    });
    return categoryTreeDtos;
    }

}

4.3.4 单元测试

定义单元测试类对service接口进行测试

@SpringBootTest
class CourseCategoryServiceTests {

    @Autowired
    CourseCategoryService courseCategoryService;

    @Test
    void testqueryTreeNodes() {
        List<CourseCategoryTreeDto> categoryTreeDtos = courseCategoryService.queryTreeNodes("1");
        System.out.println(categoryTreeDtos);
    }

}

4.4 接口功能完善

4.4.1 接口层代码完善

完善controller方法，注入service调用业务层方法查询课程分类。

package com.xuecheng.content.api;

import com.xuecheng.content.model.dto.CourseCategoryTreeDto;
import com.xuecheng.content.service.CourseCategoryService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import java.util.List;

/**
 * @author TaoYaopc
 * @description 课程分类相关接口
 * @date 2023/5/22 17:45
 */
@RestController
public class CourseCategoryController {

    @Resource
    private CourseCategoryService courseCategoryService;

    @GetMapping("/course-category/tree-nodes")
    public List<CourseCategoryTreeDto> queryTreeNodes() {

        return courseCategoryService.queryTreeNodes("1");
    }
}

4.4.2 测试接口

1️⃣先使用idea的http插件进行测试

• 检查数据返回是否正常

2️⃣再进入前端页面进行测试

• 完成前后端联调

5. 新增课程

5.0 面试

5.0.1 mybatis数据库方面

1️⃣树形表的标记字段是什么？如何查询 MySql 树形表？

• 树形表定点标记字段是 parentId 即父节点的id
• 查询树形表的方法：
  1. 当层级固定时可以用表的自连接进行查询
  2. 如果想灵活查询每个层级可以使用 mysql 递归方法，使用 with recursive 实现

2️⃣MyBatis的ResultType和ResultMap的区别？

• ResultType：指定映射类型，只要查询的字段名和类型的属性名匹配可以自动映射
• ResultMap：自定义映射规则，当查询的字段名和映射类型的属性不匹配时可以通过ResultMap自定义映射规则，也可以实现一对多、一对一映射。

3️⃣#{} 和 ${} 有什么区别？

• #{}：是标记一个占位符，可以防止sql注入
• ${}：用于在动态sql中拼接字符串，可能导致sql注入

注：Sql注入简介

• Sql注入攻击是通过将恶意的 Sql 查询或添加语句插入到应用的输入参数中，
• 再在后台 Sql 服务器上解析执行进行的攻击

5.0.2 异常处理方面

1️⃣系统如何处理异常

• 我们定义一个统一的异常处理器去捕获并处理异常
• 使用控制器增强注解 @ControllerAdvice 和异常处理注解 @ExceptionHandler来实现

1. 处理自定义异常
   • 程序在编写代码时根据校验结果主动抛出自定义异常类对象，抛出异常时指定详细的异常信息，异常处理器捕获异常信息记录异常日志并响应给用户。
2. 处理未知异常
   • 接口执行过程中的一些运行时异常也会由异常处理器统一捕获，记录异常日志，统一响应给用户500错误。

1. 在异常处理器中还可以正对某个异常类型进行单独处理

5.0.3 系统参数合法性校验方面

1️⃣请求参数的合法性校验如何做

• 使用基于 JSR303 的校验框架实现，springboot 提供了 JSR-303 的支持，它就是 spring-boot-starter-validation，
• 它包括了很多校验规则，只需要在模型类中通过注解指定校验规则，在controller方法上开启校验

5.1 需求分析

5.1.1 业务流程

根据前边对内容管理模块的数据模型分析，

• 课程相关的信息有：课程基本信息、课程营销信息、课程图片信息、课程计划、课程师资信息，
• 所以新增一门课程需要完成这几部分信息的填写。

以下是业务流程：

1. 进入课程查询列表

1. 点击添加课程，选择课程形式为录播。

1. 选择完毕，点击下一步，进入课程基本信息添加界面。
   • 本界面分两部分信息，一部分是课程基本信息上，一部分是课程营销信息。

课程基本信息：

课程营销信息：

在这个界面中填写课程的基本信息、课程营销信息上。

填写完毕，保存并进行下一步。

1. 在此界面填写课程计划信息

• 课程计划即课程的大纲目录。
• 课程计划分为两级，章节和小节。
• 每个小节需要上传课程视频，用户点击 小节的标题即开始播放视频。
• 如果是直播课程则会进入直播间。

1. 课程 计划填写完毕进入课程师资的管理。

在课程师资界面维护该课程的授课老师。

至此，一门课程新增完成。

5.1.2 数据模型

通过业务流程可知，一门课程信息涉及：课程基本信息、课程营销信息、课程计划信息、课程师资信息。

• 本节开发新增课程按钮功能， 只向课程基本信息、课程营销信息添加记录。

• 这两部分信息分别在course_base、course_market两张表存储。

• 当点击保存按钮时向这两张表插入数据。
• 这两张表是一对一关联关系。

course_base

course_market

新建课程的初始审核状态为“未提交”、初始发布状态为“未发布”。

生成课程基本信息、课程营销信息的PO、Mapper文件

5.2 接口定义

根据业务流程，这里先定义提交课程基本信息的接口。

1. 接口协议 ：HTTP POST，Content-Type为application/json

2. 请求及响应结果如下

1. 接口请求示例如下

Java
### 创建课程
POST {{content_host}}/content/course
Content-Type: application/json

{

  "mt": "",
  "st": "",
  "name": "",
  "pic": "",
  "teachmode": "200002",
  "users": "初级人员",
  "tags": "",
  "grade": "204001",
  "description": "",
  "charge": "201000",
  "price": 0,
  "originalPrice":0,
  "qq": "",
  "wechat": "",
  "phone": "",
  "validDays": 365
}

###响应结果如下
#成功响应结果如下
{
  "id": 109,
  "companyId": 1,
  "companyName": null,
  "name": "测试课程103",
  "users": "初级人员",
  "tags": "",
  "mt": "1-1",
  "mtName": null,
  "st": "1-1-1",
  "stName": null,
  "grade": "204001",
  "teachmode": "200002",
  "description": "",
  "pic": "",
  "createDate": "2022-09-08 07:35:16",
  "changeDate": null,
  "createPeople": null,
  "changePeople": null,
  "auditStatus": "202002",
  "status": 1,
  "coursePubId": null,
  "coursePubDate": null,
  "charge": "201000",
  "price": null,
  "originalPrice":0,
  "qq": "",
  "wechat": "",
  "phone": "",
  "validDays": 365
}

1. 定义请求参数类型和响应结构类型
   • 根据接口定义内容，请求参数相比 CourseBase模型类不一致，需要在dto包下自定义，
   • 模型类从课程资料/工程目录获取。
   • AddCourseDto + CourseBaseInfoDto

AddCourseDto

package com.xuecheng.content.model.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Size;
import java.math.BigDecimal;

/**
 * @author TaoYaopc
 * @description 添加课程 Dto
 * @date 2023/5/20 11:58
 */
@Data
@ApiModel(value = "AddCourseDto", description = "新增课程基本信息")
public class AddCourseDto {

    @NotEmpty(message = "课程名称不能为空")
    @ApiModelProperty(value = "课程名称", required = true)
    private String name;

    @NotEmpty(message = "适用人群不能为空")
    @Size(message = "适用人群内容过少", min = 10)
    @ApiModelProperty(value = "适用人群", required = true)
    private String users;

    @ApiModelProperty(value = "课程标签")
    private String tags;

    @NotEmpty(message = "课程分类不能为空")
    @ApiModelProperty(value = "大分类", required = true)
    private String mt;

    @NotEmpty(message = "课程分类不能为空")
    @ApiModelProperty(value = "小分类", required = true)
    private String st;

    @NotEmpty(message = "课程等级不能为空")
    @ApiModelProperty(value = "课程等级", required = true)
    private String grade;

    @ApiModelProperty(value = "教学模式（普通，录播，直播等）", required = true)
    private String teachmode;

    @ApiModelProperty(value = "课程介绍")
    private String description;

    @ApiModelProperty(value = "课程图片", required = true)
    private String pic;

    @NotEmpty(message = "收费规则不能为空")
    @ApiModelProperty(value = "收费规则，对应数据字典", required = true)
    private String charge;

    @ApiModelProperty(value = "价格")
    private Float price;
    @ApiModelProperty(value = "原价")
    private Float originalPrice;


    @ApiModelProperty(value = "qq")
    private String qq;

    @ApiModelProperty(value = "微信")
    private String wechat;
    @ApiModelProperty(value = "电话")
    private String phone;

    @ApiModelProperty(value = "有效期")
    private Integer validDays;
}

CourseBaseInfoDto

package com.xuecheng.content.model.dto;

import com.xuecheng.content.model.po.CourseBase;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.math.BigDecimal;

/**
 * @author TaoYaopc
 * @description 课程基本信息 Dto
 * @date 2023/5/20 11:58
 */
@Data
@ApiModel(value = "CourseBaseInfoDto", description = "返回课程基本信息")
public class CourseBaseInfoDto extends CourseBase {


    /**
     * 收费规则，对应数据字典
     */
    private String charge;

    /**
     * 价格
     */
    private Float price;


    /**
     * 原价
     */
    private Float originalPrice;

    /**
     * 咨询qq
     */
    private String qq;

    /**
     * 微信
     */
    private String wechat;

    /**
     * 电话
     */
    private String phone;

    /**
     * 有效期天数
     */
    private Integer validDays;

    /**
     * 大分类名称
     */
    private String mtName;

    /**
     * 小分类名称
     */
    private String stName;

}

1. 定义接口如下

@ApiOperation("新增课程")
@PostMapping("/content/course")
public CourseBaseInfoDto createCourseBase(@RequestBody AddCourseDto addCourseDto) {

    return null;
}

5.3 接口开发

5.3.1 保存课程基本信息

根据需求分析，新增课程表单中包括了课程基本信息、课程营销信息，

• 需要分别向课程基本信息表、课程营销表保证数据。

1. 定义 Service 接口

/**
  * 新增课程
  * @param companyId 机构 ID
  * @param addCourseDto 新增课程信息
  * @return 返回课程信息
*/
CourseBaseInfoDto createCourseBase(Long companyId, AddCourseDto addCourseDto);

1. 编写service接口实现类，实现向课程基本信息表保存数据：

@Transactional
@Override
public CourseBaseInfoDto createCourseBase(Long companyId, AddCourseDto dto) {

    // 参数合法性校验
    if (StringUtils.isBlank(dto.getName())) {
        throw new RuntimeException("课程名称为空");
    }

    if (StringUtils.isBlank(dto.getMt())) {
        throw new RuntimeException("课程分类为空");
    }

    if (StringUtils.isBlank(dto.getSt())) {
        throw new RuntimeException("课程分类为空");
    }

    if (StringUtils.isBlank(dto.getGrade())) {
        throw new RuntimeException("课程等级为空");
    }

    if (StringUtils.isBlank(dto.getTeachmode())) {
        throw new RuntimeException("教育模式为空");
    }

    if (StringUtils.isBlank(dto.getUsers())) {
        throw new RuntimeException("适应人群为空");
    }

    if (StringUtils.isBlank(dto.getCharge())) {
        throw new RuntimeException("收费规则为空");
    }

    // 向课程基本信息表course_base写入数据
    CourseBase courseBaseNew = new CourseBase();
    // 将传入的页面的参数放到courseBaseNew对象
    // courseBaseNew.setName(dto.getName());
    // courseBaseNew.setDescription(dto.getDescription());
    BeanUtils.copyProperties(dto, courseBaseNew); // 只要属性名称一致就可以拷贝
    courseBaseNew.setCompanyId(companyId);
    courseBaseNew.setCreateDate(LocalDateTime.now());
    // 审核状态默认为未提交
    courseBaseNew.setAuditStatus("202002");
    // 发布状态为未发布
    courseBaseNew.setStatus("202001");
    // 插入数据库
    int insert = courseBaseMapper.insert(courseBaseNew);
    if(insert <= 0) {
        throw new RuntimeException("添加课程失败");
    }
    
    // todo:向课程营销表保存课程营销信息
	// todo:查询课程基本信息及营销信息并返回
    
    // 向课程营销系course_market写入数据
    CourseMarket courseMarketNew = new CourseMarket();
    // 将页面输入的数据拷贝到courseMarketNew
    BeanUtils.copyProperties(dto, courseMarketNew);
    // 设置主键，课程的 id
    Long courseId = courseBaseNew.getId();
    courseMarketNew.setId(courseId);
    // 保存营销信息
    int success = saveCourseMarket(courseMarketNew);
    if(success <= 0) {
        throw new RuntimeException("保存课程营销信息失败");
    }
    // 从数据库查询课程的详细信息，包括两部分，并返回
    return getCourseBaseInfo(courseId);
}

5.3.2 保存营销信息

// 单独写一个方法保存营销信息，逻辑：存在则更新，不存在则添加
private int saveCourseMarket(CourseMarket courseMarketNew) {

    // 参数的合法性校验
    String charge = courseMarketNew.getCharge();
    if(StringUtils.isEmpty(charge)) {
        throw new RuntimeException("收费规则为空");
    }
    // 如果课程收费，价格没有填写也需要抛出异常
    if(charge.equals("201001")) {
        if(courseMarketNew.getPrice() == null || courseMarketNew.getPrice().floatValue() <= 0) {
            throw new RuntimeException("课程的价格不能为空并且必须大于0");
        }
    }

    // 从数据库查询营销信息，存在则更新，不存在则添加
    Long courseId = courseMarketNew.getId();
    CourseMarket courseMarket = courseMarketMapper.selectById(courseId);
    if(courseMarket == null) {
        // 插入数据库
        return courseMarketMapper.insert(courseMarketNew);
    } else {
        // 将courseMarketNew 拷贝到 courseMarket
        BeanUtils.copyProperties(courseMarketNew, courseMarket);
        courseMarket.setId(courseId);
        // 更新
        return courseMarketMapper.updateById(courseMarket);
    }
}

5.3.3 查询课程基本信息及营销信息并返回

// 查询课程信息
private CourseBaseInfoDto getCourseBaseInfo(long courseId) {
    // 从课程基本信息表查询
    CourseBase courseBase = courseBaseMapper.selectById(courseId);
    if(courseBase == null) {
        return null;
    }
    // 从课程营销表查询
    CourseMarket courseMarket = courseMarketMapper.selectById(courseId);
    // 组装在一起
    CourseBaseInfoDto courseBaseInfoDto = new CourseBaseInfoDto();
    BeanUtils.copyProperties(courseBase, courseBaseInfoDto);
    BeanUtils.copyProperties(courseMarket, courseBaseInfoDto);
    // 通过 courseCategoryMapper 查询分类信息，将分类名称放在 courseBaseInfoDto对象
    // 包括大分类的名称，和小分类的名称
    CourseCategory courseCategoryMt = courseCategoryMapper.selectById(courseBase.getMt());
    CourseCategory courseCategorySt = courseCategoryMapper.selectById(courseBase.getSt());
    courseBaseInfoDto.setMtName(courseCategoryMt.getName());
    courseBaseInfoDto.setMtName(courseCategorySt.getName());

    return courseBaseInfoDto;
}

5.4 接口测试

1. 首先去完善controller方法：

@ApiOperation("新增课程")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody AddCourseDto addCourseDto) {

    // 获取到用户所属结构的 id
    Long companyId = 1232141425L;

    return courseBaseInfoService.createCourseBase(companyId, addCourseDto);
}

1. 使用httpclient测试

在xc-content-api.http中定义：

### 创建课程
POST {{content_host}}/content/course
Content-Type: application/json

{
  "charge": "201000",
  "price": 0,
  "originalPrice":0,
  "qq": "22333",
  "wechat": "223344",
  "phone": "13333333",
  "validDays": 365,
  "mt": "1-1",
  "st": "1-1-1",
  "name": "测试课程103",
  "pic": "",
  "teachmode": "200002",
  "users": "初级人员",
  "tags": "",
  "grade": "204001",
  "description": ""
}

1. 前后端联调

打开新增课程页面，除了课程图片其它信息全部输入。

点击保存，观察浏览器请求接口参数及响应结果是否正常。

5.5 异常处理

5.5.1 异常问题分析

在service方法中有很多的参数合法性校验，当参数不合法则抛出异常，下边我们测试下异常处理。

• 请求创建课程基本信息，故意将必填项设置为空。

• 测试发现报500异常

1️⃣问题：并没有输出我们抛出异常时指定的异常信息。

• 所以，现在我们的需求是当正常操作时按接口要求返回数据，
• 当非正常流程时要获取异常信息进行记录，并提示给用户。

2️⃣异常处理除了输出在日志中，还需要提示给用户，前端和后端需要作一些约定：

1. 错误提示信息统一以 json 格式返回给前端。

2. 以HTTP状态码决定当前是否出错，非200为操作异常。

3️⃣如何规范异常信息？

• 代码中统一抛出项目的自定义异常类型，这样可以统一去捕获这一类或几类的异常。

• 规范了异常类型就可以去获取异常信息。

• 如果捕获了非项目自定义的异常类型统一向用户提示“执行过程异常，请重试”的错误信息。

4️⃣如何捕获异常？

• 代码统一用try/catch方式去捕获代码比较臃肿，可以通过SpringMVC提供的控制器增强类统一由一个类去完成异常的捕获。

如下图：

5.5.2 统一异常处理实现

根据上边分析的方案，统一在base基础工程实现统一异常处理，各模块依赖了base基础工程都 可以使用。

1️⃣首先在base基础工程添加需要依赖的包：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

2️⃣定义一些通用的异常信息

• 从课程资料/工程目录 拷贝CommonError 类到base工程com.xuecheng.base.execption下。

package com.xuecheng.base.Exception;

/**
 * @author TaoYaopc
 * @description 通用异常信息
 * @date 2023/5/21 11:08
 */
public enum CommonError {

	UNKOWN_ERROR("执行过程异常，请重试。"),
	PARAMS_ERROR("非法参数"),
	OBJECT_NULL("对象为空"),
	QUERY_NULL("查询结果为空"),
	REQUEST_NULL("请求参数为空");

	private String errMessage;

	public String getErrMessage() {
		return errMessage;
	}

	private CommonError( String errMessage) {
		this.errMessage = errMessage;
	}

}

3️⃣自定义异常类型

• 在base工程com.xuecheng.base.execption下自定义异常类。

package com.xuecheng.base.Exception;

/**
 * @author TaoYaopc
 * @description 本项目自定义异常类型
 * @date 2023/5/23 16:18
 */
public class XueChengPlusException extends RuntimeException{
    private String errMessage;

    public XueChengPlusException() {
        super();
    }

    public XueChengPlusException(String message) {
        super(message);
        this.errMessage = message;
    }

    public String getErrMessage() {
        return errMessage;
    }

    public void setErrMessage(String errMessage) {
        this.errMessage = errMessage;
    }

    public static void cast(String message) {
        throw new XueChengPlusException(message);
    }

    public static void cast(CommonError error) {
        throw new XueChengPlusException(error.getErrMessage());
    }
}

4️⃣响应用户的统一类型

package com.xuecheng.base.Exception;

import java.io.Serializable;

/**
 * @author TaoYaopc
 * @description 和前端约定返回的异常信息模型
 * @date 2023/5/21 11:08
 */
public class RestErrorResponse implements Serializable {

    private String errMessage;

    public RestErrorResponse(String errMessage) {
        this.errMessage = errMessage;
    }

    public String getErrMessage() {
        return errMessage;
    }

    public void setErrMessage(String errMessage) {
        this.errMessage = errMessage;
    }
}

5️⃣全局异常处理器

从 Spring 3.0 - Spring 3.2 版本之间，对 Spring 架构和 SpringMVC 的Controller 的异常捕获提供了相应的异常处理。

• @ExceptionHandler

  • Spring3.0提供的标识在方法上或类上的注解，用来表明方法的处理异常类型。

• @ControllerAdvice

  • Spring3.2提供的新注解，从名字上可以看出大体意思是控制器增强，在项目中来增强SpringMVC中的Controller。
  • 通常和@ExceptionHandler 结合使用，来处理SpringMVC的异常信息。

• @ResponseStatus

  • Spring3.0提供的标识在方法上或类上的注解，用状态代码和应返回的原因标记方法或异常类。
  • 调用处理程序方法时，状态代码将应用于HTTP响应。

通过上面的两个注解便可实现微服务端全局异常处理，具体代码如下：

package com.xuecheng.base.Exception;

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;

/**
 * @author TaoYaopc
 * @description 全局异常处理器
 * @date 2023/5/23 16:25
 */
@Slf4j
@ControllerAdvice
// @RestControllerAdvice
public class GlobalExceptionHandler {

    // 对项目的自定义异常进行处理
    @ResponseBody // 信息返回格式为json
    @ExceptionHandler(XueChengPlusException.class) // 捕获异常类型
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) // 状态码
    public RestErrorResponse customException(XueChengPlusException e) {
        // 记录异常
        log.error("系统异常{}", e.getErrMessage(), e);

        // 解析出异常信息
        String errMessage = e.getErrMessage();
        RestErrorResponse restErrorResponse = new RestErrorResponse(errMessage);
        return restErrorResponse;
    }

    @ResponseBody
    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public RestErrorResponse exception(Exception e) {
        // 记录异常
        log.error("系统异常{}", e.getMessage(), e);

        // 解析出异常信息
        RestErrorResponse restErrorResponse = new RestErrorResponse(CommonError.UNKOWN_ERROR.getErrMessage());
        return restErrorResponse;
    }
}

5.5.3 异常处理测试

1️⃣修改业务代码

• 在异常处理测试之前首先在代码中抛出自定义类型的异常，这里以新增课程的service方法为例进行代码修改。

@Transactional
@Override
public CourseBaseInfoDto createCourseBase(Long companyId, AddCourseDto dto) {

    // 参数合法性校验
    if (StringUtils.isBlank(dto.getName())) {
        // throw new RuntimeException("课程名称为空");
        XueChengPlusException.cast("课程名称为空");
    }

    if (StringUtils.isBlank(dto.getUsers())) {
        // throw new RuntimeException("适应人群为空");
        XueChengPlusException.cast("适应人群为空");
    }

    if (StringUtils.isBlank(dto.getCharge())) {
        // throw new RuntimeException("收费规则为空");
        XueChengPlusException.cast("收费规则为空");
    }
    // ....
}

2️⃣首先使用httpclient测试

• 请求新增课程接口，故意将必填项课程名称设置为空。

• 测试结果与预期一致，可以捕获异常并响应异常信息，

3️⃣前后端调用测试

• 仍然测试新增课程接口，当课程收费的时候必须填写价格，这里设置课程为收费，价格设置为空。

• 通过测试发现，前端正常提示代码 中抛出的异常信息。

• 至此，项目异常处理的测试完毕，我们在开发中对于业务分支中错误的情况要抛出项目自定义的异常类型。

5.7 JSR303校验

5.7.1 统一校验的要求

前端请求后端接口传输参数，是在controller中校验还是在Service中校验？

• 答案是都需要校验，只是分工不同。

• Contoller中校验请求参数的合法性，

  • 包括：必填项校验，数据格式校验，比如：是否是符合一定的日期格式，等。

• Service中要校验的是业务规则相关的内容，

  • 比如：课程已经审核通过所以提交失败。

• Service中根据业务规则去校验不方便写成通用代码，Controller中则可以将校验的代码写成通用代码。

早在JavaEE6规范中就定义了参数校验的规范，它就是JSR-303，它定义了Bean Validation，即对bean属性进行校验。

• SpringBoot提供了JSR-303的支持，它就是spring-boot-starter-validation，
• 它的底层使用Hibernate Validator，Hibernate Validator是Bean Validation 的参考实现。

所以，我们准备在Controller层使用spring-boot-starter-validation完成对请求参数的基本合法性进行校验。

5.7.2 统一校验实现

1️⃣首先在Base工程添加spring-boot-starter-validation的依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2️⃣在javax.validation.constraints包下有很多这样的校验注解，直接使用注解定义校验规则即可。

限制	说明
@Null	限制只能为 null
@NotNull	限制必须不为 null
@AssertFalse	限制必须为 false
@AssertTrue	限制必须为 true
@DecimalMax(value)	限制必须为一个不大于指定值的数字
@DecimalMin(value)	限制必须为一个不小于指定值的数字
@Digits(integer, fraction)	限制必须为一个小数，且整数部分的位数不能超过 integer，小数部分的位数不能超过 fraction
@Future	限制必须是一个将来的日期
@Max(value)	限制必须为一个不大于指定值的数字
@Min(value)	限制必须为一个不小于指定值的数字
@Past	限制必须是一个过去的日期
@Pattern(value)	限制必须符合指定的正则表达式
@Size(max, min)	限制字符长度必须在 min 到 max 之间
@Past	验证注解的元素值（日期类型）比当前时间早
@NotEmpty	验证注解的元素值部位 null 且不为空（字符串长度不为0、集合大小不为0）
@NotBlank	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于 @NotEmpty，@NotBlank 只应用于字符串且在比较时会去除字符串的空格
@Email	验证注解的元素值时Email，也可以通过正则表达式和 flag 指定自定义的email格式

3️⃣现在准备对内容管理模块添加课程接口进行参数校验，如下接口：

@ApiOperation("新增课程基础信息")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody AddCourseDto addCourseDto){
    //机构id，由于认证系统没有上线暂时硬编码
    Long companyId = 1232141425L;
  	return courseBaseInfoService.createCourseBase(companyId,addCourseDto);
}

• 此接口使用AddCourseDto模型对象接收参数，所以进入AddCourseDto类，在属性上添加校验规则
• 下边用到了@NotEmpty和@Size两个注解，
  • @NotEmpty表示属性不能为空，
  • @Size表示限制属性内容的长短。

package com.xuecheng.content.model.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Size;
import java.math.BigDecimal;

/**
     * @description 添加课程dto
     * @author TaoYaopc
     * @date 2023/5/21 17:40
     */
@Data
@ApiModel(value="AddCourseDto", description="新增课程基本信息")
public class AddCourseDto {

    @NotEmpty(message = "课程名称不能为空")
    @ApiModelProperty(value = "课程名称", required = true)
    private String name;

    @NotEmpty(message = "适用人群不能为空")
    @Size(message = "适用人群内容过少",min = 10)
    @ApiModelProperty(value = "适用人群", required = true)
    private String users;

    @ApiModelProperty(value = "课程标签")
    private String tags;

    @NotEmpty(message = "课程分类不能为空")
    @ApiModelProperty(value = "大分类", required = true)
    private String mt;

    @NotEmpty(message = "课程分类不能为空")
    @ApiModelProperty(value = "小分类", required = true)
    private String st;

    @NotEmpty(message = "课程等级不能为空")
    @ApiModelProperty(value = "课程等级", required = true)
    private String grade;

    @ApiModelProperty(value = "教学模式（普通，录播，直播等）", required = true)
    private String teachmode;

    @ApiModelProperty(value = "课程介绍")
    private String description;

    @ApiModelProperty(value = "课程图片", required = true)
    private String pic;

    @NotEmpty(message = "收费规则不能为空")
    @ApiModelProperty(value = "收费规则，对应数据字典", required = true)
    private String charge;

    @ApiModelProperty(value = "价格")
    private BigDecimal price;

}

• 定义好校验规则还需要开启校验，在controller方法中添加@Validated注解，如下：

@ApiOperation("新增课程基础信息")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody @Validated AddCourseDto addCourseDto){
    //机构id，由于认证系统没有上线暂时硬编码
    Long companyId = 1L;
  	return courseBaseInfoService.createCourseBase(companyId,addCourseDto);
}

4️⃣如果校验出错Spring会抛出MethodArgumentNotValidException异常，

• 我们需要在统一异常处理器中捕获异常，解析出异常信息。代码如下：

@ResponseBody
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public RestErrorResponse methodArgumentNotValidException(MethodArgumentNotValidException e) {
    BindingResult bindingResult = e.getBindingResult();
    List<String> msgList = new ArrayList<>();
    //将错误信息放在msgList
    bindingResult.getFieldErrors().stream().forEach(item->msgList.add(item.getDefaultMessage()));
    //拼接错误信息
    String msg = StringUtils.join(msgList, ",");
    log.error("【系统异常】{}",msg);
    return new RestErrorResponse(msg);
}

5️⃣重启内容管理服务。

• 使用httpclient进行测试，将必填项设置为空，“适用人群” 属性的内容设置1个字。

• 执行测试，接口响应结果如下：

{
  "errMessage": "课程名称不能为空,课程分类不能为空,课程分类不能为空,适用人群内容过少"
}

5.7.3 分组校验

有时候在同一个属性上设置一个校验规则不能满足要求，

• 比如：订单编号由系统生成，在添加订单时要求订单编号为空，在更新 订单时要求订单编写不能为空。
• 此时就用到了分组校验，同一个属性定义多个校验规则属于不同的分组，
  • 比如：添加订单定义@NULL规则属于insert分组，更新订单定义@NotEmpty规则属于update分组，
  • insert和update是分组的名称，是可以修改的。

下边举例说明

• 我们用class类型来表示不同的分组，所以我们定义不同的接口类型（空接口）表示不同的分组，

1️⃣由于校验分组是公用的，所以定义在 base工程中。如下：

package com.xuecheng.base.Exception;

/**
 * @author TaoYaopc
 * @description 用于分级校验，定义一些常用的组
 * @date 2023/5/23 18:24
 */
public class ValidationGroups {
    public interface Inster{};
    public interface Update{};
    public interface Delete{};
}

2️⃣下边在定义校验规则时指定分组：

@NotEmpty(groups = {ValidationGroups.Inster.class},message = "添加课程名称不能为空")
@NotEmpty(groups = {ValidationGroups.Update.class},message = "修改课程名称不能为空")
// @NotEmpty(message = "课程名称不能为空")
@ApiModelProperty(value = "课程名称", required = true)
private String name;

3️⃣在Controller方法中启动校验规则指定要使用的分组名：

@ApiOperation("新增课程基础信息")
@PostMapping("/course")
public CourseBaseInfoDto createCourseBase(@RequestBody @Validated({ValidationGroups.Inster.class}) AddCourseDto addCourseDto){
    //机构id，由于认证系统没有上线暂时硬编码
    Long companyId = 1L;
  	return courseBaseInfoService.createCourseBase(companyId,addCourseDto);
}

4️⃣再次测试，由于这里指定了Insert分组，所以抛出 异常信息：添加课程名称不能为空。

• 如果修改分组为ValidationGroups.Update.class，异常信息为：修改课程名称不能为空。

5.7.4 校验规则不满足？

如果javax.validation.constraints包下的校验规则满足不了需求怎么办？

1. 手写校验代码 。

2. 自定义校验规则注解。

如何自定义校验规则注解，请自行查阅资料实现。

6. 修改课程

6.1 需求分析

6.1.1 业务流程

1. 进入课程列表查询

1. 点击编辑，因为课程审核通过方可发布，任何时候都 可以编辑，下图是编辑课程的界面：

进入编辑界面显示出当前课程的信息。

1. 修改成功自动进入课程计划编辑页面。

6.1.2 数据模型

通过业务流程可知，一门课程信息涉及：课程基本信息、课程营销信息、课程计划信息、课程师资信息。

• 这两部分信息分别在course_base、course_market两张表存储。
• 当点击保存按钮时向这两张表插入数据。
• 这两张表是一对一关联关系。

course_base

course_market

新建课程的初始审核状态为“未提交”、初始发布状态为“未发布”。

生成课程基本信息、课程营销信息的PO、Mapper文件

1️⃣进入课程编辑界面

• 界面中显示了课程的当前信息，需要根据课程id查询课程基本和课程营销信息，显示在表单上。

2️⃣编辑、提交

• 修改课程提交的数据比新增课程多了一项课程id，因为修改课程需要针对某个课程进行修改。

3️⃣保存数据

• 编辑完成保存课程基础信息和课程营销信息。

• 更新课程基本信息表中的修改人、修改时间。

6.2 接口定义

6.2.1 查询课程信息

定义根据课程id查询课程信息接口。

接口示例如下：

Java
GET /content/course/40
Content-Type: application/json
#响应结果
#{
#  "id": 40,
#  "companyId": 1232141425,
#  "companyName": null,
#  "name": "SpringBoot核心",
#  "users": "Spring Boot初学者",
#  "tags": "Spring项目的快速构建",
#  "mt": "1-3",
#  "mtName": null,
#  "st": "1-3-2",
#  "stName": null,
#  "grade": "200003",
#  "teachmode": "201001",
#  "description": "课程系统性地深度探讨 Spring Boot 核心特性，引导小伙伴对 Java 规范的重视，启发对技术原理性的思考，掌握排查问题的技能，以及学习阅读源码的方法和技巧，全面提升研发能力，进军架构师队伍。",
#  "pic": "https://cdn.educba.com/academy/wp-content/uploads/2018/08/Spring-BOOT-Interview-questions.jpg",
#  "createDate": "2019-09-10 16:05:39",
#  "changeDate": "2022-09-09 07:27:48",
#  "createPeople": null,
#  "changePeople": null,
#  "auditStatus": "202004",
#  "status": "203001",
#  "coursePubId": 21,
#  "coursePubDate": null,
#  "charge": "201001",
#  "price": 0.01
#}

查询结果为单条课程信息，内容和新增课程返回结果一致，所以采用与新增课程一致的模型类。

接口定义如下：

@ApiOperation("根据课程id查询课程基础信息")
@GetMapping("/course/{courseId}")
public CourseBaseInfoDto getCourseBaseById(@PathVariable Long courseId){
    return null;
}

6.2.2 修改课程信息

1️⃣根据前边的数据模型分析，修改课程提交的数据比新增多了课程id，接口示例如下：

Java
### 修改课程
PUT /content/course
Content-Type: application/json

{
  "id": 40,
  "companyName": null,
  "name": "SpringBoot核心",
  "users": "Spring Boot初学者",
  "tags": "Spring项目的快速构建",
  "mt": "1-3",
  "st": "1-3-2",
  "grade": "200003",
  "teachmode": "201001",
  "description": "课程系统性地深度探讨 Spring Boot 核心特性，引导小伙伴对 Java 规范的重视，启发对技术原理性的思考，掌握排查问题的技能，以及学习阅读源码的方法和技巧，全面提升研发能力，进军架构师队伍。",
  "pic": "https://cdn.educba.com/academy/wp-content/uploads/2018/08/Spring-BOOT-Interview-questions.jpg",
  "charge": "201001",
  "price": 0.01
}

###修改成功响应结果如下
#{
#  "id": 40,
#  "companyId": 1232141425,
#  "companyName": null,
#  "name": "SpringBoot核心",
#  "users": "Spring Boot初学者",
#  "tags": "Spring项目的快速构建",
#  "mt": "1-3",
#  "mtName": null,
#  "st": "1-3-2",
#  "stName": null,
#  "grade": "200003",
#  "teachmode": "201001",
#  "description": "课程系统性地深度探讨 Spring Boot 核心特性，引导小伙伴对 Java 规范的重视，启发对技术原理性的思考，掌握排查问题的技能，以及学习阅读源码的方法和技巧，全面提升研发能力，进军架构师队伍。",
#  "pic": "https://cdn.educba.com/academy/wp-content/uploads/2018/08/Spring-BOOT-Interview-questions.jpg",
#  "createDate": "2019-09-10 16:05:39",
#  "changeDate": "2022-09-09 07:27:48",
#  "createPeople": null,
#  "changePeople": null,
#  "auditStatus": "202004",
#  "status": "203001",
#  "coursePubId": 21,
#  "coursePubDate": null,
#  "charge": "201001",
#  "price": 0.01
#}

2️⃣这里定义修改课程提交的数据模型。

package com.xuecheng.content.model.dto;

import com.xuecheng.base.Exception.ValidationGroups;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import javax.validation.constraints.NotEmpty;

/**
 * @author TaoYaopc
 * @version v1.0
 * @description TODO
 * @date 2023/5/24 10:06
 */
@Data
public class EditCourseDto extends AddCourseDto{

    // @NotEmpty(message = "课程id不能为空", groups = {ValidationGroups.Update.class})
    @ApiModelProperty(value = "课程id", required = true)
    private Long id;

}

3️⃣修改后返回最新课程信息，采用与新增课程接口返回类型一致的数据模型。

• 接口定义如下：

@ApiOperation("修改课程基础信息")
@PutMapping("/course")
public CourseBaseInfoDto modifyCourseBase(@RequestBody @Validated EditCourseDto editCourseDto){
    
}

6.3 接口开发

6.3.1 查询课程信息

1️⃣查询课程信息的Service方法在新增课程接口开发中已实现，无需实现，如下：

//根据课程id查询课程基本信息，包括基本信息和营销信息
public CourseBaseInfoDto getCourseBaseInfo(long courseId){
    //查询课程信息
    CourseBase courseBase = courseBaseMapper.selectById(courseId);
    if(courseBase == null){
        return null;
    }
    //查询营销信息
    CourseMarket courseMarket = courseMarketMapper.selectById(courseId);
    //要返回的对象
    CourseBaseInfoDto courseBaseInfoDto = new CourseBaseInfoDto();
    BeanUtils.copyProperties(courseBase,courseBaseInfoDto);
    if(courseMarket != null){
        BeanUtils.copyProperties(courseMarket,courseBaseInfoDto);
    }
    //查询分类名称
    CourseCategory courseCategoryBySt = courseCategoryMapper.selectById(courseBase.getSt());
    courseBaseInfoDto.setStName(courseCategoryBySt.getName());
    CourseCategory courseCategoryByMt = courseCategoryMapper.selectById(courseBase.getMt());
    courseBaseInfoDto.setMtName(courseCategoryByMt.getName());

    return courseBaseInfoDto;
}

2️⃣需要将查询课程信息的方法提到接口上，这样在controller中通过接口调用此方法。

3️⃣完善接口层代码 ：

@ApiOperation("根据课程id查询课程基础信息")
@GetMapping("/course/{courseId}")
public CourseBaseInfoDto getCourseBaseById(@PathVariable Long courseId){
    return courseBaseInfoService.getCourseBaseInfo(courseId);
}

4️⃣测试查询课程

• 用httpclient测试查询课程接口：

6.3.2 修改课程信息

1️⃣修改Service修改课程的接口定义：

/**
     * 修改课程
     * @param companyId 机构id
     * @param editCourseDto 修改课程信息
     * @return 课程详细信息
     */
CourseBaseInfoDto updateCourseBase(Long companyId, EditCourseDto editCourseDto);

2️⃣ServiceImpl中的实现方法：

@Transactional
@Override
public CourseBaseInfoDto updateCourseBase(Long companyId, EditCourseDto dto) {

    //课程id
    Long courseId = dto.getId();
    CourseBase courseBase = courseBaseMapper.selectById(courseId);
    if(courseBase==null){
        XueChengPlusException.cast("课程不存在");
    }

    //校验本机构只能修改本机构的课程
    if(!courseBase.getCompanyId().equals(companyId)){
        XueChengPlusException.cast("本机构只能修改本机构的课程");
    }

    //封装基本信息的数据
    BeanUtils.copyProperties(dto,courseBase);
    courseBase.setChangeDate(LocalDateTime.now());

    //更新课程基本信息
    int i = courseBaseMapper.updateById(courseBase);

    //封装营销信息的数据
    CourseMarket courseMarket = new CourseMarket();
    BeanUtils.copyProperties(dto,courseMarket);
    saveCourseMarket(courseMarket);
    //查询课程信息
    CourseBaseInfoDto courseBaseInfo = this.getCourseBaseInfo(courseId);
    return courseBaseInfo;

}

3️⃣最后完善接口层代码：

@ApiOperation("修改课程基础信息")
@PutMapping("/course")
public CourseBaseInfoDto modifyCourseBase(@RequestBody @Validated EditCourseDto editCourseDto){
    //机构id，由于认证系统没有上线暂时硬编码
    Long companyId = 1232141425L;
    return courseBaseInfoService.updateCourseBase(companyId,editCourseDto);
}

6.4 接口测试

1️⃣接口开发完成进行测试，使用httpclient测试

### 根据课程id查询课程信息
GET {{content_host}}/content/course/40
Content-Type: application/json
#响应结果
#{
#  "id": 40,
#  "companyId": 1232141425,
#  "companyName": null,
#  "name": "SpringBoot核心",
#  "users": "Spring Boot初学者",
#  "tags": "Spring项目的快速构建",
#  "mt": "1-3",
#  "mtName": null,
#  "st": "1-3-2",
#  "stName": null,
#  "grade": "200003",
#  "teachmode": "201001",
#  "description": "课程系统性地深度探讨 Spring Boot 核心特性，引导小伙伴对 Java 规范的重视，启发对技术原理性的思考，掌握排查问题的技能，以及学习阅读源码的方法和技巧，全面提升研发能力，进军架构师队伍。",
#  "pic": "https://cdn.educba.com/academy/wp-content/uploads/2018/08/Spring-BOOT-Interview-questions.jpg",
#  "createDate": "2019-09-10 16:05:39",
#  "changeDate": "2022-09-09 07:27:48",
#  "createPeople": null,
#  "changePeople": null,
#  "auditStatus": "202004",
#  "status": "203001",
#  "coursePubId": 21,
#  "coursePubDate": null,
#  "charge": "201001",
#  "price": 0.01
#}

### 修改课程
PUT {{content_host}}/content/course
Content-Type: application/json

{
  "id": 40,
  "name": "SpringBoot核心",
  "users": "Spring Boot初学者",
  "tags": "Spring项目的快速构建",
  "mt": "1-3",
  "st": "1-3-2",
  "grade": "200003",
  "teachmode": "201001",
  "description": "课程系统性地深度探讨 Spring Boot 核心特性，引导小伙伴对 Java 规范的重视，启发对技术原理性的思考，掌握排查问题的技能，以及学习阅读源码的方法和技巧，全面提升研发能力，进军架构师队伍。",
  "pic": "https://cdn.educba.com/academy/wp-content/uploads/2018/08/Spring-BOOT-Interview-questions.jpg",
  "charge": "201001",
  "price": 0.01
}

### 修改成功响应结果如下
#{
#  "id": 40,
#  "companyId": 1232141425,
#  "companyName": null,
#  "name": "SpringBoot核心",
#  "users": "Spring Boot初学者",
#  "tags": "Spring项目的快速构建",
#  "mt": "1-3",
#  "mtName": null,
#  "st": "1-3-2",
#  "stName": null,
#  "grade": "200003",
#  "teachmode": "201001",
#  "description": "课程系统性地深度探讨 Spring Boot 核心特性，引导小伙伴对 Java 规范的重视，启发对技术原理性的思考，掌握排查问题的技能，以及学习阅读源码的方法和技巧，全面提升研发能力，进军架构师队伍。",
#  "pic": "https://cdn.educba.com/academy/wp-content/uploads/2018/08/Spring-BOOT-Interview-questions.jpg",
#  "createDate": "2019-09-10 16:05:39",
#  "changeDate": "2022-09-09 07:27:48",
#  "createPeople": null,
#  "changePeople": null,
#  "auditStatus": "202004",
#  "status": "203001",
#  "coursePubId": 21,
#  "coursePubDate": null,
#  "charge": "201001",
#  "price": 0.01
#}

2️⃣前端开发完毕进行前后端接口联调。

7. 查询课程计划

7.1 需求分析

7.1.1 业务流程

课程基本信息添加或修改成功将自动进入课程计划编辑器界面，如下图：

• 课程计划即课程的大纲目录。

• 课程计划分为两级：大章节和不小章节。

本小节完成课程计划信息的查询。

7.1.2 数据模型

1️⃣从课程计划查询界面上可以看出整体上是 一个树型结构，课程计划表teachplan如下：

• 每个课程计划都有所属课程。

• 每个课程的课程计划有两个级别，

  • 第一级为大章节，grade为1、
  • 第二级为小章节，grade为2、3。
  • 第二级的parentid为第一级的id。

• 课程计划的显示顺序根据排序字段去显示。

2️⃣根据业务流程中的界面原型，课程计划列表展示时还有课程计划关联的视频信息。

• 课程计划关联的视频信息在teachplan_media表，结构如下：

3️⃣两张表是一对一关系，每个课程计划只能在teachplan_media表中存在一个视频。

7.2 接口定义

1️⃣接口示例如下：

GET /teachplan/22/tree-nodes
[
    {
        "changeDate" : null,
        "courseId" : 74,
        "cousePubId" : null,
        "createDate" : null,
        "endTime" : null,
        "grade" : "2",
        "isPreview" : "0",
        "mediaType" : null,
        "orderby" : 1,
        "parentid" : 112,
        "pname" : "第1章基础知识",
        "startTime" : null,
        "status" : null,
        "id" : 113,
        "teachPlanTreeNodes" : [
            {
                "changeDate" : null,
                "courseId" : 74,
                "cousePubId" : null,
                "createDate" : null,
                "endTime" : null,
                "grade" : "3",
                "isPreview" : "1",
                "mediaType" : "001002",
                "orderby" : 1,
                "parentid" : 113,
                "pname" : "第1节项目概述",
                "startTime" : null,
                "status" : null,
                "id" : 115,
                "teachPlanTreeNodes" : null,
                "teachplanMedia" : {
                    "courseId" : 74,
                    "coursePubId" : null,
                    "mediaFilename" : "2.avi",
                    "mediaId" : 41,
                    "teachplanId" : 115,
                    "id" : null
                }
            }
        ],
        "teachplanMedia" : null
    },
    {
        "changeDate" : null,
        "courseId" : 74,
        "cousePubId" : null,
        "createDate" : null,
        "endTime" : null,
        "grade" : "2",
        "isPreview" : "0",
        "mediaType" : "",
        "orderby" : 1,
        "parentid" : 112,
        "pname" : "第2章快速入门",
        "startTime" : null,
        "status" : null,
        "id" : 242,
        "teachPlanTreeNodes" : [
            {
                "changeDate" : null,
                "courseId" : 74,
                "cousePubId" : null,
                "createDate" : null,
                "endTime" : null,
                "grade" : "3",
                "isPreview" : "1",
                "mediaType" : "001002",
                "orderby" : 2,
                "parentid" : 242,
                "pname" : "第1节搭建环境",
                "startTime" : null,
                "status" : null,
                "id" : 244,
                "teachPlanTreeNodes" : null,
                "teachplanMedia" : {
                    "courseId" : 74,
                    "coursePubId" : null,
                    "mediaFilename" : "3.avi",
                    "mediaId" : 42,
                    "teachplanId" : 244,
                    "id" : null
                }
            },
            {
                "changeDate" : null,
                "courseId" : 74,
                "cousePubId" : null,
                "createDate" : null,
                "endTime" : null,
                "grade" : "3",
                "isPreview" : "0",
                "mediaType" : "001002",
                "orderby" : 3,
                "parentid" : 242,
                "pname" : "第2节项目概述",
                "startTime" : null,
                "status" : null,
                "id" : 245,
                "teachPlanTreeNodes" : null,
                "teachplanMedia" : {
                    "courseId" : 74,
                    "coursePubId" : null,
                    "mediaFilename" : "1a.avi",
                    "mediaId" : 39,
                    "teachplanId" : 245,
                    "id" : null
                }
            }
        ],
        "teachplanMedia" : null
    }
]

2️⃣查询课程计划的请求参数：课程id

• 响应结果需要自定义模型类：

package com.xuecheng.content.model.dto;

import com.xuecheng.content.model.po.Teachplan;
import com.xuecheng.content.model.po.TeachplanMedia;
import lombok.Data;
import lombok.ToString;

import java.util.List;

/**
 * @author TaoYaopc
 * @version v1.0
 * @description 课程计划信息模型类
 * @date 2023/5/25 15:51
 */
@Data
@ToString
public class TeachplanDto extends Teachplan {

    /**
     * 与媒资关联的信息
     */
    private TeachplanMedia teachplanMedia;

    /**
     * 小章节list
     */
    private List<TeachplanDto> teachPlanTreeNodes;
}

3️⃣定义接口如下：

package com.xuecheng.content.api;

import com.xuecheng.content.model.dto.TeachplanDto;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**
 * @author TaoYaopc
 * @version v1.0
 * @description 课程计划管理相关的接口
 * @date 2023/5/25 15:55
 */
@Api(value = "课程计划编辑接口",tags = "课程计划编辑接口")
@RestController
public class TeachplanController {

    @ApiOperation("查询课程计划树形结构")
    @ApiImplicitParam(value = "courseId",name = "课程Id",required = true,dataType = "Long",paramType = "path")
    @GetMapping("/teachplan/{courseId}/tree-nodes")
    public List<TeachplanDto> getTreeNodes(@PathVariable Long courseId) {

        return null;
    }
}

7.3 接口开发

7.3.1 DAO 开发

1️⃣Mapper接口使用sql查询课程计划，组成一个树型结构。

• 在TeachplanMapper自定义方法：

package com.xuecheng.content.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.xuecheng.content.model.dto.TeachplanDto;
import com.xuecheng.content.model.po.Teachplan;

import java.util.List;

/**
 * <p>
 * 课程计划 Mapper 接口
 * </p>
 * @author itcast
 */
public interface TeachplanMapper extends BaseMapper<Teachplan> {

    /**
     * 课程计划查询
     * @param courseId 课程id
     * @return 返回list集合
     */
    List<TeachplanDto> selectTreeNodes(Long courseId);
}

2️⃣定义mapper.xml中的sql语句，分析如下：

1. 一级分类和二级分类通过teachplan表的自链接进行，

   • 如果只有一级分类其下边没有二级分类，此时也需要显示一级分类，
   • 这里使用左连接，左边是一级分类，右边是二级分类。

2. 由于当还没有关联视频时teachplan_media对应的记录为空，所以需要teachplan和teachplan_media左链接。

sql如下：

select one.id            one_id,
       one.pname         one_pname,
       one.parentid      one_parentid,
       one.grade         one_grade,
       one.media_type    one_mediaType,
       one.start_time    one_stratTime,
       one.end_time      one_endTime,
       one.orderby       one_orderby,
       one.course_id     one_courseId,
       one.course_pub_id one_coursePubId,
       two.id            two_id,
       two.pname         two_pname,
       two.parentid      two_parentid,
       two.grade         two_grade,
       two.media_type    two_mediaType,
       two.start_time    two_stratTime,
       two.end_time      two_endTime,
       two.orderby       two_orderby,
       two.course_id     two_courseId,
       two.course_pub_id two_coursePubId,
       tm.media_fileName mediaFilename,
       tm.id             teachplanMeidaId,
       tm.media_id       mediaId

from teachplan one
         inner join teachplan two on two.parentid = one.id
         left join teachplan_media tm on two.id = tm.teachplan_id
where one.parentid = 0
  and one.course_id = 117
order by one.orderby, two.orderby

3️⃣定义mapper.xml

<resultMap id="treeNodeResultMap" type="com.xuecheng.content.model.dto.TeachplanDto">
    <!-- 一级数据映射 -->
    <id column="one_id" property="id"/>
    <result column="one_pname" property="pname"/>
    <result column="one_parentid" property="parentid"/>
    <result column="one_grade" property="grade"/>
    <result column="one_mediaType" property="mediaType"/>
    <result column="one_stratTime" property="startTime"/>
    <result column="one_endTime" property="endTime"/>
    <result column="one_orderby" property="orderby"/>
    <result column="one_courseId" property="courseId"/>
    <result column="one_coursePubId" property="coursePubId"/>

    <!-- 映射子节点，一对多映射，ofType List中的对象类型 -->
    <collection property="teachplanDtoNodes" ofType="com.xuecheng.content.model.dto.TeachplanDto">
        <!-- 二级数据映射 -->
        <id column="two_id" property="id"/>
        <result column="two_pname" property="pname"/>
        <result column="two_parentid" property="parentid"/>
        <result column="two_grade" property="grade"/>
        <result column="two_mediaType" property="mediaType"/>
        <result column="two_stratTime" property="startTime"/>
        <result column="two_endTime" property="endTime"/>
        <result column="two_orderby" property="orderby"/>
        <result column="two_courseId" property="courseId"/>
        <result column="two_coursePubId" property="coursePubId"/>
        <!--一对一映射-->
        <association property="teachplanMedia" javaType="com.xuecheng.content.model.po.TeachplanMedia">
            <id column="teachplanMediaId" property="id"/>
            <result column="mediaFilename" property="mediaFilename"/>
            <result column="mediaId" property="mediaId"/>
        </association>
    </collection>
</resultMap>

<select id="selectTreeNodes" parameterType="long" resultMap="treeNodeResultMap">
    select one.id            one_id,
    one.pname         one_pname,
    one.parentid      one_parentid,
    one.grade         one_grade,
    one.media_type    one_mediaType,
    one.start_time    one_stratTime,
    one.end_time      one_endTime,
    one.orderby       one_orderby,
    one.course_id     one_courseId,
    one.course_pub_id one_coursePubId,
    two.id            two_id,
    two.pname         two_pname,
    two.parentid      two_parentid,
    two.grade         two_grade,
    two.media_type    two_mediaType,
    two.start_time    two_stratTime,
    two.end_time      two_endTime,
    two.orderby       two_orderby,
    two.course_id     two_courseId,
    two.course_pub_id two_coursePubId,
    tm.media_fileName mediaFilename,
    tm.id             teachplanMeidaId,
    tm.media_id       mediaId

    from teachplan one
    inner join teachplan two on two.parentid = one.id
    left join teachplan_media tm on two.id = tm.teachplan_id
    where one.parentid = 0
    and one.course_id = #{courseId}
    order by one.orderby, two.orderby
</select>

4️⃣随后进行单元测试

7.3.2 Service 开发

定义service接口

package com.xuecheng.content.service;

import com.xuecheng.content.model.dto.TeachplanDto;

import java.util.List;

/**
 * @author TaoYaopc
 * @version v1.0
 * @description 课程计划管理相关的接口
 * @date 2023/5/25 16:43
 */
public interface TeachplanService {

    /**
     * 查询课程计划
     * @param courseId 课程id
     * @return 课程计划信息
     */
    List<TeachplanDto> findTeachplanTree(Long courseId);
}

定义service接口实现类

package com.xuecheng.content.service.impl;

import com.xuecheng.content.mapper.TeachplanMapper;
import com.xuecheng.content.model.dto.TeachplanDto;
import com.xuecheng.content.service.TeachplanService;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import java.util.List;

/**
 * @author TaoYaopc
 * @version v1.0
 * @description TODO
 * @date 2023/5/25 16:44
 */
@Service
public class TeachplanServiceImpl implements TeachplanService {

    @Resource
    private TeachplanMapper teachplanMapper;

    @Override
    public List<TeachplanDto> findTeachplanTree(Long courseId) {

        return teachplanMapper.selectTreeNodes(courseId);
    }
}

7.4 接口测试

1. 完善接口层代码

@ApiOperation("查询课程计划树形结构")
@ApiImplicitParam(value = "courseId",name = "课程Id",required = true,dataType = "Long",paramType = "path")
@GetMapping("/teachplan/{courseId}/tree-nodes")
public List<TeachplanDto> getTreeNodes(@PathVariable Long courseId) {

    return teachplanService.findTeachplanTree(courseId);
}

1. 使用httpclient测试

### 查询某个课程的课程计划

GET {{content_host}}/content/teachplan/117/tree-nodes

1. 前后端联调
   • 进入课程编辑页面
   • 保存进入下一步

观察课程计划获取是否成功。

• 进入新增课程页面
• 新增课程成功，自动进入课程计划编辑界面。

由于是新增的课程，课程计划为空。

8. 新增/修改计划

8.1 需求分析

8.1.1 业务流程

1. 进入课程计划界面

1. 点击“添加章”新增第一级课程计划。

   • 新增成功自动刷新课程计划列表。

2. 点击“添加小节”向某个第一级课程计划下添加小节。

   • 新增成功自动刷新课程计划列表。

   • 新增的课程计划自动排序到最后。

3. 点击“章”、“节”的名称，可以修改名称、选择是否免费。

8.1.2 数据模型

1. 新增第一级课程计划

   • 名称默认为：新章名称 [点击修改]
   • grade：1
   • orderby: 所属课程中同级别下排在最后

2. 新增第二级课程计划

   • 名称默认为：新小节名称 [点击修改]

   • grade：2

   • orderby: 所属课程计划中排在最后

3. 修改第一级、第二级课程计划的名称，修改第二级课程计划是否免费

8.2 接口定义

1️⃣接口示例如下：

### 新增课程计划--章,当grade为1时parentid为0
POST /teachplan
Content-Type: application/json

{
  "courseId" : 74,
  "parentid": 0,
  "grade" : 1,
  "pname" : "新章名称 [点击修改]"
}
### 新增课程计划--节
POST {{content_host}}/content/teachplan
Content-Type: application/json

{
  "courseId" : 74,
  "parentid": 247,
  "grade" : 2,
  "pname" : "小节名称 [点击修改]"
}

2️⃣具体分析

• 同一个接口接收新增和修改两个业务请求，以是否传递课程计划id 来判断是新增还是修改。

• 如果传递了课程计划id说明当前是要修改该课程计划，否则是新增一个课程计划。

3️⃣定义接收请求参数的数据模型类：

• 定义SaveTeachplanDto

package com.xuecheng.content.model.dto;

import lombok.Data;

/**
 * @author TaoYaopc
 * @version v1.0
 * @description 新增大章节、小章节、修改章节信息
 * @date 2023/5/29 15:12
 */
@Data
public class SaveTeachplanDto {
    
    /***
     * 教学计划id
     */
    private Long id;

    /**
     * 课程计划名称
     */
    private String pname;

    /**
     * 课程计划父级Id
     */
    private Long parentid;

    /**
     * 层级，分为1、2、3级
     */
    private Integer grade;

    /**
     * 课程类型:1视频、2文档
     */
    private String mediaType;


    /**
     * 课程标识
     */
    private Long courseId;

    /**
     * 课程发布标识
     */
    private Long coursePubId;


    /**
     * 是否支持试学或预览（试看）
     */
    private String isPreview;

}

4️⃣接口定义：

@ApiOperation("课程计划创建或修改")
@PostMapping("/teachplan")
public void saveTeachplan(@RequestBody SaveTeachplanDto teachplan) {

}

8.3 接口开发

8.3.1 Mapper 开发

根据业务的分析，Mapper使用自动生成的mapper即可满足要求。

8.3.2 Service 开发

定义保存课程计划的Service接口。

/**
     * 新增/修改/保存课程计划
     * @param saveTeachplanDto 保存模型类
     */
void saveTeachplan(SaveTeachplanDto saveTeachplanDto);

编写接口实现：

@Override
public void saveTeachplan(SaveTeachplanDto saveTeachplanDto) {
    // 通过新增课程计划id判断是新增还是修改
    Long teachplanId = saveTeachplanDto.getId();
    if(teachplanId == null) {
        // 新增
        Teachplan teachplan = new Teachplan();
        BeanUtils.copyProperties(saveTeachplanDto, teachplan);
        // 确定排序字段，找到它的同级节点个数，排序字段就是个数加 1
        Long parentid = saveTeachplanDto.getParentid();
        Long courseId = saveTeachplanDto.getCourseId();
        Integer count = getTeachplanCount(parentid, courseId);
        teachplan.setOrderby(count+1);

        teachplanMapper.insert(teachplan);
    } else {
        // 修改
        Teachplan teachplan = teachplanMapper.selectById(teachplanId);
        // 将参数复制到 teachplan
        BeanUtils.copyProperties(saveTeachplanDto, teachplan);
        teachplanMapper.updateById(teachplan);
    }
}

private Integer getTeachplanCount(Long parentid, Long courseId) {
    LambdaQueryWrapper<Teachplan> queryWrapper = new LambdaQueryWrapper<>();
    queryWrapper.eq(Teachplan::getCourseId, courseId).eq(Teachplan::getParentid, parentid);
    Integer count = teachplanMapper.selectCount(queryWrapper);
    return count;
}

8.4 接口测试

1️⃣完善接口的代码 ，调用service方法完成课程计划的创建和修改。

@ApiOperation("课程计划创建或修改")
@PostMapping("/teachplan")
public void saveTeachplan(@RequestBody SaveTeachplanDto teachplan) {

    teachplanService.saveTeachplan(teachplan);
}

2️⃣首先使用httpclient做以下测试。

• 添加章

### 新增课程计划--章
POST {{content_host}}/content/teachplan
Content-Type: application/json

{
  "courseId" : 74,
  "parentid": 0,
  "grade" : 1,
  "pname" : "新章名称 [点击修改]"
}

• 添加小节

### 新增课程计划--节,从数据库找到第一级的课程计划id向其下边添加计划
POST {{content_host}}/content/teachplan
Content-Type: application/json

{
  "courseId" : 74,
  "parentid": 247,
  "grade" : 2,
  "pname" : "小节名称 [点击修改]"
}

• 保存课程计划

Java
### 课程课程计划,需要从数据库找到修改的课程计划id
POST {{content_host}}/content/teachplan
Content-Type: application/json

{
  "changeDate" : null,
  "courseId" : 22,
  "cousePubId" : null,
  "createDate" : null,
  "ctlBarShow" : false,
  "ctlEditTitle" : true,
  "endTime" : null,
  "grade" : "2",
  "isPreview" : "1",
  "mediaType" : "",
  "orderby" : 1,
  "parentid" : 237,
  "pname" : "第1节修改名称",
  "startTime" : null,
  "status" : null,
  "teachPlanId" : 240
}

3️⃣前后端联调

• 分别联调新增章、新增小节、保存计划信息。

8.5 bug 修复

通过接口测试我们发现：

1. 使用 httpclient 测试没有问题

2. 前后端联调时发现新增的第一级目录不能显示在列表中。

请自己分析并修复。

1️⃣通过 F12 网页端调试工具发现

• 查询方法 tree-nodes 响应值里面未出现新增章节名称
• 由此猜测可能是查询方法有bug

2️⃣观察 controller 和 ServiceImpl

• 发现查询方法是由 mapper 定义
• mapper 是通过 自定义 sql 语句直接与数据库交互
• 由此可见，问题在sql语句中

@ApiOperation("查询课程计划树形结构")
@ApiImplicitParam(value = "courseId",name = "课程Id", required = true, dataType = "Long",paramType = "path")
@GetMapping("/teachplan/{courseId}/tree-nodes")
public List<TeachplanDto> getTreeNodes(@PathVariable Long courseId) {

    return teachplanService.findTeachplanTree(courseId);
}

@Override
public List<TeachplanDto> findTeachplanTree(Long courseId) {

    return teachplanMapper.selectTreeNodes(courseId);
}

3️⃣查询课程计划树形结构 sql 语句 如下：

• 发现由于新增的大章节底下无小节
• 而表查询采用内连接，由于内连接（inner join）左右两表需都有值才有效，而新增章节没有小节
• 查询过程中略过了新增章节
• 如此需将内连接改为左内连接（left join），只要左表有值便有效

select one.id            one_id,
       one.pname         one_pname,
       one.parentid      one_parentid,
       one.grade         one_grade,
       one.media_type    one_mediaType,
       one.start_time    one_stratTime,
       one.end_time      one_endTime,
       one.orderby       one_orderby,
       one.course_id     one_courseId,
       one.course_pub_id one_coursePubId,
       two.id            two_id,
       two.pname         two_pname,
       two.parentid      two_parentid,
       two.grade         two_grade,
       two.media_type    two_mediaType,
       two.start_time    two_stratTime,
       two.end_time      two_endTime,
       two.orderby       two_orderby,
       two.course_id     two_courseId,
       two.course_pub_id two_coursePubId,
       tm.media_fileName mediaFilename,
       tm.id             teachplanMeidaId,
       tm.media_id       mediaId

from teachplan one
         left join teachplan two on two.parentid = one.id
         left join teachplan_media tm on two.id = tm.teachplan_id
where one.parentid = 0
  and one.course_id = 117
order by one.orderby, two.orderby

9. 项目实战

9.1 删除课程计划

9.1.1 需求分析

课程计划添加成功，如果课程还没有提交时可以删除课程计划。

• 未提交，audit_status为 202002

删除第一级别的大章节时要求大章节下边没有小章节时方可删除。

• 需根据大章节的 parentid 匹配 id = parentid，若count = 0 则可删除大章节

删除第二级别的小章节的同时需要将teachplan_media表关联的信息也删除。

• teachplan

• teachplan_media

• teachplan_work

9.1.2 接口定义

删除课程计划的接口定义：

• 传入课程计划id进行删除操作。

Request URL: /content/teachplan/246
Request Method: DELETE

如果失败返回：
{"errCode":"120409","errMessage":"课程计划信息还有子级信息，无法操作"}

如果成功：状态码200，不返回信息

1️⃣接口定义：

@ApiOperation("删除课程计划")
@DeleteMapping("/teachplan/{teachplanId}")
public void deleteTeachplan(@PathVariable Long teachplanId) {

    teachplanService.removeTeachplan(teachplanId);
}

2️⃣Service 开发

/**
     * 删除课程计划
     * @param teachplanId 课程计划id
     */
void removeTeachplan(Long teachplanId);

3️⃣Service 实现

@Transactional
@Override
public void removeTeachplan(Long teachplanId) {
    // 根据id查询teachplan
    Teachplan teachplan = teachplanMapper.selectById(teachplanId);
    // 如果teachplan的 层级grade为1，则查询是否有子节点，如果为2则直接删除
    if(teachplan.getGrade() == 1) {
        // 则查询是否有子节点
        LambdaQueryWrapper<Teachplan> queryWrapper = new LambdaQueryWrapper<>();
        queryWrapper.eq(Teachplan::getParentid, teachplanId);
        Integer count = teachplanMapper.selectCount(queryWrapper);
        if(count > 0) {
            // 有子节点，提示错误信息
            XueChengPlusException.cast("课程计划信息还有子级信息，无法操作");
        }
        deleteTeachplanWithMediaAndWork(teachplanId);
    } else {
        // 如果为2则直接删除
        deleteTeachplanWithMediaAndWork(teachplanId);
    }

}

private void deleteTeachplanWithMediaAndWork(Long teachplanId) {
    // 课程计划表 teachplan
    teachplanMapper.deleteById(teachplanId);
    // 课程计划视频表 teachplan_media
    teachplanMapper.deleteById(teachplanId);
    // 课程计划作业表 teachplan_work
    teachplanMapper.deleteById(teachplanId);
}

9.1.3 接口测试

首先使用httpclient工具进行测试

### 删除课程计划
DELETE {{content_host}}/content/teachplan/43

分以下情况测试：

1. 删除大章节，大章节下有小章节时不允许删除。

2. 删除大章节，大单节下没有小章节时可以正常删除。

3. 删除小章节，同时将关联的信息进行删除。

其后进行前后端联调

9.2 课程计划排序

9.2.1 需求分析

课程计划新增后默认排在同级别最后，课程计划排序功能是可以灵活调整课程计划的显示顺序，如下图：

• 上移表示将课程计划向上移动。

• 下移表示将课程计划向下移动。

业务逻辑：

• 向上移动后和上边同级的课程计划交换位置，可以将两个课程计划的排序字段值进行交换。

  • 先查出父节点id相同的所有节点，再按orderby排序，即可知道上下节点分别是谁

• 向下移动后和下边同级的课程计划交换位置，可以将两个课程计划的排序字段值进行交换。

  • 先查出父节点id相同的所有节点，再按orderby排序，即可知道上下节点分别是谁

9.2.2 接口定义

接口示例如下：

向下移动：

• 参数1：movedown 为 移动类型，表示向下移动
• 参数2：43为课程计划id

Request URL: http://localhost:8601/api/content/teachplan/movedown/43
Request Method: POST

向上移动：

• 参数1：moveup 为 移动类型，表示向上移动
• 参数2：43为课程计划id

Request URL: http://localhost:8601/api/content/teachplan/moveup/43
Request Method: POST

每次移动传递两个参数：

1. 移动类型: movedown和moveup

2. 课程计划id

1️⃣ Controller 接口

@ApiOperation("课程计划排序---下移")
@PostMapping("/teachplan/movedown/{teachplanId}")
public void movedown(@PathVariable Long teachplanId) {

    teachplanService.movedown(teachplanId);
}

@ApiOperation("课程计划排序---上移")
@PostMapping("/teachplan/moveup/{teachplanId}")
public void moveup(@PathVariable Long teachplanId) {

    teachplanService.moveup(teachplanId);
}

2️⃣ Service 接口

/**
     * 课程计划下移
     * @param teachplanId 课程计划id
     */
void movedown(Long teachplanId);

/**
     * 课程计划下移
     * @param teachplanId 课程计划id
     */
void moveup(Long teachplanId);

3️⃣ ServiceImpl 实现类

@Override
public void movedown(Long teachplanId) {
    // 先查询本课程计划，得到父节点id
    Teachplan teachplan = teachplanMapper.selectById(teachplanId);
    Long parentid = teachplan.getParentid();

    // 查询所有父节点一样的课程计划
    List<Teachplan> teachplanList = teachplanMapper.selectList(new LambdaQueryWrapper<Teachplan>()
                                                               .eq(Teachplan::getParentid, parentid).eq(Teachplan::getCourseId, teachplan.getCourseId()));
    Collections.sort(teachplanList, ((o1, o2) -> (o1.getOrderby() - o2.getOrderby())));
    moveList(teachplanId, teachplanList);
}

@Override
public void moveup(Long teachplanId) {
    // 先查询本课程计划，得到父节点id
    Teachplan teachplan = teachplanMapper.selectById(teachplanId);
    Long parentid = teachplan.getParentid();

    // 查询所有父节点一样的课程计划
    List<Teachplan> teachplanList = teachplanMapper.selectList(new LambdaQueryWrapper<Teachplan>()
                                                               .eq(Teachplan::getParentid, parentid).eq(Teachplan::getCourseId, teachplan.getCourseId()));
    Collections.sort(teachplanList, ((o1, o2) -> (o2.getOrderby() - o1.getOrderby())));
    moveList(teachplanId, teachplanList);
}

private void moveList(Long teachplanId, List<Teachplan> teachplanList) {
    for (int i = 0; i < teachplanList.size(); i++) {
        Teachplan teachplan1 = teachplanList.get(i);
        if (teachplanId.equals(teachplan1.getId()) && i + 1 < teachplanList.size()) {
            // 若还有下家则交换
            Teachplan teachplan2 = teachplanList.get(i + 1);
            Integer orderby = teachplan1.getOrderby();
            teachplan1.setOrderby(teachplan2.getOrderby());
            teachplan2.setOrderby(orderby);
            // 更新数据库
            teachplanMapper.updateById(teachplan1);
            teachplanMapper.updateById(teachplan2);
            return;
        }
    }
    XueChengPlusException.cast("无法移动，请检查后重试！");
}

9.2.3 接口测试

该功能可直接进行前后端联调，可以立即看到 效果。

1、向上移动测试

先找一个上边有课程计划的进行测试，向上移动后两个交换顺序。

再找最上边的课程计划向上移动，操作后位置不变因为已经在最上边了。

2、向下移动测试

先找一个下边有课程计划的进行测试，向下移动后两个交换顺序。

再找最下边的课程计划向下移动，操作后位置不变因为已经在最下边了。

9.3 师资管理

9.3.1 需求分析

在课程计划维护界面点击下一步进入师资管理界面：

点击添加教师打开添加界面，如下图，不用实现上传照片。

添加成功查询教师信息如下：

在这个界面可以删除老师，也可以点击编辑，修改教师信息：

注意：

只允许向机构自己的课程中添加老师、删除老师。

机构id统一使用：1232141425L

9.3.2 师资查询

查询教师接口请求示例

get /courseTeacher/list/75
75为课程id，请求参数为课程id

响应结果
[{"id":23,"courseId":75,"teacherName":"张老师","position":"讲师","introduction":"张老师教师简介张老师教师简介张老师教师简介张老师教师简介","photograph":null,"createDate":null}]

1️⃣接口定义：Controller

package com.xuecheng.content.api;

import com.xuecheng.content.model.po.CourseTeacher;
import com.xuecheng.content.service.CourseTeacherService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import java.util.List;

/**
 * @author TaoYaopc
 * @version v1.0
 * @description 师资信息管理
 * @date 2023/5/30 15:34
 */
@Api(value = "师资信息管理接口", tags = "师资信息管理接口")
@RestController
public class CourseTeacherController {

    @Resource
    private CourseTeacherService courseTeacherService;

    @ApiOperation("课程师资信息查询")
    @GetMapping("/courseTeacher/list/{courseId}")
    public List<CourseTeacher> list(@PathVariable Long courseId) {
        
        return courseTeacherService.queryCourseTeacherList(courseId);
    }
}

2️⃣ Service 接口定义

package com.xuecheng.content.service;

import com.xuecheng.content.model.po.CourseTeacher;

import java.util.List;

/**
 * @author TaoYaopc
 * @version v1.0
 * @description 师资信息管理
 * @date 2023/5/30 15:36
 */
public interface CourseTeacherService {

    /**
     * 查询课程所有师资信息
     * @param courseId 课程id
     * @return 师资信息 list
     */
    List<CourseTeacher> queryCourseTeacherList(Long courseId);

}

3️⃣ ServiceImpl 实现类

package com.xuecheng.content.service.impl;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.xuecheng.base.Exception.XueChengPlusException;
import com.xuecheng.content.mapper.CourseTeacherMapper;
import com.xuecheng.content.model.po.CourseTeacher;
import com.xuecheng.content.service.CourseTeacherService;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import java.util.List;

/**
 * @author TaoYaopc
 * @version v1.0
 * @description 师资信息管理
 * @date 2023/5/30 15:36
 */
@Service
public class CourseTeacherServiceImpl implements CourseTeacherService {

    @Resource
    private CourseTeacherMapper courseTeacherMapper;

    @Override
    public List<CourseTeacher> queryCourseTeacherList(Long courseId) {
        return courseTeacherMapper.selectList(
                new LambdaQueryWrapper<CourseTeacher>().eq(CourseTeacher::getCourseId, courseId));
    }

}

9.3.3 添加教师

添加教师请求示例

post  /courseTeacher

请求参数：
{
  "courseId": 75,
  "teacherName": "王老师",
  "position": "教师职位",
  "introduction": "教师简介"
}
响应结果：
{"id":24,"courseId":75,"teacherName":"王老师","position":"教师职位","introduction":"教师简介","photograph":null,"createDate":null}

1️⃣接口定义：Controller

@ApiOperation("添加/修改教师信息")
@PostMapping("/courseTeacher")
public CourseTeacher modifyCourseTeacher(@RequestBody @Validated CourseTeacher courseTeacher) {

    return courseTeacherService.updateCourseTeacher(courseTeacher);
}

2️⃣ Service 接口定义

/**
     * 修改/添加老师
     * @param courseTeacher 老师信息
     * @return 老师信息
     */
CourseTeacher updateCourseTeacher(CourseTeacher courseTeacher);

3️⃣ ServiceImpl 实现类

@Override
public CourseTeacher updateCourseTeacher(CourseTeacher courseTeacher) {
    if (courseTeacher.getId() == null) {
        // 添加操作
        int insert = courseTeacherMapper.insert(courseTeacher);
        if (insert <= 0) {
            XueChengPlusException.cast("添加教师失败");
        }
    } else {
        // 修改操作
        int i = courseTeacherMapper.updateById(courseTeacher);
        if (i <= 0) {
            XueChengPlusException.cast("修改教师失败");
        }
    }

    return courseTeacherMapper.selectOne(new LambdaQueryWrapper<CourseTeacher>().eq(CourseTeacher::getTeacherName, courseTeacher.getTeacherName()));
}

9.3.4 修改教师

修改教师请求示例

put /courseTeacher
请求参数：
{
  "id": 24,
  "courseId": 75,
  "teacherName": "王老师",
  "position": "教师职位",
  "introduction": "教师简介",
  "photograph": null,
  "createDate": null
}
响应：
{"id":24,"courseId":75,"teacherName":"王老师","position":"教师职位","introduction":"教师简介","photograph":null,"createDate":null}

1️⃣接口定义：Controller

@ApiOperation("添加/修改教师信息")
@PostMapping("/courseTeacher")
public CourseTeacher modifyCourseTeacher(@RequestBody @Validated CourseTeacher courseTeacher) {

    return courseTeacherService.updateCourseTeacher(courseTeacher);
}

2️⃣ Service 接口定义

/**
     * 修改/添加老师
     * @param courseTeacher 老师信息
     * @return 老师信息
     */
CourseTeacher updateCourseTeacher(CourseTeacher courseTeacher);

3️⃣ ServiceImpl 实现类

@Override
public CourseTeacher updateCourseTeacher(CourseTeacher courseTeacher) {
    if (courseTeacher.getId() == null) {
        // 添加操作
        int insert = courseTeacherMapper.insert(courseTeacher);
        if (insert <= 0) {
            XueChengPlusException.cast("添加教师失败");
        }
    } else {
        // 修改操作
        int i = courseTeacherMapper.updateById(courseTeacher);
        if (i <= 0) {
            XueChengPlusException.cast("修改教师失败");
        }
    }

    return courseTeacherMapper.selectOne(new LambdaQueryWrapper<CourseTeacher>().eq(CourseTeacher::getTeacherName, courseTeacher.getTeacherName()));
}

4️⃣

9.3.5 删除教师

删除教师请求示例

delete /ourseTeacher/course/75/26

75:课程id
26:教师id，即course_teacher表的主键
请求参数：课程id、教师id

响应：状态码200，不返回信息

1️⃣接口定义：Controller

@ApiOperation("删除教师信息")
@DeleteMapping("/courseTeacher/course/{courseId}/{teacherId}")
public void modifyCourseTeacher(@PathVariable Long courseId, @PathVariable Long teacherId) {

    courseTeacherService.deleteCourseTeacher(courseId, teacherId);
}

2️⃣ Service 接口定义

void deleteCourseTeacher(Long courseId, Long teacherId);

3️⃣ ServiceImpl 实现类

@Override
public void deleteCourseTeacher(Long courseId, Long teacherId) {
    int delete = courseTeacherMapper.delete(new LambdaQueryWrapper<CourseTeacher>()
                                            .eq(CourseTeacher::getId, teacherId).eq(CourseTeacher::getCourseId, courseId));
    if (delete <= 0) {
        XueChengPlusException.cast("删除教师失败");
    }
}

9.3.6 接口测试

1、添加教师

2、查询教师

3、修改教师

4、删除教师

9.4 删除课程

9.4.1 需求分析

课程的审核状态为未提交时方可删除。

删除课程需要删除课程相关的基本信息、营销信息、课程计划、课程教师信息。

9.4.2 接口定义

delete  /course/87
87为课程id
请求参数：课程id
响应：状态码200，不返回信息

1️⃣接口定义：Controller

@ApiOperation("删除课程")
@DeleteMapping("/course/{courseId}")
public void deleteCourse(@PathVariable Long courseId) {

    courseBaseInfoService.deleteCourse(courseId);
}

2️⃣ Service 接口定义

/**
     * 删除课程
     * @param courseId 课程id
     */
void deleteCourse(Long courseId);

3️⃣ ServiceImpl 实现类

@Transactional
@Override
public void deleteCourse(Long courseId) {
    // 判断课程提交状态，未提交才可删除，202002
    CourseBase courseBase = courseBaseMapper.selectById(courseId);
    if(!"202002".equals(courseBase.getAuditStatus())) {
        XueChengPlusException.cast("无法删除，请检查课程审核状态！");
    }

    // 删除课程基本信息：course_base
    courseBaseMapper.deleteById(courseId);

    // 删除课程营销信息：course_market
    courseMarketMapper.deleteById(courseId);

    // 删除课程教师信息：course_teacher
    courseTeacherMapper.delete(new LambdaQueryWrapper<CourseTeacher>()
                               .eq(CourseTeacher::getCourseId, courseId));

    // 删除课程计划：teachplan
    teachplanMapper.delete(new LambdaQueryWrapper<Teachplan>()
                           .eq(Teachplan::getCourseId, courseId));

    // 删除课程计划媒资信息：teachplan_media
    teachplanMediaMapper.delete(new LambdaQueryWrapper<TeachplanMedia>()
                                .eq(TeachplanMedia::getCourseId, courseId));

    // 删除课程计划作业信息：teachplan_work
}

9.4.3 接口测试

找到一门课程进行删除，删除后从数据库确认课程基本信息、课程营销信息、课程计划、课程计划关联信息、课程师资是否删除成功。