本文主要是介绍给springmvc接口快速增加字段检索,外键从表检索,外键从表查询的searchdb注解，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！
介绍
日常业务中经常会遇见根据几个字段进行检索，可能检索字段还分散在不同的表中需要进行join关联查询; 也有查询的结果集中带有Id字段，我们需要结果集中带有id对应的实体表的某些字段，这些需要写关联查询的sql才能完成的业务功能。
比如:
我们查询订单表order，需要使用订单号，用户username进行检索，结果集中还需要username等用户字段，往往设计order表时只有userId字段。这时就需要join关联，这种方式增加的sql语句的复杂度，在检索字段或者结果集变动时需要改动sql语句。在分库的情况下join难度增大。
在这个需求下，使用@serachdb，你的order查询只需要select * from order，其他的检索字段，结果集整合，会自动完成。
源码地址
https://github.com/mangues/search-db
0.0.3版本:
- @DictSearch 删除 合并到 @SearchDb上
- 支持controller 参数检索注解
安装方式
具体案例可以查看 demo分支
maven
<dependency><groupId>top.mangues</groupId><artifactId>searchdb-spring-boot-starter</artifactId><version>0.0.3-RELEASE</version>
</dependency>
Gradle
compile 'top.mangues:searchdb-spring-boot-starter:0.0.3-RELEASE'
配置，mybatis 插件
mybatis-config.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration><plugins><!-- sqldb拦截器 --><plugin interceptor="com.mangues.searchdb.mybatis.SearchInterceptor"><property name="dialect" value="mysql"/></plugin></plugins>
</configuration>
使用方法
以下图片随机网上截取
一、简单使用
user表
id name password
1 张三 123456
2 李思 123456
- 正常查询所有user数据
@GetMapping("/list")
@ApiOperation(value = "获取用户列表")
public Object orderList() {return iUserService.list();
}
- 加上字段name检索，只需要添加注解 @SearchDb，搜索类UserSearch，UserSearch必须继承接口SearchBean，
或者参数加上注解@SearchParam(column=“必须指定”)
@GetMapping("/list")
@ApiOperation(value = "获取用户列表")
@SearchDb
public Object orderList(UserSearch userSearch,@RequestParam @SearchParam(column = "name",symbol = SearchParamEnum.like) String username) {return iUserService.list();
}
@SearchParam参数：
- column: 数据库需要检索字段，不写默认变量名下划线形式userName-user_name
- symbol: 检索类型：=、like、in、between and。目前这几种，后期加别的
@Data
public class UserSearch implements SearchBean {@SearchParam(column = "password",symbol = SearchParamEnum.like)private String password;
}二、其他使用
1. 检索时间格式化
order_info 表
id user_id order_num create_at state
1 1 ED123456 2018-12-19 22:23:23 -1
2 2 ED234566 2018-12-20 22:23:23 2
3 1 DF345677 2018-12-21 22:23:23 -2
数据库格式是 2018-12-19 22:23:23 形式，可是查询需要按日查询
dateFormat 后接数据库 FORMAT_DATE 函数的格式化 字符串
@SearchParam(column = "create_at",symbol = SearchParamEnum.between_and,dateFormat = "%Y-%m-%d")
@ApiModelProperty(value = "订单时间范围 2018-12-11,2018-12-24")
private String createDate;
2.between and 用法
必须字符串参数，"," 分隔前后两个检索参数
@SearchParam(column = "create_at",symbol = SearchParamEnum.between_and,dateFormat = "%Y-%m-%d")
@ApiModelProperty(value = "订单时间范围 2018-12-11,2018-12-24")
private String createDate;
3.枚举变量检索支持
必须实现 Enum 接口的string 方法，返回值就是对应的枚举在数据库中的存储值，此处是code
public enum OrderStateEnum implements Enum {REFUND(-2,"已经退单"),NOFINISH(-1,"订单未完成锁定中"),NOSETTLEMWNT(0,"未结算"),SETTLEMWNT(1,"已结算");Integer code;String msg;private OrderStateEnum(Integer code, String msg) {this.code = code;this.msg = msg;}@Overridepublic String string() {return code+"";}3.外键查询
@SearchDb
自动查询填充主表外键所对应的从表数据
比如 select * from order_info 结果集中的user_id 是外键，此注解可以自动完善user_id 对应的user数据
例子：
@DictSearch开启功能，resultClass 对应返回list 或者 object 类型
@GetMapping("/list")
@ApiOperation(value = "获取订单列表")
@SearchDb(resultClass = OrderInfo.class)
public Object orderList(OrderSearch orderSearch) {return orderInfoService.list();
}
@DictParam描述外键所需要的配置
- dictTable：从表
- columns: 所要显示的从表字段
- dictId：从表外键字段 默认id
public class OrderInfo@DictParam(dictTable = "user",columns = {"name","password"},dictId="id")private Integer userId;...
}
结果： 自动填充的 userIdDictMap
[{"userIdDictMap": {"password": "123456","name": "张三","id": 1},"orderNum": "ED123456","state": -1"userId": 1,"createAt": "2018-12-19T22:23:23"},
]
四、增强@SearchParam外键检索
支持外键检索
比如 select * from order_info 只能检索user_id字段，此注解可以利用 user_id 对应的从表 user 中的字段进行检索
例子
@SearchParam(column = "name",symbol = SearchParamEnum.like,isDictColumn = true,dictColumn = "user_id",dictTable = "user")private String userName;
增加：
- isDictColumn 此字段否外键
- dictColumn： 对应的主表外键字段
- dictTable: 从表
这篇关于给springmvc接口快速增加字段检索,外键从表检索,外键从表查询的searchdb注解的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！
