Java从入门到入土之mybatis初级篇

Mybatis

1. Mybatis所需包
   下载地址：https://github.com/mybatis/mybatis-3/releases
   
2. 配置文件
   mybatis-config.xml（名字没有强制要求，一般这样命名）

<?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 mybatis配置文件的根标签，必须有且只有一个 -->
<configuration><!--  configuration 中的元素，不但有类型限制，也有顺序限制
properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,
reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers? 
顺序为排列顺序，？表示可以有0个或多个-->
    <!-- 引入外部文件，一般将如数据库连接的属性写在外部文件，增强拓展性，下面会贴出数据库属性文件-->
    <properties resource="dataSource.properties"/>
    <!-- Setting 中的属性很多主要是配置 MyBatis 框架运行时的一些行为
    的，例如缓存、延迟加载、结果集控制、执行器、分页设置、命名规则等一系列控制性参数，其所有的 setting
     配置都放在父标签 settings 标签中-->
    <settings>
    	<!-- 配置Log的实现为Log4j-->
        <setting name="logImpl" value="LOG4J" />
    </settings>
	<!--给类取别名：pojo对象的别名 -->
    <typeAliases>
        <!--对类单独进行别名设置  -->
        <typeAlias alias="user" type="com.daily.pojo.User"></typeAlias>
        <!-- 对包进行扫描，可以批量进行别名设置，设置规则是：获取类名称，将其第一个字母变为小写 -->
        <package name="com.daily.pojo"/>
    </typeAliases>
    <!--当mybatis 对 PreparedStatement设入一个参数或者是从ResultSet 返回一个值的时候，类型句柄被用将值转为相匹配的JAVA类型,就是数据库和Java之间数据类型转换，此标签用来自定义转换，一般不修改-->
    <typeHandlers></typeHandlers>
    <!--每次Mybatis为结果对象创建一个新实例，都会用到ObjectFactory。默认的ObjectFactory与使用目标类的构造函数创建一个实例相同，如果有已经映射的参数，那也可能使用带参数的构造函数。如果你重写ObjectFactory的默认操作，你就可以创建你自己的对象-->
    <objectFactory type=""></objectFactory>
    <!-- 插件 -->
    <plugins>
        <!--分页插件-->
        <plugin interceptor="com.github.pagehelper.PageHelper">
            <!-- 设置数据库类型 Oracle,Mysql,MariaDB,SQLite,Hsqldb,PostgreSQL六种数据库-->
            <property name="dialect" value="mysql"/>
        </plugin>
    </plugins>
     <!--MyBatis可以配置多个环境。这可以帮助你SQL映射对应多种数据库等。
    定义默认使用的数据源 为develoment1-->
    <environments default="development1">
        <!--配置id为development的数据源  -->
        <environment id="development1">
            <!--配置事务管理，采用JDBC的事务管理,与spring整合或交给spring管理-->
            <transactionManager type="JDBC"></transactionManager>
            <!-- POOLED:mybatis自带的数据源，JNDI:基于tomcat的数据源 -->
             <!-- 定义数据源使用数据库连接池 type=UNPOOLED表示不使用数据库连接池 -->
            <dataSource type="POOLED">
                <!--使用外部资源文件${}取值-->
                <property name="driver" value="${jdbc.driver}" />
                <property name="url" value="${jdbc.url}" />
                <property name="username" value="${jdbc.name}" />
                <property name="password" value="${jdbc.password}" />
            </dataSource>
        </environment>
        <environment id="development2">
            <!--配置事务管理，采用JDBC的事务管理,与spring整合或交给spring管理-->
            <transactionManager type="JDBC"></transactionManager>
            <!-- POOLED:mybatis自带的数据源，JNDI:基于tomcat的数据源 -->
             <!-- 定义数据源使用数据库连接池 type=UNPOOLED表示不使用数据库连接池 -->
            <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>

    <!-- 将mapper映射器文件加入到配置文件中 -->
    <mappers>
        <!--单个的mapper.xml文件添加-->
        <mapper resource="com/mapper/UserMapper.xml"/>
        <!--整个包的mapper.xml文件批量添加-->
        <package name="com.mapper"/>
        <!--如果xml映射文件与接口绑定则 只需要将接口加到配置文件中，不能与上面的package标签同时存在-->
        <mapper class="com.mapper.UserMapper"/>
    </mappers>
