目录

• 一、MyBatis的CRUD操作
• 二、MyBatis拓展
  • 1、别名配置处理
    • 1.2、自定义别名
    • 1.3、系统自带的别名
  • 2、属性配置处理
  • 3、查询结果映射
    • 3.1、使用给字段起别名的方式
    • 3.2、resultMap元素
  • 4、Mapper组件
    • 4.1、Mapper接口
  • 5、参数处理
  • 6、# 和 $ 的区别
• 三、MyBatis使用注解开发
  • Insert注解
  • Delete注解
  • Update注解
  • Select注解

MyBatis文档

一、MyBatis的CRUD操作

跳转到目录

• 编写接口

public interface UserMapper {// 查询所有用户List<User> getUserList();// 根据id来查询用户User getUser(int id);// 根据id来更新用户信息int updateUser(User user);// 插入一条用户信息int insertUser(User user);// 根据id来删除用户int deleteUser(int id);
}

• 编写mybatis映射文件/Mapper文件

select元素: 专门用来做查询的SQL
-id属性: 唯一标识,用来标识某一条SQL语句
-parameterType属性: 表示执行该SQL语句需要的参数的类型(建议不写),MyBatis可以自行推断出来
-resultType属性: 把结果集中每一行数据封装成什么类型的对象

insert元素:
获取自动增长的主键
useGeneratedKeys属性: 是否需要返回自动生成的主键
keyProperty: 把自动生成的主键值设置到对象的哪一个属性上

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--命名空间,类似包的概念: namespace:绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.sunny.dao.UserMapper"><!--select元素: 专门用来做查询的SQL-id属性: 唯一标识,用来标识某一条SQL语句-parameterType属性: 表示执行该SQL语句需要的参数的类型(建议不写),MyBatis可以自行推断出来-resultType属性: 把结果集中每一行数据封装成什么类型的对象--><select id="getUserList" resultType="com.sunny.domain.User">SELECT * FROM user;</select><!-- #{id} 相当于在测试方法中selectOne传递过来的值 --><select id="getUser" parameterType="int" resultType="com.sunny.domain.User">SELECT * FROM user WHERE id = #{id};</select><update id="updateUser" parameterType="com.sunny.domain.User">UPDATE user SET name = #{name}, pwd = #{pwd} WHERE id = #{id};</update><!--这里的parameterType可以不写insert元素:获取自动增长的主键useGeneratedKeys属性: 是否需要返回自动生成的主键keyProperty: 把自动生成的主键值设置到对象的哪一个属性上--><insert id="insertUser" parameterType="com.sunny.domain.User" useGeneratedKeys="true" keyProperty="id">INSERT INTO user (id, name, pwd) VALUES (null , #{name}, #{pwd});</insert><delete id="deleteUser" parameterType="int">DELETE FROM user WHERE id = #{id};</delete></mapper>

• UserMapperTest

