MyBatis-Plus自定义SQL的详细过程记录

目录

• 前言
• 一、在src/main/resource目录下编写XML
• 1.1  目录结构
• 1.2   编写实体类对应的Mapper接口
• 1.3  编写UserMapper.xml
• 1.4  在配置文件中扫描我们的xml配置的位置。
• 1.5  测试
• 二、在src/main/java目录下编写XML
• 2.1  目录结构
• 2.2   编写实体类对应的Mapper接口
• 2.3   编写UserMapper.xml
• 2.4   编写配置文件
• 2.5   配置pom.xml（重要）
• 2.6  测试
• 三、classpath和classpath*的区别
• 小结
• 总结

前言

当我们在开发过程中，如果MyBatis-Plus中的SQL语句并不能满足我们的需求，那么我们可以在XML文件中自定义SQL语句，这样的话我们就可以在MyBatis-Plus的基础上继续提高我们的开发效率了。本篇博客也将讲解如何在src/main/resource目录下和src/main/java目录下对XML的配置。

一、在src/main/resource目录下编写XML

1.1  目录结构

我们将UserMapper.xml放在resource下的mapper目录中，我的整个项目目录如下

1.2   编写实体类对应的Mapper接口

Tip:我们这里自定义了getAll()方法，获取全部用户的信息。

package com.yixin.mapper;

import com.yixin.pojo.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.springframework.stereotype.Repository;

import java.util.List;

/**
 * <p>
 *  Mapper 接口
 * </p>
 *
 * @author yixin
 * @since 2022-01-17
 */
@Repository
public interface UserMapper extends BaseMapper<User> {

    public List<User> getAll();

}

1.3  编写UserMapper.xml

<?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.yixin.mapper.UserMapper">

    <select id="getAll" resultType="com.yixin.pojo.User">
        select * from user
    </select>

</mapper>

1.4  在配置文件中扫描我们的xml配置的位置。

application.properties:

mybatis-plus.mapper-locations=classpath:/mapper/**.xml

1.5  测试

import org.springframework.boot.test.context.SpringBootTest;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

@SpringBootTest
class AutoApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    void test() {

        List<User> userList=userMapper.getAll();
        System.out.println(userList);
    }
}

结果：

可以发现，成功出现我们的信息了！

二、在src/main/java目录下编写XML

2.1  目录结构

TIp:在java下的mapeer目录中建立存放我们的xml配置的目录xml包

2.2   编写实体类对应的Mapper接口

package com.yixin.mapper;

import com.yixin.pojo.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.springframework.stereotype.Repository;

import java.util.List;

/**
 * <p>
 *  Mapper 接口
 * </p>
 *
 * @author yixin
 * @since 2022-01-17
 */
@Repository
public interface UserMapper extends BaseMapper<User> {

    public List<User> getAll();

}

2.3   编写UserMapper.xml

<?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.yixin.mapper.UserMapper">

    <select id="getAll" resultType="com.yixin.pojo.User">
        select * from user
    </select>

</mapper>

2.4   编写配置文件

application.properties：

mybatis-plus.mapper-locations=classpath:com/yixin/mapper/xml/UserMapper.xml

2.5   配置pom.xml（重要）

这一步非常重要，因为如果没有配置pom.xml就去运行，那么会出现以下的错误。

为什么呢？

这是因为在maven默认情况下是不会将src/main/java目录的xml等资源打包进入class文件夹的，而是直接忽略掉。不信的话我们去看一下target目录。

可以发现这里并没有将我们的xml文件打包进去。

解决方案：配置pom.xml

我们只需在pom中加入如下配置，告诉idea，在编译的时候将src/main/java下的xml一起打包进class文件夹中，这样也就不会报异常了。

<build>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>
    </build>

2.6  测试

import org.springframework.boot.test.context.SpringBootTest;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

@SpringBootTest
class AutoApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    void test() {

        List<User> userList=userMapper.getAll();
        System.out.println(userList);
    }
}

结果：

可以发现成功出现我们的数据库信息了！

我们再去查看以下target目录：

可以发现，已经把我们的xml配置导进来了，如果发现还是没有的话，建议把target目录删除，然后重新运行，就可以重新生成target目录了，这时候就能发现你的xml文件了。

三、classpath和classpath*的区别

classpath:只会在你的class路径下寻找

classpath*:不仅包含class路径，还包括jar文件中(class路径)进行查找

一般来说，在大型公司的项目开发中都会需要用到classpath*进行文件配置，因为通常会用到第三方的jar，所以大多情况下会需要查找这些jar的配置文件。

小结

以上就是【一心同学】对在MyBatis-Plus中【自定义SQL】的步骤和注意事项的讲解，【自定义SQL】可以帮助我们在MyBatis-Plus的基础上去编写我们自己的SQL语句，让我们的开发变得【十分高效】。

总结

到此这篇关于MyBatis-Plus自定义SQL的文章就介绍到这了,更多相关MyBatis-Plus自定义SQL内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！