### 使用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来实现简单的逻辑
- BeetlSQL 3 指南
- 数据访问框架
- 适合用户
- 编译源码
- 直接看代码
- 闲大赋介绍
- BeetlSQL3 特点
- 数据库访问工具的痛点
- BeetlSQL3 例子
- 基础例子
- 结果集映射
- 翻页查询
- 演示like,batchUpdate,in 操作
- 自动fetch
- 多数据库
- 代码生成框架
- 安装BeetlSQL
- 直接安装
- 框架集成
- 编译源码
- 快速开始
- 环境准备
- 环境搭建
- 使用BeetlSQL
- 按照主键查寻
- 更新
- 按照模板查询
- 执行SQL
- 执行模板SQL
- 使用Query
- 使用Mapper
- 使用模板文件
- SQLManager
- 内置语句
- 内置查询API
- template查询
- 更新操作
- 执行SQL
- 执行模板SQL
- 把SQL放到文件里
- 翻页查询
- SQLResult
- Stream查询
- 存储过程调用
- NameConversion(重要)
- DBStyle
- Inerceptor
- SQLManagerExtend
- 强制使用数据源
- Mapper
- 实现Mapper
- @Sql
- @Update @BatchUpdate
- @Template
- 参数名称
- 参数返回值
- 执行SQL文件
- 翻页查询
- @SqlProvider
- @SpringData
- @SubQuery
- @InheritMapper
- @Call
- StreamData
- Default Method
- 定义自己的BaseMapper
- 限制Java代码中SQL长度
- 数据模型
- POJO
- 不严格的POJO
- 交集(重要)
- @Table 注解
- @Column 注解
- 主键
- RowMapper
- ResultSetMapper
- Json配置映射
- Json自动映射
- XML支持
- 自动Fetch
- AttributeConvert
- BeanConvert
- 枚举
- 混合模型
- Map模型
- 动态模型
- 模型其他注解
- 安全扩展注解
- BeetlSql 单表查询工具Query
- Query使用方式和风格介绍
- Query主要操作简介
- 查询器获取
- SELECT简单的条件查询
- 复杂的条件查询
- 查询字段智能处理
- 健壮的变量
- 自定义实现
- INSERT操作
- UPDATE操作
- DELETE操作
- single查询和unique
- COUNT查询
- GROUP分组查询和Having子句
- 分页查询
- ORDER BY 排序
- page分页查询
- 方法调用顺序
- Markdown文件
- Beetl 入门
- 定界符号
- 变量
- 算数表达式
- 逻辑表达式
- 控制语句
- 访问变量属性
- 判断对象非空(重要)
- 调用方法
- 自定义方法
- 内置方法
- 标签功能
- 附录
- Idea 插件
- 代码生成
- 多库使用
- 业务主从库
- 主从库延迟问题
- 多个业务库
- 合并多个业务库 1
- 合并多个业务库 2
- 单表多租户
- 每个租户一个表
- 多库多租户
- 使用ShardingSphere
- Saga(试验)
- 关于Saga的一些认识
- 关于隔离性
- BeetlSQL Saga
- SagaMapper
- Saga 多库事务实现
- Saga 微服务 实现
- 配置 Saga Server
- Swagger
- BeetlSQL 性能
- 测试方法
- 最新
- 2021-11-21
- 2020-9-28
- Spring 快速开始
- 环境准备
- 环境搭建
- SpringBoot 快速开始
- 环境准备
- 环境搭建
- 扩展BeetlSQL3
- 完整配置
- BaseMapper定制
- 代码生成
- SQLExecutor定制
- 第三方
- MetadataManager
- JFinal集成
- ExecuteContext
- 参考ACT
- 数据库表到Java对象
- Solon
- NameConversion
- ViewType
- RowMapper
- ResultSetMapper
- AttributeConvert
- BeanConvert
- Fetch
- 代码生成
- 扩展BeetlSQL3
- BaseMapper定制
- SQLExecutor定制
- MetadataManager
- ExecuteContext
- 数据库表到Java对象
- NameConversion
- ViewType
- RowMapper
- ResultSetMapper
- AttributeConvert
- BeanConvert
- Fetch
- 代码生成
- BeetlSQL 多数据库支持
- 多库之间的不同
- 跨库支持实现
- DBStyle
- MySqlStyle 例子
- H2Style例子
- ClickHouseStyle例子
- HBaseStyle例子
- DruidStyle例子
- MetadataManager
- BeanProcessor
- 与BeetlSQL2的区别
- 使用区别