net.guerlab.cloud.web.webmvc.autoconfigure.WebMvcGlobalExceptionHandlerAutoConfigure Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guerlab-cloud-web-webmvc Show documentation
The newest version!
/*
 * Copyright 2018-2025 guerlab.net and other contributors.
 *
 * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 3 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.gnu.org/licenses/lgpl-3.0.html
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.guerlab.cloud.web.webmvc.autoconfigure;

import java.util.ServiceLoader;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.SearchStrategy;
import org.springframework.boot.autoconfigure.web.servlet.error.AbstractErrorController;
import org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration;
import org.springframework.boot.autoconfigure.web.servlet.error.ErrorViewResolver;
import org.springframework.boot.web.servlet.error.ErrorAttributes;
import org.springframework.boot.web.servlet.error.ErrorController;
import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Bean;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import net.guerlab.cloud.commons.exception.handler.ResponseBuilder;
import net.guerlab.cloud.commons.exception.handler.StackTracesHandler;
import net.guerlab.cloud.web.core.autoconfigure.GlobalExceptionHandlerAutoConfigure;
import net.guerlab.cloud.web.core.exception.handler.GlobalExceptionLogger;
import net.guerlab.cloud.web.core.exception.handler.ThrowableResponseBuilder;
import net.guerlab.cloud.web.core.properties.GlobalExceptionProperties;
import net.guerlab.cloud.web.webmvc.exception.handler.WebMvcGlobalExceptionHandler;

/**
 * 异常统一处理配置自动配置.
 *
 * @author guer
 */
@Slf4j
@AutoConfiguration(before = ErrorMvcAutoConfiguration.class, after = GlobalExceptionHandlerAutoConfigure.class)
public class WebMvcGlobalExceptionHandlerAutoConfigure {

	/**
	 * 创建异常控制器.
	 *
	 * @param errorAttributes    errorAttributes
	 * @param errorViewResolvers errorViewResolvers
	 * @return 异常控制器
	 */
	@Bean
	@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
	public AbstractErrorController basicErrorController(ErrorAttributes errorAttributes,
			ObjectProvider errorViewResolvers) {
		log.debug("create CustomerErrorController");
		return new CustomerErrorController(errorAttributes, errorViewResolvers.orderedStream().toList());
	}

	/**
	 * 异常统一处理配置.
	 *
	 * @author guer
	 */
	@SuppressWarnings("unused")
	@RestControllerAdvice
	public static class DefaultWebMvcGlobalExceptionHandler extends WebMvcGlobalExceptionHandler {

		/**
		 * 初始化异常统一处理配置.
		 *
		 * @param messageSource             messageSource
		 * @param stackTracesHandler        堆栈处理
		 * @param globalExceptionLogger     全局异常处理日志记录器
		 * @param defaultBuilder            通用异常处理
		 * @param globalExceptionProperties 全局异常处理配置
		 */
		public DefaultWebMvcGlobalExceptionHandler(MessageSource messageSource,
				StackTracesHandler stackTracesHandler,
				GlobalExceptionLogger globalExceptionLogger,
				ThrowableResponseBuilder defaultBuilder,
				GlobalExceptionProperties globalExceptionProperties) {
			super(messageSource, stackTracesHandler, globalExceptionLogger,
					ServiceLoader.load(ResponseBuilder.class).stream().map(ServiceLoader.Provider::get)
							.toList(), defaultBuilder, globalExceptionProperties);
		}
	}
}