Mybatis的maven使用与springboot的使用

最新推荐文章于 2025-02-12 18:34:38 发布

原创最新推荐文章于 2025-02-12 18:34:38 发布 · 725 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#maven #java #spring boot

本文详细介绍了如何在Maven工程中使用Mybatis，包括添加依赖、配置核心文件、创建工具类、定义实体类和DAO接口以及测试Mapper。接着讨论了Springboot中集成Mybatis的简化步骤，如配置数据源、mapper注册以及编写测试。强调了配置文件中mapper的注册和路径设置的重要性，同时提到了Maven中资源配置文件可能出现的问题及其解决方案。

Maven 使用Mybatis

1. 创建Maven工程在pom里面添加依赖

 <dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.17</version>
        </dependency>
    </dependencies>

这里我插入了mybatis mysql 以及junit测试

2 在resources 里面mybatis核心配置

在这里插入图片描述

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&amp;useSSL=true"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/demo/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

主要是配置那几个property
以及最后的重点！！！非常非常重要，必须要注册你的mapper！！！

<mappers>
        <mapper resource="com/example/demo/mapper/UserMapper.xml"/>
    </mappers>

3. 因为要引用这个核心配置，已经建立工厂等等操作都是每次使用mybatis必须要做的步骤所以把它们整合到一起，做一个工具类，mybatisUtil

在这里插入图片描述

官方文档罗列：每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。

从 XML 文件中构建 SqlSessionFactory 的实例非常简单，建议使用类路径下的资源文件进行配置。但也可以使用任意的输入流（InputStream）实例，比如用文件路径字符串或 file:// URL 构造的输入流。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，使得从类路径或其它位置加载资源文件更加容易。

package com.example.demo.utils;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;
import java.io.InputStream;

public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory;
    static {
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}

总的来说就是我们获取核心配置，构造工程，最后获得最重要的SqlSession，在测试的时候通过这个sqlsession我们可以获得mapper，从而进行对数据库的操作

4. 然后就是与jdbc类似的建立实体类，dao接口，但是mybatis是大大简化了jdbc，不用再用接口实现了去做大量重复性的模板语句，取而代之的是更加专注于功能业务的配置文件来代替对sql的操作，也就是xxxmapper.xml

在这里插入图片描述
这里通过这个接口与这个xml映射
这里的id就是接口里面的方法名，这里的resultType就是我们要返回的类型，下面的select就是我们要进行的数据库操作，这个xml文件可以配置很多很多这种操作，相比于jdbc，如果要进行这种操作，省略了大量的模板代码

<?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="queryAll" resultType="com.example.demo.entity.User">
    select * from mybatis.user
  </select>
    <select id="queryById" resultType="com.example.demo.entity.User">
    select * from user where id=#{id}
  </select>
</mapper>

5. 然后就可以对这个mapper进行测试

package com.example.demo.mapper;

import com.example.demo.entity.User;
import com.example.demo.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.junit.Test;

import java.util.List;

public class UserMapperTest {
    private SqlSessionFactory sqlSessionFactory;
    @Test
    public void selectTest(){
       SqlSession sqlSession= MybatisUtils.getSqlSession();
       //获取mapper
       UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
        List<User> users=userMapper.queryAll();
        for(User user:users){
            System.out.println(user.toString());
        }
        sqlSession.close();
    }
}

在这里插入图片描述

Springboot的mybatis使用

Springboot是对spring的简化，他有很多自动配置，所以在springboot中配置mybatis要更简便

1. 首先是创建了springboot项目并且导入mybatis依赖，以及mysql依赖，这里只是对数据库做学习，所以没有弄前端web，这一步是没有问题的

<dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.0</version>
</dependency>
<dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

2 然后在springboot的基本配置文件中，application.yml,当然也可以在application.properties里面设置我们的数据源以及基本的mapper注册

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&useSSL=true
    username: root
    password: root
mybatis:
  mapper-locations: classpath:/mapper/*.xml

这里要注意！！！

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

这一步是非常重要的

mybatis:
  mapper-locations: classpath:/mapper/*.xml
  config-location:

这里有两个location，如果看了我上面的，可以发现，这个config-location是我们一开始设置的mybatis核心设置，我们在这里面去注册我们的mapper，它注册我们mapper.xml的路径，从而我们可以找到它，但在springboot，你可以直接用你的mapper.xml文件，因为springboot有个很优秀的功能就是自动配置。我们可以直接mapper-locations，注册我们的mapper.xml路径。

简而言之，config-location里面配置有mapper.xml路径，如果我们用了config-location,并且mybatis-config.xml文件里面有mapper.xml的路径以及注册了，我们就不需要mapper-locations，直接用config-location。如果我们不用config-location，那我们就直接写mapper.xml文件，用mapper-locations去找到它就好，我们自己都不用写核心配置文件。这里我是直接用mapper-locaions
还有要注意一个点，这个路径，classpath,我们之间是用/斜杠分开，还有上面maven配置mapper，我们用resources，resource="com/example/demo/mapper/UserMapper.xml"这个文件路径也要用反斜杠隔开，而不是点，用点只能查到你的java文件这种，查不到xml文件
我们基础的环境配置以及配置完成了

现在我们就可以编写实现业务的功能了

3 编写实体类，以及mapper，同时在resources里面编写我们的mapper.xml映射文件

在这里插入图片描述
UserMapper 通过注解标记Mapper，Repository，因为是个接口类

@Mapper
@Repository
public interface UserMapper {
    //查询
    public List<User> queryAll();
    //添加数据
    public int add(User userLogin);
    //根据用户名查询数据
    public User queryByName(String name);

}

配置相应的xml映射，这里与上面maven的配置基本一致，就是springboot会使用注解标注，从而在springboot中会扫描到这个组件，并注册到应用上下文里面

<?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="queryAll" resultType="com.example.demo.entity.User">
        select * from user
    </select>

    <insert id="add" parameterType="com.example.demo.entity.User">
        insert into user values (#{id},#{name},#{hobby})
    </insert>

    <select id="queryByName" resultType="com.example.demo.entity.User">
        select * from user where name = #{name}
    </select>

</mapper>

一样都是id对应方法名，resultType规定返回值类型

4 可以在springboot的test里面去测试我们的连接与使用，因为是第一次用springboot连接数据库，我测试了下数据库是否连接成功


@SpringBootTest
class DemoMybatisTest01ApplicationTests {
    @Autowired
    DataSource dataSource;
    @Autowired
    UserMapper userMapper;
    @Test
    void contextLoads() throws Exception{
        System.out.println("获取的数据库连接为"+dataSource.getConnection());
    }
    @Test
    void toTest(){
        List<User> user = userMapper.queryAll();
        user.forEach(e-> System.out.println(e.toString()));
    }
}

在这里插入图片描述
可以看到是可以连接成功的。
可能的错误：

核心配置文件的mapper忘记注册
注册的mapper路径写错了这里提供一个官方文档的规范，关于mapper的路径映射
Maven由于它的约定大于配置，可能在开发过程中遇到我们写的配置文件，无法被导出或者生效的问题，也就是说你允许test，但是生成的target里面，以我们的maven文件为例，mapper目录下只有UserMapper ，没有UserMapper.xml,也就是下面红线划出的这个文件是没有的

为了解决这个问题需要在pom.xml里面加入这个，这是所有maven都应该注意的一点，就是我们的配置文件无法生效的问题，这是个类似万能的东西，就放进去就好了，会把你的配置文件都生成了的

	 <!--在build中配置resources，来防止我们资源导出失败的问题-->
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>