</configuration>

Setting属性详解
typeHandler句柄详解
资源文件
dataSource.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc.url=jdbc:mysql://localhost:3306/数据库名
jdbc.username=root
jdbc.password=root

resultMap

<?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">
<!--命名空间namespace，不与接口绑定可以自定义，与接口绑定需要写接口全地址，我这里绑定了StudentMapper接口-->
<mapper namespace="com.mapper.StudentMapper">
	<!--如何是一对一的关系可以不需要，处理一对多的关系需要用到，例如，一个老师有多个学生，id属性为唯一标识-->
	<resultMap type="com.pojo.Teacher" id="teacher">
		<!--constructor对应javabean中的构造方法,不需要可以省略-->
		<constructor>
			<!-- idArg 对应构造方法中的id参数 -->
			<idArg column=""/>
			<!-- arg 对应构造方法中的普通参数 -->
			<arg column=""/>
		</constructor>
		<!--数据库表的主键-->
		<id column="tid" property="tid" />
		<!--pojo类与表的字段对应，可以不一样，只需要将两者关联起来-->
		<result column="name" property="name" javaType="String" jdbcType="VARCHAR"/>
		<!--association 为关联关系，是实现N对一的关键。javaBean中有用到其他Bean作为属性
            property 为javabean中容器对应字段名 Student类中的Teacher对象名
            column 为体现在数据库中列名 需要用到的查询条件 Student类中的tid
            javaType 指定关联的类型 数据类型com.pojo.Teacher-->
		<association property="" column="" javaType=""></association>
		<!--collection，对应javabean中容器类型, 是实现一对多的关键,即有其他JavaBean的集合List
            property 为javabean中容器对应字段名list
            column 为体现在数据库中列名，查询list数据需要用到的条件，tid
            ofType 就是指定javabean中容器指定的类型 list，map....
			select 指定方法查询集合累的元素-->
		<collection property="" column="" ofType="" select="">
		</collection>
	</resultMap>
</mapper>

一个Teacher，Student的demo

pojo实体类
Teacher

package com.pojo;

import java.util.List;

public class Teacher {
	
	private int tid;
	private String name;
	private List<Student> students;
	
	public Teacher() {
		super();
	}

	public Teacher(int tid, String name) {
		super();
		this.tid = tid;
		this.name = name;
	}

	public int getTid() {
		return tid;
	}

	public void setTid(int tid) {
		this.tid = tid;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}
	
	public List<Student> getStudents() {
		return students;
	}

	public void setStudents(List<Student> students) {
		this.students = students;
	}

	@Override
	public String toString() {
		return "Teacher [tid=" + tid + ", name=" + name + ", students=" + students + "]";
	}
}

Student

package com.pojo;

public class Student {

	private int sid;
	private String name;
	private int tid;

	public Student() {
		super();
	}

	public int getsid() {
		return sid;
	}
	public void setsid(int sid) {
		this.sid = sid;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public int getTid() {
		return tid;
	}
	public void setTid(int tid) {
		this.tid = tid;
	}

	@Override
	public String toString() {
		return "Student{" +
				"sid=" + sid +
				", name='" + name + '\'' +
				", tid=" + tid +
				'}';
	}
}

xml映射文件
StudentMapper.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.mapper.StudentMapper">
    <resultMap type="com.pojo.Student" id="student">
        <id column="sid" property="sid" />
        <result column="name" property="name" javaType="String" jdbcType="VARCHAR"/>
        <result column="tid" property="tid" />
    </resultMap>
    <!--与接口绑定时，查询语句的id与接口方法名对应,
    resultType 返回值类型
    resultMap 与上面的resultMap标签对应
    parameterType 参数类型
    parameterMap 自定义与resultMap对应，一般不用-->
    <select id="getStudentByTid" resultType="student" parameterType="int">
        select * from student where tid = #{tid}
    </select>
</mapper>

TeacherMapper.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.mapper.TeacherMapper">
<resultMap type="com.pojo.Teacher" id="teacher">
	<id column="tid" property="tid"/>
	<result column="name" property="name"/>
	<!--Teacher类有List<Student> students的属性
	property 对应该属性的对象名
	column 需要用到tid作为查询条件
	ofType 类型为List
	select 调用的查询方法为com.mapper.StudentMapper.getStudentByTid-->
	<collection property="students" column="tid" ofType="list" select="com.mapper.StudentMapper.getStudentByTid">
		<!--实体类与字段名关联，默认自动注入名字相同的属性-->
		<id column="sid" property="sid"/>
		<result column="name" property="name"/>
		<result column="tid" property="tid"/>
	</collection>
</resultMap>
<select id="getByTid" parameterType="int" resultMap="teacher">
	select * from teacher where tid = #{tid}
</select>
</mapper>

dao层接口
StudentMapper

public interface StudentMapper {

