在ABP VNext框架中对HttpApi模块的控制器进行基类封装

在ABP VNext框架中,HttpApi项目是我们作为Restful格式的控制器对象的封装项目,但往往很多案例都是简单的继承基类控制器AbpControllerBase,而需要在每个控制器里面重写很多类似的Create/Update/Delete/Get/GetList等常规Restful接口的调用,千篇一律的重复,本篇随笔介绍如何对这些内容通过基类的方式实现,子类无需重复代码,并且强类型所有的接口实现。

1、Restful接口的CRUD实现

在我们使用HttpApi项目进一步封装ABP VNext框架的Application项目中的应用服务,作为Restful格式的控制器对象,往往都需要实现基本的Create/Update/Delete/Get/GetList等常规Restful接口的实现调用,官方很多案例也都是把这部分代码进行重复在重复,如下所示。

例如对于客户对象Customer的HttpApi项目控制器的代码如下:

    /// <summary>
    /// 客户信息控制器
    /// </summary>
    //[Area("crm")]
    [RemoteService]
    [ControllerName("Customer")]
    [Route("api/customer")]
    public class CustomerController : AbpControllerBase, ICustomerAppService
    {
        private readonly ICustomerAppService _customerAppService;

        public CustomerController(ICustomerAppService customerAppService)
        {
            _customerAppService = customerAppService;
        }

        /// <summary>
        /// 创建对象
        /// </summary>
        [HttpPost]
        public Task<CustomerDto> CreateAsync(CreateCustomerDto input)
        {
            return _customerAppService.CreateAsync(input);
        }

        /// <summary>
        /// 删除对象
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpDelete]
        [Route("{id}")]
        public Task DeleteAsync(string id)
        {
            return _customerAppService.DeleteAsync(id);
        }

        /// <summary>
        /// 根据ID获取指定对象
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpGet]
        [Route("{id}")]
        public Task<CustomerDto> GetAsync(string id)
        {
            return _customerAppService.GetAsync(id);
        }

        /// <summary>
        /// 分页获取列表记录
        /// </summary>
        /// <param name="input"></param>
        /// <returns></returns>
        [HttpGet]
        public Task<PagedResultDto<CustomerDto>> GetListAsync(CustomerPagedDto input)
        {
            return _customerAppService.GetListAsync(input);
        }

        /// <summary>
        /// 更新对象
        /// </summary>
        [HttpPut]
        [Route("{id}")]
        public Task<CustomerDto> UpdateAsync(string id, CustomerDto input)
        {
            return _customerAppService.UpdateAsync(id, input);
        }

        /// <summary>
        /// 获取字段列别名
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        [Route("columnalias")]
        public Task<Dictionary<string, string>> GetColumnNameAlias()
        {
            return _customerAppService.GetColumnNameAlias();
        }
    }

对于其他业务对象,这部分基本上千篇一律的重复一次,就是为了简单的封装一下CRUD的常规接口。

那么我们是否可以考虑通过基类的方式来抽取这部分代码,放到基类里面去实现,以后只需要继承该基类就完事了呢?

考虑到这些Restful的API接口实现,很多都是特定的业务对象,如上面的CustomerDto、CustomerPagedDto 等,那这些就需要通过泛型的方式指定类型给基类了。

而业务接口 ICustomerAppService 也是一个特定的业务接口,也需要传递给基类处理,这样才能进行调用的。

2、HttpApi 基类控制器的实现

我们注意到上面项目的ICustomerService的接口定义如下:

    /// <summary>
    /// 客户信息,应用层服务接口定义
    /// </summary>
    public interface ICustomerAppService : 
        ICrudAppService<CustomerDto, string, CustomerPagedDto, CreateCustomerDto, CustomerDto>
    {
        ///// <summary>
        ///// 获取指定条件的数量
        ///// </summary>
        ///// <param name="input">查找条件</param>
        ///// <returns></returns>
        //Task<int> CountAsync(CustomerPagedDto input);

        /// <summary>
        /// 获取字段中文别名(用于界面显示)的字典集合
        /// </summary>
        /// <returns></returns>
        Task<Dictionary<string, string>> GetColumnNameAlias();

    }

它是继承自ICrudAppService接口(Abp的基类接口)并传递几个相关的实体类参数作为基类的接口强类型构建的。

那么我们的HttpApi 基类控制器也可以采用这种方式来传递对应的类型,作为基类接口的处理需要。

