MyBatis框架使用

一、第一种开发模式

使用MyBatis的SqlSession中提供的方法进行简单的增删改查。

1. 导包：到官网下载MyBatis的jar包，可以到中文官网上下载，下载完成后，在项目中导入MyBatis的核心jar包以及附属jar包，另外，还需要导入数据库连接的jar包，否则是连接不了数据库的。

http://www.mybatis.cn/82.html

2. 配置MyBatis主配置文件：配置文件的命名格式一般为mybatis-config.xml；一般放置在src目录下。

3. 添加MyBatis主配置文件的头部信息；

4. 在MyBatis主配置文件中，可以配置的内容有(properties?, settings?, typeAliases?, typeHandlers?, objectFactory?, objectWrapperFactory?, plugins?, environments?, databaseIdProvider?, mappers?)这么多，在添加配置内容是一定要严格的按照前后顺序进行配置。

• < properties > ：读取配置文件，通过属性resource读取配置文件，一般用于读取 db.properties 文件。

• < typeAliases >：配置别名，有两种方式，一是使用子标签 < typeAlias > 为某全限定类名添加别名，然后就可以在实体类的配置文件中以该别名取代全限定类名。二是使用子标签 < package > 扫描某个包，然后就可以在实体类的配置文件中直接输入类名而不需要全限定类名，因为主配置文件中已经有包名，再加上类名就组合成了全限定类名。

• < environments >：配置环境，可以通过子标签 < environment > 配置多种环境，通过子标签的id属性进行区分，通过default属性选择要使用的环境配置，环境可以配置事务和配置数据源，数据源的值可以使用 < properties > 读取的文件的值。

• < mapper >： 关联实体类的配置文件，通过子标签 < mapper > 关联实体类的配置文件。

• …

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!--    读取配置文件--><properties resource="db.properties"/><!--    配置别名--><typeAliases>
<!--        <typeAlias type="com.gec.domain.User" alias="User"/>--><package name="com.gec.domain"/></typeAliases><!--   配置环境，可以配置多个环境，default表示选择其中的某个环境--><environments default="dev"><environment id="dev"><!--            配置事务，这里先选择JDBC方式--><transactionManager type="JDBC"/><!--            配置数据源--><dataSource type="POOLED"><property name="driver" value="${driver}"/><property name="url" value="${url}"/><property name="username" value="${username}"/><property name="password" value="${password}"/></dataSource></environment></environments><!--    关联实体类的映射文件--><mappers><mapper resource="com/gec/domain/UserMapper.xml"/></mappers>
</configuration>

5. 配置实体类的映射文件：位置可以放在与实体类同一目录下，命名格式一般为 实体类名+Mapper.xml;

6. 添加实体类配置文件的头部信息。

7. 在该配置文件中主要用于写SQL语句，通过标签的不同来区别不同的SQL语句和执行的操作，常用有 < select > / < insert > / < update > / < delete > 四种标签，通过id属性来唯一区别SQL语句。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- 这里的命名空间namespase可以随便取值，但如果是使用接口方式编程则不能随便写，必须与接口名相同 -->
<mapper namespace="aaa"><select id="selectUserById" parameterType="int" resultType="User">select * from tb_user where id = #{id};</select><!--    查询所有--><select id="selectUserList" resultType="User">select * from tb_user;</select><!--    模糊查询--><!--<select id="selectUserLikeName" parameterType="string" resultType="User">select * from tb_user where username like #{username};</select>--><select id="selectUserLikeName" parameterType="string" resultType="User">select * from tb_user where username like '%${value}%';</select><!--    添加--><insert id="saveUser" parameterType="User">insert into tb_user (username, password) values (#{username}, #{password});</insert><!--    修改--><update id="updateUserById" parameterType="User">update tb_user set username=#{username}, password=#{password} where id=#{id};</update><!--    删除--><delete id="deleteUserById" parameterType="int">delete from tb_user where id=#{id};</delete>
</mapper>

8. MyBatis的增删改查操作：

