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;
/**
 * @ClassName: ExceptionControllerAdvice
 * @Description:
 * @author: renkai721@163.com
 * @date: 2022年06月10日 9:14 下午
 */
@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;

/**
 * @ClassName: ExceptionControllerAdvice
 * @Description:
 * @author: renkai721@163.com
 * @date: 2022年06月10日 9:14 下午
 */
@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文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds">
	<property name="CUSTOM_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread]%logger -%msg%n"/>
	<include resource="org/springframework/boot/logging/logback/base.xml"/>

	<!-- 控制台设置 -->
	<appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>${CUSTOM_LOG_PATTERN}</pattern>
		</encoder>
	</appender>
	<appender name="ROLLING-FILE-INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<file>logs/myproject.log</file>
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<!-- daily rollover -->
			<fileNamePattern>logs/myproject.%d{yyyy-MM-dd}.log</fileNamePattern>
			<!-- 保留30天的历史日志 -->
			<maxHistory>30</maxHistory>
		</rollingPolicy>
		<encoder>
			<pattern>${CUSTOM_LOG_PATTERN}</pattern>
		</encoder>
	</appender>
	<appender name="ROLLING-FILE-WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<file>logs/myproject-warn.log</file>
		<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
			<level>WARN</level>
		</filter>
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<!-- daily rollover -->
			<fileNamePattern>logs/myproject-warn.%d{yyyy-MM-dd}.log</fileNamePattern>
			<!-- 保留30天的历史日志 -->
			<maxHistory>30</maxHistory>
		</rollingPolicy>
		<encoder>
			<pattern>${CUSTOM_LOG_PATTERN}</pattern>
		</encoder>
	</appender>
	<appender name="grpc-log" class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.log.GRPCLogClientAppender">
		<encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
			<layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.mdc.TraceIdMDCPatternLogbackLayout">
				<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level logger_name:%logger{36} - [%thread] - message:%msg%n</pattern>
			</layout>
		</encoder>
	</appender>
    <!-- additivity="false" 解决控制台输出重复日志 -->
	<logger name="cn.renkai721" level="DEBUG" additivity="false">
		<appender-ref ref="ROLLING-FILE-INFO"/>
		<appender-ref ref="ROLLING-FILE-WARN"/>
		<appender-ref ref="consoleAppender"/>
		<appender-ref ref="grpc-log"/>
	</logger>
    <!-- additivity="false" 解决控制台输出重复日志 -->
	<logger name="org.springframework" level="ERROR" additivity="false">
		<appender-ref ref="ROLLING-FILE-INFO"/>
		<appender-ref ref="ROLLING-FILE-WARN"/>
		<appender-ref ref="consoleAppender"/>
		<appender-ref ref="grpc-log"/>
	</logger>
</configuration>

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

		<dependency>
			<groupId>org.apache.skywalking</groupId>
			<artifactId>apm-toolkit-logback-1.x</artifactId>
			<version>8.7.0</version>
		</dependency>