什么是mybatis

MyBatis是支持普通SQL查询，存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis使用简单的XML或注解用于配置和原始映射，将接口和Java的POJOs（Plan Old Java Objects，普通的Java对象）映射成数据库中的记录.

orm工具的基本思想

无论是用过的hibernate,mybatis,你都可以法相他们有一个共同点：

1. 从配置文件(通常是XML配置文件中)得到 sessionfactory.
2. 由sessionfactory 产生 session
3. 在session 中完成对数据的增删改查和事务提交等.
4. 在用完之后关闭session 。
5. 在java 对象和 数据库之间有做mapping 的配置文件，也通常是xml 文件。

mybatis实战教程(mybatis in action)之一：开发环境搭建

mybatis 的开发环境搭建，选择: eclipse j2ee 版本，mysql 5.1 ,jdk 1.7,mybatis3.2.0.jar包。这些软件工具均可以到各自的官方网站上下载。

首先建立一个名字为 MyBaits 的 dynamic web project

1. 现阶段，你可以直接建立java 工程，但一般都是开发web项目，这个系列教程最后也是web的，所以一开始就建立web工程。
2. 将 mybatis-3.2.0-SNAPSHOT.jar，mysql-connector-java-5.1.22-bin.jar 拷贝到 web工程的lib目录.
3. 创建mysql 测试数据库和用户表,注意，这里采用的是 utf-8 编码

创建用户表,并插入一条测试数据

程序代码

Create TABLE `user` (`id` int(11) NOT NULL AUTO_INCREMENT,`userName` varchar(50) DEFAULT NULL,`userAge` int(11) DEFAULT NULL,`userAddress` varchar(200) DEFAULT NULL,PRIMARY KEY (`id`)) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;Insert INTO `user` VALUES ('1', 'summer', '100', 'shanghai,pudong');

到此为止，前期准备工作就完成了。下面开始真正配置mybatis项目了。

1. 在MyBatis 里面创建两个源码目录，分别为 src_user,test_src, 用如下方式建立,鼠标右键点击 JavaResource.

2. 设置mybatis 配置文件:Configuration.xml, 在src_user目录下建立此文件，内容如下:

程序代码

< ?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><typeAliases> <typeAlias alias="User" type="com.yihaomen.mybatis.model.User"/> </typeAliases> <environments default="development"><environment id="development"><transactionManager type="JDBC"/><dataSource type="POOLED"><property name="driver" value="com.mysql.jdbc.Driver"/><property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis" /><property name="username" value="root"/><property name="password" value="password"/></dataSource></environment></environments><mappers><mapper resource="com/yihaomen/mybatis/model/User.xml"/></mappers>< /configuration>

3. 建立与数据库对应的 java class,以及映射文件.

在src_user下建立package:com.yihaomen.mybatis.model ,并在这个 package 下建立 User 类:

程序代码

package com.yihaomen.mybatis.model;public class User {private int id;private String userName;private String userAge;private String userAddress;public int getId() {return id;}public void setId(int id) {this.id = id;}public String getUserName() {return userName;}public void setUserName(String userName) {this.userName = userName;}public String getUserAge() {return userAge;}public void setUserAge(String userAge) {this.userAge = userAge;}public String getUserAddress() {return userAddress;}public void setUserAddress(String userAddress) {this.userAddress = userAddress;}}

同时建立这个User 的映射文件 User.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.yihaomen.mybatis.models.UserMapper"><select id="selectUserByID" parameterType="int" resultType="User">select * from `user` where id = #{id}</select>< /mapper>

下面对这几个配置文件解释下：

1.Configuration.xml 是 mybatis 用来建立 sessionFactory 用的，里面主要包含了数据库连接相关东西，还有 java 类所对应的别名，比如 <typeAlias alias="User" type="com.yihaomen.mybatis.model.User"/> 这个别名非常重要，你在 具体的类的映射中，比如User.xml 中 resultType 就是对应这里的。要保持一致，当然这里的 resultType 还有另外单独的定义方式，后面再说。

2. Configuration.xml 里面 的<mapper resource="com/yihaomen/mybatis/model/User.xml"/>是包含要映射的类的xml配置文件。

3. 在User.xml 文件里面 主要是定义各种SQL 语句，以及这些语句的参数，以及要返回的类型等.

开始测试

在test_src 源码目录下建立com.yihaomen.test这个package,并建立测试类Test:

程序代码

package com.yihaomen.test;import java.io.Reader;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.yihaomen.mybatis.model.User;public class Test {private static SqlSessionFactory sqlSessionFactory;private static Reader reader; static{try{reader = Resources.getResourceAsReader("Configuration.xml");sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);}catch(Exception e){e.printStackTrace();}}public static SqlSessionFactory getSession(){return sqlSessionFactory;}public static void main(String[] args) {SqlSession session = sqlSessionFactory.openSession();try {User user = (User) session.selectOne("com.yihaomen.mybatis.models.UserMapper.selectUserByID", 1);System.out.println(user.getUserAddress());System.out.println(user.getUserName());} finally {session.close();}}}

现在运行这个程序，是不是得到查询结果了。恭喜你，环境搭建配置成功，接下来第二章，将讲述基于接口的操作方式，增删改查。
整个工程目录结构如下:

mybatis实战教程(mybatis in action)之二：以接口的方式编程

前面一章，已经搭建好了eclipse,mybatis,mysql的环境，并且实现了一个简单的查询。请注意，这种方式是用SqlSession实例来直接执行已映射的SQL语句：

session.selectOne("com.yihaomen.mybatis.models.UserMapper.selectUserByID", 1)

其实还有更简单的方法，而且是更好的方法，使用合理描述参数和SQL语句返回值的接口（比如IUserOperation.class），这样现在就可以至此那个更简单，更安全的代码，没有容易发生的字符串文字和转换的错误.下面是详细过程:

在src_user源码目录下建立 com.yihaomen.mybatis.inter 这个包，并建立接口类 IUserOperation , 内容如下：

程序代码

package com.yihaomen.mybatis.inter;import com.yihaomen.mybatis.model.User;public interface IUserOperation { public User selectUserByID(int id);}

请注意，这里面有一个方法名 selectUserByID 必须与 User.xml 里面配置的 select 的id 对应（<select id="selectUserByID"）

重写测试代码

public static void main(String[] args) {SqlSession session = sqlSessionFactory.openSession();try {IUserOperation userOperation=session.getMapper(IUserOperation.class);User user = userOperation.selectUserByID(1);System.out.println(user.getUserAddress());System.out.println(user.getUserName());} finally {session.close();}}

整个工程结构图现在如下：

运行这个测试程序，就可以看到结果了。

mybatis实战教程(mybatis in action)之三:实现数据的增删改查

前面已经讲到用接口的方式编程。这种方式，要注意的一个地方就是。在User.xml 的配置文件中，mapper namespace="com.yihaomen.mybatis.inter.IUserOperation" ，命名空间非常重要，不能有错，必须与我们定义的package 和 接口一致。如果不一致就会出错,这一章主要在上一讲基于接口编程的基础上完成如下事情:

1. 用 mybatis 查询数据，包括列表
2. 用 mybatis 增加数据
3. 用 mybatis 更新数据.
4. 用 mybatis 删除数据.

查询数据，前面已经讲过简单的，主要看查询出列表的

查询出列表，也就是返回list, 在我们这个例子中也就是 List<User> , 这种方式返回数据，需要在User.xml 里面配置返回的类型 resultMap, 注意不是 resultType, 而这个resultMap 所对应的应该是我们自己配置的

程序代码

< !-- 为了返回list 类型而定义的returnMap --><resultMap type="User" id="resultListUser"><id column="id" property="id" /><result column="userName" property="userName" /><result column="userAge" property="userAge" /><result column="userAddress" property="userAddress" /></resultMap>

查询列表的语句在 User.xml

程序代码

< !-- 返回list 的select 语句，注意 resultMap 的值是指向前面定义好的 --><select id="selectUsers" parameterType="string" resultMap="resultListUser">select * from user where userName like #{userName}</select>

在 IUserOperation 接口中增加方法：public List<User> selectUsers(String userName);

现在在 Test 类中做测试

程序代码

public void getUserList(String userName){SqlSession session = sqlSessionFactory.openSession();try {IUserOperation userOperation=session.getMapper(IUserOperation.class); List<User> users = userOperation.selectUsers(userName);for(User user:users){System.out.println(user.getId()+":"+user.getUserName()+":"+user.getUserAddress());}} finally {session.close();}}

现在在main 方法中可以测试：

程序代码

public static void main(String[] args) {Test testUser=new Test();testUser.getUserList("%");}

