企业🤖AI智能体构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
## 实现Mapper 推荐通过继承已有接口BaseMapper来实现Mapper ```java public interface UserMapper extends BaseMapper<UserEntity> { } ``` BaseMapper 具备很多内置的CRUD方法,因此有了UserMapper后,同样可以不写任何SQL,可以轻易的完成常用操作。例如 ```java //得到UserMapper接口的一个代理实现类,如果使用spring框架,则可以自动注入mapper UserMapper mapper = sqlManager.getMapper(UserMapper.class); List<UserEntity> list = mapper.all(); boolean isExist = mapper.exist(2); UserEntity me = mapper.unique(1); me.setName("newName"); mapper.updateById(me); ``` BaseMapper是BeetlSQL3提供的一个默认的类(你可以完成自己的BaseMapper,参考《定义自己的Mapper》),BaseMapper定义如下 ```java /** * BaseMapper.定义了一个Mapper接口,并内置了多个方法 * 开发者可以定义自己的"BaseMapper",并使用AutoMapper注解来申明这是内置的,beetlsql会调用其注解使用的接口 * @param <T> the generic type * @author xiandafu */ public interface BaseMapper<T> { /** * 通用插入,插入一个实体对象到数据库,所以字段将参与操作,除非你使用ColumnIgnore注解 *SqlResource * @param entity */ @AutoMapper(InsertAMI.class) void insert(T entity); /** * 插入实体到数据库,对于null值不做处理 * * @param entity */ @AutoMapper(InsertTemplateAMI.class) void insertTemplate(T entity); /** * 批量插入实体。此方法不会获取自增主键的值,如果需要,建议不适用批量插入,适用 * <pre> * insert(T entity,true); * </pre> * * @param list */ @AutoMapper(InsertBatchAMI.class) void insertBatch(List<T> list); /** * 根据主键更新对象,所以属性都参与更新。也可以使用主键ColumnIgnore来控制更新的时候忽略此字段 * @param entity * @return */ @AutoMapper(UpdateByIdAMI.class) int updateById(T entity); /** * 根据主键更新对象,只有不为null的属性参与更新 * * @param entity * @return */ @AutoMapper(UpdateTemplateByIdAMI.class) int updateTemplateById(T entity); /** * 按照主键更新更新或插入,自增或者序列id自动赋值给entity * @param entity 待更新/插入的实体对象 * @return 如果是插入操作,返回true,如果是更新,返回false */ @AutoMapper(UpsertAMI.class) boolean upsert(T entity); /**按照主键更新或插入,更新失败,会调用插入,属性为空的字段将不更新或者插入。自增或者序列id自动赋值给entity * @param entity 待更新/插入的实体对象 * @return */ @AutoMapper(UpsertByTemplateAMI.class) int upsertByTemplate(T entity); /** * 根据主键删除对象,如果对象是复合主键,传入对象本生即可 * * @param key * @return */ @AutoMapper(DeleteByIdAMI.class) int deleteById(Object key); /** * 根据主键获取对象,如果对象不存在,则会抛出一个Runtime异常 * * @param key * @return */ @AutoMapper(UniqueAMI.class) T unique(Object key); /** * 根据主键获取对象,如果对象不存在,返回null * * @param key * @return */ @AutoMapper(SingleAMI.class) T single(Object key); /** * 根据一批主键查询 * @param key * @return */ @AutoMapper(SelectByIdsAMI.class) List<T> selectByIds(List<?> key); default boolean exist(Object key){ return this.getSQLManager().exist(this.getTargetEntity(),key); } /** * 根据主键获取对象,如果在事物中执行会添加数据库行级锁(select * from table where id = ? for update),如果对象不存在,返回null * * @param key * @return */ @AutoMapper(LockAMI.class) T lock(Object key); /** * 返回实体对应的所有数据库记录 * * @return */ @AutoMapper(AllAMI.class) List<T> all(); /** * 返回实体在数据库里的总数 * * @return */ @AutoMapper(AllCountAMI.class) long allCount(); /** * 模板查询,返回符合模板得所有结果。beetlsql将取出非null值(日期类型排除在外),从数据库找出完全匹配的结果集 * * @param entity * @return */ @AutoMapper(TemplateAMI.class) List<T> template(T entity); /** * 模板查询,返回一条结果,如果没有,返回null * * @param entity * @return */ @AutoMapper(TemplateOneAMI.class) <T> T templateOne(T entity); /** * 符合模板得个数 * * @param entity * @return */ @AutoMapper(TemplateCountAMI.class) long templateCount(T entity); /** * 执行一个jdbc sql模板查询 * * @param sql * @param args * @return */ @AutoMapper(ExecuteAMI.class) List<T> execute(String sql, Object... args); /** * 执行一个更新的jdbc sql * * @param sql * @param args * @return */ @AutoMapper(ExecuteUpdateAMI.class) int executeUpdate(String sql, Object... args); @AutoMapper(GetSQLManagerAMI.class) SQLManager getSQLManager(); /** * 返回一个Query对象 * * @return */ @AutoMapper(QueryAMI.class) Query<T> createQuery(); /** * 返回一个LambdaQuery对象 * * @return */ @AutoMapper(LambdaQueryAMI.class) LambdaQuery<T> createLambdaQuery(); /** * 得到mapper的范型类 * @return */ @AutoMapper(GetTargetEntityAMI.class) Class getTargetEntity(); } ``` BaseMapper提供了POJO常用的CRUD方法,每个BaseMapper的接口方法都是通过@AutoMapper注解申明一个实现类,实现类调用SQLManager相关得API。 关于此实现类,可以参考《扩展BeetlSQL3》 除了BaseMapper提供的方法外,你还可以为Mapper添加各种访问数据库的方法,说明如下