谷粒学院（三）讲师管理模块(后端) | swagger | 统一日志 | 统一返回结果

最新推荐文章于 2023-12-07 15:30:55 发布
最新推荐文章于 2023-12-07 15:30:55 发布
阅读量596 收藏 2
点赞数 2
文章标签： javaee 微服务
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/LXYDSF/article/details/122851692
版权

文章目录

一、讲师查询功能

1、编写查询 controller 代码内容

@RestController
@RequestMapping("/eduservice/teacher")
public class EduTeacherController {

    @Autowired
    private 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

image-20220209163704103

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

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

image-20220209163722053

在application.yml中设置:

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

image-20220209164001693

二、讲师逻辑删除功能

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 {

    @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("lxy", "www.baidu.com", "2422737092@qq.com"))
                .build();
    }
}

4、Swagger2具体使用

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

image-20220209164823045

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

image-20220209165236912

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

  • 定义在类上：@Api
  • 定义在方法上：@ApiOperation
  • 定义在参数上：@ApiParam
@Api(description = "讲师管理")
@RestController
@RequestMapping("/eduservice/teacher")
public class EduTeacherController {

    @Autowired
    private 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;
    }
}

image-20220209165711925

四、统一返回结果对象

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 {

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

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("gmtModified", new Date(), metaObject);
    }
}

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

image-20220209220733010

八、讲师添加功能

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

image-20220208104928695

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中测试

image-20220208104350519

九、讲师修改功能

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;

img

2.统一异常处理

  • 在service-base中创建统一异常处理类GlobalExceptionHandler.java：
@ControllerAdvice
public class GlobalExceptionHandler {

    //统一异常处理
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e){
        e.printStackTrace();
        return R.error();
    }
}
  • Swagger测试

img

3.处理特定异常

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

img

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测试

img

十一、统一日志处理

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

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

image-20220208160844656

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>