可以看到，结果成功查询出来。如果是查询单个数据的话，用第二讲用过的方法就可以了。

用mybatis 增加数据

在 IUserOperation 接口中增加方法：public void addUser(User user);

在 User.xml 中配置

程序代码

< !--执行增加操作的SQL语句。id和parameterType 分别与IUserOperation接口中的addUser方法的名字和 参数类型一致。以#{name}的形式引用Student参数 的name属性，MyBatis将使用反射读取Student参数 的此属性。#{name}中name大小写敏感。引用其他 的gender等属性与此一致。seGeneratedKeys设置 为"true"表明要MyBatis获取由数据库自动生成的主 键；keyProperty="id"指定把获取到的主键值注入 到Student的id属性--> <insert id="addUser" parameterType="User" useGeneratedKeys="true" keyProperty="id"> insert into user(userName,userAge,userAddress) values(#{userName},#{userAge},#{userAddress}) </insert>

然后在 Test 中写测试方法:

程序代码

/*** 测试增加,增加后，必须提交事务，否则不会写入到数据库.*/public void addUser(){User user=new User();user.setUserAddress("人民广场");user.setUserName("飞鸟");user.setUserAge(80);SqlSession session = sqlSessionFactory.openSession();try {IUserOperation userOperation=session.getMapper(IUserOperation.class);userOperation.addUser(user);session.commit();System.out.println("当前增加的用户 id为:"+user.getId());} finally {session.close();}}

用mybatis 更新数据

方法类似，先在 IUserOperation 中增加方法：public void addUser(User user);

然后配置 User.xml

程序代码

<update id="updateUser" parameterType="User" >update user set userName=#{userName},userAge=#{userAge},userAddress=#{userAddress} where id=#{id}</update>

Test 类总的测试方法如下：

程序代码

