mybatis浅度总结

环境描述：

idea2018 jdk1.8 maven3.61

准备工作：

pom.xml中引入jar包：

<!--mysql依赖 必要-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
</dependency>
<!--mybatis依赖 必要-->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.2</version>
</dependency>
<!--junit依赖 测试-->
<dependency>
    <groupId>Junit</groupId>
    <artifactId>Junit</artifactId>
    <version>4.12</version>
</dependency>
<!--log4j依赖 日志-->
<!-- https://mvnrepository.com/artifact/log4j/log4j -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>
<!--lombok依赖 非必要-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.10</version>
</dependency>
<！--缓存依赖-->
<dependency>
    <groupId>org.mybatis.caches</groupId>
    <artifactId>mybatis-ehcache</artifactId>
    <version>1.1.0</version>
</dependency>
由于maven约定大于配置，可能导致我们的配置文件无法导出或者生效，解决方案，早pom.xml中添加如下配置：

<!--在build中配置resources，来防止我们资源导出失败的问题-->

<build>
    <resources>
        <resource>
            <directory>src/main/java</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>false</filtering>
        </resource>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.xml</include>
            </includes>
            <filtering>false</filtering>
        </resource>
    </resources>
</build>
mybatis-config.xml配置文件
mybatis比较重要的配置和属性<!--具体设置可以草考官网内容：https://mybatis.org/mybatis-3/zh/configuration.html#settings-->

　　configuration（配置）
　　properties（属性）
　　settings（设置）
　　typeAliases（类型别名）
　　typeHandlers（类型处理器）
　　objectFactory（对象工厂）
　　plugins（插件）
　　environments（环境配置）
　　environment（环境变量）
　　transactionManager（事务管理器）
　　dataSource（数据源）
　　databaseIdProvider（数据库厂商标识）
　　mappers（映射器）

<?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>
    <properties resource="db.properties"></properties> <!--外部导入数据库配置-->
    
    <settings> 

　　　　　<!--设置日志-->

        <setting name="logImpl" value="STDOUT_LOGGING"/><!--设置STDOUT_LOGGING日志-->

　　　　 <typeAlias alias="user"  type="com.xjw.pojo.User"></typeAlias> <!--log4j日志-->

    </settings>

　<!--实体类较少时可以使用下面方式给实体类起别名，减少全限定名的冗余-->
　　　<typeAlias type="com.xjw.pojo.XXX" alias="XXX"/>
  <!--扫描实体类的包，默认别名就为这个类的类名,首字母小写 如果要设定类的别名可以在实体类上加注解@Alias("xxx")-->

    <typeAliases>
        <package name="com.xjw.pojo"></package>
    </typeAliases>

    <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="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
    <mappers><!--映射每一个mapper.xml必须在下面配置映射 配置映射的方式有三种，具体参照官网-->

　　　　<mapper class="com.xxx.dao.XXXMapper"></mapper>
　　　　<package name="com.xxx.dao"></package>
　　　　<mapper resource="com/xxx/dao/XXXMapper.xml"/>

    </mappers>
</configuration>

db.properties文件
driver=com.mysql.jdbc.Driver

url=jdbc:mysql://localhost:3306/数据库名?useSSL=true&useUnicode=true&characterEncoding=utf-8
username=自己数据账号
password=自己数据库密码

log4j.properties文件

#将等级为DEBUG的日志信息输出到console和file这两个目的地，console和file的定义在下面的代码
log4j.rootLogger=DEBUG,console,file

#控制台输出的相关设置
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n

#文件输出的相关设置
log4j.appender.file = org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./log/xxx.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n

#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG

编写util包下的MybatisUtil.java来获得SqlSession对象

package com.xxx.util;

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.InputStream;

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

编写与数据库对应的实体类（可以使用lombok来简化开发）
编写操作数据库的接口xxx
编写对应的接口的xxxMapper.xml文件 （记得每一个xxxMapper.xml文件在mybatis-config.xml中进行映射配置）xxxMapper.xml文件示例（注意xxxMapper.xml的文件路径要与对应接口Java文件的路径一直，即同一个包下，也可在将xxxMapper.xml放在resources下，只要创建相同包即可，编译时会自动将其整合到一起）

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.xxx.dao.xxxMapper"><!--对应xxxMapper.java文件-->
</mapper>