MyBatis入门CRUD和全局配置文件

Love The Way You Lie 2022-04-18 06:14 315阅读 0赞

### 一、MyBatis简介 ###

**      [github下载地址][github]          [官方文档地址][Link 1]：**

**1. 什么是 MyBatis ？**

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。

**2、MyBatis的配置文件，有两种,，参考文档**

1）MyBatis的全局配置文件/主配置文件

起名：自定义，推荐mybatis-config.xml，见名知意

路径：放在classpath的根路径

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70][]

2）MyBatis的映射文件/Mapper文件

起名：自定义，推荐XxxMapper.xml，见名知意。

Mybatis映射文件三要素为：SQL，映射规则和 POJO类。

**3、认识几个类 **

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 1][]

### 二、简单入门实例 ###

创建 Maven java普通项目，引入jar包依赖，

MyBatis3.4.6     mysql

**1、pom.xml中引入 mybatis依赖**

<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>5.1.46</version>
            </dependency>
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.8</version>
                <scope>provided</scope>
            </dependency>
            
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>compile</scope>
            </dependency>
            
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
        </dependencies>
    
    
        <build>
            <resources>
                <resource>
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.xml</include>
                    </includes>
                </resource>
            </resources>
        </build>

**2、配置文件**

**     数据库文件：db.properties**

jdbc.driverClass=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://localhost:3306/mybatis_demo?useUnicode=true&characterEncoding=utf8&useSSL=true
    jdbc.user=root
    jdbc.password=123456

**     表语句：**

CREATE TABLE `t_user` (
      `id` bigint(11) NOT NULL AUTO_INCREMENT,
      `username` varchar(255) DEFAULT NULL,
      `pazzword` varchar(255) DEFAULT NULL,
      `salary` decimal(10,2) DEFAULT NULL,
      `reg_date` datetime DEFAULT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8;

**     log4j日志文件：log4j.properties**

log4j.rootLogger = debug,stdout
    log4j.appender.stdout = org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.Target = System.out
    log4j.appender.stdout.Threshold = debug
    log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
    log4j.appender.stdout.layout.ConversionPattern=%5p [%t] %m%n

**     全局配置文件（官方文档有demo,可复制）：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>
        
        <properties resource="db.properties"></properties>
        
        <settings>
            
            <setting name="logImpl" value="LOG4J"/>
            
            
        </settings>
    
        
        <environments default="dev">
            <environment id="dev"> 		
                <transactionManager type="JDBC" />  
                <dataSource type="POOLED">  	
                    <property name="driver" value="${jdbc.driverClass}" />
                    <property name="url" value="${jdbc.url}" />
                    <property name="username" value="${jdbc.user}" />
                    <property name="password" value="${jdbc.password}" />
                </dataSource>
            </environment>
        </environments>
    
        
        <mappers>
            
            
            <package name="cn.jq.jqmybatis.dao" /> 
        </mappers>
    </configuration>

![20191014211021932.png][]

**     引入Mapper映射文件（在后面）**

**3、创建POJO对象和Dao类**

**     User类**

import lombok.Data;
    import java.math.BigDecimal;
    import java.util.Date;
    
    @Data
    public class User {
        private Long id;
        private String username;
        private String pazzword;
        private BigDecimal salary;
        private Date regDate; //用户注册时间
    }

**     UserMapper接口**

public interface UserMapper {
        User getUser(Long id);
    }

**     Mapper映射文件（官方文档有demo,可复制）：UserMapper.xml**

**4、测试类**

import cn.jq.jqmybatis.dao.UserMapper;
    import cn.jq.jqmybatis.model.User;
    import org.apache.ibatis.io.Resources;
    import org.apache.ibatis.session.SqlSession;
    import org.apache.ibatis.session.SqlSessionFactory;
    import org.apache.ibatis.session.SqlSessionFactoryBuilder;
    import org.junit.Test;
    
    import java.io.InputStream;
    import java.nio.charset.Charset;
    import java.util.List;
    
    public class App {
    
        @Test
        public void testGet() throws Exception {
            //1. 创建SqlSessionFacotry工厂类对象，根据读取全局配置文件
            Resources.setCharset(Charset.forName("utf-8"));//设置编码格式
            InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    
            //2. 打开数据库连接会话
            SqlSession session = sqlSessionFactory.openSession();
    
            // 3. CRUD操作
     /*       // Mapper接口方式： jdk动态代理，项目中普遍使用，这里先不用
            UserMapper userMapper = session.getMapper(UserMapper.class);
            // 调用查询一条记录的方法
            User user = userMapper.getUser(1L);
     */
            User user = session.selectOne("cn.jq.jqmybatis.dao.UserMapper.getUser", 3L);
            System.out.println(user);
            List<Object> list = session.selectList("cn.jq.jqmybatis.dao.UserMapper.listAll");
            list.forEach(user1 -> {
                System.out.println(user1);
            });
            //4.关闭会话
            session.close();
        }
    }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 2][]