public void updateUser(){//先得到用户,然后修改，提交。SqlSession session = sqlSessionFactory.openSession();try {IUserOperation userOperation=session.getMapper(IUserOperation.class);User user = userOperation.selectUserByID(4); user.setUserAddress("原来是魔都的浦东创新园区");userOperation.updateUser(user);session.commit();} finally {session.close();}}

用mybatis 删除数据

同理，IUserOperation 增加方法：public void deleteUser(int id);

配置User.xml

程序代码

<delete id="deleteUser" parameterType="int">delete from user where id=#{id}</delete>

然后在Test类中写测试方法:

程序代码

/*** 删除数据，删除一定要 commit.* @param id*/public void deleteUser(int id){SqlSession session = sqlSessionFactory.openSession();try {IUserOperation userOperation=session.getMapper(IUserOperation.class); userOperation.deleteUser(id);session.commit(); } finally {session.close();}}

这样，所有增删改查都完成了，注意在增加，更改，删除的时候要调用session.commit()，这样才会真正对数据库进行操作，否则是没有提交的。

到此为止，简单的单表操作，应该都会了，接下来的时间了，我会讲多表联合查询，以及结果集的选取。

mybatis实战教程(mybatis in action)之四:实现关联数据的查询

有了前面几章的基础，对一些简单的应用是可以处理的，但在实际项目中，经常是关联表的查询，比如最常见到的多对一，一对多等。这些查询是如何处理的呢，这一讲就讲这个问题。我们首先创建一个Article 这个表，并初始化数据.

程序代码

Drop TABLE IF EXISTS `article`;Create TABLE `article` (`id` int(11) NOT NULL auto_increment,`userid` int(11) NOT NULL,`title` varchar(100) NOT NULL,`content` text NOT NULL,PRIMARY KEY (`id`)) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8;-- ------------------------------ 添加几条测试数据-- ----------------------------Insert INTO `article` VALUES ('1', '1', 'test_title', 'test_content');Insert INTO `article` VALUES ('2', '1', 'test_title_2', 'test_content_2');Insert INTO `article` VALUES ('3', '1', 'test_title_3', 'test_content_3');Insert INTO `article` VALUES ('4', '1', 'test_title_4', 'test_content_4');

你应该发现了，这几个文章对应的userid都是1，所以需要用户表user里面有id=1的数据。可以修改成满足自己条件的数据.按照orm的规则，表已经创建了，那么肯定需要一个对象与之对应，所以我们增加一个 Article 的class

程序代码

package com.yihaomen.mybatis.model;public class Article {private int id;private User user;private String title;private String content;public int getId() {return id;}public void setId(int id) {this.id = id;}public User getUser() {return user;}public void setUser(User user) {this.user = user;}public String getTitle() {return title;}public void setTitle(String title) {this.title = title;}public String getContent() {return content;}public void setContent(String content) {this.content = content;}}

注意一下，文章的用户是怎么定义的，是直接定义的一个User对象。而不是int类型。

多对一的实现

场景:在读取某个用户发表的所有文章。当然还是需要在User.xml 里面配置 select 语句, 但重点是这个 select 的resultMap 对应什么样的数据呢。这是重点，这里要引入 association 看定义如下:

程序代码

< !-- User 联合文章进行查询 方法之一的配置 (多对一的方式) --> <resultMap id="resultUserArticleList" type="Article"><id property="id" column="aid" /><result property="title" column="title" /><result property="content" column="content" /><association property="user" javaType="User"><id property="id" column="id" /><result property="userName" column="userName" /><result property="userAddress" column="userAddress" /> </association> </resultMap>< select id="getUserArticles" parameterType="int" resultMap="resultUserArticleList">select user.id,user.userName,user.userAddress,article.id aid,article.title,article.content from user,articlewhere user.id=article.userid and user.id=#{id}</select>

这样配置之后，就可以了，将select 语句与resultMap 对应的映射结合起来看，就明白了。用association 来得到关联的用户，这是多对一的情况，因为所有的文章都是同一个用户的。

还有另外一种处理方式，可以复用我们前面已经定义好的 resultMap ,前面我们定义过一个 resultListUser ,看这第二种方法如何实现:

程序代码

<resultMap type="User" id="resultListUser"><id column="id" property="id" /><result column="userName" property="userName" /><result column="userAge" property="userAge" /><result column="userAddress" property="userAddress" /></resultMap><!-- User 联合文章进行查询 方法之二的配置 (多对一的方式) --> <resultMap id="resultUserArticleList-2" type="Article"><id property="id" column="aid" /><result property="title" column="title" /><result property="content" column="content" /> <association property="user" javaType="User" resultMap="resultListUser" /> </resultMap><select id="getUserArticles" parameterType="int" resultMap="resultUserArticleList">select user.id,user.userName,user.userAddress,article.id aid,article.title,article.content from user,articlewhere user.id=article.userid and user.id=#{id}</select>

将 association 中对应的映射独立抽取出来，可以达到复用的目的。

好了，现在在Test 类中写测试代码:

程序代码

public void getUserArticles(int userid){SqlSession session = sqlSessionFactory.openSession();try {IUserOperation userOperation=session.getMapper(IUserOperation.class); List<Article> articles = userOperation.getUserArticles(userid);for(Article article:articles){System.out.println(article.getTitle()+":"+article.getContent()+":作者是:"+article.getUser().getUserName()+":地址:"+article.getUser().getUserAddress());}} finally {session.close();}}

漏掉了一点，我们一定要在 IUserOperation 接口中，加入 select 对应的id 名称相同的方法：

public List<Article> getUserArticles(int id);

然后运行就可以测试。

mybatis实战教程(mybatis in action)之五:与spring3集成

在这一系列文章中，前面讲到纯粹用mybatis 连接数据库，然后 进行增删改查，以及多表联合查询的的例子，但实际项目中，通常会用 spring 这个沾合剂来管理 datasource 等。充分利用spring 基于接口的编程，以及aop ,ioc 带来的方便。用spring 来管理 mybatis 与管理hibernate 有很多类似的地方。今天的重点就是数据源管理以及 bean的配置。

你可以下载源码后，对比着看，源代码没有带jar包，太大了，空间有限. 有截图，你可以看到用到哪些jar包，源码在本文最后.

1. 首先对前面的工程结构做一点改变，在src_user源代码目录下建立文件夹config ,并将原来的 mybatis 配置文件 Configuration.xml 移动到这个文件夹中, 并在config 文家夹中建立 spring 配置文件：applicationContext.xml ，这个配置文件里最主要的配置：

程序代码

< !--本示例采用DBCP连接池，应预先把DBCP的jar包复制到工程的lib目录下。 --> <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"><property name="driverClassName" value="com.mysql.jdbc.Driver"/> <property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis?characterEncoding=utf8"/><property name="username" value="root"/> <property name="password" value="password"/> </bean> <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <!--dataSource属性指定要用到的连接池--> <property name="dataSource" ref="dataSource"/> <!--configLocation属性指定mybatis的核心配置文件--> <property name="configLocation" value="config/Configuration.xml"/> </bean> <bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean"> <!--sqlSessionFactory属性指定要用到的SqlSessionFactory实例--> <property name="sqlSessionFactory" ref="sqlSessionFactory" /> <!--mapperInterface属性指定映射器接口，用于实现此接口并生成映射器对象--> <property name="mapperInterface" value="com.yihaomen.mybatis.inter.IUserOperation" /></bean>

[b]这里面的重点就是 org.mybatis.spring.SqlSessionFactoryBean 与 org.mybatis.spring.mapper.MapperFactoryBean[b] 实现了 spring 的接口，并产生对象。详细可以查看 mybatis-spring 代码。（http://code.google.com/p/mybatis/）,如果仅仅使用，固定模式，这样配置就好。

然后写测试程序

package com.yihaomen.test;import java.util.List;import org.springframework.context.ApplicationContext;import org.springframework.context.support.ClassPathXmlApplicationContext;import com.yihaomen.mybatis.inter.IUserOperation;import com.yihaomen.mybatis.model.Article;import com.yihaomen.mybatis.model.User;public class MybatisSprintTest {private static ApplicationContext ctx; static { ctx = new ClassPathXmlApplicationContext("config/applicationContext.xml"); } public static void main(String[] args) { IUserOperation mapper = (IUserOperation)ctx.getBean("userMapper"); //测试id=1的用户查询，根据数据库中的情况，可以改成你自己的.System.out.println("得到用户id=1的用户信息");User user = mapper.selectUserByID(1);System.out.println(user.getUserAddress()); //得到文章列表测试System.out.println("得到用户id为1的所有文章列表");List<Article> articles = mapper.getUserArticles(1);for(Article article:articles){System.out.println(article.getContent()+"--"+article.getTitle());}} }

运行即可得到相应的结果.

工程图：

用到的jar包，如下图：

mybatis实战教程(mybatis in action)之六:与Spring MVC 的集成

前面几篇文章已经讲到了mybatis与spring 的集成。但这个时候，所有的工程还不是web工程，虽然我一直是创建的web 工程。今天将直接用mybatis与Spring mvc 的方式集成起来，源码在本文结尾处下载.主要有以下几个方面的配置

1. web.xml 配置 spring dispatchservlet ,比如为:mvc-dispatcher
2. mvc-dispatcher-servlet.xml 文件配置
3. spring applicationContext.XML文件配置(与数据库相关，与mybatis sqlSessionFaction 整合，扫描所有mybatis mapper 文件等.)
4. 编写controller 类
5. 编写页面代码.

先有个大概映像，整个工程图如下:

1. web.xml 配置 spring dispatchservlet ,比如为:mvc-dispatcher

程序代码 程序代码

<context-param><param-name>contextConfigLocation</param-name><param-value>classpath*:config/applicationContext.xml</param-value></context-param><listener><listener-class>org.springframework.web.context.ContextLoaderListener</listener-class></listener><listener><listener-class>org.springframework.web.context.ContextCleanupListener</listener-class></listener><servlet><servlet-name>mvc-dispatcher</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class><load-on-startup>1</load-on-startup></servlet><servlet-mapping><servlet-name>mvc-dispatcher</servlet-name><url-pattern>/</url-pattern></servlet-mapping>

2. 在web.xml 同目录下配置 mvc-dispatcher-servlet.xml 文件,这个文件名前面部分必须与你在web.xml里面配置的DispatcherServlet 的servlet名字对应.其内容为:

程序代码

<beans xmlns="http://.yihaomen.service" /> 等这样的。

在controller层中测试,直接调用dao层方法
在controller中加入方法:

程序代码

@AutowiredUserDAO userDAO;.......@RequestMapping("/daolist")public ModelAndView listalldao(HttpServletRequest request,HttpServletResponse response){List<Article> articles=userDAO.getUserArticles(1);//制定视图，也就是list.jspModelAndView mav=new ModelAndView("list");mav.addObject("articles",articles);return mav;}

这样可以得到同样的结果，而且满足了一般程序的设计方法.代码结构如下:

以上所述是本文给大家介绍的Mybatis实战教程之入门到精通（经典）的相关知识，希望对大家有所帮助。