MyBatis入门指南：从零搭建第一个CRUD程序

<｜begin▁of▁sentence｜># 1. 概述 ## 1.1. 什么是MyBatis - MyBatis 是一款优秀的**持久层框架** - 它支持自定义 SQL、存储过程以及高级映射 - MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作 - MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录 ## 1.2. 持久化 数据持久化 - 持久化就是将程序的数据在持久状态和瞬时状态转化的过程 - 内存：**断电即失** - 数据库(Jdbc)，io文件持久化。 **为什么需要持久化？** - 有一些对象，不能让他丢掉。 - 内存太贵了 ## 1.3. 持久层 Dao层，Service层，Controller层…. - 完成持久化工作的代码块 - 层界限十分明显。 ## 1.4. 为什么需要Mybatis - 帮助程序猿将数据存入到数据库中。 - 方便 - 传统的JDBC代码太复杂了。简化。框架。自动化。 - 不用Mybatis也可以。更容易上手。 **技术没有高低之分** - 优点： - 简单易学 - 灵活 - sql和代码的分离，提高了可维护性。 - 提供映射标签，支持对象与数据库的orm字段关系映射 - 提供对象关系映射标签，支持对象关系组建维护 - 提供xml标签，支持编写动态sql。 # 2. 第一个Mybatis程序 思路：搭建环境–>导入Mybatis–>编写代码–>测试！ ## 2.1. 搭建环境 搭建数据库 ```sql CREATE DATABASE `mybatis`; USE `mybatis`; CREATE TABLE `user`( `id` INT(20) NOT NULL PRIMARY KEY, `name` VARCHAR(30) DEFAULT NULL, `pwd` VARCHAR(30) DEFAULT NULL )ENGINE=INNODB DEFAULT CHARSET=utf8; INSERT INTO `user`(`id`,`name`,`pwd`) VALUES (1,'狂神','123456'), (2,'张三','abcdef'), (3,'李四','987654') ``` 新建项目 1. 新建一个普通的maven项目 2. 删除src目录 3. 导入maven依赖 ```xml mysql mysql-connector-java 5.1.47 org.mybatis mybatis 3.5.2 junit junit 4.12 ``` ## 2.2. 创建一个模块 - 编写mybatis的核心配置文件 ```xml ``` - 编写mybatis工具类 ```java //sqlSessionFactory --> sqlSession public class MybatisUtils { private static SqlSessionFactory sqlSessionFactory; static{ try { //使用Mybatis第一步：获取sqlSessionFactory对象 String resource = "mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); } catch (IOException e) { e.printStackTrace(); } } //既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。 // SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。 public static SqlSession getSqlSession(){ return sqlSessionFactory.openSession(); } } ``` ## 2.3. 编写代码 - 实体类 ```java public class User { private int id; private String name; private String pwd; public User() { } public User(int id, String name, String pwd) { this.id = id; this.name = name; this.pwd = pwd; } 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 String getPwd() { return pwd; } public void setPwd(String pwd) { this.pwd = pwd; } @Override public String toString() { return "User{" + "id=" + id + ", name='" + name + '\'' + ", pwd='" + pwd + '\'' + '}'; } } ``` - Dao接口 ```java public interface UserDao { List getUserList(); } ``` - 接口实现类由原来的UserDaoImpl转变为一个 Mapper配置文件. ```xml select * from mybatis.user ``` ## 2.4. 测试 注意点： org.apache.ibatis.binding.BindingException: Type interface com.kuang.dao.UserDao is not known to the MapperRegistry. **MapperRegistry是什么？** 核心配置文件中注册 mappers - junit测试 ```java @Test public void test(){ //第一步：获得SqlSession对象 SqlSession sqlSession = MybatisUtils.getSqlSession(); //方式一：getMapper UserDao userDao = sqlSession.getMapper(UserDao.class); List userList = userDao.getUserList(); for (User user : userList) { System.out.println(user); } //关闭SqlSession sqlSession.close(); } ``` 可能会遇到的问题： 1. 配置文件没有注册 2. 绑定接口错误。 3. 方法名不对 4. 返回类型不对 5. Maven导出资源问题 # 3. CRUD ## 3.1. namespace namespace中的包名要和 Dao/mapper 接口的包名一致！ ## 3.2. select 选择，查询语句; - id : 就是对应的namespace中的方法名； - resultType：Sql语句执行的返回值！ - parameterType ： 参数类型！ 1. 编写接口 ```java //根据ID查询用户 User getUserById(int id); ``` 1. 编写对应的mapper中的sql语句 ```xml select * from mybatis.user where id = #{id} ``` 1. 测试 ```java @Test public void getUserById() { SqlSession sqlSession = MybatisUtils.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); User user = mapper.getUserById(1); System.out.println(user); sqlSession.close(); } ``` ## 3.3. Insert ```xml insert into mybatis.user (id, name, pwd) values (#{id},#{name},#{pwd}); ``` ## 3.4. Update ```xml update mybatis.user set name=#{name},pwd=#{pwd} where id = #{id}; ``` ## 3.5. Delete ```xml delete from mybatis.user where id = #{id}; ``` 注意点： - 增删改需要提交事务！ ## 3.6. 分析错误 - 标签不要匹配错 - resource 绑定mapper，需要使用路径！ - 程序配置文件必须符合规范！ - NullPointerException，没有注册到资源! - 输出的xml文件中存在中文乱码问题！ - maven资源没有导出问题！ ## 3.7. 万能Map 假设，我们的实体类，或者数据库中的表，字段或者参数过多，我们应当考虑使用Map！ ```java //万能的Map int addUser2(Map map); ``` ```xml insert into mybatis.user (id, pwd) values (#{userid},#{passWord}); ``` ```java @Test public void addUser2(){ SqlSession sqlSession = MybatisUtils.getSqlSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); Map map = new HashMap(); map.put("userid",5); map.put("passWord","2222333"); mapper.addUser2(map); sqlSession.commit(); sqlSession.close(); } ``` Map传递参数，直接在sql中取出key即可！ 【parameterType=“map”】 对象传递参数，直接在sql中取对象的属性即可！【parameterType=“Object”】 只有一个基本类型参数的情况下，可以直接在sql中取到！ 多个参数用Map，**或者注解！** ## 3.8. 思考题 模糊查询怎么写？ 1. Java代码执行的时候，传递通配符 % % ```java List userList = mapper.getUserLike("%李%"); ``` 1. 在sql拼接中使用通配符！ ```sql select * from mybatis.user where name like "%"#{value}"%" ``` # 4. 配置解析 ## 4.1. 核心配置文件 - mybatis-config.xml - MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。 ```xml configuration（配置） properties（属性） settings（设置） typeAliases（类型别名） typeHandlers（类型处理器） objectFactory（对象工厂） plugins（插件） environments（环境配置） environment（环境变量） transactionManager（事务管理器） dataSource（数据源） databaseIdProvider（数据库厂商标识） mappers（映射器） ``` ## 4.2. 环境配置（environments） MyBatis 可以配置成适应多种环境 **不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。** 学会使用配置多套运行环境！ Mybatis默认的事务管理器就是 JDBC ， 连接池 ： POOLED ## 4.3. 属性（properties） 我们可以通过properties属性来实现引用配置文件 这些属性都是可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，亦可通过 properties 元素的子元素来传递。【db.properties】 编写一个配置文件 db.properties ```properties driver=com.mysql.jdbc.Driver url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8 username=root password=123456 ``` 在核心配置文件中引入 ```xml ``` - 可以直接引入外部文件 - 可以在其中增加一些属性配置 - 如果两个文件有同一个字段，优先使用外部配置文件的！ ## 4.4. 类型别名（typeAliases） - 类型别名是为 Java 类型设置一个短的名字。‘ - 存在的意义仅在于用来减少类完全限定名的冗余。 ```xml ``` 也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如： 扫描实体类的包，它的默认别名就为这个类的 类名，首字母小写！ ```xml ``` 在实体类比较少的时候，使用第一种方式。 如果实体类十分多，建议使用第二种。 第一种可以DIY别名，第二种则·不行·，如果非要改，需要在实体上增加注解 ```java @Alias("user") public class User {} ``` ## 4.5. 设置 这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。  ## 4.6. 其他配置 - [typeHandlers（类型处理器）](https://mybatis.org/mybatis-3/zh/configuration.#typeHandlers) - [objectFactory（对象工厂）](https://mybatis.org/mybatis-3/zh/configuration.#objectFactory) - plugins插件 - mybatis-generator-core - mybatis-plus - 通用mapper ## 4.7. 映射器（mappers） MapperRegistry：注册绑定我们的Mapper文件； 方式一： 【推荐使用】 ```xml ``` 方式二：使用class文件绑定注册 ```xml ``` 注意点： - 接口和他的Mapper配置文件必须同名！ - 接口和他的Mapper配置文件必须在同一个包下！ 方式三：使用扫描包进行注入绑定 ```xml ``` 注意点： - 接口和他的Mapper配置文件必须同名！ - 接口和他的Mapper配置文件必须在同一个包下！ 练习时间： - 将数据库配置文件外部引入 - 实体类别名 - 保证UserMapper 接口 和 UserMapper.xml 改为一致！并且放在同一个包下！ ## 4.8. 生命周期和作用域 生命周期，和作用域，是至关重要的，因为错误的使用会导致非常严重的**并发问题**。 **SqlSessionFactoryBuilder：** - 一旦创建了 SqlSessionFactory，就不再需要它了 - 局部变量 **SqlSessionFactory：** - 说白了就是可以想象为 ：数据库连接池 - SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，**没有任何理由丢弃它或重新创建另一个实例。** - 因此 SqlSessionFactory 的最佳作用域是应用作用域。 - 最简单的就是使用**单例模式**或者静态单例模式。 **SqlSession：** - 连接到连接池的一个请求！ - SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 - 用完之后需要赶紧关闭，否则资源被占用！  这里面的每一个Mapper，就代表一个具体的业务！ # 5. 解决属性名和字段名不一致的问题 ## 5.1. 问题 数据库中的字段  新建一个项目，拷贝之前的，测试实体类字段不一致的情况 ```java public class User { private int id; private String name; private String password; } ``` 测试出现问题  ```xml // select * from mybatis.user where id = #{id} //类型处理器 // select id,name,pwd from mybatis.user where id = #{id} ``` 解决方法： - 起别名 ```xml select id,name,pwd as password from mybatis.user where id = #{id} ``` ## 5.2. resultMap 结果集映射 ``` id name pwd id name password ``` ```xml select * from mybatis.user where id = #{id} ``` - `resultMap` 元素是 MyBatis 中最重要最强大的元素 - ResultMap 的设计思想是，对于简单的语句根本不需要配置显式的结果映射，而对于复杂一点的语句只需要描述它们的关系就行了。 - `ResultMap` 最优秀的地方在于，虽然你已经对它相当了解了，但是根本就不需要显式地用到他们。 # 6. 日志 ## 6.