** resultType属性：要求结果集的列名和属性名必须要匹配，**

**   若不匹配时，可以使用SQL语句的AS别名(不推荐) 或者 设置开启自动驼峰命名规则映射 或者使用 resultMap属性（后面讲）**

### **三、抽取MyBatisUtil，简单实现CRUD** ###

**    MyBatisUtil类**

import org.apache.ibatis.io.Resources;
    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;
    import java.nio.charset.Charset;
    
    /**
     * MyBatis 工具类
     */
    public class MyBatisUtil {
        private static SqlSessionFactory sqlSessionFactory = null;
    
        static {
            // 创建SqlSessionFacotry工厂类对象，根据读取全局配置文件
            try {
                Resources.setCharset(Charset.forName("utf-8"));//设置编码格式
                sqlSessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream("mybatis-config.xml"));
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    
        // 返回一个 SqlSession对象
        public static SqlSession getSession() {
            return sqlSessionFactory.openSession();
        }
    }

**    UserMapper.xml**

<?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="cn.jq.jqmybatis.dao.UserMapper">
        
        <select id="getUser" parameterType="java.lang.Long" resultType="cn.jq.jqmybatis.model.User">
    		select * from t_user where id = #{id}
    	</select>
        <select id="listAll" resultType="cn.jq.jqmybatis.model.User">
    		select * from t_user
    	</select>
    
    	
    	<insert id="insert" useGeneratedKeys="true" keyProperty="id">
    		insert into t_user(username, pazzword, salary, reg_date) value (#{username}, #{pazzword}, #{salary}, #{regDate})
    	</insert>
    
    	<update id="update" >
    		update t_user set username = #{username}, reg_date = #{regDate} where id = #{id}
    	</update>
    
    	<delete id="delete" >
    		delete from t_user where id = #{id}
    	</delete>
    </mapper>

**    测试类**

public class App {
    
        @Test
        public void testGet() throws Exception {
            //2. 打开数据库连接会话
            SqlSession session = MyBatisUtil.getSession();
            User user = session.selectOne("cn.jq.jqmybatis.dao.UserMapper.getUser", 3L);
            System.out.println(user);
            session.close();
        }
    
        @Test
        public void testUpdate() throws Exception {
            SqlSession session = MyBatisUtil.getSession();
            User user = new User();
            user.setId(4L);
            user.setUsername("asda");
            user.setRegDate(new Date());
            session.update("cn.jq.jqmybatis.dao.UserMapper.update", user);
            // 提交事务
            session.commit();
            session.close();
        }
    
        @Test
        public void testInsert() throws Exception {
            SqlSession session = MyBatisUtil.getSession();
            User user = new User();
            user.setUsername("asda");
            user.setPazzword("123456");
            user.setSalary(new BigDecimal(99.99));
            user.setRegDate(new Date());
            session.insert("cn.jq.jqmybatis.dao.UserMapper.insert", user);
            // 提交事务
            session.commit();
            System.out.println(user.getId()); // 7
            session.close();
        }
    
        @Test
        public void testDelete() throws Exception {
            //2. 打开数据库连接会话
            SqlSession session = MyBatisUtil.getSession();
            session.delete("cn.jq.jqmybatis.dao.UserMapper.delete", 5L);
            // 提交事务
            session.commit();
            session.close();
        }
    }

![20191014215253575.png][]

![20191014215415599.png][]

### 四、MyBatis 的全局配置文件 ###

MyBatis 的配置文件包含了会深深影响 MyBatis行为的设置(settings)和属性(properties)信息。配置有顺序要求，结构如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 3][]

**1、properties** ：主要作用是读取外面的properties属性文件

注意：了解一下即可，因为在项目和spring整合时，数据源是要交个spring管理的，所有肯定不会用这个配置的

**2、settings：详细参数见**[官方文档][Link 2]

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。下表描述了设置中各项的意图、默认值等。

<table> 
 <tbody> 
  <tr> 
   <td>mapUnderscoreToCamelCase</td> 
   <td style="width:476px;">是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。</td> 
   <td style="width:114px;">true | false</td> 
   <td>False</td> 
  </tr> 
 </tbody> 
</table>

**3、typeAliases**

类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关，存在的意义仅在于用来减少类完全限定名的冗余。

类型别名都不区分大小写

1）全局映射文件

2）sql映射文件

<mapper namespace="cn.jq.jqmybatis.dao.UserMapper">
    
    	<select id="getUser" resultType="uu"> 
    		select * from t_user where id = #{id}
    	</select>
    </mapper>

除了自定义别名外，系统也有常见的 Java 类型内建的相应的类型别名。基本类型别名为 其名前加\_   包装类型与集合别名 首字母变小写。比如：

![20191014224229588.png][]

注意：Mybatis已经为一些常见的 Java 类型内建的相应的类型别名。它们都是大小写不敏感的，我们的别名不能和它们重复

**4、配置环境（environments）**：

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者共享相同 Schema 的多个生产数据库， 想使用相同的 SQL 映射。许多类似的用例。

**       不过要记住：尽管可以配置多个环境，每个 SqlSessionFactory 实例只能选择其一**

环境元素**（environment）**定义了如何配置环境。

** 1）事务管理器（transactionManager）**

在 MyBatis 中有两种类型的事务管理器（也就是 type=”\[JDBC|MANAGED\]”）：

*  **JDBC**– 这个配置就是直接使用了 JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。
 *  MANAGED – 这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为。

**2）数据源（dataSource）**

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

*  许多 MyBatis 的应用程序会按示例中的例子来配置数据源。虽然这是可选的，但为了使用延迟加载，数据源是必须配置的。

有三种内建的数据源类型（也就是 type=”\[UNPOOLED|POOLED|JNDI\]”）：

**UNPOOLED**– 这个数据源的实现只是每次被请求时打开和关闭连接。虽然有点慢，但对于在数据库连接可用性方面没有太高要求的简单应用程序来说，是一个很好的选择。 不同的数据库在性能方面的表现也是不一样的，对于某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。

**POOLED**– 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这是一种使得并发 Web 应用快速响应请求的流行处理方式。

**JNDI** – 这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。

注意： 在项目和spring整合时，数据源是要交个spring管理的，比如c3p0

**5、映射器（mappers）：引入Mapper文件**

既然 MyBatis 的行为已经由上述元素配置完了，我们现在就要定义 SQL 映射语句了。但是首先我们需要告诉 MyBatis 到哪里去找到这些语句。 Java 在自动查找这方面没有提供一个很好的方法，所以最佳的方式是告诉 MyBatis 到哪里去找映射文件。你可以使用相对于类路径的资源引用， 或完全限定资源定位符（包括 file:/// 的 URL），或类名和包名等。

**1）使用相对于类路径的资源引用**

**2）使用映射器接口实现类的完全限定类名**

注意：使用class属性来讲mapper文件注入到全部配置文件里，就必须保证mapper的文件名和接口的文件名一样，只是后缀不一样，且必须都在一个包目录里才ok。

使用class属性来配置，还可以使用注解的方式来关联sql语句，不需要写UserDao.xml，只需要在接口的方法上使用注解@Select

public interface UserMapper {
    	@Select("select * from t_user where id = #{id}")
    	public User getUser(Integer id);
    }

在项目开发中，注解上的sql往往是比较简单的和不怎么会修改的，才会使用注解，因为打包发布后，java文件是不能修改的，比较复杂和重要的，可能会修改的sql语句，放到xml配置文件里，这样便于以后维护，两者配合使用。

** 3）将包内的映射器接口实现全部注册为映射器（推荐使用）**

注意：xml文件和接口必须同名，且在同一个包里才得行！或者接口和xml文件不在同一个包，必须新建一个资源文件夹，并在新建一个和接口类所在的包名，一样的包，xml文件和接口同名，把xml文件放这里，就可以搞定！视觉上号上不在一起，但发布后在classes这个类路径下看到还是在同一个包里的。

xml全局配置文件， 一般配置好之后，不会修改该文件。

### 五、Mapper接口方式 ###

在Mapper接口中定义操作方法

**1、Mapper组件包含：Mapper接口 和 Mapper文件**

1）Mapper文件和Mapper接口一般放在同一个包下

2）Mapper文件中的namespace一般设置Mapper接口的全限定名

3）Mapper文件中的操作元素的ID 对应 Mapper接口中的方法名称

**2、Mapper接口方式使用上面有用到，后面就用Mapper接口方式： 底层原理是 jdk动态代理**

// 3. CRUD操作
     /*       // Mapper接口方式： jdk动态代理，项目中普遍使用
            UserMapper userMapper = session.getMapper(UserMapper.class);
            // 调用查询一条记录的方法
            User user = userMapper.getUser(1L);
     */

更多参考文档

ends~

[github]: https://github.com/mybatis/mybatis-3
[Link 1]: http://www.mybatis.org/mybatis-3/zh/index.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70]: /images/20220418/f0443ceeed564b5eb1dbdbacbc7437cb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 1]: /images/20220418/3550df799cd44542bbbd17e496ccea07.png
[20191014211021932.png]: /images/20220418/7d0c045ec73141bea589f543fd521a86.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 2]: /images/20220418/7b10ccedc2fb42f5bda3ea5988d9e2c9.png
[20191014215253575.png]: /images/20220418/922411f0625840779870d37f2e8659f9.png
[20191014215415599.png]: /images/20220418/5ef13c92403e46fea91940a0475b4ddd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0_size_16_color_FFFFFF_t_70 3]: /images/20220418/512f818b13d1467fae96ce37bd13115d.png
[Link 2]: http://www.mybatis.org/mybatis-3/zh/configuration.html
[20191014224229588.png]: /images/20220418/8cde5877155e4ec5acf3589b3fe03c60.png