Mybatis-Plus:实现自定义SQL

2023-10-27

目录

1.简介

2.自定义SQL具体实现

2.1.注解SQL

2.2.Wrapper传参+注解SQL

2.3.Wrapper传参+xml文件SQL

2.4.正常传参+XML文件SQL

3.总结


1.简介

        Mybatis-Plus(以下简称MBP)的初衷是为了简化开发,而不建议开发者自己写SQL语句的;但是有时客户需求比较复杂,仅使用MBP提供的Service,Mapper与Wrapper进行组合,难以实现可以需求; 这时我们就要用到自定义的SQL了。

        Java 开发使用 mybatis-plus 来执行 sql 操作,往往比 mybatis 能够省时省力,因为 mybatis-plus 封装了很多常用的接口。但对于一些更为复杂的查询来说,mybatis-plus 也相形见绌,还得需要我们自定义 sql 语句。本文就来介绍一下在使用 mybatis-plus/mybatis 的情况下,如何自定义 sql 语句、动态 sql 等。

Mybatis-Plus实现自定义的方式有以下几种:

1)注解SQL

2)Wrapper传参+注解SQL

        局限性:不适用于多表关联查询,查询字段过多代码比较凌乱

3)Wrapper传参+XML文件SQL:推荐

4)对象传参+XML文件SQL

        最传统的写法,流程过于繁琐,简单的单表查询时,配置麻烦

2.自定义SQL具体实现

2.1.注解SQL

Mybatis-plus提供了注解SQL功能,可以通过注解方式实现SQL的编写,注解SQL的前提是在Mybatis的配置文件中开启注解功能。

我们可以在Mapper的继承类中,使用完整的自定义SQL;

//多数据源情况下,@DS注解用于指定数据源
@DS("zw-mysqldb")
public interface CarMapper extends BaseMapper<Car> {
 
    @Select("select * from car where car_seq = #{carSeq}")
    Car queryCar(String carSeq);

}
   @RequestMapping("/ok")
    public void testCustomSQL2() {
 
        Car car = carMapper.queryCar("11");
        System.out.println(car.toString());
    }

补充: 

1)使用@Param注解

当以下面的方式进行写SQL语句时:

    @Select("select column from table where userid = #{userid} ")
    public int selectColumn(int userid);

当你使用了使用@Param注解来声明参数时,如果使用 #{} 或 ${} 的方式都可以。

    @Select("select column from table where userid = ${userid} ")
    public int selectColumn(@Param("userid") int userid);


当你不使用@Param注解来声明参数时,必须使用使用 #{}方式。如果使用 ${} 的方式,会报错。

    @Select("select column from table where userid = ${userid} ")
    public int selectColumn(@Param("userid") int userid);
 

2)不使用@Param注解

不使用@Param注解时,参数只能有一个,并且是Javabean。在SQL语句里可以引用JavaBean的属性,而且只能引用JavaBean的属性。

    // 这里id是user的属性

    @Select("SELECT * from Table where id = ${id}")
    Enchashment selectUserById(User user);

上面的代码中使用了注解SQL的方式,通过@Select注解指定了SQL语句。在方法中使用@Param注解指定参数名称,可以方便的进行参数传递,参数名称与sql参数名称一致可省略。

注解SQL的优点是代码简洁,可读性好,同时也可以结合Wrapper等方式进行复杂的SQL构建。

2.2.Wrapper传参+注解SQL

使用Wrapper方式的一些使用场景:

1)动态查询:使用Wrapper可以根据不同的查询条件,动态地拼接SQL语句,实现精确查询。

2)多表联合查询:在多表联合查询时,使用Wrapper可以方便地拼接SQL语句,实现多表联合查询。

3)分页查询:在分页查询时,使用Wrapper可以方便地拼接SQL语句,实现分页功能。

4)条件查询:使用Wrapper可以根据不同的条件,动态地拼接SQL语句,实现条件查询。

5)排序查询:使用Wrapper可以方便地拼接SQL语句,实现排序功能

使用SQL结合Wrapper进行复杂的SQL构建时,通常需要完成以下几个步骤:

a)创建Wrapper对象

通过创建Wrapper对象,可以方便地进行SQL构建和条件设置。下面是创建Wrapper对象的示例代码:

QueryWrapper<Entity> wrapper = new QueryWrapper<>(); 

b)设置查询条件

可以使用Wrapper对象的方法设置查询条件,例如eq、ne等方法可以设置等于、不等于等条件。下面是设置查询条件的示例代码:

