ABP学习实践(三)--使用自定义基类的增删改示例

上篇文章中已经使用ABP框架使用了简单的增删改功能，但若在实际项目中这样使用，效率实在是低，所以有必要对代码进行优化，提高开发效率。

---

1.定义应用服务基类接口

本次优化代码的基本思路就是利用泛型类和接口对常用的功能进行定义和实现，最常用的几个方法就是新增、修改、详情和删除了，先从这几个方法下手了。

在应用层AbpDemo.Application创建泛型接口IAbpDemoAppServiceBase用来定义规则。同时继承了接口IApplicationService以满足ABP框架自身的约定。此外也对实体类、数据传输对象进行了约束。

    /// <summary>
    /// 应用服务基类接口
    /// </summary>
    /// <typeparam name="TEntity">实体</typeparam>
    /// <typeparam name="TEntityDto">详情数据传输对象</typeparam>
    /// <typeparam name="TPrimaryKey">主键</typeparam>
    /// <typeparam name="TCreateInput">新增数据传输对象</typeparam>
    /// <typeparam name="TUpdateInput">修改数据传输对象</typeparam>
    public interface IAbpDemoAppServiceBase<TEntity, TEntityDto, TPrimaryKey, TCreateInput, TUpdateInput> : IApplicationService
        where TEntity : class, IEntity<TPrimaryKey>
        where TUpdateInput : class, IEntityDto<TPrimaryKey>
        where TEntityDto : class, IEntityDto<TPrimaryKey>
    {

        /// <summary>
        /// 新增
        /// </summary>
        /// <param name="input">新增数据传输对象</param>
        /// <returns></returns>
        Task<TEntityDto> Create(TCreateInput input);

        /// <summary>
        /// 修改
        /// </summary>
        /// <param name="input">修改数据传输对象</param>
        /// <returns></returns>
        Task<TEntityDto> Update(TUpdateInput input);

        /// <summary>
        /// 详情
        /// </summary>
        /// <param name="id">实体标识</param>
        /// <returns></returns>
        Task<TEntityDto> Detail(TPrimaryKey id);

        /// <summary>
        /// 删除
        /// </summary>
        /// <param name="ids">实体标识集合</param>
        /// <returns></returns>
        Task<int> Delete(IEnumerable<TPrimaryKey> ids);

    }

2.实现应用服务基类

在应用层AbpDemo.Application创建泛型类AbpDemoAppServiceBase并继承接口IAbpDemoAppServiceBase以实现接口中的方法。在基类中声明了仓储并实现了新增、修改、详情和删除四个常用的方法。

    /// <summary>
    /// 应用服务基类
    /// </summary>
    /// <typeparam name="TEntity">实体</typeparam>
    /// <typeparam name="TEntityDto">详情数据传输对象</typeparam>
    /// <typeparam name="TPrimaryKey">主键</typeparam>
    /// <typeparam name="TCreateInput">新增数据传输对象</typeparam>
    /// <typeparam name="TUpdateInput">修改数据传输对象</typeparam>
    public abstract class AbpDemoAppServiceBase<TEntity, TEntityDto, TPrimaryKey, TCreateInput, TUpdateInput> : ApplicationService,
        IAbpDemoAppServiceBase<TEntity, TEntityDto, TPrimaryKey, TCreateInput, TUpdateInput>
        where TEntity : class, IEntity<TPrimaryKey>
        where TUpdateInput : class, IEntityDto<TPrimaryKey>
        where TEntityDto : class, IEntityDto<TPrimaryKey>
    {
        //仓储
        protected readonly IRepository<TEntity, TPrimaryKey> Repository;

        protected AbpDemoAppServiceBase()
        {
            LocalizationSourceName = AbpDemoConsts.LocalizationSourceName;
        }

        protected AbpDemoAppServiceBase(IRepository<TEntity, TPrimaryKey> repository)
        {
            LocalizationSourceName = AbpDemoConsts.LocalizationSourceName;
            Repository = repository;
        }

        #region 方法

        #region 新增
        /// <summary>
        /// 新增
        /// </summary>
        /// <param name="input"></param>
        /// <returns></returns>
        public virtual Task<TEntityDto> Create(TCreateInput input)
        {
            TEntity entity = input.MapTo<TEntity>();
            string id = Guid.NewGuid().ToString();
            entity.Id = ChangeTo(id);
            TEntity result = Repository.Insert(entity);
            return Task.FromResult<TEntityDto>(result.MapTo<TEntityDto>());
        }

        private static TPrimaryKey ChangeTo(string str)
        {
            TPrimaryKey result = default(TPrimaryKey);
            try
            {
                result = (TPrimaryKey)Convert.ChangeType(str, typeof(TPrimaryKey));
            }
            catch (Exception ex)
            {

            }
            return result;
        }

        #endregion

        #region 修改
        /// <summary>
        /// 修改
        /// </summary>
        /// <param name="input"></param>
        /// <returns></returns>
        public virtual Task<TEntityDto> Update(TUpdateInput input)
        {
            TEntity entity = input.MapTo<TEntity>();
            TEntity result = Repository.Update(entity);
            return Task.FromResult<TEntityDto>(result.MapTo<TEntityDto>());
        }
        #endregion

        #region 详情
        /// <summary>
        /// 详情
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        public virtual Task<TEntityDto> Detail(TPrimaryKey id)
        {
            TEntity result = Repository.Get(id);
            return Task.FromResult<TEntityDto>(result.MapTo<TEntityDto>());
        }
        #endregion

        #region 删除
        /// <summary>
        /// 删除
        /// </summary>
        /// <param name="ids"></param>
        /// <returns></returns>
        public virtual Task<int> Delete(IEnumerable<TPrimaryKey> ids)
        {
            int num = 0;
            try
            {
                foreach (TPrimaryKey id in ids)
                {
                    Repository.Delete(id);
                    num++;
                }
                return Task.FromResult<int>(num);
            }
            catch (System.Exception ex)
            {
                throw ex;
            }

        }
        #endregion

        #endregion

    }

3.使用自定义的应用服务基类

应用服务基类已经定义完成，下面就是该如何使用了。回到上篇中货品管理的模块中，只需要改变相应的基类即可。

首先是应用服务接口IGoodsAppService：

    /// <summary>
    /// 货品管理-应用服务接口
    /// </summary>
    public interface IGoodsAppService: IAbpDemoAppServiceBase<Goods,DetailGoodsDto,string,CreateGoodsDto,UpdateGoodsDto>,IApplicationService
    {

    }

然后是应用服务GoodsAppService：

    /// <summary>
    /// 货品管理-应用服务
    /// </summary>
    public class GoodsAppService: AbpDemoAppServiceBase<Goods,DetailGoodsDto,string,CreateGoodsDto,UpdateGoodsDto>,IGoodsAppService
    {
        public GoodsAppService(IRepository<Goods,string> repository):base(repository)
        {

        }

    }

改完之后瞬间就感觉清爽很多，通用的方法都由基类来实现了，如果基类无法满足，还是按照原有步骤自定义实现了。

---

源代码示例-GitHub