C#、net core、net5 WebApi的get、post请求参数实体注解及自定义注解C# 常用的ValidationAttribute 子类

进行接口请求的时候难免会对请求字段进行验证，验证对象的所有字段的值是否合乎要求，如进行非空检测，长度检测等等。在有些情况下使用框架自带的注解可能满足不了我们的需求，我们需要自定义一些注解类型，下面一起学习一下自定义注解的使用

Get方法中我们可以设置必填像或者必须符合要求才可以
例：

		/// <summary>
        /// </summary>
        /// <param name="用户名">必填项</param>
        /// <returns></returns>
        [HttpGet("{用户名:required}")]
        public string Get(string 用户名)
        {
        	//业务逻辑
            return 用户名;
        }

		using System.ComponentModel.DataAnnotations;
		[HttpGet]
        public string Get([Required] string 用户名)
        {
        	//业务逻辑
            return 用户名;
        }
        

Post方法我们可以在实体中给属性加注解

 
        public async Task<dynamic> SynchronousInformationAsync(TCreateInput input)
        {

            var ou = await this.CurrentOrganizationUnit();
            string 当前用户 = CurrentUser.Name; string 当前用户id = CurrentUser.Id.ToString();
            string 组织机构编号1 = ou.Code; string 组织机构名称1 = ou.Name;
            return new { 当前用户 = 当前用户, 当前用户id = 当前用户id, 组织机构编号1 = 组织机构编号1, 组织机构名称1 = 组织机构名称1 };

        }

using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
public class TCreateInput{
[MaxLength(3)]
[Required]
public string name{get;set;}
public string sex{get;set;}
public string address{get;set;}
}

1.自定义注解

定义一个注解类型的类，继承于ValidationAttribute

ValidationAttribute

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Text;

namespace Test.Attributes
{
    public class CheckValueType : ValidationAttribute
    {

        protected override ValidationResult IsValid(object value, ValidationContext validationContext)
        {

            string number = Convert.ToString(value);
            double v;
            if (double.TryParse(number,out v))
            {
                return ValidationResult.Success;
            }

            return new ValidationResult(FormatErrorMessage(validationContext.DisplayName));

        }
        public override string FormatErrorMessage(string displayName)
        {
            return string.Format(ErrorMessageString, displayName);
        }
    }
}

使用注解

		using Test.Attributes;

 		[CheckValueType(ErrorMessage = "体温请填写有效数据！")] 
        public string 体温 { get; set; }

默认的一些注解

Required

用法示例

[Required(ErrorMessage="请填写名称")]

如果属性为null，“”，或只包含空白字符，会引发异常（ModelState.IsValid会false）

RegularExpression

用法示例

[RegularExpression(pattern:@"^[1-9]\d*$",ErrorMessage ="请选择部门")]

上面的示例是正整数检测，其他常用正则表达式自行搜索

Compare

用来检测两个字段是否相等

示例

[Compare("NewPassword",ErrorMessage ="确认密码和新密码不一致，请检查")]

MaxLength

示例

[MaxLength(length:11,ErrorMessage ="请填写合法的手机号")]

当然手机号不可能是上面那种检测，这里只是示例

这个注解最常用在字符串上，不过神奇的是也可以用在数组上面，非常有趣

MinLength

和上面MaxLength一样

用来检测数组非空挺好用的，但是注意是无法用到List类型的属性上面的

Range

range除了能用来限定数字的使用范围以外，还可以用来限定其他类型！（当然一般正则表达式可能用的更多）

示例

[Range(0.0, 100, ErrorMessage = "请输入0.0到100的数字")]
[Range(0, 100, ErrorMessage = "请输入0到100的数字")]

因为构造函数包含3种

RangeAttribute(int32,int32)

RangeAttribute(double,double)

RangeAttribute(Type,string,string)