IDEA+Maven配置MyBatis的初体验（坑点总结）

起因

在老师的推荐下，我跟着这篇文章https://www.jb51.net/article/70923.htm尝试MyBatis的初次调试运行。途中困难重重，由于教程中的开发环境是eclipse，项目是普通的javaweb项目，而我的是idea+maven，遇到不少坑，因而在此总结一下。

开发环境

idea2017

mybatis-3.1.1

mysql-connector-java-8.0.12

maven+quickstart

创建数据库和表，针对MySQL数据库

创建sql语句如下

create database mybatis;
 use mybatis;
 CREATE TABLE users(
    id INT PRIMARY KEY AUTO_INCREMENT,
    NAME VARCHAR(20), 
    age INT);
 INSERT INTO users(NAME, age) VALUES('susi',10);
 INSERT INTO users(NAME, age) VALUES('dang',110);

使用maven创建项目，并导入依赖jar包。

选择quickstart模板。项目的最终结构应该是这样的

在pom.xml文件的project块中添加Mysql驱动和MyBatis依赖

 　　  <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
      <dependency>
          <groupId>org.mybatis</groupId>
          <artifactId>mybatis</artifactId>
          <version>3.1.1</version>
      </dependency>

      <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
      <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.12</version>
      </dependency>

在maven中需要的依赖包大部分都可以在maven主仓库里找到，地址：https://mvnrepository.com/artifact/mysql/mysql-connector-java/8.0.12

如结构图，在main下创建resource文件夹，并标识为resources root。

IDEA是不会编译src的java目录的xml文件，所以在Mybatis的配置文件中找不到xml文件！（也有可能是Maven构建项目的问题）

因此我们把xml文件都放置在resource下，这样就不会错了。

在resource下添加Mybatis的配置文件conf.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.cj.jdbc.Driver" />  <!-- 这里注意，mysql 8.0开始有了小改变 -->
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?serverTimezone=GMT%2B8" />
                <property name="username" value="root" /> 
                <property name="password" value="mysql7758258" />
            </dataSource>
        </environment>
    </environments>
    
</configuration>

注意driver的值，旧版本是com.mysql.jdbc.Driver，8.0以上的版本则是com.mysql.cj.jdbc.Driver。

定义表所对应的实体类

package com.fang.domain;

/**
 * @author fang
 * users表所对应的实体类
 */
public class User {

    //实体类的属性和表的字段名称一一对应
    private int id;
    private String name;
    private int age;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User [id=" + id + ", name=" + name + ", age=" + age + "]";
    }
}

在resource下定义操作users表的sql映射文件userMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper .//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- 为这个mapper指定一个唯一的namespace，namespace的值习惯上设置成包名+sql映射文件名，这样就能够保证namespace的值是唯一的
  例如namespace="me.gacl.mapping.userMapper"就是me.gacl.mapping(包名)+userMapper(userMapper.xml文件去除后缀)-->
<mapper namespace="com.fang.mapping.userMapper">
    <!-- 在select标签中编写查询的SQL语句， 设置select标签的id属性为getUser，id属性值必须是唯一的，不能够重复
    使用parameterType属性指明查询时使用的参数类型，resultType属性指明查询返回的结果集类型
    resultType="me.gacl.domain.User"就表示将查询结果封装成一个User类的对象返回
   User类就是users表所对应的实体类-->

    <!--根据id查询得到一个user对象-->
    <select id="getUser" parameterType="int"
            resultType="com.fang.domain.User">
        select * from users where id=#{id}
    </select>

</mapper>

在conf.xml文件中注册userMapper.xml文件

    <mappers>
        <!-- 注册userMapper.xml文件-->
        <mapper resource="userMapper.xml"></mapper>
    </mappers>

编写测试代码：执行定义的select语句

package com.fang;

import com.fang.domain.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;
import java.io.InputStream;

/**
 * mybatis
 */
public class App {
    public static void main(String[] args) throws IOException {
        //mybatis的配置文件
        String resource = "conf.xml";
        //使用类加载器加载mybatis的配置文件（它也加载关联的映射文件）
        InputStream is = App.class.getClassLoader().getResourceAsStream(resource);
        //构建sqlSession的工厂
        SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(is);
        //使用MyBatis提供的Resources类加载mybatis的配置文件（它也加载关联的映射文件）
        //Reader reader = Resources.getResourceAsReader(resource);
        //构建sqlSession的工厂
        //SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(reader);
        //创建能执行映射文件中sql的sqlSession
        SqlSession session = sessionFactory.openSession();
        /**
         * 映射sql的标识字符串，
         * me.gacl.mapping.userMapper是userMapper.xml文件中mapper标签的namespace属性的值，
         * getUser是select标签的id属性值，通过select标签的id属性值就可以找到要执行的SQL
         */
        String statement = "com.fang.mapping.userMapper.getUser";//映射sql的标识字符串
        //执行查询返回一个唯一user对象的sql
        User user = session.selectOne(statement,2 );
        System.out.println(user);

    }
}

运行结果