• 首先使用 I/O 流的方式读取主配置文件，使用 Resources.getResourceAsStream(“mybatis-config.xml”) / getResourceAsReader(“mybatis-config.xml”) 方法读取。
• 获得会话工厂的构建对象构建会话工厂：new SqlSessionFactoryBuild().build(读取配置文件的I/O流对象).
• 通过会话工厂的 openSession(boolean)方法创建一个SqlSession对象，这里可以设置布尔值为true表示自动提交事务，默认是false，即进行增删改查操作后需要手动提交事务，使用session.commit()提交。
• 查询操作，使用 session.selectOne(String, Object) / selectList(String [, Object] ) 方法进行查询，参数 1 表示命名空间下SQL语句的id；参数 2 为条件查询时输入到SQL中的参数。
• 添加操作，使用 session.insert(String, Object) 方法进行添加，参数 1 同上，参数 2 为添加的对象。
• 修改操作，使用 session.update(String, Object) 方法进行修改，参数 1、2 与添加操作类似。
• 删除操作，使用 session.delete(String, Object)，参数 1 同上， 参数 2 为删除所需的属性值。

	@Testpublic void fun1() throws IOException {String config = "mybatis-config.xml";InputStream in = Resources.getResourceAsStream(config);SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);SqlSession session = sqlSessionFactory.openSession();//参数1：填写 SQL id的名称，aaa为namespace的值，目的是唯一标识SQL语句//参数2：填写具体的实际参数User user = session.selectOne("aaa.selectUserById", 1);System.out.println(user);}

二、第二种开发方式

MyBatis面向接口编程：使用MyBatis提供的方法终究不能满足多样化的SQL语句，例如当需要传入多个参数时，MyBatis提供的方法就没辙了，所以MyBatis允许用户自定义方法，通过接口的方式满足多样化的SQL需求。

1. 添加必须的文件，实体类、实体类的映射文件和MyBatis的主配置文件是必须的，配置文件的内容参考上文。

2. 创建接口文件，除了创建上面的三个文件外，还需要创建接口文件，接口中声明了用户自定义的方法。

public interface UserMapper {List<User> selectUserLikeNameAndPassword(Map<String, String> map);List<User> selectUserLikeNameAndPassword2(@Param(value = "username") String name, @Param(value = "password") String password);int saveUser(User user);int updateUserById(User user);int deleteUserById(int id);
}

3. 接口中的方法与映射文件中的SQL语句要按照一定的规则关联起来，这样我们在调用接口的方法时，MyBatis框架才会自动为我们创建接口的实现类，执行SQL语句。

• 首先映射文件中的namespace必须等于接口的全路径名；
• 映射文件中的标签的id必须等于接口中对应的方法名；
• 映射文件中的标签的传入参数类型必须等于接口方法中的参数类型；
• 映射文件总的标签的返回类型必须等于接口方法的返回类型（若SQL的结果集是List集合，则在接口方法中用List集合接收）。

<!-- namespace的值必须等于接口的全路径名-->
<mapper namespace="com.gec.Mapper.UserMapper">
<!--    配置实体类属性与数据库表的映射，当两边的命名不相同时需要设置;可以只设置不相同的属性与列，相同的属性与列可以省略不写
--><resultMap id="UserMap" type="User">
<!--        <id property="id" column="id"></id>--><result property="userName" column="username"></result>
<!--        <result property="password" column="password"></result>--></resultMap><!--    传入map集合--><select id="selectUserLikeNameAndPassword" parameterType="map" resultType="User">select * from tb_user where username like #{username} and password=#{password};</select><!--    传入多个参数, 另外parameterType属性可以省略--><select id="selectUserLikeNameAndPassword2" resultMap="UserMap">select * from tb_user where username like #{username} and password=#{password};</select>
</mapper>

4. 若实体类的属性名与数据库表的列名不相同，则需要配置属性名与列名的关系，注意，可以值设置不相同的属性与列，相同的属性与列可以忽略不写。使用标签 < resultMap > 配置，通过子标签 < id > 和 < result > 配置属性与列的一一对应关系。

<!--    配置实体类属性与数据库表的映射，当两边的命名不相同时需要设置;可以只设置不相同的属性与列，相同的属性与列可以省略不写
--><resultMap id="UserMap" type="User">
<!--        <id property="id" column="id"></id>--><result property="userName" column="username"></result>
<!--        <result property="password" column="password"></result>--></resultMap>