```

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

GlobalExceptionHandler.java 类上添加注解

 @Slf4j

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

image-20220208160844656

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方法
爱编程的大李子
关注
  • 2
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
c# swagger 笔记二
鲸码的博客
07-24 957
1.添加接口注释 效果图： 2.汉化步骤 第一步：添加js文件 js文件的代码 /// /// 中文转换 /// var SwaggerTranslator = (function () { //定时执行检测是否转换成中文,最多执行500次 即500*50/1000=25s var iexcute = 0, //中
guli_school_java:尚硅谷谷粒学院项目 后端代码
04-08
guli_school_java 尚硅谷谷粒学院项目 后端代码
谷粒学院-第二天-Swagger
m0_56054652的博客
09-07 329
一、Swagger2介绍 前后端分离开发模式中，api文档是最好的沟通方式。 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 1. 及时性 (接口变更后，能够及时准确地通知相关前后端开发人员) 2. 规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息) 3. 一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧) 4. 可...
谷粒学院-第二天笔记
weixin_38867113的博客
11-17 673
谷粒学院-第二天笔记一、项目结构guli-parent：在线教学根目录(父工程)，管理四个子模块：子模块1：​canal-client：canal数据库表同步模块（统计同步数据）​子模块2：common：公共模块父节点子模块3：infrastructure：基础服务模块父节点子模块4：service：api接口服务父节点二、创建工程1.创建父工程2.读入数据总结 一、项目结构 guli-parent：在线教学根目录(父工程)，管理四个子模块： 子模块1：​canal-client：canal数据库表同步模
谷粒学院-整合Swagger进行接口测试
兴趣是最好的老师
03-19 824
一、Swagger2介绍 前后端分离开发模式中，api文档是最好的沟通方式。 Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的Web服务。 及时性(接口变更后，能够及时准确地通知相关前后端开发人员) 规范性(并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息) 一致性(接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧) 可测性(直接在接口文档上进行测试，以方便理解业务) 二、配置Swagger2 1、创建co...
尚硅谷谷粒学院学习笔记2--讲师相关内容，整合swagger，统一返回结果
dyk
10-04 538
讲师相关内容编写eduteacher后台管理api接口查询所有逻辑删除讲师跨域配置整合swagger2创建common模块在common中引入相关依赖在模块service-base中，创建swagger的配置类在模块service模块中引入service-base在service-edu启动类上添加注解swagger访问地址统一返回数据格式在common模块下创建子模块common-utils创建接口定义返回码创建统一结果返回类统一返回结果使用在service模块中添加common_utils依赖修改Con
Python库 | swagger-codegen-0.1.26.tar.gz
03-10
Swagger Codegen 是一个开源项目，它允许开发人员根据OpenAPI规范（之前称为Swagger）自动生成客户端库、服务器 stubs 和 API 文档。这个资源是针对Python的版本，具体为 Swagger Codegen 的0.1.26版，打包成`.tar....
Python库 | swagger-coverage-2.1.3.tar.gz
05-22
资源分类：Python库 所属语言：Python 资源全名：swagger-coverage-2.1.3.tar.gz 资源来源：官方 安装方法：https://lanzao.blog.csdn.net/article/details/101784059
Python库 | swagger-bundler-0.1.9.tar.gz
03-10
Swagger-Bundler是一个Python库，主要用于处理与Swagger相关的任务，它在开发过程中扮演着重要的角色，尤其是在构建RESTful API文档和接口测试方面。Swagger是一个流行的开放API规范，它使用JSON格式来定义和描述Web...
PyPI 官网下载 | swagger_tester-0.2.6.tar.gz
02-02
Swagger Tester 是一个Python库，主要用于测试基于Swagger（OpenAPI）规范的API接口。这个库的版本为0.2.6，可以从Python Package Index (PyPI)官网下载，它以`.tar.gz`格式提供，这是一种常见的源码压缩包格式。...
Python库 | swagger_to-1.1.0.tar.gz
05-22
资源分类：Python库 所属语言：Python 资源全名：swagger_to-1.1.0.tar.gz 资源来源：官方 安装方法：https://lanzao.blog.csdn.net/article/details/101784059
swagger统一返回对象没有展示名称
你就像甜甜的益达
06-11 5005
我们使用的统一返回对象 然后swagger里面展示的一直是这样: 没有将data里面数据展示出来,后来细看,发现没有加泛型,加上泛型: 解决: 我们只需要将返回实体类上面加上对应注解即可: @ApiModelProperty(value = "主键", example = "1") ...
SpringBoot整合Swagger与统一返回结果问题
傅老师的博客
07-08 2285
写此博客，以此留念，解决了因使用统一返回结果对象导致，swagger-ui看不到返回对象属性注释的原因。（没有使用泛型导致） Springboot统一结果返回对象 @Data @ApiModel("统一API响应结果封装") public class DataResult<T> { /**操作结果 0为成功*/ @ApiModelProperty("操作结果 0为成功") private int status = 200; /**错误co...
c# swagger 笔记一
鲸码的博客
07-24 732
参考网上的一些教程总有些坑需要爬 一.使用nuget包获取Swashbule、swagger的包并安装。 我使用vs2013怎么就获取不了呢，此路不通只有另外走其他的 Swashbuckle 是一个开源项目，为使用 ASP.NET Core MVC 构建的 Web APIs 生成 Swagger 文档。Swagger 是一个机器可读的 RESTful API 表现层，它可以
统一返回结果R
qq_45100361的博客
01-02 438
//同意返回结果 @Data public class R { //这个注解是swagger的注解 @ApiModelProperty(value = "是否成功") private Boolean success; @ApiModelProperty(value = "返回码") private Integer code; @ApiModelProperty(value = "返回消息") private String message;
IDEA配置Swagger+统一返回数据嵌套展示信息(不被拦截器拦截处理)
最新发布
withme977的博客
12-07 1293
Swagger UI接口文档及相应字段展示&接口文档不被拦截直接访问
SpringBoot11、12整合swagger与统一返回处理
qq_45800365的博客
10-21 257
SpringBoot学习笔记
谷粒学苑--接口文档详细说明、技术&问题总结
xiaoxin的博客
08-22 571
xiaoxin课堂接口文档及详细说明
谷粒学院-MySQL高级教程
fy588268的博客
11-06 845
课程介绍 MySQL是目前常用的关系型数据库管理系统，在WEB应用方面 MySQL 也是目前很好的 RDBMS 应用软件之一。随着淘宝去IOE(去除IBM小型机、Oracle数据库及EMC存储设备)化的推进，MySQL 数据库在当前的互联网应用中变得越来越重要，本教程主要讲授针对 Java 开发所需的 MySQL 高级知识，课程中会让大家快速掌握索引，如何避免索引失效，索引的优化策略，了解inn...
前端如何连接后端的swagger
05-27
前端可以通过以下步骤连接后端的Swagger： 1. 在后端使用Swagger工具生成API文档和API定义文件。 2. 将API定义文件提供给前端开发人员使用。 3. 在前端项目中安装Swagger UI组件。可以使用npm或者直接下载Swagger...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

爱编程的大李子

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值