技术标签: 通用接口参数 MybatisPlus QueryWarpper 后台 Mybaits Plus SpringBoot 接口参数 自定义查询接口
这是一款基于Mybatis插件查询功能的二次开发,让你的查询变得更加简单,简洁,方便和灵活。从此告别和前端人员的频繁沟通!! common-query组件在2.0.0版本后以去除Mybatis-plus的引用,将专注于基于Mybatis的查询功能。之前版本不影响使用,若想继续使用基于Mybatis-Plus的查询组件可以引用下面的包!
<dependency>
<groupId>com.github.DDLoveWorld</groupId>
<artifactId>common-query-mybatisplus</artifactId>
<version>1.0.1</version>
</dependency>
大家都了解一个简单完整SQL的样子是以下形式的:
SELECT ID,NAME FROM T_USER WHERE ID = 1;
上面是一个最简单的SQL查询语句了。(查询用户ID等于1的用户,返回用户的ID和名称)
本人把一个SQL分成了以下几个模块,那么给大家来拆分下上面的结构:
SELECT、FROM 、WHERE
上面的这三个单词都是关键字了。ID , NAME
是对查询到的结果进行返回,标明要返回的列名数据T_USER
这个就是表间关系,当然这个是最简单的表间关系了,仅仅是一个单表。实际开发中肯定是有很多业务是要多表关联查询了。(这个也是在实际设计中也是最难平衡的一个点了。为什么这么说后续我会进行解释)ID = 1 WHERE
后面都是筛选条件了,这里也是比较核心的地方(当然了,这个也不难,因为咱把这部分交给了Mybatis-plus了)任何事物都是有弊端的,只是看你的取舍了。
<dependency>
<groupId>com.github.DDLoveWorld</groupId>
<artifactId>common-query</artifactId>
<version>2.0.0</version>
</dependency>
下面我就用一个用户管理的业务来给大家具体展示下如何使用:
2. 建立一个用户管理查询控制VO类 SysUserVO
package com.hld.query.test.vo;
import com.hld.query.annotations.TableFiledInfo;
import com.hld.query.annotations.TableRelations;
import lombok.Data;
/**
* @author huald [email protected]
* @since 1.0.0 2019-09-03
*/
@Data
@TableRelations(mRelation = "sys_user T", mTableName = "sys_user", mTableAlias = "T")
public class SysUserVO {
private static final long serialVersionUID = 1L;
private final static String RELATION_DEPT = " left join sys_dept A on A.id = T.dept_id";
/**
* 用户id
*/
@TableFiledInfo()
private Long id;
/**
* 登录用户ID
*/
private Long loginId;
/**
* 用户名称
*/
@TableFiledInfo(filedSql = "select name from login_user B where B.id = T.login_id")
private String username;
/**
* 真实姓名
*/
@TableFiledInfo()
private String realName;
/**
* 用户所在部门的id
*/
@TableFiledInfo()
private Long deptId;
@TableFiledInfo(relation = RELATION_DEPT, tableName = "sys_dept", tableAlias = "A", filedName = "name")
private String deptName;
}
上面这个类有以下几点作用:
@TableRelations
类表间关系注解。它主要的作用是规定主表的表名、别名、主表表间关系@TableFiledInfo()
字段表间关系注解。它主要是用于告知哪些字段可以被查询使用。同时也是为非主表字段做一定的配置。/**
* 自定义查询
*
* @param params
* @return
*/
@PostMapping("commonQuery")
public Result commonQuery(@RequestBody QueryOptions params) {
return QueryUtils.getResult(sysUserMapper, params, SysUserVO.class);
}
特殊说明下:
各个业务的dao层需要继承我这边基于MybatisPlus插件中实现的CommonMapper
具体可自行参考源码!
对于开发来说,上面的三步就已经算结束了!这样是不是非常nice,再加上一个代码生成器。真是能不能在爽一下了!
有了上面的查询接口,那么对于用户管理这个业务基本就不在需要其他任何的查询接口了!我就说后端们你们happy不!
下面来给大家仔细说下:
解释说明已经在代码中做了描述,这里就不赘述了。最后一个firstSql参数慎用。然后IOrderBy、IFilter和groupBys就去下载源码看吧!
EQUAL("=", 0),
UN_EQUAL("<>", 1),
IN("关联", 2),
NO_IN("不关联", 3),
LIKE("LIKE", 4),
NO_LIKE("NOT LIKE", 5),
GE(">=", 6),
LE("<=", 7),
LT("<", 8),
GT(">", 9),
NOT_NULL("NOT_NULL", 10),
NULL("NULL", 11),
BETWEEN("BETWEEN", 12),
NOT_BETWEEN("NOT_BETWEEN", 13),
LEFT_LIKE("LEFT_LIKE", 14),
RIGHT_LIKE("RIGHT_LIKE", 15);
- MySQL
- Oracle
什么叫自定义返回数据格式呢?当和前端打交道的时候,各位是不是有过这种场景:对于一篇新闻文章的业务,这篇文章有很多的标签。那么这些标签可能在后台数据库的存储形式是,
id | tags |
---|---|
1 | 体育,足球,欧洲杯 |
对于数据库来说就是一个字符串。自定义查询直接就返回这个字符串了。但是前端就要数组。可不是"[体育,足球,欧洲杯]"
这样的json。而是真正的数组或者集合[体育,足球,欧洲杯]
。可能单独写都ok,那么如何在自定义查询中加上此功能呢?请看下面道来:
只需一个注解@FormatSwitch 搞定
package com.hld.query.annotations;
import com.hld.query.enums.SwitchType;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 此注解用于返回数据时进行数据结构转换,定义
*
* @author huald
* @date 2020/10/13
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FormatSwitch {
/**
* 分隔符
* 例: 1,2,3 采用逗号分隔
* 默认分隔符 ,
* 分隔符,当type = STR_TO_ARRAY 时使用生效
*
* @return
*/
String separation() default ",";
/**
* 转换类型
*
* @return
*/
SwitchType type() default SwitchType.STR_TO_ARRAY;
/**
* 需要转换的对象类型
* 当 type = JSON_TO_OBJ,JSON_TO_LIST 生效
*/
Class<?> cls() default Object.class;
}
只需要在VO类中把需要进行数据格式转换的字段加上此注解就ok了。
当然目前可以有以下四种转换类型:
具体例子下面都有
/**
* 字符串转数组,采用分隔符
* 例: 1,2,3 -> [1,2,3]
*/
STR_TO_ARRAY,
/**
* 字符串数据转数组
* 例: '[1,2,3]' -> [1,2,3]
*/
JSON_TO_ARRAY,
/**
* 字符串转对象
* 例: '{}' -> {}
*/
JSON_TO_OBJ,
/**
* 字符串对象数据转集合
* 例: '[{},{}]' -> [{},{}]
*/
JSON_TO_LIST;
对于有安全脱敏的同学也可以通过注解去实现了,具体功能可以先移步代码仓库先行查看,后续把文档补全。
工具类没有太多说的了。后续可根据自己业务需求自己做工具类。比如返回接口集的封装格式。我这边统一由Result类返回。
项目已发布到maven中央仓库,项目可直接引用
<!-- https://mvnrepository.com/artifact/com.github.DDLoveWorld/common-query -->
<dependency>
<groupId>com.github.DDLoveWorld</groupId>
<artifactId>common-query-mybatisplus</artifactId>
<version>1.0.0</version>
</dependency>
最后,项目还在不断的完善中,也希望有好的设计和想法的人私信我!感谢!!
如有转载请标明出处:
https://blog.csdn.net/My_Jack/article/details/106060592
小彩蛋:
此功能配合枚举类 注入Bean/Service实现类似工厂模式功能 更优欧。让你的查询更简洁!
文章浏览阅读2w次,点赞7次,收藏51次。四个步骤1.创建C++ Win32项目动态库dll 2.在Win32项目动态库中添加 外部依赖项 lib头文件和lib库3.导出C接口4.c#调用c++动态库开始你的表演...①创建一个空白的解决方案,在解决方案中添加 Visual C++ , Win32 项目空白解决方案的创建:添加Visual C++ , Win32 项目这......_c#调用lib
文章浏览阅读4.6k次。苹方字体是苹果系统上的黑体,挺好看的。注重颜值的网站都会使用,例如知乎:font-family: -apple-system, BlinkMacSystemFont, Helvetica Neue, PingFang SC, Microsoft YaHei, Source Han Sans SC, Noto Sans CJK SC, W..._ubuntu pingfang
文章浏览阅读159次。表单表单概述表单标签表单域按钮控件demo表单标签表单标签基本语法结构<form action="处理数据程序的url地址“ method=”get|post“ name="表单名称”></form><!--action,当提交表单时,向何处发送表单中的数据,地址可以是相对地址也可以是绝对地址--><!--method将表单中的数据传送给服务器处理,get方式直接显示在url地址中,数据可以被缓存,且长度有限制;而post方式数据隐藏传输,_html表单的处理程序有那些
文章浏览阅读1.2k次。使用说明:开启Google的登陆二步验证(即Google Authenticator服务)后用户登陆时需要输入额外由手机客户端生成的一次性密码。实现Google Authenticator功能需要服务器端和客户端的支持。服务器端负责密钥的生成、验证一次性密码是否正确。客户端记录密钥后生成一次性密码。下载谷歌验证类库文件放到项目合适位置(我这边放在项目Vender下面)https://github.com/PHPGangsta/GoogleAuthenticatorPHP代码示例://引入谷_php otp 验证器
文章浏览阅读4.3k次,点赞5次,收藏11次。matplotlib.plot画图横坐标混乱及间隔处理_matplotlib更改横轴间距
文章浏览阅读2.2k次。①Storage driver 处理各镜像层及容器层的处理细节,实现了多层数据的堆叠,为用户 提供了多层数据合并后的统一视图②所有 Storage driver 都使用可堆叠图像层和写时复制(CoW)策略③docker info 命令可查看当系统上的 storage driver主要用于测试目的,不建议用于生成环境。_docker 保存容器
文章浏览阅读834次,点赞27次,收藏13次。网络拓扑结构是指计算机网络中各组件(如计算机、服务器、打印机、路由器、交换机等设备)及其连接线路在物理布局或逻辑构型上的排列形式。这种布局不仅描述了设备间的实际物理连接方式,也决定了数据在网络中流动的路径和方式。不同的网络拓扑结构影响着网络的性能、可靠性、可扩展性及管理维护的难易程度。_网络拓扑csdn
文章浏览阅读1.8k次,点赞5次,收藏8次。IOS系统Date的坑要创建一个指定时间的new Date对象时,通常的做法是:new Date("2020-09-21 11:11:00")这行代码在 PC 端和安卓端都是正常的,而在 iOS 端则会提示 Invalid Date 无效日期。在IOS年月日中间的横岗许换成斜杠,也就是new Date("2020/09/21 11:11:00")通常为了兼容IOS的这个坑,需要做一些额外的特殊处理,笔者在开发的时候经常会忘了兼容IOS系统。所以就想试着重写Date函数,一劳永逸,避免每次ne_date.prototype 将所有 ios
文章浏览阅读5.3k次。方法一:用PLSQL Developer工具。 1 在PLSQL Developer的sql window里输入select * from test for update; 2 按F8执行 3 打开锁, 再按一下加号. 鼠标点到第一列的列头,使全列成选中状态,然后粘贴,最后commit提交即可。(前提..._excel导入pl/sql
文章浏览阅读83次。Git常用命令速查手册1、初始化仓库git init2、将文件添加到仓库git add 文件名 # 将工作区的某个文件添加到暂存区 git add -u # 添加所有被tracked文件中被修改或删除的文件信息到暂存区,不处理untracked的文件git add -A # 添加所有被tracked文件中被修改或删除的文件信息到暂存区,包括untracked的文件...
文章浏览阅读202次。分享119个ASP.NET源码总有一个是你想要的_千博二手车源码v2023 build 1120
文章浏览阅读1.8k次。版权声明:转载请注明出处 http://blog.csdn.net/irean_lau。目录(?)[+]1、缺省构造函数。2、缺省拷贝构造函数。3、 缺省析构函数。4、缺省赋值运算符。5、缺省取址运算符。6、 缺省取址运算符 const。[cpp] view plain copy_空类默认产生哪些类成员函数