栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Springboot+@RestControllerAdvice导致swagger无法访问

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Springboot+@RestControllerAdvice导致swagger无法访问

系统增加了@RestControllerAdvice异常处理,后来发现所有的JSP页面和swagger都无法访问了,后来发现是配置出错,只需要把多余的配置注释就OK。

#错误配置信息
#如果增加下面的配置,那么所有的页面都会被拦截
# dont't open,because swagger doc is 404
#spring.mvc.throw-exception-if-no-handler-found=true
#spring.web.resources.add-mappings=false

下面是@RestControllerAdvice异常配置教程。

1、增加ExceptionController.java,这个异常只处理@Controller的日志,例如是JSP项目。

package cn.renkai721.exception;


import cn.renkai721.util.MsgUtil;
import cn.renkai721.util.MyConstants;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@ControllerAdvice
@Slf4j
public class ExceptionController {

    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public String exceptionHandler(Exception e){
        // 处理全局异常,所有的Controller中不能自己try catch,必须抛出由系统处理
        // 如果需要自己处理的,那么错误日志也需要自己打印或throw出错误消息
        // 获取异常信息,记录日志
        StackTraceElement stackTraceElement = e.getStackTrace()[0];
        String className = stackTraceElement.getClassName();
        String fileName = stackTraceElement.getFileName();
        int lineNumber = stackTraceElement.getLineNumber();
        String methodName = stackTraceElement.getMethodName();

        log.error("类名={},文件名={},行数={},方法名={}", className, fileName, lineNumber, methodName);
        // 这里是自定义的统一返回格
        log.error("Exception={}",e);
        return MsgUtil.outJson(MyConstants.FAILURE);
    }
}

2、增加ExceptionRestController.java,这个异常只处理@RestController的日志,例如是常规的springboot项目或JSP项目中的API REST接口。

package cn.renkai721.exception;


import cn.renkai721.util.MsgUtil;
import cn.renkai721.util.MyConstants;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;


@RestControllerAdvice
@Slf4j
public class ExceptionRestController {

    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public String exceptionHandler(Exception e){
        // 处理全局异常,所有的Controller中不能自己try catch,必须抛出由系统处理
        // 如果需要自己处理的,那么错误日志也需要自己打印或throw出错误消息
        // 获取异常信息,记录日志
        StackTraceElement stackTraceElement = e.getStackTrace()[0];
        String className = stackTraceElement.getClassName();
        String fileName = stackTraceElement.getFileName();
        int lineNumber = stackTraceElement.getLineNumber();
        String methodName = stackTraceElement.getMethodName();

        log.error("类名={},文件名={},行数={},方法名={}", className, fileName, lineNumber, methodName);
        // 这里是自定义的统一返回格
        log.error("Exception={}",e);
        return MsgUtil.outJson(MyConstants.FAILURE);
    }
}

3、写一个接口用于测试。注意,我们所有的异常都统一处理后,Controller中不要再try catch啦,如果要try catch那么自己需要把日志手动log.error("e={}",e),否则控制台输出的日志或后台打印的日志中是无法看到的。测试访问该接口,在服务器的控制台就能看到错误消息了。

@ApiIgnore
@RequestMapping(value = "/testWrong", method = RequestMethod.GET)
@ResponseBody
public String testWrong() {
// 注意,我们所有的异常都统一处理后,Controller中不要再try catch啦,如果要try catch那么自己需要把日志手动log.error("e={}",e),否则控制台输出的日志或后台打印的日志中是无法看到的。
  int i=1/0;
  return MsgUtil.outJsonSuccess();
}

4、logback-spring.xml文件



	
	

	
	
		
			${CUSTOM_LOG_PATTERN}
		
	
	
		logs/myproject.log
		
			
			logs/myproject.%d{yyyy-MM-dd}.log
			
			30
		
		
			${CUSTOM_LOG_PATTERN}
		
	
	
		logs/myproject-warn.log
		
			WARN
		
		
			
			logs/myproject-warn.%d{yyyy-MM-dd}.log
			
			30
		
		
			${CUSTOM_LOG_PATTERN}
		
	
	
		
			
				%d{HH:mm:ss.SSS} [%thread] %-5level logger_name:%logger{36} - [%thread] - message:%msg%n
			
		
	
    
	
		
		
		
		
	
    
	
		
		
		
		
	

5.pom文件中增加以下依赖

		
			org.apache.skywalking
			apm-toolkit-logback-1.x
			8.7.0
		

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/981665.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号