springcloud在线教育项目01_讲师管理模块
前后端分离
:
一、准备工作
搭建环境
二、使用mp代码生成器
使用步骤:
1.在需要生成的项目的pom文件中添加依赖
<!-- velocity 模板引擎, Mybatis Plus 代码生成器需要 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
</dependency>
2.在测试模块添加代码生成器类,然后执行该类
package com.atguigu.demo;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.junit.Test;
public class CodeGenerator {
@Test
public void run() {
// 1、创建代码生成器
AutoGenerator mpg = new AutoGenerator();
// 2、全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
//代码输出目录 projectPath:获取项目的路径,绝对路径 service_edu项目的绝对路径
//E:\code_path\guli_parent\service\service_edu--E:\code_path\guli_parent\service\service_edu
//然后它会输出到service_edu项目的service_edu\src\main\java 下
gc.setOutputDir("E:\\code_path\\guli_parent\\service\\service_edu" + "/src/main/java");
gc.setAuthor("testjava");//注释作者
gc.setOpen(false); //生成后是否打开资源管理器
gc.setFileOverride(false); //重新生成时文件是否覆盖
gc.setServiceName("%sService"); //去掉Service接口的首字母I
gc.setIdType(IdType.ID_WORKER_STR); //主键策略
gc.setDateType(DateType.ONLY_DATE);//定义生成的实体类中日期类型
gc.setSwagger2(true);//开启Swagger2模式
mpg.setGlobalConfig(gc);
// 3、数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/guli?serverTimezone=GMT%2B8");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("abc123");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
// 4、包配置 com.atguigu.eduservice 然后下边就有controller、service。。。
PackageConfig pc = new PackageConfig();
pc.setParent("com.atguigu");
pc.setModuleName("eduservice"); //模块名
pc.setController("controller");
pc.setEntity("entity");
pc.setService("service");
pc.setMapper("mapper");
mpg.setPackageInfo(pc);
// 5、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("edu_teacher");//根据哪一个表生成
strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀
strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略
strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作
strategy.setRestControllerStyle(true); //restful api风格控制器
strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符
mpg.setStrategy(strategy);
// 6、执行
mpg.execute();
}
}
三、讲师模块
3.1 查询将是表中所有数据
1.创建controller
package com.atguigu.eduservice.controller;
import com.atguigu.eduservice.entity.EduTeacher;
import com.atguigu.eduservice.service.EduTeacherService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
/**
* <p>
* 讲师 前端控制器
* </p>
*
* @author testjava
* @since 2022-09-08
*/
@RestController//交给spring容器进行管理,且里边的内容返回Json数据
@RequestMapping("/eduservice/teacher")
public class EduTeacherController {
//把service注入
@Autowired
private EduTeacherService teacherService;
//1 查询所有讲师表数据
//rest风格
@GetMapping("findAll")
public List<EduTeacher> findAllTeacher(){
//调用service的方法,实现查询功能
List<EduTeacher> list = teacherService.list(null);
return list;
}
}
2.创建启动类
package com.atguigu.eduservice;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class EduApplication {
public static void main(String[] args) {
SpringApplication.run(EduApplication.class,args);
}
}
3.创建配置类
mapper接口没有实现类,需要配置扫描到接口
@Configuration
@MapperScan("com.atguigu.eduservice.mapper")
public class EduConfig {
}
4. 进行测试
启动主启动类,访问对应端口
3.2 讲师逻辑删除
- 配置逻辑删除插件到配置类中
- 去实体类中中对应的字段上加上@TableLogic注解
- controller写方法
//2.逻辑删除讲师的方法
@DeleteMapping("{id}")//id值需要通过路径进行传递
public boolean removeTeacher(@PathVariable String id){//得到路径中的值
boolean flag = teacherService.removeById(id);
return flag;
}
- 测试,需要借助工具–swagger、postman
- 创建公共模块整合swagger,为了所有的模块都能够使用;并在该模块下写一个swagger配置类
package com.atguigu.servicebase;
import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2//swagger注解
public class SwaggerConfig {
@Bean
public Docket webApiConfig(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.paths(Predicates.not(PathSelectors.regex("/admin/.*")))
.paths(Predicates.not(PathSelectors.regex("/error.*")))
.build();
}
private ApiInfo webApiInfo(){
return new ApiInfoBuilder()
.title("网站-课程中心API文档")
.description("本文档描述了课程中心微服务接口定义")
.version("1.0")
.contact(new Contact("Helen", "http://atguigu.com", "55317332@qq.com"))
.build();
}
}
6.如何在别的模块中使用swagger
在需要swagger模块字段pom文件中添加依赖
这个依赖是另一个模块的坐标和版本号,就是写了swagger配置类的模块
在使用swagger 的启动类总添加@ComponentScan(basePackages = “”);配置扫描策略,要扫描到有swagger配置类的包(不在一个模块中需要配置)
7.启动主启动类,访问swagger
3.3 统一返回数据格式
项目中我们会将响应封装成json返回,一般我们会将所有接口的数据格式统一, 使前端(iOS Android, Web)对数据的操作更一致、轻松。
一般情况下,统一返回数据格式没有固定的格式,只要能描述清楚返回的数据状态以及要返回的具体数据就可以。但是一般会包含状态码、返回消息、数据
这几部分内容
json数据格式:对象、数组{} []
{
"success": true,
"code": 20000,
"message": "成功",
"data": {}
}
- 在在公共项目中创建需要写返回统一数据格式的代码
- 创建interface接口,定义数据返回状态码2000成功;20001失败
- 具体定定义返回的数据格式:
创建统一返回结果的类,里面定义需要返回的信息
4.将写有统一返回结果类模块的坐标、版本等,写入到需要用到统一返回结果模块的pom文件中,添加依赖,模块就能够调用模块了
5.让接口中的返回值都是自己写的统一返回值类
3.4 讲师分页功能
- 配置mp分页插件,mp分页配置类
- 编写讲师分页接口方法
- 创建苞米豆的page对象,将分页信息写在参数中:当前页、每页显示的记录数
- 调用mp生成的代码进行查询
/**
* 分页查询讲师的方法
* current :当前页
* limit: 每页显示记录数
* @return
*/
@ApiOperation(value = "分页查询讲师")
@GetMapping("pageTeacher/{current}/{limit}")
public R pageListTeacher(@PathVariable long current,
@PathVariable long limit){
//创建page对象
Page<EduTeacher> pageTeacher = new Page<>(current,limit);
//调用方法实现分页
//方法调用时,底层封装,把分页所有数据封装到pageTeacher对象里面
teacherService.page(pageTeacher,null);
long total = pageTeacher.getTotal();//总记录数
List<EduTeacher> records = pageTeacher.getRecords();//数据list集合
return R.ok().data("total",total).data("rows",records);
}
3.5 讲师分页功能带条件
多条件查询组合查询带分页
- 把条件值传到接口里面(把条件值封装成对象,把对象传递到接口中-----vo)
- 根据条件值构建条件,用wrapper
- 调用方法进行查询
@RequestBody—post提交方式
@RequestBod(request = false)—>该条件值可以为空
使用json传数据,把json数据封装到对应的对象里
@RespondBody :返回json数据
/**
* 分页查询讲师的方法带条件
* current :当前页
* limit: 每页显示记录数
* @return
*/
@ApiOperation(value = "分页查询讲师带条件")
@GetMapping("pageTeacherCondition/{current}/{limit}")
public R pageTeacherCondition(@PathVariable long current,
@PathVariable long limit,
TeacherQuery teacherQuery){
//创建page对象
Page<EduTeacher> pageTeacher = new Page<>(current,limit);
//构造条件
QueryWrapper<EduTeacher> wrapper = new QueryWrapper<>();
//多条件组合查询
String name = teacherQuery.getName();
Integer level = teacherQuery.getLevel();
String begin = teacherQuery.getBegin();
String end = teacherQuery.getEnd();
//类似动态sql,判断条件值是否为空,如果不为空拼接条件
if (!StringUtils.isEmpty(name)){
//构建条件
wrapper.like("name",name);
}
if (!StringUtils.isEmpty(level)){
wrapper.eq("level",level);
}
if (!StringUtils.isEmpty(begin)){
//大于等于
wrapper.ge("gmt_create",begin);
}
if (!StringUtils.isEmpty(end)){
//小于等于
wrapper.le("gmt_create",end);
}
//调用方法实现分页
//方法调用时,底层封装,把分页所有数据封装到pageTeacher对象里面
teacherService.page(pageTeacher,wrapper);
long total = pageTeacher.getTotal();//总记录数
List<EduTeacher> records = pageTeacher.getRecords();//数据list集合
return R.ok().data("total",total).data("rows",records);
}
3.6 添加讲师接口开发
- 给创建时间修改时间添加自动填充注解@TableField(fill = FieldFill.INSERT_UPDATE)
- 写自动填充的类
package com.atguigu.servicebase.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
//属性名称,不是字段名称
this.setFieldValByName("gmtCreate", new Date(), metaObject);
this.setFieldValByName("gmtModified", new Date(), metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("gmtModified", new Date(), metaObject);
}
}
4.写添加讲师的controlelr
/**
* 添加讲师接口方法
* @return
*/
@ApiOperation("添加讲师")
@PostMapping("addTeacher")
public R addTeacher(@RequestBody EduTeacher eduTeacher){
boolean save = teacherService.save(eduTeacher);
if (save){
return R.ok();
}else {
return R.error();
}
}
3.7 讲师的修改功能
- 根据讲师id进行查询
- 实现讲师的根据id修改功能
3.8 统一异常处理
- 创建统一返回异常类
- 给异常类模块添加有统一返回结果R的模块依赖