Mybatis-01

Mybatis-01

Mybatis介绍

  • MyBatis 是一款优秀的持久层框架。

  • MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。

  • 官网：https://mybatis.org/mybatis-3/zh/#

快速入门

①数据准备

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

②导入依赖

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

③编写核心配置

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?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.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/test"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/sinarcsinx/dao/UserDao.xml"/>
    </mappers>
</configuration>

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

com.sinarcsinx.dao.UserDao:

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

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

1
2
3
4
5
6
7
8
9
10
<?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.sinarcsinx.dao.UserDao">

    <select id="findAll" resultType="com.sinarcsinx.pojo.User">
      select * from user
    </select>
</mapper>

⑤编写测试类

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

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

参数获取

一个参数

基本参数

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

例如：接口中方法定义如下

1
User findById(Integer id);

xml中内容如下:

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

POJO

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

例如：接口中方法定义如下

1
User findByUser(User user);

xml中内容如下：

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

Map

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

例如：接口中方法定义如下

1
User findByMap(Map map);

xml中内容如下：

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

方法调用：

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

多个参数

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

例如：接口中方法定义如下

1
User findByCondition(Integer id,String username);

最终map中的键值对如下：

1
{arg1=PDD, arg0=2, param1=2, param2=PDD}

我们虽然可以使用对应的默认key来获取值，但是这种方式可读性不好，我们一般在方法参数前使用@Param来设置参数名

例如：接口中方法定义

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

最终map中的键值对如下：

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

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

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

总结

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

核心类

SqlSessionFactory

SqlSessionFactory是一个SqlSession的工厂类，主要用来获取SqlSession对象

成员方法如下：

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

SqlSession

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

成员方法如下：

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

Mybatis实现增删改查

新增

①接口中增加相关方法

1
void insertUser(User user);

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

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

注意：要记得提交事务。

删除

①接口中增加相关方法

1
void deleteById(Integer id);

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

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

注意：要记得提交事务。

修改

①接口中增加相关方法

1
void updateUser(User user);

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

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

注意：要记得提交事务。

根据id查询

①接口中增加相关方法

1
User findById(Integer id);

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

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

查询所有

①接口中增加相关方法

1
List<User> findAll();

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

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

配置文件详解

properties

可以使用properties读取properties配置文件，使用其中的resource属性来设置配置文件的路径

然后使用${key}来获取配置文件中的值

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

1
2
3
4
jdbc.url=jdbc:mysql://localhost:3306/mybatis_db
jdbc.driver=com.mysql.cj.jdbc.Driver?characterEncoding=utf-8&serverTimezone=UTC
jdbc.username=root
jdbc.password=123456

在mybatis-config.xml中：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?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="jdbc.properties"></properties>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!--获取配置文件中配置的对应的值来设置连接相关参数-->
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

settings

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

例如：

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

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

typeAliases

可以用来设置给全类名设置别名，简化书写

一般设置一个包下的类全部具有默认别名，默认别名是类目首字母小写，例如：com.sinarcsinx.pojo.User别名为user

1
2
3
<typeAliases>
    <package name="com.sinarcsinx.dao"></package>
</typeAliases>

environments

配置数据库相关的环境，例如事物管理器，连接池相关参数等

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<!--设置默认环境-->
<environments default="development">

    <!--设置该环境的唯一标识-->
    <environment id="development">
        <transactionManager type="JDBC"/>
        <dataSource type="POOLED">
            <!--获取配置文件中配置的对应的值来设置连接相关参数-->
            <property name="driver" value="${jdbc.driver}"/>
            <property name="url" value="${jdbc.url}"/>
            <property name="username" value="${jdbc.username}"/>
            <property name="password" value="${jdbc.password}"/>
        </dataSource>
    </environment>
</environments>

mappers

该标签的作用是加载映射的，加载方式有如下几种(主要使用第四种)：

①使用相对于类路径的资源引用，例如：

1
2
3
4
5
6
<!-- 使用相对于类路径的资源引用 -->
<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
  <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
  <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

②使用完全限定资源定位符（URL），例如：

1
2
3
4
5
6
<!-- 使用完全限定资源定位符（URL） -->
<mappers>
  <mapper url="file:///var/mappers/AuthorMapper.xml"/>
  <mapper url="file:///var/mappers/BlogMapper.xml"/>
  <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

③使用映射器接口实现类的完全限定类名，例如：

1
2
3
4
5
6
<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
  <mapper class="org.mybatis.builder.BlogMapper"/>
  <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

④将包内的映射器接口实现全部注册为映射器，例如：

1
2
3
4
<!-- 定义dao接口所在的包。要求xml文件存放的路径和dao接口的包名要对应 -->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>

​

打印日志

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
### direct log messages to stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### direct messages to file mylog.log ###
log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.File=c:/mylog.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

### set log levels - for more verbose logging change 'info' to 'debug' ###

log4j.rootLogger=debug, stdout

②引入依赖

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

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

如果使用#{}.他是预编译的sql可以防止SQL注入攻击
如果使用${}他是直接把参数值拿来进行拼接，这样会有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 = 北京