文章目录

一、讲师查询功能
二、讲师逻辑删除功能
三、配置Swagger2
四、统一返回结果对象
- - 1、统一返回数据格式
  - 2、统一结果返回类
  - 3、统一返回结果的使用
五、讲师分页查询
六、讲师条件查询带分页
七、自动填充封装
八、讲师添加功能
九、讲师修改功能
十、统一异常处理
十一、统一日志处理
- - 1、配置日志级别
  - 2、Logback日志

一、讲师查询功能

1、编写查询 controller 代码内容

@RestController
@RequestMapping("/eduservice/teacher")
public class EduTeacherController {@Autowiredprivate EduTeacherService eduTeacherService;// 查询讲师列表所有数据// 使用restful风格@GetMapping("findAll")public List<EduTeacher> findAll(){List<EduTeacher> list = eduTeacherService.list(null);return list;}  
}

2、创建配置类，配置mapper扫描和其他

@Configuration
@MapperScan("com.kuang.eduservice.mapper")
public class EduConfig {
}

3、配置SQL执行性能分析插件

/*** SQL 执行性能分析插件* 开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长*/
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();performanceInterceptor.setMaxTime(1000);//ms，超过此处设置的ms则sql不执行performanceInterceptor.setFormat(true);return performanceInterceptor;
}

4、创建主启动类

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

5、测试启动

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

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

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

在application.yml中设置:

spring:jackson:date-format: yyyy-MM-dd HH:mm:sstime-zone: GMT+8

二、讲师逻辑删除功能

1、配置逻辑删除插件

 //逻辑删除组件
@Bean
public ISqlInjector sqlInjector(){return new LogicSqlInjector();
}

2、逻辑删除属性上面添加注解

@TableLogic
private Boolean isDeleted;

3、编写Controller删除方法

//逻辑删除讲师方法
@DeleteMapping("removeById/{id}")
public boolean removeById(@PathVariable String id){boolean flag = eduTeacherService.removeById(id);return flag;
}

4、如何测试

借助一些工具进行测试

swagger测试（重点）：生成在线的接口文档，方便接口测试。
postman（了解）

三、配置Swagger2

1、创建common模块—在guli_parent下创建common

2、引入相关依赖

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><scope>provided </scope></dependency><!--mybatis-plus--><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><scope>provided </scope></dependency><!--lombok用来简化实体类：需要安装lombok插件--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><scope>provided </scope></dependency><!--swagger--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><scope>provided </scope></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><scope>provided </scope></dependency><!-- redis --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId></dependency><!-- spring2.X集成redis所需common-pool2<dependency><groupId>org.apache.commons</groupId><artifactId>commons-pool2</artifactId><version>2.6.0</version></dependency>-->
</dependencies>

3、创建swagger的配置类

在common下面创建子模块service_base, 并在该模块创建swagger的配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket webApiConfig(){return new Docket(DocumentationType.SWAGGER_2).groupName("webApi").apiInfo(webApiInfo()).select().paths(Predicates.not(PathSelectors.regex("/admin/.*"))).paths(Predicates.not(PathSelectors.regex("/error.*"))).build();}private ApiInfo webApiInfo(){return new ApiInfoBuilder().title("网站-课程中心API文档").description("本文档描述了课程中心微服务接口定义").version("1.0").contact(new Contact("lxy", "www.baidu.com", "2422737092@qq.com")).build();}
}

4、Swagger2具体使用

在service_edu引入service_base依赖
最后在service_edu启动类上添加注解，设置包扫描规则

访问测试: http://localhost:8001/swagger-ui.html

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

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

@Api(description = "讲师管理")
@RestController
@RequestMapping("/eduservice/teacher")
public class EduTeacherController {@Autowiredprivate EduTeacherService eduTeacherService;// 查询讲师列表所有数据// 使用restful风格@ApiOperation(value = "所有讲师列表")@GetMapping("findAll")public List<EduTeacher> findAll(){List<EduTeacher> list = eduTeacherService.list(null);return list;}//逻辑删除讲师方法@ApiOperation(value = "逻辑删除讲师")@DeleteMapping("{id}")public boolean removeById(@ApiParam(name = "id", value = "讲师ID",required = true)@PathVariable String id){boolean flag = eduTeacherService.removeById(id);return flag;}
}