public class UserMapperTest {/*** 自定义日志操作*/private static Logger logger = Logger.getLogger(UserMapperTest.class);@Testpublic void testLogger() throws Exception {// 如果日志输出级别为INFO,则输出if (logger.isInfoEnabled()) {logger.info("银行转账操作");}if (logger.isDebugEnabled()) {logger.debug("查询数据库");}if (logger.isTraceEnabled()) {logger.trace("连接数据库");}if (logger.isTraceEnabled()) {logger.trace("执行SQL");}if (logger.isDebugEnabled()) {logger.debug("转账");}if (logger.isInfoEnabled()) {logger.info("银行转账成功");}}/*** 查询所有用户** @throws IOException*/@Testpublic void testQueryUserList() throws IOException {//1. 获得sqlSession对象// SqlSession sqlSession = MybatisUtils.getSqlSession();//1. 从classpath路径去加载MyBatis全局配置文件:mybatis-config.xmlInputStream in = Resources.getResourceAsStream("mybatis-config.xml");//2. 创建sqlSessionFactory对象,好比是DataSourceSqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);//3. 创建sqlSession对象,好比是ConnectionSqlSession sqlSession = factory.openSession();//4. 具体操作// 执行SQL(方式一)/*执行SQL: UserMapper.xml中的namespace:绑定一个对应的Dao/Mapper接口相当于UserMapper接口的实现类,这里用UserMapper.class,就是面向接口编程,相当于获取UserMapper的实现类,然后通过实现类来调用接口方法*/UserMapper userMapper = sqlSession.getMapper(UserMapper.class);List<User> userList = userMapper.getUserList();// 方式二
//         List<User> userList = sqlSession.selectList("com.sunny.dao.UserDao.getUserList");for (User user : userList) {System.out.println(user);}// 关闭sqlSessionsqlSession.close();}/*** 查询id为1的用户** @throws IOException*/@Testpublic void testQueryOneUser() throws IOException {// 加载全局配置文件InputStream in = Resources.getResourceAsStream("mybatis-config.xml");// 构建sqlSessionFactory工厂类对象SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);// 根据sqlSession类对象来创建SqlSession对象SqlSession sqlSession = factory.openSession();// sqlSession相当于Connection,来执行SQL语句//User user = sqlSession.selectOne("com.sunny.dao.UserMapper.getUser", 1L);UserMapper mapper = sqlSession.getMapper(UserMapper.class);User user = mapper.getUser(1);System.out.println(user);sqlSession.close();}/*** 修改一条语句的内容** @throws Exception*/@Testpublic void testUpdateUser() throws Exception {User user = new User();user.setId(4);user.setName("土土土雅");user.setPwd("10004");// 获取SqlSession对象SqlSession sqlSession = MybatisUtils.getSqlSession();// 方式一UserMapper mapper = sqlSession.getMapper(UserMapper.class);int update = mapper.updateUser(user);// 方式二(以前的,不推荐写)// int update = sqlSession.update("com.sunny.dao.UserMapper.update",user);if (update > 0) {System.out.println("成功修改了:" + update + " 条语句!");}// 增删改必须提交事务sqlSession.commit();// 关闭资源sqlSession.close();}/*** 插入一条数据* @throws Exception*/@Testpublic void testInsertUser() throws Exception {// 获取sqlSession对象SqlSession sqlSession = MybatisUtils.getSqlSession();/*执行SQL: UserMapper.xml中的namespace:绑定一个对应的Dao/Mapper接口相当于UserMapper接口的实现类,这里用UserMapper.class,就是面向接口编程,相当于获取UserMapper的实现类,然后通过实现类来调用接口方法*/UserMapper mapper = sqlSession.getMapper(UserMapper.class);User u = new User("coder", "10007");int count = mapper.insertUser(u);if (count > 0){System.out.println("插入成功!");}// 提交事务sqlSession.commit();// 关闭资源sqlSession.close();System.out.println(u);}/*** 根据id来删除用户* @throws Exception*/@Testpublic void testDeleteUser() throws Exception{// 加载mybatis全局配置文件InputStream in = Resources.getResourceAsStream("mybatis-config.xml");// 构建SqlSessionFactory工厂对象SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);// 根据工厂对象来创建SqlSession对象SqlSession sqlSession = factory.openSession();// 根据sqlSession对象来获取mapperUserMapper mapper = sqlSession.getMapper(UserMapper.class);// 通过mapper来调用接口方法int count = mapper.deleteUser(5);if (count > 0){System.out.println("删除成功");}// 提交事务sqlSession.commit();// 关闭资源sqlSession.close();}
}

二、MyBatis拓展

跳转到目录

1、别名配置处理

跳转到目录

• Mapper.xml中的查询操作

    <select id="getUserList" resultType="com.sunny.domain.User">SELECT * FROM user;</select><!-- #{id} 相当于在测试方法中selectOne传递过来的值 --><select id="getUser" resultType="com.sunny.domain.User">SELECT * FROM user WHERE id = #{id};</select>

注意: 当写resultType结果类型时,都使用全限定类名com.sunny.domain.User,很麻烦,可以使用类型别名

使用别名(typeAlias)是一个类全限定名太长,不方便.MyBatis中别名不区分大小写

1.2、 自定义别名

跳转到目录

• 在全局配置文件mybatis-config.xml中定义别名

1. 直接给某一个类起别名

   <typeAlias type="com.sunny.domain.User" alias="User" />
   

2. 给一个包(包含子包)中所有的类起别名

   <package name="com.sunny.domain"/>
   

