创建父工程
创建父工程 edu-parent，删除 src 目录
添加 packaging 配置为 pom，并将 spring-boot-starter 改为 spring-boot-starter-web
添加依赖管理（管理公共依赖的 jar 包的版本）
创建子模块
选择 sprint 的方式或者 maven 额创建都可以，但是推荐使用 maven 的方式，因为这样可以选择关联父工程。
创建启动类
package com.yanrs.me;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class EduTeacherApplication {
public static void main(String[] args) {
SpringApplication.run(EduTeacherApplication.class, args);
}
}
添加配置文件
# 服务端口
server.port=8001
# 服务名
spring.application.name=ude-teacher
# 环境设置：dev、test、prod
spring.profiles.active=dev
# mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/edu?characterEncoding=utf-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
添加依赖
<dependencies>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- velocity 模板引擎, Mybatis Plus 代码生成器需要 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
</dependency>
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>
<!--lombok用来简化实体类：需要安装lombok插件-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--开发者工具-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
</dependency>
</dependencies>
代码生成器
package com.yanrs.edu.teacher;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.junit.Test;
/**
* @author
* @since 2018/12/13
*/
public class CodeGenerator {
@Test
public void run() {
// 1、创建代码生成器
AutoGenerator mbg = new AutoGenerator();
// 2、全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("rex"); // 代码作者 -----------------------【根据实际情况修改】 -----------------------
gc.setOpen(false); //生成后是否打开资源管理器
gc.setFileOverride(false); //重新生成时文件是否覆盖
gc.setServiceName("%sService"); //去掉Service接口的首字母I, 不添加名称类似于 IUserService
gc.setIdType(IdType.ID_WORKER); //主键策略
gc.setDateType(DateType.ONLY_DATE); //如果数据库中字段是日期类型，那么生成的实体类中的属性也是日期类型
gc.setSwagger2(true); //开启Swagger2模式
mbg.setGlobalConfig(gc);
// 3、数据源配置 -----------------------【根据实际情况修改】 -----------------------
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://127.0.0.1:3306/edu");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
dsc.setDbType(DbType.MYSQL);
mbg.setDataSource(dsc);
// 4、包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("teacher"); // -----------------------【根据实际情况修改】 -----------------------
pc.setParent("com.yanrs.edu"); // setModuleName 和 setParent 的值合起来为完成的包路径 com.yanrs.edu -----------------------【根据实际情况修改】 -----------------------
pc.setController("controller"); // 在 com.yanrs.edu 下生成 controller 包
pc.setEntity("entity"); // 在 com.yanrs.edu 下生成 entity 包
pc.setService("service"); // 在 com.yanrs.edu 下生成 service 包
pc.setMapper("mapper"); // 在 com.yanrs.edu 下生成 mapper 包
mbg.setPackageInfo(pc);
// 5、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("edu_teacher"); // 数据库表的名称， 如果是多个表 strategy.setInclude("表1", "表2"); -----------------------【根据实际情况修改】 -----------------------
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中驼峰转连字符
mbg.setStrategy(strategy);
// 6、执行
mbg.execute();
}
}
运行后就能在对应的包下生成对应的代码
接口开发-获取所有讲师
开发一个接口，测试项目是否能运行。
package com.yanrs.edu.teacher.controller;
import com.yanrs.edu.teacher.entity.Teacher;
import com.yanrs.edu.teacher.service.TeacherService;
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 rex
* @since 2020-06-14
*/
@RestController
@RequestMapping("/edu/teacher")
public class TeacherController {
// 注入 TeacherService
@Autowired
private TeacherService teacherService;
// 查询所有讲师
@GetMapping
public List<Teacher> getAllTeacher() {
return teacherService.list(null);
}
}
默认的返回中，时间的显示都是带有时区的，可以在配置文件中进行配置，让其返回正常的时间格式。
# 时间显示
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8
接口开发 - 讲师删除
实体类中添加为逻辑删除字段添加 TableLogic 注解
@TableLogic
@ApiModelProperty(value = "逻辑删除 1（true）已删除， 0（false）未删除")
private Boolean isDeleted;
配置类中添加逻辑删除插件
package com.yanrs.edu.teacher.config;
import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@Configuration
@EnableTransactionManagement
@MapperScan("com.yanrs.edu.teacher.mapper")
public class EduTeacherConfig {
/**
* 逻辑删除
* @return
*/
@Bean
public ISqlInjector iSqlInjector(){
return new LogicSqlInjector();
}
}
controller 中添加删除方法
// 删除讲师
@DeleteMapping("{id}")
public Boolean deleteTeacherById(@PathVariable("id") String id) {
return teacherService.removeById(id);
}
配置 Swagger2
确认引入了 swagger 的依赖，新建 Swagger 配置类
package com.yanrs.edu.teacher.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket webApiConfig(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.build();
}
private ApiInfo webApiInfo(){
return new ApiInfoBuilder()
.title("网站-讲师管理API文档")
.description("本文档描述了讲师管理微服务接口定义")
.version("1.0")
.contact(new Contact("jack", "http://atguigu.com", "[email protected]"))
.build();
}
}
创建公共模块
封装统一返回, 创建统一返回枚举类
package com.yanrs.edu.common;
// 定义返回数据中使用的状态码
public enum ResponseCode {
SUCCESS(90000, "成功"),
FAIL(30010, "成功"),
ERROR(30011, "错误"),
NOT_FOUND(30012, "资源未找到"),
NOT_AUTHED(30013, "无权限，访问拒绝"),
PARAM_INVAILD(30014, "提交参数非法");
private Integer code;
private String message;
public Integer getCode() {
return code;
}
public String getMessage() {
return message;
}
public void setCode(Integer code) {
this.code = code;
}
public void setMessage(String message) {
this.message = message;
}
ResponseCode(Integer code, String message) {
this.code = code;
this.message = message;
}
}
创建统一返回类
package com.yanrs.edu.common;
import lombok.Data;
import java.util.HashMap;
import java.util.Map;
// 定义具体的数据返回格式
@Data
public class R {
private Boolean success;
private Integer code;
private String message;
private Map<String, Object> data = new HashMap<>();
//操作成功，调用这个方法，返回成功的数据
public static R success() {
R r = new R();
r.setSuccess(true);
r.setCode(ResponseCode.SUCCESS.getCode());
r.setMessage("操作成功");
return r;
}
//操作失败，调用这个方法，返回失败的数据
public static R fail() {
R r = new R();
r.setSuccess(false);
r.setCode(ResponseCode.FAIL.getCode());
r.setMessage("操作失败");
return r;
}
//使用链式编程
public R success(Boolean success) {
this.setSuccess(success);
return this;
}
public R message(String message) {
this.setMessage(message);
return this;
}
public R code(Integer code) {
this.setCode(code);
return this;
}
public R data(String key, Object value) {
this.data.put(key, value);
return this;
}
public R data(Map<String, Object> map) {
this.setData(map);
return this;
}
}
在其他子工程中，引入 common 的依赖
<!--common 依赖 -->
<dependency>
<groupId>com.yanrs.me</groupId>
<artifactId>edu-common</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
接口开发-讲师分页查询
controller
// 分页查询讲师列表
@GetMapping("/list/{currentPage}/{pageSize}")
public R getPageTeacher(@PathVariable("currentPage") Integer currentPage, @PathVariable("pageSize") Integer pageSize) {
Page<Teacher> teacherPage = new Page<>(currentPage, pageSize);
teacherService.page(teacherPage, null);
return R.success().data("total", teacherPage.getTotal()).data("items", teacherPage.getRecords());
}
还要在配置类中配置分页插件，不然 total 值为空
/**
* 分页插件
* @return
*/
@Bean
public PaginationInterceptor paginationInterceptor(){
return new PaginationInterceptor();
}
接口开发-讲师条件查询且分页
controller
// 分页多条件查询讲师列表
@GetMapping("/condition/{currentPage}/{pageSize}")
public R getConditionPageTeacher(@PathVariable("currentPage") Integer currentPage, @PathVariable("pageSize") Integer pageSize, TeacherListReqVo teacherListReqVo) {
Page<Teacher> teacherPage = new Page<>(currentPage, pageSize);
teacherService.getTeacherListByCondition(teacherPage, teacherListReqVo);
return R.success().data("total", teacherPage.getTotal()).data("items", teacherPage.getRecords());
}
接口开发 - 讲师新增
新建 AddTeacherReqVo
package com.yanrs.edu.teacher.entity.vo;
import lombok.Data;
@Data
public class AddTeacherReqVo {
private String name;
private String intro;
private Integer level;
private String career;
private String avatar;
private Integer sort;
private Boolean isDeleted;
}
Controller 中
// 添加讲师
@PostMapping
public R addTeacher(@RequestBody AddTeacherReqVo addTeacherReqVo) {
Teacher teacher = new Teacher();
BeanUtils.copyProperties(addTeacherReqVo, teacher);
boolean save = teacherService.save(teacher);
if (save) {
return R.success().data("teacher", teacher);
} else {
return R.fail();
}
}
还需在实体类上设置 gmtCreate 和 gmtModified 字段的自动填充
package com.yanrs.edu.teacher.entity;
import com.baomidou.mybatisplus.annotation.*;
import java.util.Date;
import java.io.Serializable;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;
/**
* <p>
* 讲师
* </p>
*
* @author rex
* @since 2020-06-14
*/
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("edu_teacher")
@ApiModel(value="Teacher对象", description="讲师")
public class Teacher implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty(value = "讲师ID")
@TableId(value = "id", type = IdType.ID_WORKER_STR)
private String id;
@ApiModelProperty(value = "讲师姓名")
private String name;
@ApiModelProperty(value = "讲师资历,一句话说明讲师")
private String intro;
@ApiModelProperty(value = "讲师简介")
private String career;
@ApiModelProperty(value = "头衔 1高级讲师 2首席讲师")
private Integer level;
@ApiModelProperty(value = "讲师头像")
private String avatar;
@ApiModelProperty(value = "排序")
private Integer sort;
@TableLogic
@ApiModelProperty(value = "逻辑删除 1（true）已删除， 0（false）未删除")
private Boolean isDeleted;
@ApiModelProperty(value = "创建时间")
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;
@ApiModelProperty(value = "更新时间")
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;
}
新建 MybatisPlusMetaHandler 类继承 MetaObjectHandler 用于处理自动填充。这里特别要注意⚠️字段名称不是数据库中的，而是实体类中的。
package com.yanrs.edu.teacher.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 MybatisPlusMetaHandler 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);
}
}
接口开发 - 讲师修改
新建 UpdateTeacherReqVo 继承自 AddTeacherReqVo
package com.yanrs.edu.teacher.entity.vo;
import lombok.Data;
@Data
public class UpdateTeacherReqVo extends AddTeacherReqVo{
}
controller 中
// 根据 ID 修改讲师信息
@PutMapping("{id}")
public R updateTeacherById(@PathVariable("id") String id, @RequestBody UpdateTeacherReqVo updateTeacherReqVo) {
Teacher teacher = new Teacher();
BeanUtils.copyProperties(updateTeacherReqVo, teacher);
teacher.setId(id);
boolean update = teacherService.updateById(teacher);
if (update) {
return R.success().data("teacher", teacher);
} else {
return R.fail();
}
}
统一异常处理
在 handler 中新建 GlobalExceptionHandler 类，用于进行统一异常处理，当发生异常的时候就能捕捉到
package com.yanrs.edu.teacher.handler;
import com.yanrs.edu.common.R;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
@ControllerAdvice
public class GlobalExceptionHandler {
/**
* 捕捉全局异常
* @param e
* @return
*/
@ExceptionHandler(Exception.class)
@ResponseBody
public R error(Exception e){
e.printStackTrace();
return R.error();
}
/**
* 处理特定异常
* @param e
* @return
*/
// 特定异常处理 ArithmeticException
@ExceptionHandler(ArithmeticException.class)
@ResponseBody
public R error(ArithmeticException e){
e.printStackTrace();
return R.error().message("除数不能为 0");
}
}
自定义异常
新建 EduException 类，继承 RuntimeException，类中有两个属性 code 和 message
package com.yanrs.edu.teacher.handler;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
/**
* 自定义异常
*/
@Data
@AllArgsConstructor
@NoArgsConstructor
public class EduException extends RuntimeException{
private Integer code; // 状态码
private String message; // 错误描述信息
}
在 GlobalExceptionHandler 对 EduException 进行处理，当发生 EduException 的时候，接口返回相关信息
package com.yanrs.edu.teacher.handler;
import com.yanrs.edu.common.R;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
@ControllerAdvice
public class GlobalExceptionHandler {
/**
* 捕捉全局异常
* @param e
* @return
*/
@ExceptionHandler(Exception.class)
@ResponseBody
public R error(Exception e){
e.printStackTrace();
return R.error();
}
/**
* 处理特定异常
* @param e
* @return
*/
// 特定异常处理 ArithmeticException
@ExceptionHandler(ArithmeticException.class)
@ResponseBody
public R error(ArithmeticException e){
e.printStackTrace();
return R.error().message("除数不能为 0");
}
/**
* 处理自定义异常
* @param e
* @return
*/
@ExceptionHandler(EduException.class)
@ResponseBody
public R error(EduException e){
e.printStackTrace();
return R.error().message(e.getMessage()).code(e.getCode());
}
}
在需要使用的时候加上自定义异常即可
// 根据 ID 修改讲师信息
@PutMapping("{id}")
public R updateTeacherById(@PathVariable("id") String id, @RequestBody UpdateTeacherReqVo updateTeacherReqVo) {
// 没有 updateTeacherReqVo 抛出异常
if (updateTeacherReqVo==null){
throw new EduException(ResponseCode.PARAM_INVAILD.getCode(), ResponseCode.PARAM_INVAILD.getMessage());
}
Teacher teacher = new Teacher();
BeanUtils.copyProperties(updateTeacherReqVo, teacher);
teacher.setId(id);
boolean update = teacherService.updateById(teacher);
if (update) {
return R.success().data("teacher", teacher);
} else {
return R.fail();
}
}
