MyBatis 学习笔记(1) 简介和体验Demo

张云飞Vir

发布于 2021-06-29 10:22:40

2670

发布于 2021-06-29 10:22:40

文章被收录于专栏：写代码和思考

1. 背景

让我们开始学习 MyBatis 。

2. 什么是 MyBatis？

MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。

MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

MyBatis 关注接口方法和 XML 的的映射。

3. 快速示例

通过一个在项目中集成MyBatis示例先认识下MyBatis。 步骤1：创建一个 Maven 项目 创建一个 Maven 项目, 并修改pom文件引入 mybatis。

        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.3.1</version>
        </dependency>

步骤2：配置 MyBatis 先在 resouces 文件夹下建立一个文件夹 mapper , 并在这个文件夹下新增一个文件 mybatis-config.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://192.168.1.111:3306/mybatisdemo?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="mapper/CountryMapper.xml"/>
    </mappers>
    
</configuration>

这是个 mybatis 的主配置文件，指定了事务类型是 JDBC，数据源
driver 配置了 mysql 的 JDBC 驱动
url 是连接字符串
username,password 是数据库的连接账号和密码

通过上面两步，我们就配置好了项目类库依赖，数据源。下面开始写一个查询示例。

步骤3：建立数据库 这里需要一个country表，完整建表语句见本文文末的示例。

步骤4：构建一个实体 bean

public class Country {
    public Long id;
    public String countryName;
    public String countryCode;
}

步骤5：建立连接，查询数据库并获得一个对象

public class MainClass {

    public static void main(String[] args) throws IOException {
        System.out.println("ready...");

        String resource = "mapper/mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        try (SqlSession session = sqlSessionFactory.openSession()) {
            Country blog = (Country) session.selectOne("cn.zyfvir.CountryMapper.selectBlog", 1);
            printf(blog);
        }
    }

    private static void printf(Country blog) {
        System.out.println("" + blog.id + ", " + blog.countryName);
    }
}

这里打开了一个 "mapper/mybatis-config.xml"; 配置文件，并作为 InputStream 参数输入流对象传给了SqlSessionFactoryBuilder。
SqlSessionFactoryBuilder 按照这个配置文件，构建一个 SqlSessionFactory SQL的会话工厂对象。
SQL的会话工厂对象打开后，建立一个 SqlSession 会话，表明数据库连接完成。
有了数据连接就可以查询了，执行 session.selectOne("cn.zyfvir.CountryMapper.selectBlog", 1); 查询到一个对象，并自动序列号成为一个 Countr 对象
最后关闭会话，释放资源。

4. 一些讨论

mybatis 支持 xml 和注解两种方式。比如处理上文写xml配置mybatis以外，还可以直接用 java代码来配置，示例：

DataSource dataSource = BlogDataSourceFactory.getBlogDataSource();
TransactionFactory transactionFactory = new JdbcTransactionFactory();
Environment environment = new Environment("development", transactionFactory, dataSource);
Configuration configuration = new Configuration(environment);
configuration.addMapper(BlogMapper.class);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

当然，也可以用 java的注解来写查询映射而不依赖xml。

package org.mybatis.example;
public interface BlogMapper {
  @Select("SELECT * FROM blog WHERE id = #{id}")
  Blog selectBlog(int id);
}

那么一个问题是：选用 XML 还是注解方式来做映射？

使用注解来映射简单语句会使代码显得更加简洁
但对于稍微复杂一点的语句，Java 注解不仅力不从心，还会让你本就复杂的 SQL 语句更加混乱不堪。
因此，如果你需要做一些很复杂的操作，最好用 XML 来映射语句。
建议：选择何种方式来配置映射，以及认为是否应该要统一映射语句定义的形式，完全取决于你和你的团队。

换句话说，永远不要拘泥于一种方式，你可以很轻松的在基于注解和 XML 的语句映射方式间自由移植和切换。

5. 扩展

建议用接口方式的调用取代按字符串全名称方式调用 上文的调用示例中：

Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);

这种方式和用全限定名调用 Java 对象的方法类似。这样，该命名就可以直接映射到在命名空间中同名的映射器类，并将已映射的 select 语句匹配到对应名称、参数和返回类型的方法。

它还有更简洁的方式, 即按接口方式调用：先创建一个 mapper 接口类：

public interface CountryMapper {
    Country selectBlog(int id);
}

然后这么调用

CountryMapper mapper = session.getMapper(CountryMapper.class);
Country blog = mapper.selectBlog(1);

第二种方法有很多优势:

它不依赖于字符串字面值，会更安全一点，避免写错；
IDEA 有代码补全功能，可以帮你快速选择。
更简洁，易读。
因此，建议使用第二种方法

try-with-resources 语句 -- 可以自动释放资源 该try-with资源语句是try声明了一个或多个资源声明。一个资源是一个对象的程序与它完成后，必须关闭。该try-with资源语句确保每个资源在发言结束时关闭。任何实现的对象，java.lang.AutoCloseable包括所有实现的对象java.io.Closeable，都可以用作资源。

以下示例从文件中读取第一行。它使用的实例BufferedReader从文件中读取数据。BufferedReader是程序完成后必须关闭的资源：示例：

try (BufferedReader br = new BufferedReader(new FileReader(path))) {
        return br.readLine();
}  // 自动释放，执行 close 方法。

6. 附录

配置日志 mybatis可以很方便的和各种日志框架一起使用，它有一个日志工厂类，可以讲具体写日志的操作委托给代理来执行，支持下面几种实现：

SLF4J
Apache Commons Logging
Log4j 2
Log4j
JDK logging

为此，我们要修改配置文件 mybatis-config.xml：

<configuration>
  <settings>
    ...
    <setting name="logImpl" value="LOG4J"/>
    ...
  </settings>
</configuration>

然后就可以做一些设置打印出具体执行的 SQL语句了，假设你的类的包名是这个 cn.zyfvir，我们再新建一个 log4j.properties 用于设定 log4j 的配置文件，如下：

# 全局日志配置
log4j.rootLogger=ERROR, stdout
# MyBatis 日志配置
log4j.logger.cn.zyfvir=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.cn.zyfvir=TRACE ，它打开了SQL执行的跟踪日志。参考资料：https://mybatis.org/mybatis-3/zh/logging.html

创建数据库的示例：

CREATE TABLE country
(
  id int NOT NULL AUTO_INCREMENT,
  countryName varchar(255) NULL,
  countryCode varchar(255) NULL,
  PRIMARY KEY (id)
);

INSERT country(countryName,countryCode) values('china',"cn"), ('english',"en");

完整的 pom.xml 文件。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>cn.zyfvir</groupId>
    <artifactId>mybatisdemo1</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.3.1</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.44</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

我的代码示例放到 github了，见这里：https://github.com/vir56k/java_demo/tree/master/mybatisdemo1 https://github.com/vir56k/java_demo/tree/master/mybatisdemo2