wrapper.eq("column1", value1)
       .ne("column2", value2)
       .like("column3", value3);

//示例
wrapper.eq("car_state", "1")
                .like("car_id", "渝A");

c)设置排序条件(非必须)

可以使用Wrapper对象的orderBy方法设置排序条件,例如orderByAsc、orderByDesc等方法可以设置升序、降序等条件。下面是设置排序条件的示例代码:

wrapper.orderByAsc("car_id")

d)设置分页条件(非必须)

可以使用Wrapper对象的方法设置分页条件,例如page方法可以设置页码和每页大小等条件。下面是设置分页条件的示例代码:

Page<Car> resultPage = new Page<>(1, 10);
carMapper.selectByPrimaryKey(resultPage,wrapper)

e)mapper接口

@Select("select * from car ${ew.customSqlSegment}")
Page<Car> selectByPrimaryKey(Page<Car> page, @Param(Constants.WRAPPER) QueryWrapper<Car> queryWrapper);

f)执行SQL操作

接口的方法执行SQL操作,例如selectList、selectPage等方法可以执行SQL查询操作,也可以自定义查询。下面是执行SQL操作的示例完整代码:

//分页查询方式1
QueryWrapper<Car> wrapper = new QueryWrapper<>();
Page<Car> resultPage = new Page<>(1, 10);

wrapper.eq("car_state", "1")
       .like("car_id", "渝A")
       .orderByAsc("car_id");//排序
carMapper.selectByPrimaryKey(resultPage,wrapper);


//分页查询方式2
IPage<Car> page = new Page<>(1, 10); // 分页查询
LambdaQueryWrapper<Car> qw = new LambdaQueryWrapper<Car>()
     .like(Car::getCarId, "渝A") // 车牌号 =
     .eq(Car::getCarState, 1); // 状态

//selectPage是BaseMapper自带方法
IPage<Car> userPage = carMapper.selectPage(page, qw);

注意:

1)QueryWrapper中使用自定义uservo类,不能使用LambdaQueryWrapper 

2)上边涉及到 IPage 和 Page 都可以用用于分页,这里就涉及到MybatisPlus的几种方式问题

xml文件

g)执行结果:

补充:

在实际应用中,我们还可以使用LambdaQueryWrapper和QueryWrapper实现更多复杂的查询操作,以满足不同的业务需求。例如,我们可以使用LambdaQueryWrapper和QueryWrapper进行动态查询,通过判断前端传入的参数,来组合SQL语句,实现灵活的查询操作 

public List<UserEntity> getUserList(String name, Integer age) {
    LambdaQueryWrapper<UserEntity> qw = new LambdaQueryWrapper<UserEntity>()
            .eq(StringUtils.isNotEmpty(name), UserEntity::getName, name) // 姓名 = name
            .gt(age != null, UserEntity::getAge, age); // 年龄 > age

    return userMapper.selectList(qw);
}

以上代码中,我们通过LambdaQueryWrapper实现了动态的查询操作。如果传入的name参数不为空,那么就会添加一个等于查询条件;如果传入的age参数不为空,那么就会添加一个大于查询条件。

这样的查询操作,可以根据前端传入的参数,灵活地组合SQL语句,实现更多的业务需求。

注意:

        1)mapper方法里的@Param(Constants.WRAPPER) Wrapper query对象,Constants.WRAPPER的值就是ew。
        2)首先判断ew.emptyOfWhere是否存在where条件,有的话再拼接上去,

        3)ew.customSqlSegment该值是WHERE + sql语句,还有个ew.sqlSegment是不包括WHERE字符串

        4)${ew.customSqlSegment}是一个查询条件占位符,代表Wapper查询条件。 

当然,Mybatis-Plus提供了一些自定义SQL方法,例如selectObjs、selectByMap等,可以直接使用,例如:

List<Object> objs = userMapper.selectObjs(
    new QueryWrapper<User>().select("max(age)").eq("name", "张三")
);

2.3.Wrapper传参+xml文件SQL

Wrapper传参是Mybatis中的一种高级操作方式,可以在查询时动态传递参数

1)mapper类

Car selectBySeq @Param(Constants.WRAPPER) QueryWrapper<Car> queryWrapper);

2)xml配置文件 

<select id="selectBySeq " resultMap="BaseResultMap">
        select * from `car` ${ew.customSqlSegment}
</select>

3)通过Wapper传递查询参数

使用Wrapper动态传递参数

