.NET CORE API 统一封装结果返回

原创已于 2023-01-16 15:46:14 修改 · 1k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#.netcore #开发语言

于 2023-01-16 14:37:08 首次发布

c# 同时被 3 个专栏收录

13 篇文章

订阅专栏

Asp.Net Core

12 篇文章

订阅专栏

mvc

5 篇文章

订阅专栏

文章展示了一个名为`Result`的公共类，用于封装HTTPAPI请求的成功或失败状态，包括状态码、消息和额外数据。同时，`ApiResultHelper`类提供了一系列静态方法，方便快捷地创建表示不同状态的结果对象，如成功、失败、参数错误等。在示例的`GuestLogin`方法中，使用这些工具处理登录请求的响应。

 public class Result
    {
        public static int SUCCESS = 1;
        public static int FAILURE = -1;
        public static int OTHER = 2;      //其他，页面显示
        public static int FAILURE_AUTHC = -9999;

        public static String STR_PARAM_NOT_NULL = "传入参数不能为空";
        public static String STR_SUCCESS = "操作成功";
        public static String STR_FAIL = "操作失败";


        /**
         * 请求是否错误，默认false
         */
        public Boolean success = false;
        /**
         * 请求返回code
         */
        public int code {get;set;}
        /**
         * 请求返回描述
         */
        public String msg {get;set;}

        public Object obj {get;set;}

        public Result() { }

        public Result(int code, String msg)
        {
            this.code = code;
            this.msg = msg;
        }
        public Result(int code, String msg, Boolean success)
        {
            this.code = code;
            this.msg = msg;
            this.success = success;
        }

        public Boolean isSuccess()
        {
            return success;
        }

        public void setSuccess(Boolean success)
        {
            this.success = success;
        }

        public String getMsg()
        {
            return msg;
        }

        public void setMsg(String msg)
        {
            this.msg = msg;
        }

        public Object getObj()
        {
            return obj;
        }

        public void setObj(Object obj)
        {
            this.obj = obj;
        }

        public int getCode()
        {
            return code;
        }

        public void setCode(int code)
        {
            this.code = code;
        }
    }

第二步：

 public class ApiResultHelper
    {
        #region 返回值结构
        /// <summary>
        /// ajax失败
        /// </summary>
        /// <param name="msg">失败的消息</param>
        /// <returns></returns>
        public static Result renderError(string msg)
        {
            Result result = new Result();
            result.setCode(Result.FAILURE);
            result.setMsg(msg);
            return result;
        }

        /// <summary>
        /// ajax失败
        /// </summary>
        /// <param name="msg">失败的消息</param>
        ///<param name="code">失败的编码</param>
        /// <returns></returns>
        public static Result renderError(string msg, int code)
        {
            Result result = new Result();
            result.setCode(code);
            result.setMsg(msg);
            return result;
        }
        /// <summary>
        /// ajax失败
        /// </summary> 
        /// <returns></returns>
        public static Result renderError()
        {
            Result result = new Result();
            result.setCode(Result.FAILURE);
            result.setMsg(Result.STR_FAIL);
            return result;
        }

        public static Result renderError(object obj)
        {
            Result result = new Result();
            result.setCode(Result.FAILURE);
            result.setObj(obj);
            return result;
        }

        /// <summary>
        /// ajax失败，参数为空或错误
        /// </summary> 
        /// <returns></returns>
        public static Result renderErrorParamNotNull()
        {
            Result result = new Result();
            result.setCode(Result.FAILURE);
            result.setMsg(Result.STR_PARAM_NOT_NULL);
            return result;
        }

        /// <summary>
        /// ajax成功
        /// </summary> 
        /// <returns></returns>
        public static Result renderSuccess()
        {
            Result result = new Result();
            result.setSuccess(true);
            result.setMsg(Result.STR_SUCCESS);
            return result;
        }

        /// <summary>
        /// 成功
        /// </summary>
        /// <param name="msg">消息</param>
        /// <returns></returns>
        public static Result renderSuccess(string msg)
        {
            Result result = new Result();
            result.setSuccess(true);
            result.setMsg(msg);
            return result;
        }

        /// <summary>
        /// 成功
        /// </summary>
        /// <param name="obj">对象</param>
        /// <returns></returns>
        public static Result renderSuccess(object obj)
        {
            Result result = new Result();
            result.setSuccess(true);
            result.setObj(obj);
            return result;
        }

        /// <summary>
        /// 成功
        /// </summary>
        /// <param name="obj">对象</param>
        /// <param name="msg">消息</param>
        /// <returns></returns>
        public static Result renderSuccess(object obj, string msg)
        {
            Result result = new Result();
            result.setSuccess(true);
            result.setMsg(msg);
            result.setObj(obj);
            return result;
        }
        #endregion

    }

第三步：调用

  [HttpGet]
        [Route("？？？")]
        public ActionResult<Result> GuestLogin()
        {
            var email = Appsettings.GetNode("email");
            var pass = Appsettings.GetNode("pass");
            try
            {
                var jm = ToolClass.AesEncrypt(pass, Appsettings.GetNode("？？"), Appsettings.GetNode("？？"));
                Dictionary<string, string> dic = new Dictionary<string, string>();
                dic.Add("pass", jm);
                if (!string.IsNullOrEmpty(email))
                {
                    dic.Add("email", email);
                }
                var res = HttpGetPost.DoPost(Appsettings.GetNode("？？"), dic);
                return new ContentResult { Content = res.Result, ContentType = "application/json" };
            }
            catch (Exception)
            {
                return ApiResultHelper.renderError("Internal exception", 400);
            }

        }