	List<Student> getStudentByTid(int tid);
}

TeacherMapper

public interface TeacherMapper {

	Teacher getByTid(int Tid);
}

测试类

public class Test1 {

    public static void main(String[] args) throws IOException {
        /*获取配置文件mybatis-config.xml*/
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        /*建造会话工厂SqlSessionFactory*/
        SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        /*生产SqlSession*/
        SqlSession session = sessionFactory.openSession();
        /*通过反射获取TeacherMapper*/
        TeacherMapper mapper = session.getMapper(TeacherMapper.class);
        /*调用TeacherMapper的方法*/
        Teacher teacher = mapper.getByTid(1);
        System.out.println(teacher);
    }
}

运行结果
这里的警告是没有Log4j的配置文件

log4j:WARN No appenders could be found for logger (org.apache.ibatis.logging.LogFactory).
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.
Teacher [tid=1, name=李四, students=[Student{sid=1, name='张三', tid=1}, Student{sid=2, name='赵武', tid=1}]]

Process finished with exit code 0

不适用接口绑定直接调用xml 测试类

public class Test2 {

    public static void main(String[] args) throws IOException {
        /*获取配置文件mybatis-config.xml*/
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        /*建造会话工厂SqlSessionFactory*/
        SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        /*生产SqlSession*/
        SqlSession session = sessionFactory.openSession();
        /*通过SqlSession调用sql语句，第一个参数为mapper.xml里的方法，第二个参数为方法需要的参数*/
        Teacher teacher = session.selectOne("com.mapper.TeacherMapper.getByTid", 1);
        System.out.println(teacher);
    }
}

运行结果

log4j:WARN No appenders could be found for logger (org.apache.ibatis.logging.LogFactory).
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.
Teacher [tid=1, name=李四, students=[Student{sid=1, name='张三', tid=1}, Student{sid=2, name='赵武', tid=1}]]

Process finished with exit code 0

Log4j配置文件log4j.pproperties(名称确定，不区分大小写)

log4j.rootLogger = error,console

log4j.logger.com.mapper=debug
log4j.logger.org.apache=error
log4j.logger.java.sql.Statement=error
log4j.logger.java.sql.PreparedStatement=debug
log4j.logger.java.sql.ResultSet=debug

log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern =  %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

运行结果
过滤了大部分无用信息，只留下error和sql相关信息

2019-07-24 14:05:10  [ main:0 ] - [ DEBUG ]  ==>  Preparing: select * from teacher where tid = ? 
2019-07-24 14:05:10  [ main:52 ] - [ DEBUG ]  ==> Parameters: 1(Integer)
2019-07-24 14:05:10  [ main:101 ] - [ DEBUG ]  ====>  Preparing: select * from student where tid = ? 
2019-07-24 14:05:10  [ main:101 ] - [ DEBUG ]  ====> Parameters: 1(Integer)
2019-07-24 14:05:10  [ main:103 ] - [ DEBUG ]  <====      Total: 2
2019-07-24 14:05:10  [ main:103 ] - [ DEBUG ]  <==      Total: 1
Teacher [tid=1, name=李四, students=[Student{sid=1, name='张三', tid=1}, Student{sid=2, name='赵武', tid=1}]]

Process finished with exit code 0