   一般写到domain包就可以了,自动为该包中的类名起别名,默认的别名就是类名首字母小写(不区分大小写)
3. @Alias注解可以用于设置类的别名(优先级最高)

    <!--类型别名--><!--在实体类比较少的时候，使用第一种方式。如果实体类十分多，建议使用第二种方式。--><typeAliases><!--<typeAlias type="com.sunny.domain.User" alias="User" />--><!--一般写到domain包就可以了,自动为该包中的类名起别名,默认的别名就是类名首字母小写(不区分大小写)--><package name="com.sunny.domain"/></typeAliases>

前两种设置别名的使用:

• 在实体类比较少的时候，使用第一种方式。

• 如果实体类十分多，建议使用第二种方式。

• Mapper.xml中的查询操作(使用别名)

    <select id="getUserList" resultType="com.sunny.domain.User">SELECT * FROM user;</select><!-- #{id} 相当于在测试方法中selectOne传递过来的值 --><select id="getUser" resultType="com.sunny.domain.User">SELECT * FROM user WHERE id = #{id};</select>

注意: 在全局配置文件中＜configuration＞标签中属性设置,日志设置,别名设置.都有严格的顺序,不能打乱.

eg:

• UserMapper.java

public interface UserMapper {// 只查询User表的id和name列List<User> queryUserByIdAndName();List<Map<Integer, Object>> queryUserByIdAndName2();
}

• UserMapperTest

public class UserMapperTest {/*** 只查询User表中的id和name列* @throws Exception*/@Testpublic void testQueryUserByIdAndName(){/*这种方式来查询User表中的部分列,其他列会显示null,可以将*//*SqlSession sqlSession = MybatisUtils.getSqlSession();UserMapper mapper = sqlSession.getMapper(UserMapper.class);List<User> users = mapper.queryUserByIdAndName();for (User user : users) {System.out.println(user);}*/SqlSession sqlSession = MybatisUtils.getSqlSession();UserMapper mapper = sqlSession.getMapper(UserMapper.class);List<Map<Integer, Object>> maps = mapper.queryUserByIdAndName2();for (Map<Integer, Object> map : maps) {System.out.println(map);}}
}

• UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--命名空间,类似包的概念: namespace:绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.sunny.dao.UserMapper"><!--只查询user表的id和name列-->
<!--    <select id="queryUserByIdAndName" resultType="User">-->
<!--        SELECT id,name FROM user;-->
<!--    </select>--><select id="queryUserByIdAndName2" resultType="map">SELECT id, name FROM user;</select></mapper>

1.3、 系统自带的别名

跳转到目录

一般用于接口方法返回值类型, 当接口方法返回为为int时, 可以在Mapper.xml文件中ResultType设置为int(默认), _int(别名),对大小写不敏感.

2、 属性配置处理

跳转到目录

property元素

• 修改mybatis-config.xml文件,新增

    <!--属性配置--><properties><property name="driver" value="com.mysql.jdbc.Driver"/><property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/><property name="username" value="root"/><property name="password" value="1111"/></properties>

• 数据库配置中,使用$表达式获取属性值

<!--连接池--><dataSource type="POOLED"><property name="driver" value="${driver}"/><property name="url" value="${url}"/><property name="username" value="${username}"/><property name="password" value="${password}"/></dataSource>

db.properties文件

• 新增db.properties文件:

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8
username=root
password=1111

• 修改mybatis-config.xml文件:

<!--属性配置--><properties resource="db.properties"/>

3、 查询结果映射

跳转到目录

• 在CRUD中查询方法直接通过设置别名的方式 resultType="User"来设置MyBatis把结果集中的每一行数据包装为User对象,此时必须要求数据表中的列名和对象的属性名一一对应.
  如果表中的列名和对象属性名不匹配,此时的解决方案是?

3.1、 使用给字段起别名的方式

跳转到目录

• 将关系表中的列名设置和对象中属性同名

