异常处理和swagger使用

news2024/12/29 9:10:43

全局异常处理类

定义全局异常处理类，会将错误全部提交到这个异常处理类中进行处理，这个类会将处理的统一结果响应给前端，如果不添加异常处理类，异常不会按照统一的响应格式进行，前端无法识别，当然也可以在每一个方法中捕获异常，只不过过于繁琐，不采用

处理流程图解：

@RestControllerAdvice注解：表示此类是异常处理器且@RestControllerAdvice = @ResponseBody + @ControllerAdvice，所以这个类中的方法的返回值会自动装换为json数据类型，响应回前端
@ExceptionHandler注解：表示这个方法能够处理的异常，例如：@ExceptionHandler(Exception.class)表示这个方法可以处理所有异常

import com.springmybatis.pojo.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

/**
 *  全局异常类
 */
@Slf4j
@RestControllerAdvice     // 该注解表示这个类是捕获异常的类
public class GlobalException {

    /**
     * 统一响应异常结果
     * @param exception 异常信息
     * @return 统一结果
     */
    @ExceptionHandler(Exception.class)  // 该注解表示接收所有异常信息
    public Result exceptionResult(Exception exception){
        exception.printStackTrace();
        log.info("出现异常");
        return Result.error("对不起，输入错误！");
    }
}

Swagger的介绍及使用

swagger官网：API Documentation & Design Tools for Teams | Swagger，swagger是开放阶段使用的框架，帮助后端后端人员进行后端的接口测试

直接使用swagger非常繁琐，这里使用Knife4j，Knife4j是为java MVC框架集成swagger生成Api文档的增强解决方案，对swagger进行封装，简化使用，可以生成接口文档，以及在线接口调试

使用方式：

1）导入knife4j的maven坐标：

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

2）创建配置类，加入knife4j的相关配置：

创建一个普通类继承WebMvcConfigurationSupport类就是knife4j配置类

  /**
     * 通过knife4j生成接口文档
     */
    @Bean // 由spring框架创建对象并管理对象
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("接口文档名称")
                .version("2.0")   // 版本号
                .description("描述信息（也可以是接口名）")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("要扫描的controller包"))// 如：com.sky.controller
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

3）设置静态资源的映射，否则静态接口文档的页面无法显示

  /**
     * 设置静态资源映射，重写WebMvcConfigurationSupport类中的addResourceHandlers方法
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

常用注解

通过注解可以控制生成的接口文档，使接口文档具有可读性

注解	说明
@Api	用在类上，例如Controller，表示对类的说明
@ApiModel	用在类上，一般是实体类，例如entry，DTO，VO
@ApiModelProperty	用在属性上，描述属性信息
@AipOperation	用在方法上，例如controller的方法，说明方法的用途和作用