simapi-net/Controllers/SimApiBaseController.cs

using System.Diagnostics.CodeAnalysis;
using SimApi.Communications;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using System.Linq;
using SimApi.Exceptions;

namespace SimApi.Controllers;

/// <summary>
/// 基础控制器,所有控制器均继承本控制器
/// 1. 自动验证请求参数
/// 2. 报错返回
/// 3. 错误回馈页面
/// </summary>
///
[Consumes("application/json")]
[Produces("application/json")]
public class SimApiBaseController : Controller
{
    /// <summary>
    /// 当前登录用户的ID
    /// </summary>
    protected SimApiLoginItem LoginInfo => (SimApiLoginItem)HttpContext.Items["LoginInfo"]!;

    /// <summary>
    /// 验证请求参数
    /// </summary>
    /// <param name="context"></param>
    public override void OnActionExecuting(ActionExecutingContext context)
    {
        if (context.ModelState.IsValid) return;
        foreach (var item in context.ModelState.Values.Where(item =>
                     item.ValidationState == ModelValidationState.Invalid))
        {
            Error(400, item.Errors.First().ErrorMessage);
            break;
        }
    }


    /// <summary>
    /// 错误返回
    /// </summary>
    /// <param name="code">错误代码</param>
    /// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
    /// <returns></returns>
    protected static void Error(int code = 500, string message = "")
    {
        throw new SimApiException(code, message);
    }

    /// <summary>
    /// 检测条件，根据条件返回报错 如果condition是ture报错
    /// </summary>
    /// <param name="condition">检测条件</param>
    /// <param name="code">错误代码</param>
    /// <param name="message">错误描述</param>
    protected static void ErrorWhen([DoesNotReturnIf(true)] bool condition, int code = 400, string message = "")
    {
        if (condition)
        {
            Error(code, message);
        }
    }


    /// <summary>
    /// 检测条件，根据条件返回报错 如果condition是ture报错
    /// </summary>
    /// <param name="condition">检测条件</param>
    /// <param name="code">错误代码</param>
    /// <param name="message">错误描述</param>
    protected static void ErrorWhenTrue([DoesNotReturnIf(true)] bool condition, int code = 400, string message = "")
    {
        ErrorWhen(condition, code, message);
    }


    /// <summary>
    /// 如果condition是false 报错
    /// </summary>
    /// <param name="condition"></param>
    /// <param name="code"></param>
    /// <param name="message"></param>
    protected static void ErrorWhenFalse([DoesNotReturnIf(false)] bool condition, int code = 400, string message = "")
    {
        ErrorWhen(!condition, code, message);
    }

    /// <summary>
    /// 检测给定的变量是否为NUll
    /// </summary>
    /// <param name="condition">检测条件</param>
    /// <param name="code">错误代码</param>
    /// <param name="message">错误描述</param>
    protected static void ErrorWhenNull([NotNull] object? condition, int code = 404, string message = "请求的资源不存在")
    {
        ErrorWhen(condition == null, code, message);
    }

    /// <summary>
    /// 上传文件
    /// </summary>
    /// <returns></returns>
    protected SimApiBaseResponse<string> UploadFile()
    {
        return new SimApiBaseResponse<string>();
    }
}