|
|
|
|
@ -11,15 +11,15 @@ ABP提供了用于处理Web应用程序异常的标准模型.
|
|
|
|
|
|
|
|
|
|
当满足下面**任意一个条件**时,`AbpExceptionFilter` 会处理此异常:
|
|
|
|
|
|
|
|
|
|
* 当**controller action**方法返回类型是**object**(不是view)并有异常抛出时.
|
|
|
|
|
* 当是一个请求为AJAX(Http请求头中`X-Requested-With`为`XMLHttpRequest`)时.
|
|
|
|
|
* 当**controller action**方法返回类型是**object result**(而不是view result)并有异常抛出时.
|
|
|
|
|
* 当一个请求为AJAX(Http请求头中`X-Requested-With`为`XMLHttpRequest`)时.
|
|
|
|
|
* 当客户端接受的返回类型为`application/json`(Http请求头中`accept` 为`application/json`)时.
|
|
|
|
|
|
|
|
|
|
如果异常被处理过,则会自动**记录日志**并将格式化的**JSON消息**返回给客户端.
|
|
|
|
|
|
|
|
|
|
#### 异常消息格式
|
|
|
|
|
#### 错误消息格式
|
|
|
|
|
|
|
|
|
|
每个异常消息都是`RemoteServiceErrorResponse` 类的实例.下面是一个只有 **Message** 属性的错误JSON:
|
|
|
|
|
每个错误消息都是`RemoteServiceErrorResponse` 类的实例.最简单的错误JSON只有一个 **Message** 属性,如下所示:
|
|
|
|
|
|
|
|
|
|
````json
|
|
|
|
|
{
|
|
|
|
|
@ -29,11 +29,11 @@ ABP提供了用于处理Web应用程序异常的标准模型.
|
|
|
|
|
}
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
当异常发生时,会自动填充到这些**可选字段**.
|
|
|
|
|
其它**可选字段**可以根据已发生的异常来填充.
|
|
|
|
|
|
|
|
|
|
##### 错误代码
|
|
|
|
|
|
|
|
|
|
错误的 **Code** 是字符串类型,并要求唯一的可选属性.如果抛出的异常包含 **Code** 属性,那么应该实现`IHasErrorCode` 接口,来填充这个字段.示例JSON如下:
|
|
|
|
|
错误 **代码(code)** 是异常信息中一个有唯一值并可选的字符串值.抛出的异常应实现`IHasErrorCode` 接口来填充该字段.示例JSON如下:
|
|
|
|
|
|
|
|
|
|
````json
|
|
|
|
|
{
|
|
|
|
|
@ -44,11 +44,11 @@ ABP提供了用于处理Web应用程序异常的标准模型.
|
|
|
|
|
}
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
错误 **Code** 同样可用于异常的本地化及自定义HTTP状态代码(请参阅下面的相关部分).
|
|
|
|
|
错误代码同样可用于异常信息的本地化及自定义HTTP状态代码(请参阅下面的相关部分).
|
|
|
|
|
|
|
|
|
|
##### 错误详细信息
|
|
|
|
|
|
|
|
|
|
错误的 **Details** 是可选属性.抛出的异常应该实现`IHasErrorDetails` 接口来填充这个字段.示例JSON如下:
|
|
|
|
|
错误的 **详细信息(Details)** 是可选属性.抛出的异常应实现`IHasErrorDetails` 接口来填充该字段.示例JSON如下:
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
@ -62,7 +62,7 @@ ABP提供了用于处理Web应用程序异常的标准模型.
|
|
|
|
|
|
|
|
|
|
##### 验证错误
|
|
|
|
|
|
|
|
|
|
当抛出的异常继承至`IHasValidationErrors` 接口时,返回错误对象会包含一个可选属性**validationErrors** .示例JSON如下:
|
|
|
|
|
当抛出的异常实现`IHasValidationErrors` 接口时,**validationErrors**是一个可被填充的标准字段.示例JSON如下:
|
|
|
|
|
|
|
|
|
|
````json
|
|
|
|
|
{
|
|
|
|
|
@ -85,7 +85,7 @@ ABP提供了用于处理Web应用程序异常的标准模型.
|
|
|
|
|
|
|
|
|
|
#### 日志
|
|
|
|
|
|
|
|
|
|
自动记录捕获异常的日志.
|
|
|
|
|
被捕获的异常会被自动记录到日志中.
|
|
|
|
|
|
|
|
|
|
##### 日志级别
|
|
|
|
|
|
|
|
|
|
@ -102,7 +102,7 @@ public class MyException : Exception, IHasLogLevel
|
|
|
|
|
|
|
|
|
|
##### 异常自定义日志
|
|
|
|
|
|
|
|
|
|
某些异常类型可能需要记录额外日志信息.可以通过实现`IExceptionWithSelfLogging` 来记录指定日志,例如:
|
|
|
|
|
某些异常类型可能需要记录额外日志信息.可以通过实现`IExceptionWithSelfLogging` 接口来记录指定日志,例如:
|
|
|
|
|
|
|
|
|
|
````C#
|
|
|
|
|
public class MyException : Exception, IExceptionWithSelfLogging
|
|
|
|
|
@ -114,7 +114,7 @@ public class MyException : Exception, IExceptionWithSelfLogging
|
|
|
|
|
}
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
> 扩展方法`ILogger.LogException` 用来记录日志. 在需要时可以使用相同的扩展方法.
|
|
|
|
|
> 扩展方法`ILogger.LogException` 用来记录异常日志. 在需要时可以使用相同的扩展方法.
|
|
|
|
|
|
|
|
|
|
### 业务异常
|
|
|
|
|
|
|
|
|
|
@ -140,9 +140,9 @@ throw new BusinessException(QaErrorCodes.CanNotVoteYourOwnAnswer);
|
|
|
|
|
Volo.Qa:010002
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
`Volo.Qa`在这是作为`code-namespace`. `code-namespace` 同样可以在异常 **本地化** 中使用.
|
|
|
|
|
`Volo.Qa`在这是作为`code-namespace`. `code-namespace` 同样可以在 **本地化** 异常信息时使用.
|
|
|
|
|
|
|
|
|
|
* 你可以直接抛出一个 `BusinessException` 异常或者自定义的异常.
|
|
|
|
|
* 你可以直接抛出一个 `BusinessException` 异常,或者需要时可以从该类派生你自己的Exception类型.
|
|
|
|
|
* 对于`BusinessException` 类型,其所有属性都是可选的.但是通常会设置`ErrorCode`或`Message`属性.
|
|
|
|
|
|
|
|
|
|
### 异常本地化
|
|
|
|
|
@ -153,7 +153,7 @@ Volo.Qa:010002
|
|
|
|
|
|
|
|
|
|
如果异常实现了 `IUserFriendlyException` 接口,那么ABP不会修改 `Message`和`Details`属性,而直接将它发送给客户端.
|
|
|
|
|
|
|
|
|
|
`UserFriendlyException` 类默认实现了 `IUserFriendlyException` 接口,示例如下:
|
|
|
|
|
`UserFriendlyException` 类是内建的 `IUserFriendlyException` 接口的实现,示例如下:
|
|
|
|
|
|
|
|
|
|
````C#
|
|
|
|
|
throw new UserFriendlyException(
|
|
|
|
|
@ -167,7 +167,7 @@ throw new UserFriendlyException(
|
|
|
|
|
throw new UserFriendlyException(_stringLocalizer["UserNameShouldBeUniqueMessage"]);
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
再在本地化资源的语言中添加对应的定义.例如:
|
|
|
|
|
再在本地化资源中为每种语言添加对应的定义.例如:
|
|
|
|
|
|
|
|
|
|
````json
|
|
|
|
|
{
|
|
|
|
|
@ -178,7 +178,7 @@ throw new UserFriendlyException(_stringLocalizer["UserNameShouldBeUniqueMessage"
|
|
|
|
|
}
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
**string localizer** 是支持格式化参数.例如
|
|
|
|
|
**string localizer** 支持参数化信息.例如
|
|
|
|
|
|
|
|
|
|
````C#
|
|
|
|
|
throw new UserFriendlyException(_stringLocalizer["UserNameShouldBeUniqueMessage", "john"]);
|
|
|
|
|
@ -192,12 +192,12 @@ throw new UserFriendlyException(_stringLocalizer["UserNameShouldBeUniqueMessage"
|
|
|
|
|
|
|
|
|
|
* `IUserFriendlyException`接口派生自`IBusinessException`,而 `UserFriendlyException `类派生自`BusinessException`类.
|
|
|
|
|
|
|
|
|
|
#### 错误代码
|
|
|
|
|
#### 使用错误代码
|
|
|
|
|
|
|
|
|
|
`UserFriendlyException`很好用,但是在一些高级用法里面,它存在以下问题:
|
|
|
|
|
|
|
|
|
|
* 在抛出异常的地方必须注入**string localizer** 来实现本地化 .
|
|
|
|
|
* 但是,在某些情况下,**可能注入不了string localizer**(比如,静态方法或实体中)
|
|
|
|
|
* 但是,在某些情况下,**可能注入不了string localizer**(比如,在静态上下文或实体方法中)
|
|
|
|
|
|
|
|
|
|
那么这时就可以通过使用 **错误代码** 的方式来处理本地化,而不是在抛出异常的时候.
|
|
|
|
|
|
|
|
|
|
@ -210,7 +210,7 @@ services.Configure<ExceptionLocalizationOptions>(options =>
|
|
|
|
|
});
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
再使用本地化资源,来本地化`Volo.Qa`命名空间下的所有异常. 本地化资源中应包含对应错误代码的文本. 例如:
|
|
|
|
|
然后`Volo.Qa`命名空间下的所有异常都将被对应的本地化资源进行本地化处理. 本地化资源中应包含对应错误代码的文本. 例如:
|
|
|
|
|
|
|
|
|
|
````json
|
|
|
|
|
{
|
|
|
|
|
@ -227,12 +227,12 @@ services.Configure<ExceptionLocalizationOptions>(options =>
|
|
|
|
|
throw new BusinessException(QaDomainErrorCodes.CanNotVoteYourOwnAnswer);
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
* 所有实现`IHasErrorCode` 接口的异常都具有相同的行为.因此,对错误代码的本地化,并不是`BusinessException`类所特有的.
|
|
|
|
|
* 错误消息的本地化文本的并不是必须. 如果未定义,ABP会将默认的错误消息发送给客户端. 而并不是发送异常的`Message`属性. 如果你想要发送异常的`Message`,使用`UserFriendlyException`(或使用实现`IUserFriendlyException`接口的异常类型)
|
|
|
|
|
* 抛出所有实现`IHasErrorCode` 接口的异常都具有相同的行为.因此,对错误代码的本地化,并不是`BusinessException`类所特有的.
|
|
|
|
|
* 为错误消息定义本地化文本并不是必须的. 如果未定义,ABP会将默认的错误消息发送给客户端. 而不使用异常的`Message`属性. 如果你想要发送异常的`Message`,使用`UserFriendlyException`(或使用实现`IUserFriendlyException`接口的异常类型)
|
|
|
|
|
|
|
|
|
|
##### 使用消息的格式化参数
|
|
|
|
|
|
|
|
|
|
如果错误消息包含格式化参数时,则可以使用异常的`Data`属性进行设置.例如:
|
|
|
|
|
如果有参数化的错误消息,则可以使用异常的`Data`属性进行设置.例如:
|
|
|
|
|
|
|
|
|
|
````C#
|
|
|
|
|
throw new BusinessException("App:010046")
|
|
|
|
|
@ -263,9 +263,9 @@ throw new BusinessException("App:010046")
|
|
|
|
|
}
|
|
|
|
|
````
|
|
|
|
|
|
|
|
|
|
* `WithData` 支持链式调用 (如`.WithData(...).WithData(...)`).
|
|
|
|
|
* `WithData` 支持有多个参数的链式调用 (如`.WithData(...).WithData(...)`).
|
|
|
|
|
|
|
|
|
|
### HTTP状态代码 映射
|
|
|
|
|
### HTTP状态代码映射
|
|
|
|
|
|
|
|
|
|
ABP尝试按照以下规则,自动映射常见的异常类型的HTTP状态代码:
|
|
|
|
|
|
|
|
|
|
@ -297,6 +297,6 @@ services.Configure<ExceptionHttpStatusCodeOptions>(options =>
|
|
|
|
|
|
|
|
|
|
- 当用户没有权限执行操作时,会抛出 `AbpAuthorizationException` 异常. 有关更多信息,请参阅授权文档(TODO:link).
|
|
|
|
|
- 如果当前请求的输入无效,则抛出`AbpValidationException 异常`. 有关更多信息,请参阅授权文档(TODO:link).
|
|
|
|
|
- 如果请求的实体不存在,则抛出`EntityNotFoundException` 异常. 此异常由 [repositories](Repositories.md) 抛出.
|
|
|
|
|
- 如果请求的实体不存在,则抛出`EntityNotFoundException` 异常. 此异常大多数由 [repositories](Repositories.md) 抛出.
|
|
|
|
|
|
|
|
|
|
你同样可以在代码中抛出这些类型的异常(虽然只在很少时候)
|
|
|
|
|
你同样可以在代码中抛出这些类型的异常(虽然很少需要这样做)
|
|
|
|
|
|