四、统一返回结果对象

1、统一返回数据格式

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

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

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

携带数据成功

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

携带数据成功(分页)

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

无返回数据成功

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

无返回数据失败

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

因此，我们统一结果

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

2、统一结果返回类

在common模块下创建子模块common_utils
创建接口定义返回码—创建包 com.rg.commonutils，创建接口 ResultCode

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

创建结果类—创建 R 类

@Data
public class R {@ApiModelProperty(value = "是否成功")private Boolean success;@ApiModelProperty(value = "返回码")private Integer code;@ApiModelProperty(value = "返回消息")private String message;@ApiModelProperty(value = "返回数据")private Map <String, Object> data = new HashMap <String, Object>();private R(){}  //构造方法私有化. 目的:禁止随意new 方法,只能使用我们定义的方法.public static R ok(){//定义成功方法R r = new R();r.setSuccess(true);r.setCode(ResultCode.SUCCESS);r.setMessage("成功");return r;//为了链式编程}public static R error(){//定义失败方法R r = new R();r.setSuccess(false);r.setCode(ResultCode.ERROR);r.setMessage("失败");return r;//为了链式编程}//自定义属性的相关方法(带链式编程功能)public R success(Boolean success){this.setSuccess(success);return this;}public R message(String message){this.setMessage(message);return this;}public R code(Integer code){this.setCode(code);return this;}public R data(String key, Object value){this.data.put(key, value);return this;}public R data(Map<String,Object> map){this.setData(map);return this;}}

3、统一返回结果的使用

在service模块中添加依赖—common_utils
修改Controller中的返回结果

//1.查询讲师所有数据  使用Rest风格..
@ApiOperation("所有讲师列表")
@GetMapping("findAll")
public List <EduTeacher> findAll() {List <EduTeacher> eduTeacherList = eduTeacherService.list(null);return eduTeacherList;
}//2.通过id逻辑删除讲师
@ApiOperation("根据ID删除讲师")
@DeleteMapping("removeById/{id}")
public R removeById(@ApiParam(name = "id", value = "讲师ID", required = true) @PathVariable String id) {boolean flag = eduTeacherService.removeById(id);if (flag) {return R.ok();} else {return R.error();}
}

五、讲师分页查询

1、EduConfig中配置分页插件

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

2、EduTeacherController中添加分页方法

//3.分页查询讲师
@ApiOperation("分页查询讲师")
@GetMapping("pageList/{current}/{limit}")
public R pageList(@ApiParam(name = "current", value = "当前页码", required = true)@PathVariable("current") Integer current,@ApiParam(name = "limit", value = "每页记录数", required = true)@PathVariable("limit") Integer limit) {Page <EduTeacher> page = new Page <>(current, limit);//进行分页查询eduTeacherService.page(page, null);//最后这些属性既可以通过page也可以通过iPage获取,因为分页后的数据会被重新封装到这些对象里面.// Map <String, Object> map = new HashMap <>();// map.put("total",page.getTotal());// map.put("rows", page.getRecords());// return R.ok().data(map);return R.ok().data("total", page.getTotal()).data("rows", page.getRecords());
}

六、讲师条件查询带分页

要求:根据讲师名称name，讲师头衔level、讲师入驻时间查询

1、创建查询对象

创建com.rg.eduservice.entiy.vo包，创建TeacherQuery类查询对象

@ApiModel(value = "Teacher查询对象",description = "讲师查询对象封装")
@Data
public class TeacherQuery implements Serializable {private static final long serialVersionUID = 1L;@ApiModelProperty(value = "教师名称,模糊查询")private String name;@ApiModelProperty(value = "头衔 1高级讲师 2首席讲师")private Integer level;@ApiModelProperty(value = "查询开始时间", example = "2019-01-01 10:10:10")private String begin;@ApiModelProperty(value = "查询结束时间", example = "2019-12-01 10:10:10")private String end;
}

2、编写controller

//4.根据条件查询讲师
@ApiOperation("根据条件查询讲师")
@PostMapping("pageQuery/{current}/{limit}") //@RequestBody: 通过json传递数据,把数据封装到对象中. json数据只能封装到请求体中,所以就需要用到POST请求
public R pageQuery(@ApiParam(name = "current", value = "当前页码", required = true)@PathVariable("current") Integer current,@ApiParam(name = "limit", value = "每页记录数", required = true)@PathVariable("limit") Integer limit,@ApiParam(name = "teacherQuery",value = "查询条件",required = false) @RequestBody(required = false) TeacherQuery teacherQuery){//required = false,表示条件可有可无Page <EduTeacher> page = 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();//mybatis我们学过动态sql,这里我们可以使用MP简化操作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_modified", end);}eduTeacherService.page(page, wrapper);//分页查询return R.ok().data("total", page.getTotal()).data("rows", page.getRecords());
}

七、自动填充封装

1、在service-base中创建自动填充类

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {//这里设置的是属性名称,而非字段名称this.setFieldValByName("gmtCreate", new Date(), metaObject);this.setFieldValByName("gmtModified", new Date(), metaObject);}@Overridepublic void updateFill(MetaObject metaObject) {this.setFieldValByName("gmtModified", new Date(), metaObject);}
}

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

八、讲师添加功能

1、在实体类添加自动填充注解

2.EduTeacherController中新增方法

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

3.Swagger中测试

九、讲师修改功能

1.EduTeacherController中新增方法

//6.根据讲师Id进行查询-->数据回显功能
@GetMapping("getById/{id}")
@ApiOperation("根据id查询讲师")
public R getById(@ApiParam(name = "id",value = "讲师ID",required = true) @PathVariable String id){EduTeacher eduTeacher = eduTeacherService.getById(id);return R.ok().data("teacher", eduTeacher);
}//7.讲师修改功能
@ApiOperation("修改讲师")
@PutMapping("updateById")
public R updateById(@ApiParam(name = "eduTeacher",value = "讲师信息",required = true) @RequestBody EduTeacher eduTeacher){boolean flag = eduTeacherService.updateById(eduTeacher);if(flag){return R.ok();}else{return R.error();}
}

十、统一异常处理

1.制造异常

int a = 10/0;

2.统一异常处理

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

@ControllerAdvice
public class GlobalExceptionHandler {//统一异常处理@ExceptionHandler(Exception.class)@ResponseBodypublic R error(Exception e){e.printStackTrace();return R.error();}
}

Swagger测试

3.处理特定异常

GlobalExceptionHandler中添加

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

Swagger

4.自定义异常

创建自定义异常类

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

添加异常处理方法

@ExceptionHandler(GuliException.class)
@ResponseBody
public R error(GuliException e){e.printStackTrace();return R.error().message(e.getMsg()).code(e.getCode());
}

业务中需要的位置抛出GuliException

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

Swagger测试

十一、统一日志处理

1、配置日志级别

日志记录器（Logger）的行为是分等级的。如下表所示：

分为：OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL

默认情况下，spring boot从控制台打印出来的日志级别只有INFO及以上级别，可以配置日志级别

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

2、Logback日志

spring boot内部使用Logback作为日志实现的框架。

Logback和log4j非常相似，如果你对log4j很熟悉，那对logback很快就会得心应手。

logback相对于log4j的一些优点：https://blog.csdn.net/caisini_vc/article/details/48551287

1.配置logback日志

删除application.properties中的日志配置

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

安装idea彩色日志插件：grep-console

resources 中创建 logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration  scan="true" scanPeriod="10 seconds"><!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 --><!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true --><!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 --><!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 --><contextName>logback</contextName><!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 --><property name="log.path" value="D:/guli_log/edu" /><!-- 彩色日志 --><!-- 配置格式变量：CONSOLE_LOG_PATTERN 彩色日志格式 --><!-- magenta:洋红 --><!-- boldMagenta:粗红--><!-- cyan:青色 --><!-- white:白色 --><!-- magenta:洋红 --><property name="CONSOLE_LOG_PATTERN"value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |%blue(%thread) |%blue(%file:%line) |%green(%logger) |%cyan(%msg%n)"/><!--输出到控制台--><appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"><!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息--><!-- 例如：如果此处配置了INFO级别，则后面其他位置即使配置了DEBUG级别的日志，也不会被输出 --><filter class="ch.qos.logback.classic.filter.ThresholdFilter"><level>INFO</level></filter><encoder><Pattern>${CONSOLE_LOG_PATTERN}</Pattern><!-- 设置字符集 --><charset>UTF-8</charset></encoder></appender><!--输出到文件--><!-- 时间滚动输出 level为 INFO 日志 --><appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 正在记录的日志文件的路径及文件名 --><file>${log.path}/log_info.log</file><!--日志文件输出格式--><encoder><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern><charset>UTF-8</charset></encoder><!-- 日志记录器的滚动策略，按日期，按大小记录 --><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 每天日志归档路径以及格式 --><fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern><timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"><maxFileSize>100MB</maxFileSize></timeBasedFileNamingAndTriggeringPolicy><!--日志文件保留天数--><maxHistory>15</maxHistory></rollingPolicy><!-- 此日志文件只记录info级别的 --><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>INFO</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter></appender><!-- 时间滚动输出 level为 WARN 日志 --><appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 正在记录的日志文件的路径及文件名 --><file>${log.path}/log_warn.log</file><!--日志文件输出格式--><encoder><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern><charset>UTF-8</charset> <!-- 此处设置字符集 --></encoder><!-- 日志记录器的滚动策略，按日期，按大小记录 --><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern><timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"><maxFileSize>100MB</maxFileSize></timeBasedFileNamingAndTriggeringPolicy><!--日志文件保留天数--><maxHistory>15</maxHistory></rollingPolicy><!-- 此日志文件只记录warn级别的 --><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>warn</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter></appender><!-- 时间滚动输出 level为 ERROR 日志 --><appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 正在记录的日志文件的路径及文件名 --><file>${log.path}/log_error.log</file><!--日志文件输出格式--><encoder><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern><charset>UTF-8</charset> <!-- 此处设置字符集 --></encoder><!-- 日志记录器的滚动策略，按日期，按大小记录 --><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern><timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"><maxFileSize>100MB</maxFileSize></timeBasedFileNamingAndTriggeringPolicy><!--日志文件保留天数--><maxHistory>15</maxHistory></rollingPolicy><!-- 此日志文件只记录ERROR级别的 --><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>ERROR</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter></appender><!--<logger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<logger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。name:用来指定受此logger约束的某一个包或者具体的某一个类。level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，如果未设置此属性，那么当前logger将会继承上级的级别。--><!--使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：第一种把<root level="INFO">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息第二种就是单独给mapper下目录配置DEBUG模式，代码如下，这样配置sql语句会打印，其他还是正常DEBUG级别：--><!--开发环境:打印控制台--><springProfile name="dev"><!--可以输出项目中的debug日志，包括mybatis的sql日志--><logger name="com.guli" level="INFO" /><!--root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，默认是DEBUG可以包含零个或多个appender元素。--><root level="INFO"><appender-ref ref="CONSOLE" /><appender-ref ref="INFO_FILE" /><appender-ref ref="WARN_FILE" /><appender-ref ref="ERROR_FILE" /></root></springProfile><!--生产环境:输出到文件--><springProfile name="pro"><root level="INFO"><appender-ref ref="CONSOLE" /><appender-ref ref="DEBUG_FILE" /><appender-ref ref="INFO_FILE" /><appender-ref ref="ERROR_FILE" /><appender-ref ref="WARN_FILE" /></root></springProfile></configuration>

2.将错误日志输出到文件

GlobalExceptionHandler.java 类上添加注解

 @Slf4j

在异常处理类中添加异常输出语句:

3.将日志堆栈信息输出到文件

上述的操作只能将错误信息的第一行输出到文件中,如果需要全部信息需要以下操作.

定义工具类

guli-framework-common下创建util包，创建ExceptionUtil.java工具类

public class ExceptionUtil {public static String getMessage(Exception e) {StringWriter sw = null;PrintWriter pw = null;try {sw = new StringWriter();pw = new PrintWriter(sw);// 将出错的栈信息输出到printWriter中e.printStackTrace(pw);pw.flush();sw.flush();} finally {if (sw != null) {try {sw.close();} catch (IOException e1) {e1.printStackTrace();}}if (pw != null) {pw.close();}}return sw.toString();}
}

调用

log.error(ExceptionUtil.getMessage(e));

GuliException中添加toString方法

ingProfile>

```