BeetlSQL BaseMapper类的注释详解（因为在开发工具里面看到的注释都会乱码，所以特地找了一下BaseMapper的注释

public interface BaseMapper {

/**
     * 通用插入，插入一个实体对象到数据库，所以字段将参与操作，除非你使用ColumnIgnore注解
     * @param entity
     /
    void insert(T entity);
    /*
     * （数据库表有自增主键调用此方法）如果实体对应的有自增主键，插入一个实体到数据库，设置assignKey为true的时候，将会获取此主键
     * @param entity
     * @param autDbAssignKey 是否获取自增主键
     /
    void insert(T entity,boolean autDbAssignKey);
    /*
     * 插入实体到数据库，对于null值不做处理
     * @param entity
     /
    void insertTemplate(T entity);
    /*
     * 如果实体对应的有自增主键，插入实体到数据库，对于null值不做处理,设置assignKey为true的时候，将会获取此主键
     * @param entity
     * @param autDbAssignKey
     /
    void insertTemplate(T entity,boolean autDbAssignKey);
    /*
     * 批量插入实体。此方法不会获取自增主键的值，如果需要，建议不适用批量插入，适用
     *

     * insert(T entity,true);

     * 

     * @param list
     /
    void insertBatch(List list);
    /*
     * （数据库表有自增主键调用此方法）如果实体对应的有自增主键，插入实体到数据库，自增主键值放到keyHolder里处理
     * @param entity
     * @return
     /
    KeyHolder insertReturnKey(T entity);
    
    /*
     * 根据主键更新对象，所以属性都参与更新。也可以使用主键ColumnIgnore来控制更新的时候忽略此字段
     * @param entity
     * @return
     /
    int updateById(T entity);
    /*
     * 根据主键更新对象，只有不为null的属性参与更新
     * @param entity
     * @return
     /
    int updateTemplateById(T entity);
    
    /*
     * 根据主键删除对象，如果对象是复合主键，传入对象本生即可
     * @param key
     * @return
     */
    int deleteById(Object key);

/**
     * 根据主键获取对象，如果对象不存在，则会抛出一个Runtime异常
     * @param key
     * @return
     /
    T unique(Object key);
    /*
     * 根据主键获取对象，如果对象不存在，返回null
     * @param key
     * @return
     /
    T single(Object key);
    
    
    /*
     * 根据主键获取对象，如果在事物中执行会添加数据库行级锁(select * from table where id = ? for update)，如果对象不存在，返回null
     * @param key
     * @return
     /
    T lock(Object key);
    
    /*
     * 返回实体对应的所有数据库记录
     * @return
     /
    List all();
    /*
     * 返回实体对应的一个范围的记录
     * @param start
     * @param size
     * @return
     /
    List all(int start,int size);
    /*
     * 返回实体在数据库里的总数
     * @return
     /
    long allCount();
    
    /*
     * 模板查询，返回符合模板得所有结果。beetlsql将取出非null值（日期类型排除在外），从数据库找出完全匹配的结果集
     * @param entity
     * @return
     */
    List template(T entity);

/**
     * 模板查询，返回一条结果,如果没有，返回null
     * @param entity
     * @return
     */
     T templateOne(T entity);

List template(T entity,int start,int size);
    
    void templatePage(PageQuery query);
    /**
     * 符合模板得个数
     * @param entity
     * @return
     /
    long templateCount(T entity);
    
    
    
    /*
     * 执行一个jdbc sql模板查询
     * @param sql
     * @param args
     * @return
     /
    List execute(String sql,Object… args);
    /*
     * 执行一个更新的jdbc sql
     * @param sql
     * @param args
     * @return
     /
    int executeUpdate(String sql,Object… args );
    
    SQLManager getSQLManager();
    
    /*
     * 返回一个Query对象
     * @return
     */
    Query createQuery();

/**
     * 返回一个LambdaQuery对象
     * @return
     */
    LambdaQuery createLambdaQuery();
}

作者：flystarfly
来源：CSDN
原文：https://blog.csdn.net/flystarfly/article/details/82752597
版权声明：本文为博主原创文章，转载请附上博文链接！