5. 编写SQL语句，基本与原始SQL语句相同，不同点在于：传入的参数通过 #{参数名} 使用，若是模糊查询的话，传入的参数可能需要 “%” 包起来，这时候使用 ‘%#{value}%’ ，其中value若是没有在接口方法的参数中使用注解 @param(value="…") 指定特定的名字的话，可以写成任意一个非关键字的名字，若是要传入多个参数的话，也要在接口方法的参数中添加注解 @param(value="…")。

6. 准备完成后就可以调用方法执行SQL语句了，在此之前最好先检查一下 MyBatis 主配置文件中是否有关联实体类的映射文件。

7. 在测试方法中：

• 首先同样是要先获得SqlSession对象；
• 使用SqlSession对象的getMapper(接口.class) 方法获得接口的实例对象；
• 调用实例对象的方法进行增删改查。

	@Testpublic void fun1(){String config = "mybatis-config.xml";InputStream in = Resources.getResourceAsStream(config);SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);SqlSession session = sqlSessionFactory.openSession();//mapper 的 SQL 传参中，除了可以传入基本数据类型+String和实体类外，还可以传入复杂类型。Map<String, String> map = new HashMap<>();map.put("username", "%张%");map.put("password", "12345");//使用接口方式自定义UserMapper mapper = session.getMapper(UserMapper.class);List<User> users = mapper.selectUserLikeNameAndPassword(map);for (User s : users) {System.out.println(s);}}

8. 另外，除了查询外，增删改都需要在执行完方法后提交事务，否则即使修改了数据也不能持久化到数据库中。

三、动态SQL

MyBatis提供多种标签来帮助程序员编写动态SQL语句：

1. if 标签：根据 test 属性中的布尔值（true/false）来决定是否拼接 if 块中的SQL语句。

	<select id="selectNewSql" resultMap="UserMap">select * from tb_user where<if test="username!=null and username!=''"> username like #{username} </if><if test="password!=null and password!=''"> and password=#{password}</if></select>

2. where 标签：使用该标签将条件括起来，若存在条件时会自动添加关键字 where ，并且会将多余 and、or 等关键字删除。一般与 if 标签配合使用。

	<select id="selectNewSql" resultMap="UserMap">select * from tb_user<where><if test="username!=null and username!=''">username like #{username}</if><if test="password!=null and password!=''">and password=#{password}</if></where></select>

3. set 标签：使用在更新语句中国，代替 set 关键字，会自动添加关键字 set ，并且会将多余的“，”删除。一般配合 if 标签使用。

	<update id="updateUser" parameterType="User">update tb_user<set><if test="userName!=null and userName!=''"> username=#{userName},</if><if test="password!=null and password!=''"> password=#{password} </if></set>where id=#{id}</update>

4. foreach 标签：若传入的参数是 List 集合时使用该标签遍历集合，注意需要在接口方法的参数中使用 @param(value="…") 注解设置集合的名字，否则会找不到。在 foreach 标签中使用 collection 属性接收集合的名字，open 属性设置开始内容，item 属性设置遍历的每一个元素名，separate 属性设置元素之间的分隔符，close 属性设置结束内容，最后在 foreach 块中通过 #{item定义的名字} bianli jihe .

	<select id="selectUserByIds" resultMap="UserMap">select * from tb_user<where><foreach collection="ids" open="id in(" item="id" separator="," close=")">#{id}</foreach></where></select>

5. sql 标签：抽取重复的SQL语句，将重复的SQL语句抽取出来，使用标签的 id 属性唯一标识。

	<sql id="base_sql">select * from tb_user</sql>

6. include 标签：一般用于引入sql标签抽取的SQL语句，使用标签的 refid 属性选择想要引入的sql标签内容即可。

	<select id="selectUserByIds" resultMap="UserMap"><include refid="base_sql"/><include refid="whereSql"/></select>

7. choose、when、otherwise 标签：效果类似于Java中的switch语句，使用方法与JSTL中的choose一样，when 标签的 test 属性中设置条件，可以有多个when，若所有的 when 都不执行的话，就执行 otherwise 标签的内容。

	<select id="selectUserByNameOrPassword" parameterType="User" resultMap="UserMap"><include refid="base_sql"/><where><choose><when test="userName!=null and userName!=''">username=#{userName}</when><otherwise>password=#{password}</otherwise></choose></where></select>

…
…
…