MyBatis——通過package管理映射文件的引入

1 前言

在覈心配置文件（mybatis-config.xml）中，引入映射文件（如：StudentMapper.xml）的方法如下。其缺點是：當映射文件較多時，需要引入的映射文件也較多，使得 mybatis-config.xml 文件代碼量劇增。

<!-- 引入映射文件 -->
<mappers>
	<mapper resource="StudentMapper.xml"/>
</mappers>

通過 package 管理映射文件的引入，能夠避免 mybatis-config.xml 文件因映射文件過多而劇增，方法如下。

<!-- 引入映射文件 -->
<mappers>
	<package name="com.mapper"/>
</mappers>

2 實驗環境

（1）導入 JAR 包

其中，前2個 jar 包下載地址見 → log4j-1.2.17.jar、 mybatis-3.4.1.jar，將 jar 包放入 lib 目錄下，並選中所有 jar 包，右鍵，選擇【Add to Build Path】。

（2）配置文件

 log4j.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
		<param name="Encoding" value="UTF-8" />
		<layout class="org.apache.log4j.PatternLayout">
			<param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS} %m (%F:%L)\n" />
		</layout>
	</appender>

	<logger name="java.sql">
		<level value="debug" />
	</logger>

	<logger name="org.apache.ibatis">
		<level value="info" />
	</logger>

	<root>
		<priority value="debug" />
		<appender-ref ref="STDOUT" />
	</root>
</log4j:configuration>

注意：log4j.xml文件名不能隨意更改。

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>
	<!-- 設置或引入資源文件 -->
	<properties resource="jdbc.properties"></properties>
	
	<!-- 設置連接數據庫的環境，default用於設置默認使用的數據庫環境 -->
	<environments default="mysql">
		<!-- 設置某個具體的數據庫環境 -->
		<environment id="mysql">
			<transactionManager type="JDBC" />
			<dataSource type="POOLED">
				<property name="driver" value="${jdbc.driver}" />
				<property name="url" value="${jdbc.url}" />
				<property name="username" value="${jdbc.username}" />
				<property name="password" value="${jdbc.password}" />
			</dataSource>
		</environment>
	</environments>
	
	<!-- 引入映射文件 -->
	<mappers>
		<package name="com.mapper"/>
	</mappers>
</configuration>

注意：<package> 標籤的作用是：將 name 值指定的包裏的映射文件都引入。

jdbc.properties

# K = V
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/users?characterEncoding=UTF-8
jdbc.username=root
jdbc.password=0.

3 案例分析

首先在 MySQL 中創建數據庫：users，再在此數據庫中創建表：students，包含sid（int）、sname（varchar） 2個字段，其中，sid 設置了自增，students 表中數據如下：

3.1 方法一（映射文件和 DAO 接口在同一包下）

工作目錄如下：

注意：DAO 接口（StudentMapper.java）與映射文件（StudentMapper.xml） 在同一個包下。

Student.java

package com.bean;

public class Student {
	private Integer sid;
	private String sname;
	
	public Integer getId() {
		return sid;
	}
	
	public void setId(Integer sid) {
		this.sid = sid;
	}
	
	public String getName() {
		return sname;
	}
	
	public void setName(String sname) {
		this.sname = sname;
	}

	@Override
	public String toString() {
		return "Student [sid=" + sid + ", sname=" + sname + "]";
	}
}

注意：儘量保持 Student 類中屬性名與數據庫中 students 表格的屬性名同名，如果不同名，在查詢時需要使用別名，使得別名與 Student 類中對應屬性名同名。 

StudentMapper.java

package com.mapper;

import com.bean.Student;

public interface StudentMapper {
	public Student getStudentById(Integer sid);
}

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">
	<!-- public Student getStudentById(Integer sid); -->
	<select id="getStudentById" resultType="com.bean.Student">
		select sid,sname from students where sid = #{id}
	</select>
</mapper>

注意：namespace 需要指向 StudentMapper.java；<select> 標籤中 id 值需要與 StudentMapper.java 中相應方法名同名，resultType 爲該方法返回值的數據類型。 

Test.java

package com.test;

import java.io.IOException;
import java.io.InputStream;
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 com.bean.Student;
import com.mapper.StudentMapper;

public class Test {
	
	public static void main(String[] args) throws IOException {
		InputStream is=Resources.getResourceAsStream("mybatis-config.xml");
		SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(is);
		SqlSession sqlSession=sqlSessionFactory.openSession(true); //自動提交事務
		//getMapper：會通過動態代理動態生成StudentMapper的代理實現類
		StudentMapper mapper=sqlSession.getMapper(StudentMapper.class);
		
		Student student=mapper.getStudentById(1001); //查詢一條數據
		System.out.println(student);
	}
}

控制檯輸出如下：

DEBUG 06-11 21:34:52,042 ==>  Preparing: select sid,sname from students where sid = ?  (BaseJdbcLogger.java:145)
DEBUG 06-11 21:34:52,071 ==> Parameters: 1001(Integer) (BaseJdbcLogger.java:145)
DEBUG 06-11 21:34:52,089 <==      Total: 1 (BaseJdbcLogger.java:145)
Student [sid=1001, sname=張三]

3.1 方法一（映射文件和 DAO 接口在不同包下）

工作目錄如下：

注意：DAO 接口（StudentMapper.java）與映射文件（StudentMapper.xml） 分別在 src 和 conf 兩個文件夾的 com.mapper 包下（兩個包必須同名）。

以上是在 Package Explorer 視圖下看到的工作目錄，在 Navigator（【Window】→【Show View】→【Navigator】）視圖下，可以看到 StudentMapper.java 與 StudentMapper.xml 仍在同一文件下，如下所示：