mybatis入门实例

一、mybatis环境搭建

1.创建maven工程配置环境

打开IDEA ，File->New->Project，右边选择Maven，左边不要勾选任何东西，点击next，输入项目名称即可。

在pom.xml文件中添加如下内容：packaging是打包方式，log4j是为了输出日志，junit是为了单元测试。其中版本号视各自版本来定。

<packaging>jar</packaging>
    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.18</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13-rc-2</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

2.创建实体类和dao接口

事先准备好数据库，创建一个user表，如下图：

对应的SQL语句如下：

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` int(11) NOT NULL auto_increment,
  `username` varchar(32) NOT NULL COMMENT '用户名称',
  `birthday` datetime default NULL COMMENT '生日',
  `sex` char(1) default NULL COMMENT '性别',
  `address` varchar(256) default NULL COMMENT '地址',
  PRIMARY KEY  (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
insert  into `user`(`id`,`username`,`birthday`,`sex`,`address`) values (41,'老王','2018-02-27 17:47:08','男','北京'),(42,'小二王','2018-03-02 15:09:37','女','北京金燕龙'),(43,'小二王','2018-03-04 11:34:34','女','北京金燕龙'),(45,'传智播客','2018-03-04 12:04:06','男','北京金燕龙'),(46,'老王','2018-03-07 17:37:26','男','北京'),(48,'小马宝莉','2018-03-08 11:44:00','女','北京修正');

在src/main/java目录创建domain包，在domain下创建实体类User，类的属性和数据库中表的属性保持一致，每个属性都有Get()和Set()方法，最后覆盖toString()函数。如下：

public class User implements Serializable {
    private Integer id;
    private String username;
    private Date birthday;
    private String sex;
    private String address;
  
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", birthday=" + birthday +
                ", sex='" + sex + '\'' +
                ", address='" + address + '\'' +
                '}';
    }
}

在src/main/java目录创建dao包，在dao包下创建接口IUserDao，包含一个查询所有用户的findAll()函数，如下：

public interface IUserDao {
        //查询所有用户
    List<User> findAll();
}

3.创建mybatis主配置文件

在resources目录下创建主配置文件，名称任意，一般为SqlMapConfig.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">
<!-- mybatis的主配置文件 -->
<configuration>
    <!-- 配置环境 -->
    <environments default="mysql">
        <!-- 配置mysql的环境 -->
        <environment id="mysql">
            <!-- 配置事务的类型 -->
            <transactionManager type="JDBC"></transactionManager>
            <!-- 配置数据源（连接池） -->
            <dataSource type="POOLED">
                <!-- 配置连接数据库的四个基本信息 -->
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
                <property name="username" value="root"/>
                <property name="password" value="12345678"/>
            </dataSource>
        </environment>
    </environments>

    <!-- 指定映射配置文件的位置，映射配置文件指的是每个dao独立的配置文件 -->
    <mappers>
        <mapper resource="dao/IUserDao.xml" />
    </mappers>
</configuration>

在同级目录下创建log4j.properties文件，配置log4j，便于查看日志。

# Set root category priority to INFO and its only appender to CONSOLE.
#log4j.rootCategory=INFO, CONSOLE            debug   info   warn error fatal
log4j.rootCategory=debug, CONSOLE, LOGFILE

# Set the enterprise logger category to FATAL and its only appender to CONSOLE.
log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE

# CONSOLE is set to be a ConsoleAppender using a PatternLayout.
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n

# LOGFILE is set to be a File appender using a PatternLayout.
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=axis.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n

4.创建映射配置文件

在resources目录下创建dao目录，然后在dao目录下创建映射配置文件，注意SqlMapConfig的<mappers>标签下的resource属性要和此处的文件名对应，namespace就是一个命名空间，类似于包。

<?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="dao.IUserDao">
    <!-- 配置查询所有 -->
    <select id="findAll" resultType="domain.User">
        select * from user;
    </select>
</mapper>

5.环境搭建的注意事项

1.在mybatis中，持久层的操作接口名称和映射配置文件也叫mapper，所以IUserDao.xml有时候也叫做IUserMapper.xml。

2.MyBatis的映射配置文件位置必须和dao接口的包结构相同。

3.映射配置文件的mapper标签的namespace属性的取值必须是dao接口的全限定类名。

4.映射配置文件的操作配置（如select），id属性的取值必须是dao接口的方法名，因为查询操作有返回值，所以必须指定一个返回的结果类型，属性为resultType，取值是返回值的类，这里就是user。

5.在实际开发中，通常会严格按照2，3，4点进行，因为当我们按照此规则时，就无需再写dao的实现类。

二、通过配置文件来实现入门实例

1.测试函数运行

在test/java中创建包创建类MybatisTest，在类中创建Main函数，主要有以下几步：

1.读取配置文件

2.创建SqlSessionFactory工厂

3.使用工厂生产SqlSession对象

4.使用SqlSession创建Dao的代理对象

5.使用代理对象执行方法

6.释放资源

public class MybatisTest {
    public static void main(String[] args) throws Exception{
        //1.读取配置文件
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
        //2.创建SqlSessionFactory工厂
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = builder.build(in);
        //3.使用工厂生产SqlSession对象
        SqlSession session = factory.openSession();
        //4.使用SqlSession创建Dao的代理对象
        IUserDao userDao = session.getMapper(IUserDao.class);
        //5.使用代理对象执行方法
        List<User> users = userDao.findAll();
        for(User user : users) {
            System.out.println(user);
        }
        //6.释放资源
        session.close();
        in.close();

    }
}

最后点击运行，运行时可能会报错“java不支持发行版本 5”，这主要是因为是因为Maven默认的Java版本是1.5，而大部分人装的都是新的版本，可参考Intellij idea 报错：Error : java 不支持发行版本5。最终运行结果如下：

三、通过注解来实现入门实例

1.代码修改

在使用注解来进行开发时，和使用xml来指定映射略有不同，主要在如下几点：

1.在上述项目的resources目录下的dao目录中删除文件IUserDao.xml，并且将主配置文件SqlMapConfig.xml的<mappers>标签修改为如下：

<!-- 使用注解方式配置，需要使用class属性指出被注解dao的全限定类名 -->
    <mappers>
        <mapper class="dao.IUserDao" />
    </mappers>

2.在src/main/java目录下的dao包中的IUserDao类的findAll()方法上添加@Select注解：

public interface IUserDao {
    //查询所有用户操作
    @Select("select * from user")
    List<User> findAll();
}

四、通过自定义DAO实现类来实现入门实例

1.代码修改

自定义DAO实现类时，和第一个项目的不同之处在于如下几点：

1.在src/main/java目录的dao包下创建impl包，并在impl包下创建DAO实现类UserDaoImpl，如下：

public class UserDaoImpl implements IUserDao {

    private SqlSessionFactory factory;

    public UserDaoImpl(SqlSessionFactory factory){
       this.factory = factory;
    }

    public List<User> findAll(){
        //1.使用工厂创建SqlSession对象
        SqlSession session = factory.openSession();
        //2.使用session执行查询所有方法
        List<User> users = session.selectList("com.whu.cs.dao.IUserDao.findAll");
        session.close();
        //3.返回查询结果
        return users;
    }
}

2.对src/test/java目录下的test包中的MybatisTest类进行修改如下：

public class MybatisTest {
    public static void main(String[] args) throws Exception{
        //1.读取配置文件
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
        //2.创建SqlSessionFactory工厂
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = builder.build(in);
        //3.使用工厂创建dao对象
        IUserDao userDao = new UserDaoImpl(factory);
        //4.使用dao对象执行方法
        List<User> users = userDao.findAll();
        for(User user : users) {
            System.out.println(user);
        }
        //5.释放资源
        in.close();

    }
}