Mybatis 入门（一）

Mybatis入门

示例代码我上传到 gitee 上了，可以先拉到本地，结合着一起看。

项目地址：https://gitee.com/shizhiqian0021/MyBatisDemo.git
拉取示例代码时，请拉取所有分支，master 分支只是做了示例的初始化

A Simple Demo

1. 首先我们在数据库中建一个 mydemo 库，在其下建一个表，建表示例 SQL 如下：

DROP TABLE IF EXISTS `country`;
CREATE TABLE `country` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `countryname` varchar(255) DEFAULT NULL COMMENT '国名',
  `countrycode` varchar(255) DEFAULT NULL COMMENT '代码',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8;
​
-- ----------------------------
-- Records of country
-- ----------------------------
INSERT INTO `country` VALUES ('1', '中国', 'CN');
INSERT INTO `country` VALUES ('2', '美国', 'US');
INSERT INTO `country` VALUES ('3', '俄罗斯', 'RU');
INSERT INTO `country` VALUES ('4', '英国', 'GB');
INSERT INTO `country` VALUES ('5', '法国', 'FR');

2. XML Configure

<?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>
    <settings>
        <setting name="logImpl" value="LOG4J"/>
    </settings>
​
    <typeAliases>
        <package name="com.mybatis.simple.model"/>
    </typeAliases>
​
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC">
                <property name="" value=""/>
            </transactionManager>
            <dataSource type="UNPOOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mydemo?characterEncoding=utf-8&amp;serverTimezone=UTC&amp;useSSL=false" />
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
​
    <mappers>
        <mapper resource="mapper/CountryMapper.xml"/>
    </mappers>
​
</configuration>

• <settings> 中的 logImpl 属性配置指定使用 LOG4J 输出日志。

• <typeAliases> 元素下配置了一个包的别名；通常确定一个类时，需要使用类的全限定名称，在这里通过配置包的别名，在使用这个包下的类时，就不需要写包名的部分，直接写类名即可。

• <environments> 中主要配置了数据库连接信息，如：driver、url、username、password。

• <mappers> 中配置了一个包含完整路径的 CountryMapper.xml 文件，这个 XML 文件是 Mybatis 的 SQL 语句和映射配置文件。

  ---

接下来，我们创建一个实体类，由于 Mybatis 是一个结果集映射框架，这里我们要创建的实体类实际上是一个数据值对象（Data Value Object）,一般情况下，一个表对应一个实体，用于 INSERT、UPDATE、DELETE 和一些简单的 SELECT 操作，

3. 实体类 Country 如下：

public class Country {
    private Long id;
    private String countryName;
    private String countryCode;
​
    // getter 和 setter 方法
}

注意，这里的 Country 实体类的绝对路径应该是我们在上面的 <typeAliases> 中配置的别名包下。

接下来，我们创建一个 Mapper 文件，这个 Mapper 文件的绝对路径应与上面 <mappers> 中配置的文件 路径相同

<?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.simple.mapper.CountryMapper">
    <select id="selectAll" resultType="Country">
        SELECT id,countryname,countrycode FROM country
    </select>
</mapper>

• <mapper> : XML 的根元素，属性 namespace 定义了当前 XML 的命名空间

• </select>元素 ：我们定义的一个简单的 SELECT 查询

• id 属性：定义了当前 SELECT 查询的唯一一个 ID

• retultType： 定义了当前查询的返回类型，注意，由于我们前面的 <typeAliases> 标签中设置了别名，故此，在这里我们可以直接写类名即可；如果没有设置别名，我们这里的 resultType 后的值必须是当前返回类型的类的全局限定名。

• SELECT ID,... : 查询 SQL 语句。

  ---

Mybatis 的配置文件、实体类和实体所对应的 Mapper 文件到这里我们就设置完了。

4. 接下来我们配置一下 LOG4J，以便查看 Mybatis 操作数据库的过程：

在 src/main/resources 中添加 log4j.properties 配置文件，输入如下内容。

# 全局配置
log4j.rootLogger=ERROR,stdout
# MyBatis 日志配置
log4j.logger.com.mybatis.simple.mapper=TRACE
# 控制台输出配置
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

注意：这里我们配置的 log4j.logger.com.mybatis.simple.mapper=TRACE 对应的是 com.mybatis.simple.mapper 包。

在 MyBatis 的日志实现中，配置的包名，实际上是 XML 配置中的 namespace 属性值的一部分。

MyBatis 日志的最低级别是 TRACE.

 

设置完这些配置之后，我们来创建一个测试类：

public class CountryMapperTest {
    private static SqlSessionFactory sqlSessionFactory;
    @BeforeClass
    public static void init(){
        try {
            Reader resourceAsReader = Resources.getResourceAsReader("mybatis-config.xml");
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsReader);
            resourceAsReader.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    @Test
    public void testSelectAll(){
​
            SqlSession sqlSession = sqlSessionFactory.openSession();
        try {
            List<Country> selectAll = sqlSession.selectList("selectAll");
            System.out.println(selectAll.toString());
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            sqlSession.close();
        }
    }
}

启动测试类，便可以在控制台中看到如下日志：