Mybatis-01

1. 框架

  1. 框架相当于是一个脚手架，内部已经写好了很多代码，我们只要其基础上进行开发就可以提高我们的开发效率。

框架阶段学习：

①先去学习如何使用框架

②然后再使用熟练的情况下去猜测内部的原理

③通过源码去验证自己的猜测。

2.Mybatis介绍

  • MyBatis 是一款优秀的持久层框架。
  • MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
  • 官网：https://mybatis.org/mybatis-3/zh/#

3. 快速入门

①数据准备

  1. CREATE DATABASE /*!32312 IF NOT EXISTS*/`mybatis_db` /*!40100 DEFAULT CHARACTER SET utf8 */;
  2. USE `mybatis_db`;
  3. DROP TABLE IF EXISTS `user`;
  4. CREATE TABLE `user` (
  5.   `id` int(11) NOT NULL AUTO_INCREMENT,
  6.   `username` varchar(50) DEFAULT NULL,
  7.   `age` int(11) DEFAULT NULL,
  8.   `address` varchar(50) DEFAULT NULL,
  9.   PRIMARY KEY (`id`)
  10. ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;
  11. insert  into `user`(`id`,`username`,`age`,`address`) values (1,'UZI',19,'上海'),(2,'PDD',25,'上海');

②导入依赖

  1.         <!--mybatis依赖-->
  2.         <dependency>
  3.             <groupId>org.mybatis</groupId>
  4.             <artifactId>mybatis</artifactId>
  5.             <version>3.5.4</version>
  6.         </dependency>
  7.         <!--mysql驱动-->
  8.         <dependency>
  9.             <groupId>mysql</groupId>
  10.             <artifactId>mysql-connector-java</artifactId>
  11.             <version>5.1.47</version>
  12.         </dependency>

③编写核心配置

在资源目录下创建：mybatis-config.xml 内容如下：

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE configuration
  3.         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-3-config.dtd">
  5. <configuration>
  6.     <environments default="development">
  7.         <environment id="development">
  8.             <transactionManager type="JDBC"/>
  9.             <dataSource type="POOLED">
  10.                 <property name="driver" value="com.mysql.jdbc.Driver"/>
  11.                 <property name="url" value="jdbc:mysql://localhost:3306/test"/>
  12.                 <property name="username" value="root"/>
  13.                 <property name="password" value="root"/>
  14.             </dataSource>
  15.         </environment>
  16.     </environments>
  17.     <mappers>
  18.         <mapper resource="com/sangeng/dao/UserDao.xml"/>
  19.     </mappers>
  20. </configuration>

④定义接口及对应的xml映射文件

com.sangeng.dao.UserDao:

  1. public interface UserDao {
  2.     List<User> findAll();
  3. }

资源目录下：com/sangeng/dao/UserDao.xml

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper
  3.         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  5. <mapper namespace="com.sangeng.dao.UserDao">
  7.     <select id="findAll" resultType="com.sangeng.pojo.User">
  8.       select * from user
  9.     </select>
  10. </mapper>

⑤编写测试类

获取SqlSession,通过SqlSession获取UserDao调用对应的方法

  1.     public static void main(String[] args) throws IOException {
  2.         //定义mybatis配置文件的路径
  3.         String resource = "mybatis-config.xml";
  4.         InputStream inputStream = Resources.getResourceAsStream(resource);
  5.         SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
  6.         //获取Sqlsession对象
  7.         SqlSession sqlSession = sqlSessionFactory.openSession();
  8.         //获取UserDao实现类对象
  9.         UserDao userDao = sqlSession.getMapper(UserDao.class);
  10.         //调用方法测试
  11.         List<User> userList = userDao.findAll();
  12.         System.out.println(userList);
  13.         //释放资源
  14.         sqlSession.close();
  15.     }

3.9 高效编程

3.9.1 配置代码模板

image-1.png

3.9.2 Mybatis插件

  1.     下载安装Free Mybatis plugin，安装完后重启IDEA

4. 参数获取

4.1 一个参数

4.1.1 基本参数

  1. 我们可以使用#{}直接来取值，写任意名字都可以获取到参数。但是一般用方法的参数名来取。

例如：

接口中方法定义如下

  1. User findById(Integer id);

xml中内容如下:

  1. <select id="findById" resultType="com.sangeng.pojo.User">  select * from user where id = #{id}</select>

4.1.2 POJO

  1. 我们可以使用POJO中的属性名来获取对应的值。

例如：

接口中方法定义如下

  1. User findByUser(User user);

xml中内容如下：

  1.     <select id="findByUser" resultType="com.sangeng.pojo.User">
  2.         select * from user where id = #{id} and username = #{username} and age = #{age} and address = #{address}
  3.     </select>

4.1.3 Map

  1. 我们可以使用map中的key来获取对应的值。

例如：

接口中方法定义如下

  1. User findByMap(Map map);

xml中内容如下：

  1.     <select id="findByMap" resultType="com.sangeng.pojo.User">
  2.         select * from user where id = #{id} and username = #{username} and age = #{age} and address = #{address}
  3.     </select>

方法调用：

  1.         Map map = new HashMap();
  2.         map.put("id",2);
  3.         map.put("username","PDD");
  4.         map.put("age",25);
  5.         map.put("address","上海");
  6.         userDao.findByMap(map);

4.2 多个参数

  1. Mybatis会把多个参数放入一个Map集合中，默认的key是argx和paramx这种格式。

例如：

接口中方法定义如下

  1. User findByCondition(Integer id,String username);

最终map中的键值对如下：

  1. {arg1=PDD, arg0=2, param1=2, param2=PDD}
  1. 我们虽然可以使用对应的默认key来获取值，但是这种方式可读性不好。我们一般在方法参数前使用@Param来设置参数名。

例如：

接口中方法定义

  1. User findByCondition(@Param("id") Integer id,@Param("username") String username);

最终map中的键值对如下：

  1. {id=2, param1=2, username=PDD, param2=PDD}

所以我们就可以使用如下方式来获取参数

  1.     <select id="findByCondition" resultType="com.sangeng.pojo.User">
  2.          select * from user where id = #{id} and username = #{username}
  3.     </select>

4.3 总结

  1. 建议如果只有一个参数的时候不用做什么特殊处理。如果是有多个参数的情况下一定要加上@Param来设置参数名。

5. 核心类

5.1 SqlSessionFactory

  1. SqlSessionFactory是一个SqlSession的工厂类。主要用来获取SqlSession对象。、

成员方法如下：

  1. SqlSession openSession();
  2. //获取SqlSession对象，传入的参数代表创建的SqlSession是否自动提交
  3. SqlSession openSession(boolean autoCommit);

5.2 SqlSession

  1.  SqlSession 提供了在数据库执行 SQL 命令所需的所有方法 。它还提供了事务的相关操作。

成员方法如下：

  1. T getMapper(Class<T> type);//获取mapper对象
  2. void commit();//提交事务
  3. void rollback();//回滚事务
  4. void close();//释放资源

6.Mybatis实现增删改查

6.1 新增

①接口中增加相关方法

  1. void insertUser(User user);

②映射文件UserDao.xml增加响应的标签

  1.     <insert id="insertUser">
  2.         insert into user values(null,#{username},#{age},#{address})
  3.     </insert>

注意：要记得提交事务。

6.2 删除

①接口中增加相关方法

  1. void deleteById(Integer id);

②映射文件UserDao.xml增加响应的标签

  1.     <delete id="deleteById">
  2.         delete from user where id = #{id}
  3.     </delete>

注意：要记得提交事务。

6.3 修改

①接口中增加相关方法

  1. void updateUser(User user);

②映射文件UserDao.xml增加响应的标签

  1.     <!--更新用户-->
  2.     <update id="updateUser">
  3.         UPDATE USER SET age = #{age} , username = #{username},address = #{address} WHERE id = #{id}
  4.     </update>

注意：要记得提交事务。

6.4 根据id查询

①接口中增加相关方法

  1. User findById(Integer id);

②映射文件UserDao.xml增加响应的标签

  1.    <select id="findById" resultType="com.sangeng.pojo.User">
  2.       select * from user where id = #{id}
  3.     </select>

6.5 查询所有

①接口中增加相关方法

  1. List<User> findAll();

②映射文件UserDao.xml增加响应的标签

  1.     <select id="findAll" resultType="com.sangeng.pojo.User">
  2.       select * from user
  3.     </select>

7. 配置文件详解

7.1 properties

  1. 可以使用properties读取properties配置文件。使用其中的resource属性来设置配置文件的路径。
  3. 然后使用${key}来获取配置文件中的值

例如：

在resources目录下有jdbc.properties文件，内容如下：

  1. jdbc.url=jdbc:mysql://localhost:3306/mybatis_db
  2. jdbc.driver=com.mysql.jdbc.Driver
  3. jdbc.username=root
  4. jdbc.password=root

在mybatis-config.xml中：

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE configuration
  3.         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-3-config.dtd">
  5. <configuration>
  6.     <!--设置配置文件所在的路径-->
  7.     <properties resource="jdbc.properties"></properties>
  8.     <environments default="development">
  9.         <environment id="development">
  10.             <transactionManager type="JDBC"/>
  11.             <dataSource type="POOLED">
  12.                 <!--获取配置文件中配置的对应的值来设置连接相关参数-->
  13.                 <property name="driver" value="${jdbc.driver}"/>
  14.                 <property name="url" value="${jdbc.url}"/>
  15.                 <property name="username" value="${jdbc.username}"/>
  16.                 <property name="password" value="${jdbc.password}"/>
  17.             </dataSource>
  18.         </environment>
  19.     </environments>
  20. </configuration>

7.2 settings

  1. 可以使用该标签来设置进行一些设置

例如：

  1.     <settings>
  2.         <!--开启自动驼峰命名映射-->
  3.         <setting name="mapUnderscoreToCamelCase" value="true"/>
  4.     </settings>

具体的设置参考：https://mybatis.org/mybatis-3/zh/configuration.html#settings

7.3 typeAliases

  1. 可以用来设置给全类名设置别名，简化书写。一般设置一个包下的类全部具有默认别名。默认别名是类目首字母小写。例如：com.sangeng.pojo.User别名为user
  1.    <typeAliases>
  2.         <package name="com.sangeng.dao"></package>
  3.     </typeAliases>

7.4 environments

  1. 配置数据库相关的环境，例如事物管理器，连接池相关参数等。
  1.     <!--设置默认环境-->
  2.     <environments default="development">
  4.         <!--设置该环境的唯一标识-->
  5.         <environment id="development">
  6.             <transactionManager type="JDBC"/>
  7.             <dataSource type="POOLED">
  8.                 <!--获取配置文件中配置的对应的值来设置连接相关参数-->
  9.                 <property name="driver" value="${jdbc.driver}"/>
  10.                 <property name="url" value="${jdbc.url}"/>
  11.                 <property name="username" value="${jdbc.username}"/>
  12.                 <property name="password" value="${jdbc.password}"/>
  13.             </dataSource>
  14.         </environment>
  15.     </environments>

7.5 mappers

  1. 该标签的作用是加载映射的，加载方式有如下几种(**主要使用第四种**)：
  3. ①使用相对于类路径的资源引用，例如：
  1. <!-- 使用相对于类路径的资源引用 -->
  2. <mappers>
  3.   <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  4.   <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  5.   <mapper resource="org/mybatis/builder/PostMapper.xml"/>
  6. </mappers>
  1. ②使用完全限定资源定位符（URL），例如：
  1. <!-- 使用完全限定资源定位符（URL） -->
  2. <mappers>
  3.   <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  4.   <mapper url="file:///var/mappers/BlogMapper.xml"/>
  5.   <mapper url="file:///var/mappers/PostMapper.xml"/>
  6. </mappers>
  1. ③使用映射器接口实现类的完全限定类名，例如：
  1. <!-- 使用映射器接口实现类的完全限定类名 -->
  2. <mappers>
  3.   <mapper class="org.mybatis.builder.AuthorMapper"/>
  4.   <mapper class="org.mybatis.builder.BlogMapper"/>
  5.   <mapper class="org.mybatis.builder.PostMapper"/>
  6. </mappers>
  1. ④将包内的映射器接口实现全部注册为映射器，例如：
  1. <!-- 定义dao接口所在的包。要求xml文件存放的路径和dao接口的包名要对应 -->
  2. <mappers>
  3.   <package name="org.mybatis.builder"/>
  4. </mappers>

8. 打印日志

①log4j配置 在resources目录下创建log4j.properties文件，内容如下：

  1. ### direct log messages to stdout ###
  2. log4j.appender.stdout=org.apache.log4j.ConsoleAppender
  3. log4j.appender.stdout.Target=System.out
  4. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
  5. log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
  7. ### direct messages to file mylog.log ###
  8. log4j.appender.file=org.apache.log4j.FileAppender
  9. log4j.appender.file.File=c:/mylog.log
  10. log4j.appender.file.layout=org.apache.log4j.PatternLayout
  11. log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
  13. ### set log levels - for more verbose logging change 'info' to 'debug' ###
  15. log4j.rootLogger=debug, stdout

②引入依赖

  1.         <dependency>
  2.             <groupId>log4j</groupId>
  3.             <artifactId>log4j</artifactId>
  4.             <version>1.2.17</version>
  5.         </dependency>

9.获取参数时 #{}和${}的区别

  1. 如果使用#{}.他是预编译的sql可以防止SQL注入攻击<br />    如果使用${}他是直接把参数值拿来进行拼接，这样会有SQL注入的危险

如果使用的是#{}来获取参数值日志如下：
Preparing: select from user where id = ? and username = ? and age = ? and address = *?
Parameters: 2(Integer), 快乐风男(String), 29(Integer), 北京(String)

如果使用${}来获取参数值日志如下：
Preparing: select * from user where id = 2 and username = 快乐风男 and age = 29 and address = 北京