1.使用Wrapper基类,自定义Where后面的SQL语句;

2.使用QueryWrapper

  • select | select(String... sqlSelect)

    例select("id", "name", "age")

上面两种方式任意选择一种,参数都是Wrapper

    @RequestMapping("/ok")
    public void testCustomSQL2() {
        LambdaQueryWrapper<Car> query = new LambdaQueryWrapper<>();
        query.eq(Car::getCarId, "11");

        Car car= carMapper.queryCarSeq(query);

        System.out.println(car.toString());
    }

//或者
Wrapper wrapper = new QueryWrapper<Car>().eq("car_state", 1).like("cai_id", "渝");
List<Car> userList = carMapper.queryCarSeq(wrapper);

XML文件SQL和Wrapper传参结合的优点在于提高了代码的可维护性、可读性和安全性,适用于代码量大,需要多人协作开发的场景,并且能够防止SQL注入攻击 

2.4.正常传参+XML文件SQL

在resources目录下创建一个mapper文件夹,然后创建一个与Mapper接口同名的xml文件,例如UserMapper.xml,定义自定义SQL语句

 //xml文件式,myabtis原生方式   
 Car selectByAnnotationXML(String seq);

在mapper下创建文件UserDao.xml 

 <select id="selectByAnnotationXML" parameterType="java.lang.String" resultMap="BaseResultMap">
        select *
        from car
        where car_seq = #{seq,jdbcType=VARCHAR}
    </select>

这种方式是在接触mybatis时候,最基础的方式 

3.总结

        总的来说,sql的写法有两种,一种是直接使用注解写在mapper方法上,一种是写在xml文件中;传参的方式也有两种,一种是通过方法传参直接在xml文件中组装sql,一种是通过Wapper传递参数条件构造器

注解的优点

        简洁易懂:相比于XML配置,注解的使用更加简洁直观,使代码更具可读性和可维护性。

        易于调试:注解配置可以直接在Java类中编写,减少了在XML中查找和修改SQL的时间。

        更好的性能:在执行大量的增删改操作时,注解配置的性能更高,因为没有XML解析的开销。

注解的缺点

        不利于维护:将SQL和Java代码耦合在一起,使得代码难以维护和重构,特别是在涉及到较复杂SQL的情况下。

        SQL可读性差:相比于在XML中编写SQL,注解中的SQL语句通常会更加冗长和难以读懂。

XML的优点

        易于维护:将SQL分离出Java代码,代码的维护性更高,特别是在需要修改SQL时。

        SQL可读性好:在XML中编写SQL,可以使得SQL的格式更加清晰,可读性更强。

        易于管理:XML配置文件可以全局管理,使得项目的结构更加清晰明了。

XML的缺点

        繁琐:XML配置相对于注解,配置较为繁琐,需要更多的代码量。

        性能问题:在执行大量操作时,XML的解析和读取会占用一定的时间,降低了系统的性能

总之,注解和XML的选择应根据项目的实际情况和需求进行决定。对于简单的查询和操作,注解可能更加适合;而对于复杂的查询和操作,XML则更加适合。

