MyBatis使用：入门

MyBatis使用入门

最近项目用到了Mybatis，这个东西以前用过，不过好久不用，稍显生疏，并且当时用的是ibatis-2.x版本，现在已经更新到mybatis-3.2.0-SNAPSHOT，功能和特性有好多更新。今天下午抽了个时间重新读了下文档，发现基本特性上变化不太大。注意本文记录的是基本的内容，仅用作记录，供参考。

本文使用mybatis-3.1.1.jar包

MyBatis作为持久层框架，主要思想就是讲sql从程序中剥离出来，卸载配置文件中，实现灵活配置。

好处是将Sql和程序剥离，在不修改程序代码的情况下，通过直接修改sql来更新业务内容。

缺点是需要自行写Sql语句，这点也总是被拿来和Hibernate作对比，不过作为程序猿/媛，Sql也是修炼中的一环，个人认为这个反而应该是最大的优点才对。自己编写的Sql语句才能在性能上面有所保证，而Hibernate处理Sql优化这块还是过于依赖框架本身了。

本文作为示例教程，仅简单实现CRUD操作，更细致的操作请参考官方的文档：http://code.google.com/p/mybatis/

使用建表语句，在mysql中建立如下user表：

CREATE TABLE `user` (   `id` bigint(20) NOT NULL auto_increment,  `userId` varchar(32), `userName` varchar(30) character set utf8 NOT NULL,   `password` varchar(80) character set utf8 NOT NULL,   `comment` varchar(250) character set utf8 default NULL,primary key(`id`) ) ENGINE=MyISAM AUTO_INCREMENT=5 DEFAULT CHARSET=utf8;

我们先看下configuration.xml配置文件，主要是配置数据库环境和mapper.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>
    <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://10.11.200.226:3306/gdd?characterEncoding=UTF-8" />                
	                        <property name="username" value="root" />                
	                        <property name="password" value="1234" />            
                        </dataSource>
           </environment>
           <environment id="online">
                        <transactionManager type="JDBC" />
                        <dataSource type="POOLED">                
	                        <property name="driver" value="com.mysql.jdbc.Driver"/>                
	                        <property name="url" value="jdbc:mysql://10.11.200.226:3306/gdd?characterEncoding=UTF-8" />                
	                        <property name="username" value="root" />                
	                        <property name="password" value="1234" />            
                        </dataSource>
           </environment>    
   </environments>    
   <mappers>
           <mapper resource="com/mybatis/application/UserDaoMapper.xml"/>
   </mappers>
</configuration>

这个文件里面有development和online环境，可以再代码中选择使用不同的配置。

UserDaoMapper.xml文件，这个文件保存的是Sql语句和POJO之间映射关系。

