Abp IRepository 方法解释(1)

//
    // 摘要:
    //     This interface is implemented by all repositories to ensure implementation of
    //     fixed methods.
    //    **实现这一接口以确保使用存储库中的方法
    // 类型参数:
    //   TEntity:
    //     Main Entity type this repository works on
    //      **实体类
    //   TPrimaryKey:
    //     Primary key type of the entity

//     **实体类的主键类型
    public interface IRepository<TEntity, TPrimaryKey> : IRepository, ITransientDependency where TEntity : class, IEntity<TPrimaryKey>
    {

    //
        // 摘要:
        //     Gets count of all entities in this repository.
        //
        // 返回结果:
        //     Count of entities
        int Count();

  //
        // 摘要:
        //     Gets count of all entities in this repository based on given predicate.
        //   **基于委托方法条件来获取实体个数
        // 参数:
        //   predicate:
        //     A method to filter count
        //   过滤的方法
        // 返回结果:
        //     Count of entities
        int Count(Expression<Func<TEntity, bool>> predicate);

  //
        // 摘要:
        //     Gets count of all entities in this repository.
        //
        // 返回结果:
        //     Count of entities
        Task<int> CountAsync();

  // 摘要:
        //     Gets count of all entities in this repository based on given predicate.
        //
        // 参数:
        //   predicate:
        //     A method to filter count
        //
        // 返回结果:
        //     Count of entities
        Task<int> CountAsync(Expression<Func<TEntity, bool>> predicate);

  // 摘要:
        //     Deletes an entity.
        //
        // 参数:
        //   entity:
        //     Entity to be deleted
        void Delete(TEntity entity);

  // 摘要:
        //     Deletes an entity by primary key.
        //
        // 参数:
        //   id:
        //     Primary key of the entity
        void Delete(TPrimaryKey id);

  

  // 摘要:
        //     Deletes many entities by function. Notice that: All entities fits to given predicate
        //     are retrieved and deleted. This may cause major performance problems if there
        //     are too many entities with given predicate.
        //    ***通过传递的表达式树来删除多个实体,注意:如果有委托中有太多的实体,有可能引发重大的性能问题
        // 参数:
        //   predicate:
        //     A condition to filter entities

  //**过滤实体的条件
        void Delete(Expression<Func<TEntity, bool>> predicate);

   // 摘要:
        //     Deletes an entity by primary key.
        //
        // 参数:
        //   id:
        //     Primary key of the entity
        Task DeleteAsync(TPrimaryKey id);

  // 摘要:
        //     Deletes many entities by function. Notice that: All entities fits to given predicate
        //     are retrieved and deleted. This may cause major performance problems if there
        //     are too many entities with given predicate.
        //
        // 参数:
        //   predicate:
        //     A condition to filter entities
        Task DeleteAsync(Expression<Func<TEntity, bool>> predicate);

  

   // 摘要:
        //     Deletes an entity.
        //
        // 参数:
        //   entity:
        //     Entity to be deleted
        Task DeleteAsync(TEntity entity);

   // 摘要:
        //     Gets an entity with given given predicate or null if not found.
        //    **根据条件来查找实体,如果找不到则返回null
        // 参数:
        //   predicate:
        //     Predicate to filter entities
        TEntity FirstOrDefault(Expression<Func<TEntity, bool>> predicate);

  

  // 摘要:
        //     Gets an entity with given primary key or null if not found.
        //  **通过主键来获取实体类,找不到则返回null
        // 参数:
        //   id:
        //     Primary key of the entity to get
        //
        // 返回结果:
        //     Entity or null
        TEntity FirstOrDefault(TPrimaryKey id);

   // 摘要:
        //     Gets an entity with given given predicate or null if not found.
        //
        // 参数:
        //   predicate:
        //     Predicate to filter entities
        Task<TEntity> FirstOrDefaultAsync(Expression<Func<TEntity, bool>> predicate);

   // 摘要:
        //     Gets an entity with given primary key or null if not found.
        //
        // 参数:
        //   id:
        //     Primary key of the entity to get
        //
        // 返回结果:
        //     Entity or null
        Task<TEntity> FirstOrDefaultAsync(TPrimaryKey id);

  

  // 摘要:
        //     Gets an entity with given primary key.
        //
        // 参数:
        //   id:
        //     Primary key of the entity to get
        //
        // 返回结果:
        //     Entity
        TEntity Get(TPrimaryKey id);

  // 摘要:
        //     Used to get a IQueryable that is used to retrieve entities from entire table.
        //
        // 返回结果:
        //     IQueryable to be used to select entities from database
        IQueryable<TEntity> GetAll();

  

   // 摘要:
        //     Used to get a IQueryable that is used to retrieve entities from entire table.
        //     One or more
        //
        // 参数:
        //   propertySelectors:
        //     A list of include expressions.
        //
        // 返回结果:
        //     IQueryable to be used to select entities from database
        IQueryable<TEntity> GetAllIncluding(params Expression<Func<TEntity, object>>[] propertySelectors);

   // 摘要:
        //     Used to get all entities.
        //
        // 返回结果:
        //     List of all entities
        List<TEntity> GetAllList();

  // 摘要:
        //     Used to get all entities based on given predicate.
        //
        // 参数:
        //   predicate:
        //     A condition to filter entities
        //
        // 返回结果:
        //     List of all entities
        List<TEntity> GetAllList(Expression<Func<TEntity, bool>> predicate);

  // 摘要:
        //     Used to get all entities.
        //
        // 返回结果:
        //     List of all entities
        Task<List<TEntity>> GetAllListAsync();

  // 摘要:
        //     Used to get all entities based on given predicate.
        //
        // 参数:
        //   predicate:
        //     A condition to filter entities
        //
        // 返回结果:
        //     List of all entities
        Task<List<TEntity>> GetAllListAsync(Expression<Func<TEntity, bool>> predicate);

   // 摘要:
        //     Gets an entity with given primary key.
        //
        // 参数:
        //   id:
        //     Primary key of the entity to get
        //
        // 返回结果:
        //     Entity
        Task<TEntity> GetAsync(TPrimaryKey id);

   // 摘要:
        //     Inserts a new entity.
        //
        // 参数:
        //   entity:
        //     Inserted entity
        TEntity Insert(TEntity entity);

   // 摘要:
        //     Inserts a new entity and gets it's Id. It may require to save current unit of
        //     work to be able to retrieve id.
        //    **插入一个实体返回其Id,
        // 参数:
        //   entity:
        //     Entity
        //
        // 返回结果:
        //     Id of the entity
        TPrimaryKey InsertAndGetId(TEntity entity);

  // 摘要:
        //     Inserts a new entity and gets it's Id. It may require to save current unit of
        //     work to be able to retrieve id.
        //
        // 参数:
        //   entity:
        //     Entity
        //
        // 返回结果:
        //     Id of the entity
        Task<TPrimaryKey> InsertAndGetIdAsync(TEntity entity);

  // 摘要:
        //     Inserts a new entity.
        //
        // 参数:
        //   entity:
        //     Inserted entity
        Task<TEntity> InsertAsync(TEntity entity);

   // 摘要:
        //     Inserts or updates given entity depending on Id's value.
        //
        // 参数:
        //   entity:
        //     Entity
        TEntity InsertOrUpdate(TEntity entity);

  // 摘要:
        //     Inserts or updates given entity depending on Id's value. Also returns Id of the
        //     entity. It may require to save current unit of work to be able to retrieve id.
        //
        // 参数:
        //   entity:
        //     Entity
        //
        // 返回结果:
        //     Id of the entity
        TPrimaryKey InsertOrUpdateAndGetId(TEntity entity);

  // 摘要:
        //     Inserts or updates given entity depending on Id's value. Also returns Id of the
        //     entity. It may require to save current unit of work to be able to retrieve id.
        //
        // 参数:
        //   entity:
        //     Entity
        //
        // 返回结果:
        //     Id of the entity
        Task<TPrimaryKey> InsertOrUpdateAndGetIdAsync(TEntity entity);

  // 摘要:
        //     Inserts or updates given entity depending on Id's value.
        //
        // 参数:
        //   entity:
        //     Entity
        Task<TEntity> InsertOrUpdateAsync(TEntity entity);

  // 摘要:
        //     Creates an entity with given primary key without database access.
        //     **为实体创建一个主键,此主键不是数据库生成的
        // 参数:
        //   id:
        //     Primary key of the entity to load
        //
        // 返回结果:
        //     Entity
        TEntity Load(TPrimaryKey id);

  // 摘要:
        //     Gets count of all entities in this repository (use if expected return value is
        //     greather than System.Int32.MaxValue.
        //
        // 返回结果:
        //     Count of entities
        long LongCount();

  // 摘要:

   //     Gets count of all entities in this repository based on given predicate (use this
        //     overload if expected return value is greather than System.Int32.MaxValue).
        //
        // 参数:
        //   predicate:
        //     A method to filter count
        //
        // 返回结果:
        //     Count of entities
        long LongCount(Expression<Func<TEntity, bool>> predicate);

  // 摘要:
        //     Gets count of all entities in this repository (use if expected return value is
        //     greather than System.Int32.MaxValue.
        //
        // 返回结果:
        //     Count of entities
        Task<long> LongCountAsync();

  // 摘要:
        //     Gets count of all entities in this repository based on given predicate (use this
        //     overload if expected return value is greather than System.Int32.MaxValue).
        //
        // 参数:
        //   predicate:
        //     A method to filter count
        //
        // 返回结果:
        //     Count of entities
        Task<long> LongCountAsync(Expression<Func<TEntity, bool>> predicate);

  // 摘要:
        //     Used to run a query over entire entities. Abp.Domain.Uow.UnitOfWorkAttribute
        //     attribute is not always necessary (as opposite to Abp.Domain.Repositories.IRepository`2.GetAll)
        //     if queryMethod finishes IQueryable with ToList, FirstOrDefault etc..
        // 
        // 参数:
        //   queryMethod:
        //     This method is used to query over entities
        //
        // 类型参数:
        //   T:
        //     Type of return value of this method
        //
        // 返回结果:
        //     Query result
        T Query<T>(Func<IQueryable<TEntity>, T> queryMethod);

   // 摘要:
        //     Gets exactly one entity with given predicate. Throws exception if no entity or
        //     more than one entity.
        //  得到仅有的一个查询出的实体,如果没有该实体或者多余一个将会抛出异常
        // 参数:
        //   predicate:
        //     Entity
        TEntity Single(Expression<Func<TEntity, bool>> predicate);

  / 摘要:
        //     Gets exactly one entity with given predicate. Throws exception if no entity or
        //     more than one entity.
        //
        // 参数:
        //   predicate:
        //     Entity
        Task<TEntity> SingleAsync(Expression<Func<TEntity, bool>> predicate);

  // 摘要:
        //     Updates an existing entity.
        //
        // 参数:
        //   entity:
        //     Entity
        TEntity Update(TEntity entity);

   // 摘要:
        //     Updates an existing entity.
        //
        // 参数:
        //   id:
        //     Id of the entity
        //
        //   updateAction:
        //     Action that can be used to change values of the entity
        //
        // 返回结果:
        //     Updated entity
        TEntity Update(TPrimaryKey id, Action<TEntity> updateAction);

  // 摘要:
        //     Updates an existing entity.
        //
        // 参数:
        //   entity:
        //     Entity
        Task<TEntity> UpdateAsync(TEntity entity);

  // 摘要:
        //     Updates an existing entity.
        //
        // 参数:
        //   id:
        //     Id of the entity
        //
        //   updateAction:
        //     Action that can be used to change values of the entity
        //
        // 返回结果:
        //     Updated entity
        Task<TEntity> UpdateAsync(TPrimaryKey id, Func<TEntity, Task> updateAction);

}

上一篇:在小程序中使用md5


下一篇:Docker:从头开始基于CentOS-Minimal安装Docker