常用方法参考官方文档

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Mybatis-Plus:实现自定义SQL 的相关文章

  • 将查询结果作为 CSV 文件从 Docker PostgreSQL 容器导出到本地计算机

    我不确定这是否可能 或者我是否做错了什么 因为我对 Docker 还很陌生 基本上 我想将 PostgreSQL docker 容器内的查询结果作为 csv 文件导出到本地计算机 这就是我到目前为止所得到的 首先 我使用以下命令运行 Pos
  • CHAR(64) 或 BINARY(32) 在 SQL SERVER 中存储 SHA256 哈希

    我正在讨论在 SQL Server 中存储 SHA256 哈希时使用哪种数据类型 应该是 CHAR 64 还是 BINARY 32 该列将成为唯一聚集索引的一部分 我知道此时我可能会吹毛求疵 但是我想第一次就把这件事做好 而且我知道有时原始
  • android-security :Google Play 警告:您的应用程序包含 SQL 注入问题

    作为我们应用程序的一部分 我们使用两个 contentProvider 但两者都受到 android exported false 的保护 但我们仍然收到一封 Google Play 警告邮件 您的应用程序包含 SQL 注入问题 他们提到的
  • 如何使 cx-oracle 将查询结果绑定到字典而不是元组?

    这是我的代码 我想找到一种方法将查询结果作为字典列表而不是元组列表返回 看起来 cx oracle 通过部分文档讨论 绑定 来支持这一点 虽然我不知道它是如何工作的 def connect dsn cx Oracle makedsn hos
  • 如何使用JSqlParser向sql添加where条件?

    我想用JSqlParser向sql添加where条件 例如 Before select from test table where a 1 group by c After select from test table where a 1
  • 根据同一 select 语句中先前计算的行(或列)计算新行(或列)

    我正在尝试根据年度销售增长预期来计算年度预期销售量 在一张表中 我有实际销量 create table Sales ProductId int Year int GrowthRate float insert into Sales valu
  • 查找至少有 2 名员工的部门

    我需要做sql问题将显示至少有 2 人的所有部门 SELECT department name FROM department INNER JOIN employee ON department id employee department
  • SQLAlchemy:如何过滤日期字段?

    这是模型 class User Base birthday Column Date index True in database it s like 1987 01 17 我想在两个日期之间进行过滤 例如选择 18 30 年区间内的所有用户
  • 选择列的一部分

    我想知道是否有人可以帮助查询以选择列的一部分 criteriadata 列包含如下所示的数据 标准数据 14 27 15 14 30 15 DD 14 38 15 通过 14 33 15 通过 如何只选择数字 15 之后出现的数据 非常感谢
  • Django:ImageField 需要文件路径还是实际的图像对象?

    Running Windows 7 Python 3 3 Django 1 6 我对如何将图像存储为 Django 数据库中表的一部分感到困惑 有一个领域叫做ImageField 这是Docs https docs djangoprojec
  • 当表有聚集索引时,数据是如何存储的

    我发现了无数的帖子 开头都是这样的很多时候我遇到人们说 聚集索引根据聚集索引键对表内的数据进行物理排序 这不是真的 然后这些帖子继续描述它是如何通过链表或其他方式实际存储的 例如 这个post http sqlwithmanoj wordp
  • 使用连接字段的 SQL JOIN

    我有两个表 Table1 包含一列 该列构成 Table2 中列的部分值 例如 表1 XName 123456 表2 ZName ABC 123456 我需要创建一个与这些匹配的 JOIN 但是使用 MS SQL 2008 我在完成这项工作
  • Django 视图中的原始 SQL 查询

    我将如何使用原始 SQL 执行以下操作views py from app models import Picture def results request all Picture objects all yes Picture objec
  • Oracle SQL 查询日期格式

    我总是对 ORACLE SQL 查询中的日期格式感到困惑 并花几分钟时间去谷歌 有人可以向我解释当数据库表中有不同格式的日期时解决问题的最简单方法吗 例如 我有一个日期列为 ES DATE 保存的数据为 27 APR 12 11 52 48
  • 参数的性能不如硬编码值

    我有一个执行得很糟糕的存储过程 当我声明一个变量时 设置它的值 然后在 where 子句中使用它 该语句需要一个多小时才能运行 当我对 where 子句中的变量进行硬编码时 它的运行时间不到一秒 我开始通过执行计划来查找问题所在 看起来当我
  • 如何为不存在的值创建一行并用 0 值填充计数?

    在 SQL Server 中 我对数据上的用户年龄组运行查询 其中 在某些年里 每个年龄组的用户数为零 例如 2013 年有 18 21 年龄组的用户 因此查询返回下一个年龄组 22 25 作为第一行 因为没有包含 18 21 的条目 相反
  • 使用临时表替换 WHERE IN 子句

    我让用户输入我需要在表中查询的值列表 该列表可能非常大 并且长度在编译时未知 而不是使用WHERE IN 我认为使用临时表并对其执行联接会更有效 我在另一个SO问题中读到了这个建议 目前找不到它 但会在找到时进行编辑 要点是这样的 CREA
  • ORACLE 在立即执行中批处理 DDL 语句

    我正在尝试在一个 Execute Immediate 语句中运行多个 ddl 语句 我认为这会很简单 但看来我错了 想法是这样的 declare v cnt number begin select count into v cnt from
  • MySQL如何进行浮点加法的数学计算?

    我测试过SELECT 0 1 0 2 用MySQL MariaDB 查询 它返回了正确的答案 MariaDB none gt SELECT 0 1 0 2 0 1 0 2 0 3 1 row in set 0 000 sec 在大多数编程语
  • SQL 语法检查器和验证器? [关闭]

    Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 有没有类似 SQL 的 lint 语法检查器和验证器 之类的东西 有一个项目 SQLLint 检测 S

随机推荐