<?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.mybatis.application.UserDao"> 
   <select id="selectAll" resultType="com.mybatis.application.User"> 
          select * from user order by userName asc    
   </select> 
   <insert id="insert" parameterType="com.mybatis.application.User">
          insert into user(userId,userName,password,comment) values(#{userId},#{userName},#{password},#{comment})    
   </insert>
   <update id="update" parameterType="com.mybatis.application.User">
           update user set userId=#{userId},password=#{password},comment=#{comment} where userName=#{userName}   
   </update>   
   <delete id="delete" parameterType="String">       
   			delete from user where userName=#{userName}    
   </delete>        
   <select id="findUserByName" parameterType="String" resultType="com.mybatis.application.User">
           select * from user where userName=#{userName}  limit 1 
   </select>
</mapper>

其中#{userName}是传入的参数，这个参数的要求比较严格，parameterType是参数类型，resultType是查询返回的数据类型。

User POJO实体类：

package com.mybatis.application;

public class User {
    private String id;
    private String userId;
    private String userName;
    private String password;
    private String comment;
    public String getId () {
        return id;
    }
    public void setId ( String id ) {
        this.id = id;
    }
    public String getUserId () {
        return userId;
    }
    public void setUserId ( String userId ) {
        this.userId = userId;
    }
    public String getUserName () {
        return userName;
    }
    public void setUserName ( String userName ) {
        this.userName = userName;
    }
    public String getPassword () {
        return password;
    }
    public void setPassword ( String password ) {
        this.password = password;
    }
    public String getComment () {
        return comment;
    }
    public void setComment ( String comment ) {
        this.comment = comment;
    }
   
}

UserDao内容，这个主要是实现功能和Sql的映射，在ibatis中，还需要UserDaoImpl实现，现在直接定好好UserDao接口，就可以直接建立Sql和功能的映射，这个还真是个方便之处。

package com.mybatis.application;

import java.util.List;

public interface UserDao {
    public int insert(User user);
    public int update(User user);
    public int delete(String userName); 
    public List<User> selectAll(); 
    public User findUserByName(String userName);
}

 最早使用这个Dao的时候，还需要有实现，现在只要方法名和定义的Sql id一致即可，这个也节省好多代码量。

UserDaoTest内容，本来是想引用JUnit进行测试的，后来Eclipse MVN出了点问题，更新超慢还卡死，就不再使用Junit，但是代码尽量靠近Junit的测试风格。

package com.mybatis.application;

import java.io.IOException;
import java.io.Reader;
import java.util.Iterator;
import java.util.List;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class UserDaoTest {
    
    private static SqlSessionFactory sqlSessionFactory;
    static {
        String resource = "configuration.xml";
        Reader reader = null;
        try {
            reader = Resources.getResourceAsReader(resource);
        } catch (IOException e) {
            e.printStackTrace();
        }
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        sqlSessionFactory = builder.build(reader);
    }
    
    public static void main(String[] args) throws Exception{
        testInsert();
        testQuery();
        testUpdate();
        testQuery();
        testDelete();
        testQuery();
    }
    
    public static  void testInsert(){
        SqlSession session = sqlSessionFactory.openSession();
        UserDao userDao = session.getMapper(UserDao.class);
        User user = new User();
        user.setUserId("ID0001");
        user.setUserName("tiancaixiangshi");
        user.setPassword("ppnn18%");
        user.setComment("wtf");
        userDao.insert(user);
        session.commit();
        session.close();
    }
    
    
    public static  void testUpdate(){
        SqlSession session = sqlSessionFactory.openSession();
        UserDao userDao = session.getMapper(UserDao.class);
        User user = new User();
        user.setUserId("ID" + System.currentTimeMillis());
        user.setUserName("tiancaixiangshi");
        user.setPassword("ppnn18%");
        user.setComment("WTF");
        userDao.update(user);
        session.commit();
        session.close();
    }
    
    public static  void testDelete(){
        SqlSession session = sqlSessionFactory.openSession();
        UserDao userDao = session.getMapper(UserDao.class);
        userDao.delete("tiancaixiangshi");
        session.commit();
        session.close();
    }
    
    public static void testQuery(){
        SqlSession session = sqlSessionFactory.openSession();
        UserDao userDao = session.getMapper(UserDao.class);
        List<User> users = userDao.selectAll();
        Iterator<User> iter = users.iterator();
        while (iter.hasNext()) {
            User u = iter.next();
            System.out.println("userid:" + u.getUserId() + "  username：" + u.getUserName() + " password：" + u.getPassword());
        }
        session.commit();
        session.close();
    }
    
}

在写Mapper.xml文件时，需要注意Dao类和POJO对象的完整路径，如果定义不对的话，会出现下面这两种异常情况：

Type interface XXX is not known to the MapperRegistry

Mapped Statements collection does not contain value for userName

这两个错误的话注意检查类和对象的路径，另外就是检查Sql的语句是否准确。

再说两句额外的话，MyBatis的本身定位是数据持久化框架，看官方文档，MyBatis作为IoC的一部分和Spring、Guice结合，大大减轻了开发者的工作量。如果现在的场景并没有Spring、Guice这样的框架，还想用MyBatis怎么办？其实很简单，直接使用mybatis-core部分就可以完成工作。我们需要理解框架的定位，离开Spring我们还是可以继续玩的转的。

如果选择只用Mybatis，弃掉Spring的话，需要自己管理SqlSession，实现自己的业务内容。如果离开了Spring，并不能操作MyBatis的话，就需要反思自己的知识体系了。

本文的内容比较简单，仅作为参考吧，其中需要注意的地方还是有一些的。