我们定义一个控制器基类MyAbpControllerBase,让它继承自常规的AbpControllerBase接口,并实现ICrudAppService接口,如下所示。

    /// <summary>
    /// 自定义ABP控制器基类,用于实现通用的CRUD等方法
    /// </summary>
    public abstract class MyAbpControllerBase<TEntityDto, TKey, TGetListInput, TCreateInput, TUpdateInput> : AbpControllerBase, 
        IMyCrudAppService<TEntityDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
        where TEntityDto : IEntityDto<TKey>
        where TGetListInput : IPagedAndSortedResultRequest
        where TCreateInput : IEntityDto<TKey>
        where TUpdateInput : IEntityDto<TKey>
    {
        protected IMyCrudAppService<TEntityDto, TKey, TGetListInput, TCreateInput, TUpdateInput> _service;

        public MyAbpControllerBase(IMyCrudAppService<TEntityDto, TKey, TGetListInput, TCreateInput, TUpdateInput> service)
        {
            _service = service;
        }

这样我们就定义好这个基类,并且通过让它传递相关的业务对象和对象外键类型,强类型相关的接口处理,并让它实现了相关的构造函数。

那么对应的接口实现,我们只需要调用 _service 的处理即可。

        /// <summary>
        /// 创建对象
        /// </summary>
        /// <param name="input"></param>
        /// <returns></returns>
        [HttpPost]
        public Task<TEntityDto> CreateAsync(TCreateInput input)
        {
            return _service.CreateAsync(input);
        }

        /// <summary>
        /// 删除对象
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpDelete]
        [Route("{id}")]
        public Task DeleteAsync(TKey id)
        {
            return _service.DeleteAsync(id);
        }

        /// <summary>
        /// 获取指定id的记录
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        [HttpGet]
        [Route("{id}")]
        public Task<TEntityDto> GetAsync(TKey id)
        {
            return _service.GetAsync(id);
        }

        /// <summary>
        /// 获取条件的列表
        /// </summary>
        [HttpGet]
        public Task<PagedResultDto<TEntityDto>> GetListAsync(TGetListInput input)
        {
            return _service.GetListAsync(input);
        }

        /// <summary>
        /// 更新对象
        /// </summary>
        [HttpPut]
        [Route("{id}")]
        public Task<TEntityDto> UpdateAsync(TKey id, TUpdateInput input)
        {
            return _service.UpdateAsync(id, input);
        }

我们还可以自己增加一些特殊的接口和基类的实现,这样我们对于常规的接口就不需要添加重复的实现代码了,只需要继承基类就可以了。

子类继承基类的代码如下所示。

    /// <summary>
    /// 客户信息控制器
    /// </summary>
    [RemoteService]
    [ControllerName("Customer")]
    [Route("api/customer")]
    public class CustomerController : 
        MyAbpControllerBase<CustomerDto, string, CustomerPagedDto,CreateCustomerDto, CustomerDto>, 
        ICustomerAppService
    {
        private readonly ICustomerAppService _customerAppService;

        public CustomerController(ICustomerAppService customerAppService) : base(customerAppService)
        {
            _customerAppService = customerAppService;
        }
    }

这样这个CustomerController默认就具有所有相关的常规接口了,不需要千篇一律的重写那些繁杂的代码,清爽了很多。

而如果我们需要额外增加一些接口的处理,那么在其接口定义增加,并实现即可,如下代码所示。

    /// <summary>
    /// 客户信息,应用层服务接口定义
    /// </summary>
    public interface ICustomerAppService : 
        IMyCrudAppService<CustomerDto, string, CustomerPagedDto, CreateCustomerDto, CustomerDto>
    {

        /// <summary>
        /// 增加的额外测试接口
        /// </summary>
        /// <returns></returns>
        Task<bool> TestExtra();
    }

HttpApi项目的实现代码如下所示。

    /// <summary>
    /// 客户信息控制器
    /// </summary>
    [RemoteService]
    [ControllerName("Customer")]
    [Route("api/customer")]
    public class CustomerController : 
        MyAbpControllerBase<CustomerDto, string, CustomerPagedDto,CreateCustomerDto, CustomerDto>, 
        ICustomerAppService
    {
        private readonly ICustomerAppService _customerAppService;

        public CustomerController(ICustomerAppService customerAppService) : base(customerAppService)
        {
            _customerAppService = customerAppService;
        }

        /// <summary>
        /// 测试额外的接口调用
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        [Route("test-extra")]
        public async Task<bool> TestExtra()
        {
            return await _customerAppService.TestExtra();
        }
    }

启动Swagger的查看接口界面,我们可以看到,Customer控制器所发布的接口信息,如下所示。

 

 一切都是那么的美好,以后再也不用重复书写或看到那些重复的,没有技术含量的代码了。

 

主要研究技术:代码生成工具、会员管理系统、客户关系管理软件、病人资料管理软件、Visio二次开发、酒店管理系统、仓库管理系统等共享软件开发
专注于Winform开发框架/混合式开发框架Web开发框架Bootstrap开发框架微信门户开发框架的研究及应用
  转载请注明出处:
撰写人:伍华聪  http://www.iqidi.com 
    

posted on 2021-12-31 11:54  伍华聪  阅读(505)  评论(2编辑  收藏  举报

导航