我这样写代码,比直接使用 MyBatis 效率提高了 100 倍
共 16994字,需浏览 34分钟
·
2021-12-14 14:53
来源:juejin.cn/post/7027733039299952676
mybatis
、hibernate
、data-jdbc
等都是我们常用的 ORM 框架。它们有时候很好用,比如简单的 CRUD,事务的支持都非常棒。但有时候用起来也非常繁琐,比如接下来我们要聊到的一个常见的开发需求,而对这类需求,本文会给出一个比直接使用这些 ORM 开发效率至少会提高 100 倍的方法(绝无夸张)。首先数据库有两张表
接下来我们要实现一个用户查询的功能
可按
用户名
字段查询,要求:可按
年龄
字段查询,要求:可按 角色ID
查询,要求:精确匹配可按 用户ID
查询,要求:同年龄
字段搜索公众号互联网架构师复“2T”,送你一份惊喜礼包。 可指定只输出哪些列(例如,只查询 ID
与用户名
列)支持分页(每次查询后,页面都要显示满足条件的用户总数) 查询时可选择按 ID
、用户名
、年龄
等任意字段排序
后端接口该怎么写呢?
mybatis
、hibernate
、data-jdbc
直接来写的话,100 行代码 能实现吗?手把手:只一行代码实现以上需求
假设我们项目使用的框架是 Spring Boot(当然 Bean Searcher 对框架没有要求,但在 Spring Boot 中使用更加方便)
添加依赖
<dependency>
<groupId>com.ejlchina</groupId>
<artifactId>bean-searcher-boot-starter</artifactId>
<version>3.0.1</version>
</dependency>
Gradle :搜索公众号互联网架构师复“2T”,送你一份惊喜礼包。
implementation 'com.ejlchina:bean-searcher-boot-starter:3.0.1'
然后写个实体类来承载查询的结果
@SearchBean(tables="user u, role r", joinCond="u.role_id = r.id", autoMapTo="u")
public class User {
private Long id; // 用户ID(u.id)
private String name; // 用户名(u.name)
private int age; // 年龄(u.age)
private int roleId; // 角色ID(u.role_id)
@DbField("r.name") // 指明这个属性来自 role 表的 name 字段
private int role; // 角色名(r.name)
// Getter and Setter ...
}
接着就可以写用户查询接口了
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private MapSearcher mapSearcher; // 注入检索器(由 bean-searcher-boot-starter 提供)
@GetMapping("/index")
public SearchResult<Map<String, Object>> index(HttpServletRequest request) {
// 这里咱们只写一行代码
return mapSearcher.search(User.class, MapUtils.flat(request.getParameterMap()));
}
}
上述代码中的 MapUtils
是 Bean Searcher 提供的一个工具类,MapUtils.flat(request.getParameterMap())
只是为了把前端传来的请求参数统一收集起来,然后剩下的,就全部交给MapSearcher
检索器了。
这样就完了?那我们来测一下这个接口,看看效果吧
(1)无参请求
GET /user/index
返回结果:
{
"dataList": [ // 用户列表,默认返回第 0 页,默认分页大小为 15 (可配置)
{ "id": 1, "name": "Jack", "age": 25, "roleId": 1, "role": "普通用户" },
{ "id": 2, "name": "Tom", "age": 26, "roleId": 1, "role": "普通用户" },
...
],
"totalCount": 100 // 用户总数
}
(2)分页请求(page | size)
GET /user/index? page=2 & size=10
返回结果:结构同 (1)(只是每页 10 条,返回第 2 页)
(3)数据排序(sort | order)
GET /user/index? sort=age & order=desc
返回结果:结构同 (1)(只是 dataList 数据列表以 age 字段降序输出)
(4)指定(排除)字段(onlySelect | selectExclude)
{
"dataList": [ // 用户列表,默认返回第 0 页(只包含 id,name,role 字段)
{ "id": 1, "name": "Jack", "role": "普通用户" },
{ "id": 2, "name": "Tom", "role": "普通用户" },
...
],
"totalCount": 100 // 用户总数
}
参数名
onlySelect
和selectExclude
可自定义,可与其它参数组合使用
(5)字段过滤(op = eq)
GET /user/index? age=20 GET /user/index? age=20 & age-op=eq 返回结果:结构同 (1)(但只返回 age = 20 的数据)
参数 age-op = eq
表示age
的 字段运算符 是eq
(Equal
的缩写),表示参数age
与参数值20
之间的关系是Equal
,由于Equal
是一个默认的关系,所以age-op = eq
也可以省略
参数名 age-op
的后缀 -op
可自定义,且可与其它字段参数 和 上文所列的参数(分页、排序、指定字段)组合使用,下文所列的字段参数也是一样,不再复述。
(6)字段过滤(op = ne)
GET /user/index? age=20 & age-op=ne
返回结果:结构同 (1)(但只返回 age != 20 的数据,
ne
是NotEqual
的缩写)
(7)字段过滤(op = ge)
GET /user/index? age=20 & age-op=ge
返回结果:结构同 (1)(但只返回 age >= 20 的数据,
ge
是GreateEqual
的缩写)
(8)字段过滤(op = le)
GET /user/index? age=20 & age-op=le
返回结果:结构同 (1)(但只返回 age <= 20 的数据,
le
是LessEqual
的缩写)
(9)字段过滤(op = gt)
GET /user/index? age=20 & age-op=gt
返回结果:结构同 (1)(但只返回 age > 20 的数据,
gt
是GreateThan
的缩写)
(10)字段过滤(op = lt)
GET /user/index? age=20 & age-op=lt
返回结果:结构同 (1)(但只返回 age < 20 的数据,
lt
是LessThan
的缩写)
(11)字段过滤(op = bt)
GET /user/index? age-0=20 & age-1=30 & age-op=bt
返回结果:结构同 (1)(但只返回 20 <= age <= 30 的数据,
bt
是Between
的缩写)搜索公众号互联网架构师复“2T”,送你一份惊喜礼包。
参数 age-0 = 20
表示age
的第 0 个参数值是20
。上述提到的age = 20
实际上是age-0 = 20
的简写形式。另:参数名age-0
与age-1
中的连字符-
可自定义。
(12)字段过滤(op = mv)
GET /user/index? age-0=20 & age-1=30 & age-2=40 & age-op=mv
返回结果:结构同 (1)(但只返回 age in (20, 30, 40) 的数据,
mv
是MultiValue
的缩写,表示有多个值的意思)
(13)字段过滤(op = in)
GET /user/index? name=Jack & name-op=in
返回结果:结构同 (1)(但只返回 name 包含 Jack 的数据,
in
是Include
的缩写)
(14)字段过滤(op = sw)
GET /user/index? name=Jack & name-op=sw
返回结果:结构同 (1)(但只返回 name 以 Jack 开头的数据,
sw
是StartWith
的缩写)
(15)字段过滤(op = ew)
GET /user/index? name=Jack & name-op=ew
返回结果:结构同 (1)(但只返回 name 以 Jack 结尾的数据,
sw
是EndWith
的缩写)
(16)字段过滤(op = ey)
GET /user/index? name-op=ey
返回结果:结构同 (1)(但只返回 name 为空 或为 null 的数据,
ey
是Empty
的缩写)
(17)字段过滤(op = ny)
GET /user/index? name-op=ny
返回结果:结构同 (1)(但只返回 name 非空 的数据,
ny
是NotEmpty
的缩写)
(18)忽略大小写(ic = true)
GET /user/index? name=Jack & name-ic=true
返回结果:结构同 (1)(但只返回 name 等于 Jack (忽略大小写) 的数据,
ic
是IgnoreCase
的缩写)
参数名 name-ic
中的后缀-ic
可自定义,该参数可与其它的参数组合使用,比如这里检索的是 name 等于 Jack 时忽略大小写,但同样适用于检索 name 以 Jack 开头或结尾时忽略大小写。
当然,以上各种条件都可以组合,例如
GET /user/index? name=Jack & name-op=sw & name-ic=true & roleId=1 & sort=id & size=10 & page=2 返回结果:结构同 (1)
/user/index
接口里我们确实只写了一行代码,它便可以支持这么多种的检索方式,有没有觉得现在 你写的一行代码 就可以 干过别人的一百行 呢?相关阅读:2T架构师学习资料干货分享
Bean Searcher
MapSearcher
检索器的一个 search
方法,其实,它有很多 search
方法。searchCount(Class<T> beanClass, Map<String, Object> params)
查询指定条件下的数据 总条数searchSum(Class<T> beanClass, Map<String, Object> params, String field)
查询指定条件下的 某字段 的 统计值searchSum(Class<T> beanClass, Map<String, Object> params, String[] fields)
查询指定条件下的 多字段 的 统计值search(Class<T> beanClass, Map<String, Object> params)
分页 查询指定条件下数据 列表 与 总条数search(Class<T> beanClass, Map<String, Object> params, String[] summaryFields)
同上 + 多字段 统计searchFirst(Class<T> beanClass, Map<String, Object> params)
查询指定条件下的 第一条 数据searchList(Class<T> beanClass, Map<String, Object> params)
分页 查询指定条件下数据 列表searchAll(Class<T> beanClass, Map<String, Object> params)
查询指定条件下 所有 数据 列表
MapSearcher 与 BeanSearcher
MapSearcher
检索器外,还提供了 BeanSearcher
检索器,它同样拥有 MapSearcher
拥有的方法,只是它返回的单条数据不是 Map
,而是一个 泛型 对象。参数构建工具
Map<String, Object>
类型的参数可能不太优雅,为此, Bean Searcher 特意提供了一个参数构建工具。Map<String, Object> params = MapUtils.builder()
.field(User::getName, "Jack").op(Operator.StartWith).ic()
.field(User::getRoleId, 1)
.orderBy(User::getId, "asc")
.page(2, 10)
.build()
List<User> users = beanSearcher.searchList(User.class, params);
这里使用的是 BeanSearcher
检索器,以及它的searchList(Class<T> beanClass, Map<String, Object> params)
方法。
运算符约束
name
字段只需要注解一下即可:@SearchBean(tables="user u, role r", joinCond="u.role_id = r.id", autoMapTo="u")
public class User {
@DbField(onlyOn = {Operator.Equal, Operator.StartWith})
private String name;
// 为减少篇幅,省略其它字段...
}
@DbField
注解的 onlyOn
属性,指定这个用户名 name
只能适用与 精确匹配 和 后模糊查询,其它检索方式它将直接忽略。name
只能有两种检索方式,如果再严格一点,只允许 精确匹配,那其实有两种写法。(1)还是使用运算符约束:
@SearchBean(tables="user u, role r", joinCond="u.role_id = r.id", autoMapTo="u")
public class User {
@DbField(onlyOn = Operator.Equal)
private String name;
// 为减少篇幅,省略其它字段...
}
(2)在 Controller 的接口方法里把运算符参数覆盖:
@GetMapping("/index")
public SearchResult<Map<String, Object>> index(HttpServletRequest request) {
Map<String, Object> params = MapUtils.flatBuilder(request.getParameterMap())
.field(User::getName).op(Operator.Equal) // 把 name 字段的运算符直接覆盖为 Equal
.build()
return mapSearcher.search(User.class, params);
}
条件约束
@SearchBean(tables="user u, role r", joinCond="u.role_id = r.id", autoMapTo="u")
public class User {
@DbField(conditional = false)
private int age;
// 为减少篇幅,省略其它字段...
}
@DbField
注解的 conditional
属性, 就直接不允许 age
字段参与条件了,无论前端怎么传参,Bean Searcher 都不搭理。参数过滤器
@Bean
public ParamFilter myParamFilter() {
return new ParamFilter() {
@Override
public <T> Map<String, Object> doFilter(BeanMeta<T> beanMeta, Map<String, Object> paraMap) {
// beanMeta 是正在检索的实体类的元信息, paraMap 是当前的检索参数
// TODO: 这里可以写一些自定义的参数过滤规则
return paraMap; // 返回过滤后的检索参数
}
};
}
参数咋这么怪,这么多呢,和前端有仇么
参数名是否奇怪,这其实看个人喜好,如果你不喜欢中划线
-
,不喜欢op
、ic
后缀,完全可以自定义,参考这篇文档:
参数个数的多少,其实是和需求的复杂程度相关的。如果需求很简单,那么很多参数没必要让前端传,后端直接塞进去就好。比如:
name
只要求后模糊匹配,age
只要求区间匹配,则可以:搜索公众号互联网架构师复“2T”,送你一份惊喜礼包。
@GetMapping("/index")
public SearchResult<Map<String, Object>> index(HttpServletRequest request) {
Map<String, Object> params = MapUtils.flatBuilder(request.getParameterMap())
.field(User::getName).op(Operator.StartWith)
.field(User::getAge).op(Operator.Between)
.build()
return mapSearcher.search(User.class, params);
}
这样前端就不用传 name-op
与 age-op
这两个参数了。
onlyOn
属性中指定的第一个值,前端可以省略不传):@SearchBean(tables="user u, role r", joinCond="u.role_id = r.id", autoMapTo="u")
public class User {
@DbField(onlyOn = Operator.StartWith)
private String name;
@DbField(onlyOn = Operator.Between)
private String age;
// 为减少篇幅,省略其它字段...
}
入参是 request,我 swagger 文档不好渲染了呀
Map<String, Object>
类型的参数,至于这个参数是怎么来的,和 Bean Searcher 并没有直接关系。前文之所以从 request
里取,只是因为这样代码看起来简洁,如果你喜欢声明参数,完全可以把代码写成这样:@GetMapping("/index")
public SearchResult<Map<String, Object>> index(Integer page, Integer size,
String sort, String order, String name, Integer roleId,
@RequestParam(value = "name-op", required = false) String name_op,
@RequestParam(value = "name-ic", required = false) Boolean name_ic,
@RequestParam(value = "age-0", required = false) Integer age_0,
@RequestParam(value = "age-1", required = false) Integer age_1,
@RequestParam(value = "age-op", required = false) String age_op) {
Map<String, Object> params = MapUtils.builder()
.field(Employee::getName, name).op(name_op).ic(name_ic)
.field(Employee::getAge, age_0, age_1).op(age_op)
.field(Employee::getRoleId, roleId)
.orderBy(sort, order)
.page(page, size)
.build();
return mapSearcher.search(User.class, params);
}
结语
支持 聚合查询 支持 Select|Where|From子查询 支持 实体类嵌入参数 支持 字段转换器 支持 Sql 拦截器 支持 多数据源 支持 自定义注解 等等