一、引言
MP自带的条件构造器虽然很强大，有时候也避免不了写稍微复杂一点业务的Sql，那么那么今天说说MP怎么自定义Sql语句吧。
二、配置
自定义的sql当然是写在XML文件中的啦，那么首先来定义xml文件的位置，在yml配置文件如下：
1 2 3 4 | mybatis-plus: # 如果是放在src/main/java目录下 classpath:/com/*/*/mapper/*Mapper.xml # 如果是放在resource目录 classpath:/mapper/**.xml mapper-locations: classpath:/mapper/**.xml |
三、具体实现
方法一：使用注解实现
在我们Mapper接口中定义自定义方法即可：
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | /** * User对象持久层 */public interface UserMapper extends BaseMapper<User> { /** * * 如果自定义的方法还希望能够使用MP提供的Wrapper条件构造器，则需要如下写法 * * @param userWrapper * @return */ @Select("SELECT * FROM user ${ew.customSqlSegment}") List<User> selectByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper); /** * 和Mybatis使用方法一致 * @param name * @return */ @Select("SELECT * FROM user where name = #{name}") List<User> selectByName(@Param("name") String name); } |
方式二：使用xml文件实现
使用xml一定要指定xml文件所在位置
(1) 接口文件：
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | /** * User对象持久层 */public interface UserMapper extends BaseMapper<User> { /** * * 如果自定义的方法还希望能够使用MP提供的Wrapper条件构造器，则需要如下写法 * * @param userWrapper * @return */ List<User> selectByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper); /** * 和Mybatis使用方法一致 * @param name * @return */ List<User> selectByName(@Param("name") String name); } |
(2) xml文件：
1 2 3 4 5 6 7 8 9 10 11 12 13 | <?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.example.demo.mapper.UserMapper"> <select id="selectByName" resultType="com.example.demo.model.User"> SELECT * FROM user where name = #{name} </select> <select id="selectByMyWrapper" resultType="com.example.demo.model.User"> SELECT * FROM user ${ew.customSqlSegment} </select> </mapper> |
(3) 测试文件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | /** * 自定义sql查询语句 */@Testpublic void selectByMySelect() { List<User> users = userMapper.selectByName("王天风"); users.forEach(System.out::println);}/** * 自定义sql使用Wrapper */@Testpublic void selectByMyWrapper() { QueryWrapper<User> wrapper = new QueryWrapper(); wrapper.like("name", "雨").lt("age", 40); List<User> users = userMapper.selectByMyWrapper(wrapper); users.forEach(System.out::println);} |
四、回答评论区提问
提问一：能否提供自定义Update语句与Wrapper的整合使用呢？
(1) 接口文件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | /** * 用户 Mapper 接口 */public interface UserMapper extends BaseMapper<User> { /** * 自定Wrapper修改 * * @param userWrapper 条件构造器 * @param user 修改的对象参数 * @return */ int updateByMyWrapper(@Param(Constants.WRAPPER) Wrapper<User> userWrapper, @Param("user") User user); } |
(2) xml文件
1 2 3 4 5 6 7 8 9 | <?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.example.demo.mapper.UserMapper"> <update id="updateByMyWrapper"> UPDATE user SET email = #{user.email} ${ew.customSqlSegment} </update> </mapper> |
(3) 测试文件
1 2 3 4 5 6 7 8 9 10 11 12 13 | @Testpublic void updateByMyWrapper() { // 条件构造器 QueryWrapper<User> wrapper = new QueryWrapper(); wrapper.eq("name", "admin"); // 修改后的对象 User user = new User(); user.setEmail("Test@email.com"); userMapper.updateByMyWrapper(wrapper, user);} |
- 写的很好，特别是
${ew.customSqlSegment}，以前我手写查询条件和分页沙雕了- Constants.WRAPPER 这个应该导哪个包？
importcom.baomidou.mybatisplus.core.toolkit.Constants;