  <select id="queryUserList" resultMap="BaseResultMap">SELECT u_id AS id, u_name AS name, u_pwd AS pwd FROM user1;
  </select>
  

3.2、 resultMap元素

跳转到目录

• 待解决问题: 结果集(表)中的列名和对象中的属性名称不匹配
• 解决方案: 使用resultMap元素

resultMap元素: 结果集对象的映射id属性: 当前Mapper文件中resultMap的唯一名称type属性: 把结果集中的每一行数据封装成什么类型的对象子元素:id元素: 功能和result一样,如果是主键,建议使用id元素,提升性能result元素: 匹配对象中的哪一个属性对应表中的哪一个列

<!--命名空间,类似包的概念: namespace:绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.sunny.dao.UserMapper"><!--查询一共有多少用户--><select id="queryUserCount" resultType="int">SELECT COUNT(id) FROM user1;</select><resultMap id="BaseResultMap" type="User"><result column="u_id" property="id" /><result column="u_name" property="name" /><result column="u_pwd" property="pwd" /></resultMap><select id="queryUserList" resultMap="BaseResultMap">select u_id, u_name, u_pwd from user1;</select></mapper>

4、 Mapper组件

跳转到目录

• Mapper组件: Mapper接口 + Mapper文件

下面有两种方式通过sqlSession来获取SQL并执行,下面说说两种方式的优缺点:

