制定数据验证规则,尽量在Dto中创建数据验证
ModelState是ASP.NET CORE内建的全局变量 ,用来进行数据验证,本质上 ModelState 是一个键值对类型的结构,包含当前数据模型状态,以及该模型相应的数据验证逻辑 通过调用ModelState.IsValid来提取验证结果 如果验证失败 ModelState还会提供验证失败的详细信息
1、数据注释 DataAnnotation
使用方式 :给要添加的数据验证的属性加上特性即可
如图 DataAnnotations 里面带有Attrbute属性都可以直接使用特性的方式对数据进行验证
[MaxLength(100,ErrorMessage ="标题不能超过100个字符")]
[Required(ErrorMessage ="标题必填")]
2、自定义数据验证规则(属性级别)
实现IValidatableObject接口Validate 在这个方法中可以对数据验证作补充
public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
{
if (Title== Description)
{
yield return new ValidationResult
(
"标题不能和详细信息一样",//错误信息
new[] { "TouristRouteCreationDto" } //错误路径
);
}
}
3、完成class级别的数据验证
1)新建 名为 ValidationAttrbutes文件夹 这个文件夹专门用来存放用于验证数据的 Attribute
2)在此文件下下新建 Attrbute类 继承 ValidationAttibute IsValid方法 具体实现如下
public class TouristRouteTitleMustBeDifferentFromDescriptionAttribute : ValidationAttribute
{
protected override ValidationResult IsValid(
object value, //需要验证的数据对象
ValidationContext validationContext //验证的上下文关系对象
)
{
var touristRouteDto =(TouristRouteDto) validationContext.ObjectInstance;//通过上下文关系对象,获得需要验证(当前的)的对象
if (touristRouteDto.Title==touristRouteDto.Description)
{
return new ValidationResult(
"标题不能和详细信息一样",//错误信息
new[] { "TouristRouteCreationDto" } //错误路径
);
}
return ValidationResult.Success;
}
}
3)使用特性
4、一般数据验证失败没有对返回体进行配置的话,返回的状态码400,但是数据验证失败的状态码是422,这需要在startup.cs文件进行配置
如下
services.AddControllers(
setupAction =>
{
setupAction.ReturnHttpNotAcceptable = true;//所有api都回复默认的数据结构 json 这里的默认值是false
//setupAction.OutputFormatters.Add(
// new XmlDataContractSerializerOutputFormatter()
// );//配置数据的输出格式
}
).AddXmlDataContractSerializerFormatters()
.ConfigureApiBehaviorOptions(setupAction =>
{
setupAction.InvalidModelStateResponseFactory = context => //非法模型状态响应工厂
{
var problemDetail = new ValidationProblemDetails(context.ModelState) //验证问题详情
{
Type = "这里不写都可以",
Title = "数据验证失败",
Status = StatusCodes.Status422UnprocessableEntity,
Detail="请看详细信息",
Instance = context.HttpContext.Request.Path
};
problemDetail.Extensions.Add("traceId", context.HttpContext.TraceIdentifier);//添加追踪ID
return new UnprocessableEntityObjectResult(problemDetail)
{
ContentTypes = { "application/problem+json" }
};
};
});