mybaits基础使用

mybaits官网

mybatis – MyBatis 3 | XML 映射器

mybaits使用

导入maven依赖

    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.30</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.11</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
        </dependency>

        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.17.1</version>
        </dependency>

        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.3.1</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
            <scope>provided</scope>
        </dependency>

    </dependencies>


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

创建mybaits配置文件

配置文件的名字一般是mybaits_config.xml, 配置文件的位置一般放在resources目录下

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

    <properties resource="db.properties">
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://192.168.1.1:3306/abc?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
    </properties>

    <settings>
        <setting name="logImpl" value="LOG4J2"/>
    </settings>
    
    <typeAliases>
        <typeAlias type="test01.pojo.CutFile"  alias="CutFile"/>
        <typeAlias type="test01.pojo.StudentClass"  alias="StudentClass"/>
        <typeAlias type="test01.pojo.Student"  alias="Student"/>
    </typeAliases>

    <plugins>
        <!-- com.github.pagehelper为PageHelper类所在包名 -->
        <plugin interceptor="com.github.pagehelper.PageInterceptor">
        </plugin>
    </plugins>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="user"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="test01/dao/CutFileMapper.xml"/>
        <mapper resource="dao/Student.xml"/>
        <mapper resource="dao/StudentClassMapper.xml"/>
    </mappers>

</configuration>

• 注意environments部分，要改为运行环境的信息（url,用户密码）
• mappers，存放的是项目的mapper文件，是在项目创建过程中不断增加的

• typeAliases部分是为了简化类型的使用，不必每次都写那么长的名字

下图是项目的代码文件结构

 创建log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<Configuration xmlns="http://logging.apache.org/log4j/2.0/config">

    <Appenders>
        <Console name="stdout" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS} [%t] %-5level %logger{0} - %msg%n" />
        </Console>
    </Appenders>

    <Loggers>
        <Logger name="test01" level="debug">
            <AppenderRef ref="stdout"/>
        </Logger>
        <Root level="error" >
            <AppenderRef ref="stdout"/>
        </Root>
    </Loggers>

</Configuration>

注意name的值，最好填写到dao目录上一层，比如我的项目中dao的路径是test01.dao，那么我此处就写了test01。

创建pojo对象

package test01.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.List;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class StudentClass {
    private int id;
    private String name;

    private List<Student> students;
}

上面代码中的注解，是来自lomok，这样就不用写无参构造，有参构造，getter,等方法了

package test01.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
    private int id;
    private String name;
    private StudentClass sc;
}

创建dao接口

package test01.dao;

import test01.pojo.StudentClass;
import java.util.List;
import java.util.Map;

public interface StudentClassMapper {
    List<StudentClass> getStudentClass(Map<String, Object> map);

    StudentClass getStudentAndSchool(int id);
}

创建mapper文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="test01.dao.StudentClassMapper">

    <sql id="studentClassIf">
        <if test="ids != null">
            <foreach collection="ids" item="item" open="id in (" separator="," close=")">
                #{item}
            </foreach>
        </if>
        <if test="name != null">
            And name=#{name}
        </if>
    </sql>

    <select id="getStudentClass" resultType="StudentClass" parameterType="map">
        SELECT * FROM `school_class`
        <where>
            <include refid="studentClassIf"/>
        </where>
    </select>


    <resultMap id="studentAndSchool" type="StudentClass">
        <result property="id" column="sc_id"/>
        <result property="name" column="sc_name"/>
        <collection property="students" ofType="Student">
            <result property="id" column="st_id"/>
            <result property="name" column="st_name"/>
        </collection>
    </resultMap>

    <select id="getStudentAndSchool" resultMap="studentAndSchool" parameterType="int">
        SELECT
        sc.id AS sc_id,
        sc.name AS sc_name,
        st.id AS st_id,
        st.name AS st_name
        FROM `school_class` sc, student st WHERE sc.id=st.cid AND sc.id=#{id}
    </select>

</mapper>

创建工具类

package test01.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 org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import test01.dao.CutFileDao;

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

public class MybatisUtils {

    public static Logger logger = LogManager.getLogger(CutFileDao.class);
    public static String resource = "mybatis_config.xml";
    public static SqlSessionFactory factory = null;
    public static SqlSessionFactory getSessionFactory(){
        try {
            InputStream inputStream = Resources.getResourceAsStream(resource);
            return new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    public static SqlSession getSqlSession(){
        if (factory == null){
            logger.info("创建factory");
            factory = getSessionFactory();
        }
        return factory.openSession();
    }

}

创建测试类，进行测试

package com.test.dao;

import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import test01.dao.StudentClassMapper;
import test01.dao.StudentMapper;
import test01.pojo.Student;
import test01.pojo.StudentClass;
import test01.utils.MybatisUtils;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

public class StudentTest {

    @Test
    public void getSchoolClass(){
        try (
                SqlSession sqlSession = MybatisUtils.getSqlSession();
        ){
            StudentClassMapper mapper = sqlSession.getMapper(StudentClassMapper.class);
            HashMap<String, Object> paramsMap = new HashMap<>();
//            paramsMap.put("id", 4486);
//            paramsMap.put("name", "class_01");
            ArrayList<Object> ids = new ArrayList<>();
            ids.add(1);
            ids.add(4486);
            paramsMap.put("ids", ids);
            List<StudentClass> scs = mapper.getStudentClass(paramsMap);
            for (StudentClass sc : scs) {
                System.out.println(sc);
            }
        }
    }

    @Test
    public void getSchoolAndStudent(){
        try (
                SqlSession sqlSession = MybatisUtils.getSqlSession();
        ){
            StudentClassMapper mapper = sqlSession.getMapper(StudentClassMapper.class);
            StudentClass sc = mapper.getStudentAndSchool(4486);
            System.out.println(sc);
        }
    }

}