🔥码云GVP开源项目 12k star Uniapp+ElementUI 功能强大 支持多语言、二开方便! 广告
### 使用Mapper BeetlSQL3更为推荐的使用Mapper接口,而不是SQLManager,SQLManger是更为底层的API,使用Mapper能更容易的维护业务代码 创建一个接口UserMapper ```java public interface UserMapper extends BaseMapper<UserEntity> { } ``` `BaseMapper`是BeetlSQL3提供的一个接口,内置了大量CRUD方法。 ```java //得到一个UserMapper接口的代理 UserMapper mapper = sqlManager.getMapper(UserMapper.class); UserEntity me = mapper.unique(1);//同SQLManager.unique(UserEntity.class,1) me.setName("newName"); mapper.updateById(me);//同同SQLManager.updateById(me); ``` 其他常用的方法在SQLManager也有,BaseMapper有如下内置方法 ```java /** * 通用插入,插入一个实体对象到数据库,所以字段将参与操作,除非你使用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(); ``` > 如何编写自己的BaseMaper或者扩展BaseMapper,超出了本章的范围,会在后面章节提到,如果有兴趣,可以直接查看@AutoMapper标注的类,是方法的具体实现 对于UserMapper来说,仅仅继承BaseMapper是不够的,可以在UserMapper上添加更多的数据库访问代码 ```java @Sql("select * from sys_user where id = ?") @Select UserEntity queryUserById(Integer id); @Sql("update sys_user set name=? where id = ?") @Update int updateName(String name,Integer id); @Template("select * from sys_user where id = #{id}") UserEntity getUserById(Integer id); @Template("update sys_user set name=#{name} where id = #{id}") @Update int updateName(String name,Integer id); @SpringData // 生成 select * from user hwere name=? order by id List<UserEntity> queryByNameOrderById(String name); /** * 可以定义一个default接口 * @return */ default List<DepartmentEntity> findAllDepartment(){ Map paras = new HashMap(); paras.put("exlcudeId",1); List<DepartmentEntity> list = getSQLManager().execute("select * from department where id != #{exlcudeId}",DepartmentEntity.class,paras); return list; } ``` * queryUserById 使用@Sql注解提供了Sql语句,@Select是可选的,默认都是查询操作 * updateName, 使用@Sql注解提供了Sql语句,使用@Update,表示这是更新语句,返回更新成功数目 * @Template 表示按照模板查询,这时候要求方法参数名字与模板语句的变量名一致。如果没有启用JDK8的parameter,则需要使用注解@Param来申明参数的名字 ```java @Template("select * from sys_user where id = #{id}") UserEntity getUserById(@Param("id") Integer myId); ``` * queryByNameOrderById 是使用@SpringData风格来拼接一个SQL,这会在后面详细介绍 * findAllDepartment 是一个接口方法实现,你也可以通过default method来实现简单的逻辑