.net core異常中間件的使用

更新時(shí)間：2021年06月16日 09:33:29 作者：不問前世

本文主要簡(jiǎn)單介紹一下異常中間件的使用，學(xué)習(xí).net core的同學(xué)可以了解下本文

正文

if (env.IsDevelopment())
{
	app.UseDeveloperExceptionPage();
}

這樣寫入中間件哈，那么在env環(huán)境下就會(huì)去執(zhí)行UseDeveloperExceptionPage。

public static IApplicationBuilder UseDeveloperExceptionPage(this IApplicationBuilder app)
{
	if (app == null)
	{
		throw new ArgumentNullException(nameof(app));
	}

	return app.UseMiddleware<DeveloperExceptionPageMiddleware>();
}

那么我們應(yīng)該去看DeveloperExceptionPageMiddleware中間件哈。

那么這里介紹它是如何能夠捕獲其他中間件的異常的哈。

里面的invoke:

其實(shí)它的操作是很簡(jiǎn)單的，直接在外面套了try catch。

里面的異常處理怎么處理的可以直接去看DeveloperExceptionPageMiddleware 中間件，里面的操作也比較簡(jiǎn)單處理。

測(cè)試:

[HttpGet]
public int GetService([FromServices]ISelfService selfService)
{
	throw new System.Exception("錯(cuò)誤");
	return 1;
}

結(jié)果:

因?yàn)樯厦嬲f了，這個(gè)是dev環(huán)境下，那么生產(chǎn)環(huán)境不能直接給用戶看到錯(cuò)誤信息。

正式環(huán)境:

app.UseExceptionHandler("/error");

將錯(cuò)誤轉(zhuǎn)移到/error 處理。具體UseExceptionHandler細(xì)節(jié)篇里面介紹，有許多可以借鑒的地方。

[ApiController]
[Route("[controller]")]
public class ErrorController : Controller
{
	public ILogger<ErrorController> _logger;
	public ErrorController(ILogger<ErrorController> logger)
	{
		this._logger = logger;
	}

	public IActionResult Index()
	{
		var exceptionHandlerPathFeature = HttpContext.Features.Get<IExceptionHandlerPathFeature>();

		var ex = exceptionHandlerPathFeature?.Error;

		var knownException = ex as IKnownException;

		if (knownException == null)
		{
			_logger.LogError(ex, ex.Message);
			knownException = KnownException.Unknow;
		}
		else
		{
			knownException = KnownException.FromKnowException(knowException);
		}

		return View(knownException);
	}
}

視圖:

<html>
<head>

</head>
<body>
<div>
    錯(cuò)誤碼: @Model.ErrorCode
</div>
<div>
    錯(cuò)誤信息: @Model.Message
</div>
</body>
</html>

IKnownException:

public interface IKnownException
{
	public string Message { get; }

	public int ErrorCode { get; }

	public object[] ErrorData { get; }
}

KnownException:

public class KnownException : IKnownException
{
	public string Message
	{
		get; private set;
	}

	public int ErrorCode
	{
		get; private set;
	}

	public object[] ErrorData
	{
		get;
		private set;
	}

	public readonly static IKnownException Unknow = new KnownException { Message = "未知錯(cuò)誤", ErrorCode = 99 };

	public static IKnownException FromKnowException(IKnownException Exception)
	{
		return new KnownException{Message = Exception.Message, ErrorCode = Exception.ErrorCode, ErrorData = Exception.ErrorData};
	}
}

測(cè)試1：

[HttpGet]
public int GetService([FromServices]ISelfService selfService)
{
	throw new System.Exception("錯(cuò)誤");
	return 1;
}

這種屬于未知異常，結(jié)果:

現(xiàn)在弄一個(gè)支付異常:

public class PayErrorException : Exception, IKnownException
{
	public PayErrorException(string message, int errorCode, params object[] errorData): base(message)
	{
		this.ErrorCode = errorCode;
		this.ErrorData = errorData;
	}

	public int ErrorCode { get;private set; }

	public object[] ErrorData { get;private set; }
}

測(cè)試2:

[HttpGet]
public int GetService([FromServices]ISelfService selfService)
{

	throw new PayErrorException("支付錯(cuò)誤",405,null);
	return 1;
}

將異常處理放入到中間件分支中。

app.UseExceptionHandler(errApp =>
{
	errApp.Run(async context =>
	{
		var exceptionHandlerPathFeature = context.Features.Get<IExceptionHandlerPathFeature>();
		IKnownException knownException = exceptionHandlerPathFeature.Error as IKnownException;
		if (knownException == null)
		{
			var logger = context.RequestServices.GetService<ILogger<MyExceptionFilterAttribute>>();
			logger.LogError(exceptionHandlerPathFeature.Error, exceptionHandlerPathFeature.Error.Message);
			knownException = KnownException.Unknown;
			context.Response.StatusCode = StatusCodes.Status500InternalServerError;
		}
		else
		{
			knownException = KnownException.FromKnownException(knownException);
			context.Response.StatusCode = StatusCodes.Status200OK;
		}
		var jsonOptions = context.RequestServices.GetService<IOptions<JsonOptions>>();
		context.Response.ContentType = "application/json; charset=utf-8";
		await context.Response.WriteAsync(System.Text.Json.JsonSerializer.Serialize(knownException, jsonOptions.Value.JsonSerializerOptions));
	});
});

效果一樣就不演示了。如果是已知異常錯(cuò)誤碼應(yīng)該為200，一個(gè)是500異常是系統(tǒng)無法處理，系統(tǒng)錯(cuò)誤，但是已知錯(cuò)誤是屬于系統(tǒng)正常處理。另一個(gè)是監(jiān)控系統(tǒng)，認(rèn)為報(bào)500錯(cuò)誤，是會(huì)持續(xù)放出系統(tǒng)警告。

還有一種局部異常，只在mvc中生效，而不是全局生效:

public class MyExceptionFilter : IExceptionFilter
{
	public void OnException(ExceptionContext context)
	{
		IKnownException knownException = context.Exception as IKnownException;
		if (knownException == null)
		{
			var logger = context.HttpContext.RequestServices.GetService<ILogger<MyExceptionFilterAttribute>>();
			logger.LogError(context.Exception, context.Exception.Message);
			knownException = KnownException.Unknown;
			context.HttpContext.Response.StatusCode = StatusCodes.Status500InternalServerError;
		}
		else
		{
			knownException = KnownException.FromKnownException(knownException);
			context.HttpContext.Response.StatusCode = StatusCodes.Status200OK;
		}
		context.Result = new JsonResult(knownException)
		{
			ContentType = "application/json; charset=utf-8"
		};
	}
}

在mvc 中注冊(cè):

services.AddMvc(mvcOptions =>
{
	mvcOptions.Filters.Add<MyExceptionFilter>();
}).AddJsonOptions(jsonOptions =>
{
	jsonOptions.JsonSerializerOptions.Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping;
});

最后介紹一種，只作用于某個(gè)控制器，或者action:

public class MyExceptionFilterAttribute : ExceptionFilterAttribute
{
	public override void OnException(ExceptionContext context)
	{
		IKnownException knownException = context.Exception as IKnownException;
		if (knownException == null)
		{
			var logger = context.HttpContext.RequestServices.GetService<ILogger<MyExceptionFilterAttribute>>();
			logger.LogError(context.Exception, context.Exception.Message);
			knownException = KnownException.Unknown;
			context.HttpContext.Response.StatusCode = StatusCodes.Status500InternalServerError;
		}
		else
		{
			knownException = KnownException.FromKnownException(knownException);
			context.HttpContext.Response.StatusCode = StatusCodes.Status200OK;
		}
		context.Result = new JsonResult(knownException)
		{
			ContentType = "application/json; charset=utf-8"
		};
	}
}

查看一下ExceptionFilterAttribute頭部:

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
public abstract class ExceptionFilterAttribute : Attribute, IAsyncExceptionFilter, IExceptionFilter, IOrderedFilter

上面標(biāo)志了可以放于類上也可以放于方法上。所以可以放至在controller上，也可以action上，看需求了。