NCF WebApi中 Controller的全解析

简介

上一篇我们说了如何实现一个WebApi，并运行起来

这次我们来说说WebApi的内在，我们到底做了哪些事情

仓库地址：https://github.com/NeuCharFramework/NCF

欢迎收藏，欢迎Star哦

步骤

1.在Senparc.Web中引用Senparc.Xncf.Swagger项目（此项目默认加载即可）

2.在WorkShop.Xncf.WebApiDemo01 项目下建立Controller目录

3.在Controller下面建立BaseController用来统一处理返回的内容方法

4.在Models下面建立BaseResult来处理统一返回的数据格式

5.新建ColorController，并创建具体的使用方法

6.在ColorService里面增加Api调用的方法

7.运行测试结果

实施

1.在Senparc.Web中引用Senparc.Xncf.Swagger项目（此项目默认加载即可）

 双击Senparc.Web进入文件编辑

引入项目

<ProjectReference Include="..Senparc.Xncf.SwaggerSenparc.Xncf.Swagger.csproj" />

2.在WorkShop.Xncf.WebApiDemo01 项目下建立Controllers目录，如图所示

3.在Controller下面建立BaseController用来统一处理返回的内容方法

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using WorkShop.Xncf.WebApiDemo01.Models.DatabaseModel.VO;
using WorkShop.Xncf.WebApiDemo01.Services;
using Senparc.Ncf.Core.Cache;

namespace WorkShop.Xncf.WebApiDemo01.Controllers
{
    public class BaseController : ControllerBase
    {

        public IActionResult Success(object data)
        {
            var response = new BaseResult<object>(200, "请求成功", data);
            return Ok(response);
        }

        public IActionResult Fail(object data)
        {
            var response = new BaseResult<object>(201, "请求失败", data);
            return Ok(response);
        }
    }
}

4.在Models下面建立BaseResult来处理统一返回的数据格式

using Senparc.CO2NET.Helpers;
using System;
using System.Collections.Generic;
using System.Text;

namespace WorkShop.Xncf.WebApiDemo01.Models.DatabaseModel.VO
{
    public class BaseResult<T>
    {
        public BaseResult(int code,string msg,T data)
        {
            Code = code;
            Msg = msg;
            Data = data;
            RequestTime = $"{ string.Format("{0:yyyy-MM-dd HH:mm:ss}", DateTime.Now)}";
        }

        /// <summary>
        /// 错误码，200 表示成功
        /// </summary>
        public int Code { get; set; } = 0;

        /// <summary>
        /// 消息
        /// </summary>
        public string Msg { get; set; }

        /// <summary>
        /// 主体数据
        /// </summary>
        public T Data { get; set; }

        /// <summary>
        /// 请求时间
        /// </summary>
        public string RequestTime { get; set; }


    }
}

5.新建ColorController，并创建具体的使用方法

using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.Extensions.Options;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading.Tasks;
using Senparc.Ncf.Core.Cache;
using Senparc.CO2NET.Cache;
using Senparc.CO2NET.Cache.CsRedis;
using WorkShop.Xncf.WebApiDemo01.Models.DatabaseModel.VO;
using WorkShop.Xncf.WebApiDemo01.Models.DatabaseModel.Config;
using WorkShop.Xncf.WebApiDemo01.Utils;
using WorkShop.Xncf.WebApiDemo01.Services;
using WorkShop.Xncf.WebApiDemo01.Models.DatabaseModel.Dto;

namespace WorkShop.Xncf.WebApiDemo01.Controllers
{
    /// <summary>
    /// 文件上传接口
    /// </summary>
    [Route("api/v{version:apiVersion}/[controller]/[action]")]
    [ApiController]
    [ApiVersion("1")]
    public class ColorController : BaseController
    {
        private readonly ColorService colorService;

        public ColorController(ColorService colorService)
        {
            this.colorService = colorService;
        }

        /// <summary>
        /// 获取当前颜色
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public async Task<IActionResult> GetColorAsync()
        {
            try
            {
                var response = await colorService.ApiGetColorAsync();
                return Success(response);
            }
            catch (Exception ex)
            {
                return Fail(ex.Message);
            }
        }

        /// <summary>
        /// 设置颜色
        /// </summary>
        /// <param name="type">类型(1-变亮;2-变暗;3-随机;)</param>
        /// <returns></returns>
        [HttpPost]
        public async Task<IActionResult> SetColorAsync(int type)
        {
            try
            {
                var response = await colorService.ApiSetColorAsync(type);
                return Success(response);
            }
            catch (Exception ex)
            {
                return Fail(ex.Message);
            }
        }
    }
}

6.在ColorService里面增加Api调用的方法

using Senparc.Ncf.Core.Enums;
using Senparc.Ncf.Repository;
using Senparc.Ncf.Service;
using WorkShop.Xncf.WebApiDemo01.Models.DatabaseModel.Dto;
using System;
using System.Threading.Tasks;

namespace WorkShop.Xncf.WebApiDemo01.Services
{
    public class ColorService : ServiceBase<Color>
    {
        public ColorService(IRepositoryBase<Color> repo, IServiceProvider serviceProvider)
            : base(repo, serviceProvider)
        {
        }

        public async Task<ColorDto> CreateNewColor()
        {
            Color color = new Color(-1, -1, -1);
            await base.SaveObjectAsync(color).ConfigureAwait(false);
            ColorDto colorDto = base.Mapper.Map<ColorDto>(color);
            return colorDto;
        }

        public async Task<ColorDto> Brighten()
        {
            //TODO:异步方法需要添加排序功能
            var obj = this.GetObject(z => true, z => z.Id, OrderingType.Descending);
            obj.Brighten();
            await base.SaveObjectAsync(obj).ConfigureAwait(false);
            return base.Mapper.Map<ColorDto>(obj);
        }

        public async Task<ColorDto> Darken()
        {
            //TODO:异步方法需要添加排序功能
            var obj = this.GetObject(z => true, z => z.Id, OrderingType.Descending);
            obj.Darken();
            await base.SaveObjectAsync(obj).ConfigureAwait(false);
            return base.Mapper.Map<ColorDto>(obj);
        }

        public async Task<ColorDto> Random()
        {
            //TODO:异步方法需要添加排序功能
            var obj = this.GetObject(z => true, z => z.Id, OrderingType.Descending);
            obj.Random();
            await base.SaveObjectAsync(obj).ConfigureAwait(false);
            return base.Mapper.Map<ColorDto>(obj);
        }

        //TODO: 更多业务方法可以写到这里


        #region 接口要请求的方法
        public async Task<ColorDto> ApiSetColorAsync(int type)
        {
            ColorDto dto;
            switch (type)
            {
                case 1:
                    {
                        dto = await Brighten();
                        break;
                    }
                case 2:
                    {
                        dto = await Darken();
                        break;
                    }
                default:
                    {
                        dto = await Random();
                        break;
                    }
            }
            return dto;
        }

        public async Task<object> ApiGetColorAsync()
        {
            var obj = this.GetObject(z => true, z => z.Id, OrderingType.Descending);
            return obj;
        }
        #endregion

    }
}

7.运行测试结果

https://localhost:44311/senparc-api-docs/index.html

 

 

有疑问随时欢迎交流