统一返回模型Res

Res<T>泛型类型介绍

该类型定了许多隐式转换：

• 当类型返回值是 Res<T> 时：

//以下T当作实例
return T; // 实例T => Res<T>，Code 200

return "error desc"; // string => Res<T> ，但 Data 为 null，含有错误描述和Code 400代码
//等同于：
return Res.Fail(""); // Res => Res<T> ，但 Data 为 null，含有错误描述和Code 400代码

• 当类型返回值是 Res 时：

return "error desc"; // string => Res，含有错误描述和Code 400代码

//要返回正确
return Res.Ok("正确描述");

最佳实践

以下为异步方法情况，同步类似。

返回值为Res<T>时

使用隐式转换使得代码简洁易读：

public override async Task<Res<ResponseUserCheck>> CheckUser(QueryUserCheck request,
    CancellationToken cancellationToken)
{
    var userInfo = await repo.GetUserInfo(request.Username);
    if (userInfo == null)
    {
        return $"用户名{request.Username}不存在";
    }
    return _mapper.Map<ResponseUserCheck>(userInfo); //直接返回ResponseUserCheck实例
}

使用Res<T>返回值方法时，判断响应是否正常、获取响应数据、错误等请使用以下模式：

if ((await userManger.CheckUser(req)).IsFailed(out var error, out var data)) return error;
//此时data 为 ResponseUserCheck

返回值为Res时

public override async Task<Res> Exist(User user,
    CancellationToken cancellationToken)
{
    if (!(await repo.Exist(user)))
    {
        return $"用户不存在";
    }
    return Res.Ok();
}

要在调用返回Res类型的方法后快速获取错误，请使用以下模式：

if ((await userManger.Exist(user)).IsFailed(out var error)) return error;