[Abp vNext 入坑分享] - 7.Automapper与validation的使用

简要说明

【项目源码】

【章节目录】

本文主要介绍Automapper与Validation的使用方法。首先使用Automapper的目的是引入组件完成entity与dto之间的转换以达到简化代码的目的。Abp vnext的项目中已经默认添加好此组件了【介绍】，本文只是说一些简单的用法，更进一步的使用需要到automapper的官网中查看文档

其次是Validation主要是用于入参校验，通过对dto标注相应的属性达到入参校验的功能。【abp介绍】【官方介绍】

具体步骤

1、Automapper的基础使用方法，在官方的文档中也有比较清晰的说明，所以就只是简单的根据官方文档写一次。然后试运行一下简单的效果即可。
添加相应的mapper使用的Dto，如UserDto,定义好可以对外输出的属性。

public class UserDto: EntityDto<Guid>
    {
        /// <summary>
        /// 用户名称
        /// </summary>
        public string user_name { get; set; }
        /// <summary>
        /// 用户手机号
        /// </summary>
        public string user_phone { get; set; }
        /// <summary>
        /// 用户状态
        /// </summary>
        public int user_status { get; set; }

    }

其次在AbpVnext.Learn.Application中找到LearnApplicationAutoMapperProfile类，添加我们需要的mapper，CreateMap<User, UserDto>(); 最后在UserAppServices里面添加以下代码，其中ObjectMapper.Map就是转换的方法。

 public async Task<UserDto> LoginByUserPhoneAndPwd(string user_phone,string pass_word)
        {
            var user= await _repository.FindAsync(a=>a.user_phone== user_phone&&a.pass_word== pass_word&&a.user_status==0);
            return ObjectMapper.Map<User, UserDto>(user);
        }

调试代码，输出结果如下,转换正常：

2、接下来主要介绍一下Validation的用法，官方的Validation是一个简单与轻量化的组件，主要用数据注解的方式对入参字段的合法性校验上。下面我们先来做一个简单的例子，原来登录接口的入参的参数增加以下[Required]

 /// <summary>
    /// 登录的Dto
    /// </summary>
    public class LoginDto:
    {
        /// <summary>
        /// 用户手机号
        /// </summary>
        [Required]
        public string user_phone { get; set; }
        /// <summary>
        /// 登录密码
        /// </summary>
        [Required]
        public string pass_word { get; set; }
    }

然后调试代码,测试相应接口，如下图抛出500异常，

再看日志，显示的是校验失败异常，则表明我们的注解生效了。

3、上面虽然显示我们的校验生效了，但是输出的结果明显不是我们想要的结果。一般我们需要为校验失败的入参输出统一的code和相应的字符串，让我们的提示比较清晰明了，同时也让前端开发的同事比较明确的知道这个是由于参数校验引起的问题，然后去修正相关参数。因此，我们需要替换掉abp的原有校验异常输出。

首先我们查看官方文档有说明，校验异常统一为AbpValidationException 。

因此我们在原来的LeanGlobalExceptionFilter中拦截此类型的异常，并将输出修改为code=100，如下：

  public void OnException(ExceptionContext context)
        {
            logger.LogError(new EventId(context.Exception.HResult),
           context.Exception,
           context.Exception.Message);
            if (context.Exception is AbpValidationException)
            {
                context.Result = new JsonResult(new  { ode = 100, msg = context.Exception.Message });
            }
            else
            {
                context.Result = new JsonResult(new { code = 500, msg = "系统异常" });
            }
            context.ExceptionHandled = true;
        }

然后我们再来看看调试接口的输出结果，如下，则表明我们的替换是成功了。

4、但是这样就算成功了吗？当然不是额，abp所有的校验失败输出都是输出这个：ModelState is not valid! See ValidationErrors for details.这样的输出，对我们前端或客户端同事是非常不友好的输出，都不知道错误原因与相应的字段，因此我们需要进一步去优化这些信息以达到最大程度的减少沟通成本的目的。下面我们来看看如何进行操作吧！

4.1、首先我们看一下注解里面的ValidationAttribute，这个注解包含了字段ErrorMessage是用于输出校验错误的字段的，所以我们可以好好的利用一下这个ErrorMessage来达到我们的目的。把user_phone的[Required]修改成[Required(ErrorMessage ="手机号码不能为空")]

4.2、我们回到LeanGlobalExceptionFilter这里，看一下AbpValidationException里面包含了什么信息。

如图所示，我们看到了ValidationErrors这个字段是一个List,里面包含了我们这一个请求入参的整个dto里所有校验不通过的信息列表。这样就好办了，修改原来的拦截为以下代码：

public void OnException(ExceptionContext context)
        {
            logger.LogError(new EventId(context.Exception.HResult),
           context.Exception,
           context.Exception.Message);
            if (context.Exception is AbpValidationException)
            {
                var validateerros = ((AbpValidationException)context.Exception).ValidationErrors;
                context.Result = new JsonResult(new  { ode = 100, msg = validateerros.Count > 0 ? validateerros[0].ErrorMessage : context.Exception.Message });
            }
            else
            {
                context.Result = new JsonResult(new { code = 500, msg = "系统异常" });
            }
            context.ExceptionHandled = true;
        }

然后调试代码，并测试相应的接口。现在则表示显示正常了。至于信息到底是显示第一个还是最后一个，自己判断，个人感觉都可以，因为都属于参数失败的校验

4.3、接下来我们使用一下进阶的判断，脱离于单纯的字段校验，如：假如user_phone等于pass_word的时候抛出不能相等提示。这个需要dto继承IValidatableObject然后增加Validate的实现方法，如下：

public IEnumerable<ValidationResult> Validate(
            ValidationContext validationContext)
        {
            if (user_phone == pass_word)
            {
                yield return new ValidationResult(
                    "手机号码与密码不能一样!",
                    new[] { "user_phone", "pass_word" }
                );
            }
        }

然后调试代码，并测试相应的接口，如下则表示替换成功了。。