    /*** 查询id为1的用户** @throws IOException*/@Testpublic void testQueryOneUser(){SqlSession sqlSession = MybatisUtils.getSqlSession();// 使用方式一: 来找到SQL并执行//User user = sqlSession.selectOne("com.sunny.dao.UserMapper.getUser", 1L);// 使用方式二: 来找到SQL并执行UserMapper mapper = sqlSession.getMapper(UserMapper.class);// 实际上底层调用的还是sqlSession的方法,注意:sqlSession调用CRUD方法只能传递一个参数User user = mapper.getUser(1);System.out.println(user);sqlSession.close();}

• 使用namespace.id(方式一)的方式去找到SQL元素的方式，会有几个问题:

1. namespace.id使用的是String类型,一旦编写错误,只有等到运行代码才能报错。
2. 传入的实际参数类型不能被检查。
3. 每一个操作的代码模板类似。

这种方式相对于方式二,我觉得唯一的优点就是在接口中不需要定义接口方法,直接和映射文件关联起来了.

解决方案: 使用Mapper接口,类似DAO接口,在Mapper接口中定义每一个操作方法.(上面已经使用过,这里总结一下)

4.1、 Mapper接口

跳转到目录

使用Mapper组件:

1. 创建一个Mapper接口(类似于DAO接口) , 接口的要求:
   ①这个接口的全限定名称对应着 Mapper文件的namespace ;
   ②这个接口中的方法和Mapper文件中的SQL元素一一对应 ;

    方法的名字对应SQL元素的id ;方法的参数类型对应SQL元素中定义的paramterType类型( -般不写) ;方法的返回类型对应SQL元素中定义的resultType/resultMap类型; 
   

2. 创建SqlSession ;

3. 通过SqlSession.getMapper(XxxMapper.class)方法得到一个Mapper对象;

4. 调用Mapper对象上的方法完成对象的CURD ;

5、 参数处理

跳转到目录
注意: 在SqlSession中的CRUD方法最多只能传递一个惨. 即使上面的方式二,底层仍是使用SqlSession来调用CRUD方法,如何来解决CRUD方法中只能传递一个参数呢?

方式一: 将参数封装到一个JavaBean中,将JavaBean对象作为参数传递

方式二: 使用Map来封装参数_键值对的方式

方式三: 使用注解 @Param
Param注解中的字符串就是Map中的key

• ClientMapper.java

public interface ClientMapper {// 方式一: 把多个参数封装成JavaBeanClient login1(LoginVO vo);// 方式二: 使用Map对象封装多个参数Client login2(Map<String, Object> paramMap);// 方式三: 使用Param注解, 原理是方式二. Param注解中的字符串就是Map中的keyClient login3(@Param("username") String username, @Param("password") String password);
}

• ClientMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--命名空间,类似包的概念: namespace:绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.sunny.dao.ClientMapper"><select id="login1" parameterType="LoginVo" resultType="Client">SELECT id, username, password FROM client WHERE username = #{username} AND password = #{password};</select><select id="login2" parameterType="map" resultType="Client">SELECT id, username, password FROM client WHERE username = #{username} AND password = #{password};</select><select id="login3" resultType="Client">SELECT id, username, password FROM client WHERE username = #{username} AND password = #{password};</select></mapper>

• ClientMapperTest.java

public class ClientMapperTest {/*** 方式一: 使用JavaBean来封装*/@Testpublic void testLogin1(){LoginVO vo = new LoginVO("zy", "1111");SqlSession sqlSession = MybatisUtils.getSqlSession();ClientMapper mapper = sqlSession.getMapper(ClientMapper.class);// mapper调用方法,实际底层仍是sqlSession来调用select方法Client client = mapper.login1(vo);System.out.println(client);sqlSession.close();}/*** 使用Map来封装*/@Testpublic void testLogin2(){Map<String, Object> paramMap = new HashMap<String, Object>();paramMap.put("username", "zy");paramMap.put("password", "1111");SqlSession sqlSession = MybatisUtils.getSqlSession();ClientMapper mapper = sqlSession.getMapper(ClientMapper.class);// mapper调用方法,实际底层仍是sqlSession来调用select方法.// 注意: sqlSession调用的方法,只能传递一个参数.Client client = mapper.login2(paramMap);System.out.println(client);sqlSession.close();}/*** 方式三: 使用Param注解,原理是方式二*//*HelloWorld*/@Testpublic void testLogin3(){SqlSession sqlSession = MybatisUtils.getSqlSession();ClientMapper mapper = sqlSession.getMapper(ClientMapper.class);// mapper调用方法,实际底层仍是sqlSession来调用select方法.// 注意: sqlSession调用的方法,只能传递一个参数.Client client = mapper.login3("zy", "1111");System.out.println(client);sqlSession.close();}
}

6、 # 和 $ 的区别

跳转到目录

• 使用 #

  Preparing: SELECT id, username, password FROM client WHERE username = ? AND password = ?; 
  Parameters: zy(String), 1111(String)
  

• 使用 $

  Preparing: SELECT id, username, password FROM client WHERE username = root AND password = 1111; 
  Parameters: 
  

一、两者的异同
相同: 都可以通过 # 和 $ 来获取对象中的信息

不同:
1. 使用#传递的参数会先转换为占位符?, 通过设置占位符参数的方式来设置值(会给值使用单引号引起来)
2. 使用$传递的参数,直接把解析出来的数据作为SQL语句的一部分

二、推论

#: 好比使用PrepareStatement,不会导致SQL注入问题,相对安全
$: 好比使用Statement, 可能会导致SQL注入问题,相对不安全.

三、如何选择

• 如果需要设置占位符参数的地方,全部使用 # ,也就是SQL之后可能使用 ? 的情况
• 如果我们写的内容应该作为SQL的一部分, 此时使用 $ , 比如 排序、分组查询等

三、MyBatis使用注解开发

跳转到目录

• 之前的开发MyBatis都使用XML来配置,也可以直接用注解来开发,当SQL很复杂的时候,推荐使用XML来配置

注意: 使用注解来配置的话, 就不需要Mapper.xml文件了,在主配置文件中注册映射文件的方式就要改为:

<mapper class="com/sunny/dao/UserMapper" />

在接口方法上添加注解

• Insert注解
  跳转到目录

    // 插入一条用户信息@Insert("INSERT INTO user (id, name, pwd) VALUES (null , #{name}, #{pwd})")@Options(useGeneratedKeys = true, keyProperty = "id") //生成主键int insertUser(User user);

• Delete注解
  跳转到目录

    // 根据id来删除用户@Delete("DELETE FROM user WHERE id = #{id}")int deleteUser(int id);

• Update注解
  跳转到目录

    // 根据id来更新用户信息@Update("UPDATE user SET name = #{name}, pwd = #{pwd} WHERE id = #{id}")int updateUser(User user);

• Select注解
  跳转到目录

    // 查询某个用户@Select("SELECT id AS u_id, name AS u_name, pwd AS u_pwd FROM user WHERE id = ${id}")@ResultMap("BaseResultMap")User getOneUser(int id);// 查询所有用户@Select("SELECT id AS u_id, name AS u_name, pwd AS u_pwd FROM user")@Results(id = "BaseResultMap", value = {@Result(column = "u_id", property = "id"),@Result(column = "u_name", property = "name"),@Result(column = "u_pwd", property = "pwd")})List<User> getUserList();