MyBatis简介
MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code,并且改名为MyBatis 。2013年11月迁移到Github。
iBATIS一词来源于“internet”和“abatis”的组合,是一个基于Java的持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects(DAO)
1.所需jar包
这里单独讨论MyBatis的使用,只需要放入mybatis-x.x.x.jar包即可。
如果使用maven构建项目,则需要在pom.xml的dependency中放入如下配置:
1
2
3
4
5
|
<dependency> <groupid>org.mybatis</groupid> mybatis</artifactid> <version> 3.2 . 2 </version> </dependency> |
公司目前用的3.2.2的,可以根据自己的jar包放入版本号。
如果你是与相应的框架一起集成,则需要放入集成包,比如,我们公司用mybatis与spring集成,
则还需要加入mybatis-spring-xxx.jar包,根据实际情况决定。当然了,数据库驱动jar包也是少不了的。
2.从XML中构建SqlSessionFactory
每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为中心的。
SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。
而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先定制的 Configuration 的实例构建出 SqlSessionFactory 的实例。
从 XML 文件中构建 SqlSessionFactory 的实例非常简单,建议使用类路径下的资源文件进行配置。
但是也可以使用任意的输入流(InputStream)实例,包括字符串形式的文件路径或者 file:// 的 URL 形式的文件路径来配置。
MyBatis 包含一个名叫 Resources 的工具类,它包含一些实用方法,可使从 classpath 或其他位置加载资源文件更加容易。
例如:
1
2
3
|
String resource = "mybatis-config.xml" ; InputStream is = Resources.getResourceAsStream(resource); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); |
XML 配置文件(configuration XML)中包含了对 MyBatis 系统的核心设置,包含获取数据库连接实例的数据源(DataSource)
和决定事务范围和控制方式的事务管理器(TransactionManager)。配置文件详细往后再说。
例如:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
<!--?xml version= "1.0" encoding= "UTF-8" ?--> <configuration> <environments default = "development" > <environment id= "development" > <transactionmanager type= "JDBC" > <datasource type= "POOLED" > <property name= "driver" value= "com.mysql.jdbc.Driver" > <property name= "url" value= "jdbc:mysql://192.168.200.12:3306/test_mybatis" > <property name= "username" value= "root" > <property name= "password" value= "root123" > </property></property></property></property></datasource> </transactionmanager></environment> </environments> <mappers> <!-- 注册UserMainMapper.xml文件,UserMainMapper.xml位于com.lanhuigu.mybatis.map这个包下, 所以resource写成com/lanhuigu/mybatis/map/UserMainMapper.xml--> <mapper resource= "com/lanhuigu/mybatis/map/UserMainMapper.xml" ></mapper> </mappers> </configuration> |
environment 元素体中包含了事务管理和连接池的配置。mappers 元素则是包含一组 mapper 映射器(这些 mapper 的 XML 文件包含了 SQL 代码和映射定义信息)。
3.从SqlSessionFactory中获取SqlSession
既然有了 SqlSessionFactory ,我们就可以从中获得 SqlSession 的实例。SqlSession 完全包含了面向数据库执行 SQL 命令所需的所有方法。
你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。例如:
1
2
3
4
5
6
7
8
9
10
11
12
|
SqlSessionFactory sqlSessionFactory = null ; // XML构建SqlSessionFactory工厂实例 SqlSession session = null ; // 从SqlSessionFactory工厂实例中获取SqlSession对象 try { String resource = "mybatis-config.xml" ; InputStream is = Resources.getResourceAsStream(resource); sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); session = sqlSessionFactory.openSession(); User user = session.selectOne( "com.lanhuigu.mybatis.map.UserMainMapper.queryUserMainById" , 1 ); System.out.println(user.getUsername()); } finally { session.close(); } |
用这种方式执行映射没什么问题,我们也可以用一种更加简洁的方式执行映射。
使用对于给定语句能够合理描述参数和返回值的接口(比如说UserMainMapper.class),
你现在不但可以执行更清晰和类型安全的代码,而且还不用担心易错的字符串字面值以及强制类型转换。例如:
1
2
3
|
SqlSession session = sqlSessionFactory.openSession(); UserMainMapper userMainMapper = session.getMapper(UserMainMapper. class ); User user = userMainMapper .queryUserMainById( 1 ); |
4.实例
光看不练容易迷糊,看看实例,在回去读文档,或许效果会更好。
准备jar包:
mybatis-3.2.2.jar(mybatis)
mysql-connector-java-5.1.21.jar(数据库驱动)
junit-4.4.jar(测试,不想用这个junit,用main方法测试也行)
项目结构:
数据库:
1
2
3
4
5
6
7
|
CREATE TABLE `t_user_main` ( `f_id` int (11) NOT NULL , `f_username` varchar (20) DEFAULT NULL , `f_age` int (3) DEFAULT NULL , PRIMARY KEY (`f_id`) ) ENGINE=MyISAM DEFAULT CHARSET=latin1; INSERT INTO t_user_main VALUES (1, 'testMyBatis' ,25); |
mybatis的xml配置--mybatis-config.xml:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
<! --?xml version="1.0" encoding="UTF-8" ?--> <configuration> <environments default = "development" > <environment id= "development" > <transactionmanager type= "JDBC" > <datasource type= "POOLED" > <property name = "driver" value= "com.mysql.jdbc.Driver" > <property name = "url" value= "jdbc:mysql://192.168.200.12:3306/test_mybatis" > <property name = "username" value= "root" > <property name = "password" value= "root123" > </property></property></property></property></datasource> </transactionmanager></environment> </environments> <mappers> <! -- 注册UserMainMapper.xml文件,UserMainMapper.xml位于com.lanhuigu.mybatis.map这个包下, 所以resource写成com/lanhuigu/mybatis/map/UserMainMapper.xml --> <mapper resource= "com/lanhuigu/mybatis/map/UserMainMapper.xml" ></mapper> </mappers> </configuration> |
User.java:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
package com.lanhuigu.mybatis.entity; import java.io.Serializable; public class User implements Serializable{ private static final long serialVersionUID = -3412068097348759984L; private Integer id; private String username; private Integer age; public Integer getId() { return id; } public void setId(Integer id) { this .id = id; } public String getUsername() { return username; } public void setUsername(String username) { this .username = username; } public Integer getAge() { return age; } public void setAge(Integer age) { this .age = age; } } |
UserMainMapper.xml:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
<!--?xml version= "1.0" encoding= "UTF-8" ?--> <!-- 为这个mapper指定一个唯一的namespace,namespace的值习惯上设置成包名+去掉sql映射文件后缀的文件名, 这样就能够保证namespace的值是唯一的,例如namespace= "com.lanhuigu.mybatis.map.UserMainMapper" 就是com.lanhuigu.mybatis.map(包名)+UserMainMapper(UserMainMapper.xml文件去除后缀) --> <mapper namespace= "com.lanhuigu.mybatis.map.UserMainMapper" > <!-- 在select标签中编写查询的SQL语句, 设置select标签的id属性为queryUserMainById,id属性值必须是唯一的, 不能够重复使用parameterType属性指明查询时使用的参数类型,resultType属性指明查询返回的结果集类型 resultType= "com.lanhuigu.mybatis.entity.User" 就表示将查询结果封装成一个User类的对象返回 User类就是users表所对应的实体类 --> <select id= "queryUserMainById" parametertype= "int" resulttype= "com.lanhuigu.mybatis.entity.User" > select f_id id, f_username username, f_age age from t_user_main where f_id = #{id} </select> </mapper> |
MyBatisTest.java测试代码:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
package com.lanhuigu.mybatis; import java.io.IOException; import java.io.InputStream; import org.apache.ibatis.io.Resources; import org.apache.ibatis.session.SqlSession; import org.apache.ibatis.session.SqlSessionFactory; import org.apache.ibatis.session.SqlSessionFactoryBuilder; import org.junit.Test; import com.lanhuigu.mybatis.entity.User; public class MyBatisTest { @Test public void testMyBatis() throws IOException { SqlSessionFactory sqlSessionFactory = null ; // XML构建SqlSessionFactory工厂实例 SqlSession session = null ; // 从SqlSessionFactory工厂实例中获取SqlSession对象 try { //1.mybatis的配置文件路径,这里放在classpath下,相当于src下 String resource = "mybatis-config.xml" ; //2.读取mybatis配置文件,同时创建SqlSessionFactory工厂实例 //======2.1使用类加载器加载mybatis的配置文件(它也加载关联的映射文件) //InputStream is = MyBatisTest.class.getClassLoader().getResourceAsStream(resource); //构建SqlSessionFactory工厂 //sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); //======2.2使用MyBatis提供的Resources类加载mybatis的配置文件(它也加载关联的映射文件) //Reader reader = Resources.getResourceAsReader(resource); //构建SqlSessionFactory工厂 //sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader); //======2.3 使用MyBatis提供的Resources类加载mybatis的配置文件 InputStream is = Resources.getResourceAsStream(resource); //构建SqlSessionFactory工厂 sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); //3.创建能执行映射文件中sql的sqlSession session = sqlSessionFactory.openSession(); /** * 映射sql的标识字符串: * com.lanhuigu.mybatis.map.UserMainMapper是UserMainMapper.xml文件中mapper标签的namespace属性的值, * queryUserMainById是UserMainMapper.xml文件select标签的id属性值,通过select标签的id属性值, * 通过这两个的组合就可以找到要执行的SQL */ //执行查询返回一个唯一user对象的sql,注意:"com.lanhuigu.mybatis.map.UserMainMapper.queryUserMainById"为映射sql的标识字符串 User user = session.selectOne( "com.lanhuigu.mybatis.map.UserMainMapper.queryUserMainById" , 1 ); System.out.println(user.getUsername()); } finally { session.close(); } } } |
控制台输出:
对于以上实例,在测试代码中:
1
2
|
User user = session.selectOne( "com.lanhuigu.mybatis.map.UserMainMapper.queryUserMainById" , 1 ); System.out.println(user.getUsername()); |
这段代码使用起来是不是很不爽,我们说过有种更直接的方式:
在项目结构map下加上一个映射接口:
1
2
3
4
5
|
package com.lanhuigu.mybatis.map; import com.lanhuigu.mybatis.entity.User; public interface UserMainMapper { public User queryUserMainById( int id); } |
同时,将测试的代码做如下修改:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
package com.lanhuigu.mybatis; import java.io.IOException; import java.io.InputStream; import org.apache.ibatis.io.Resources; import org.apache.ibatis.session.SqlSession; import org.apache.ibatis.session.SqlSessionFactory; import org.apache.ibatis.session.SqlSessionFactoryBuilder; import org.junit.Test; import com.lanhuigu.mybatis.entity.User; import com.lanhuigu.mybatis.map.UserMainMapper; public class MyBatisTest { @Test public void testMyBatis() throws IOException { SqlSessionFactory sqlSessionFactory = null ; // XML构建SqlSessionFactory工厂实例 SqlSession session = null ; // 从SqlSessionFactory工厂实例中获取SqlSession对象 try { //1.mybatis的配置文件路径,这里放在classpath下,相当于src下 String resource = "mybatis-config.xml" ; //2.读取mybatis配置文件,同时创建SqlSessionFactory工厂实例 //======2.1使用类加载器加载mybatis的配置文件(它也加载关联的映射文件) //InputStream is = MyBatisTest.class.getClassLoader().getResourceAsStream(resource); //构建SqlSessionFactory工厂 //sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); //======2.2使用MyBatis提供的Resources类加载mybatis的配置文件(它也加载关联的映射文件) //Reader reader = Resources.getResourceAsReader(resource); //构建SqlSessionFactory工厂 //sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader); //======2.3 使用MyBatis提供的Resources类加载mybatis的配置文件 InputStream is = Resources.getResourceAsStream(resource); //构建SqlSessionFactory工厂 sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); //3.创建能执行映射文件中sql的sqlSession session = sqlSessionFactory.openSession(); /** * 映射sql的标识字符串: * com.lanhuigu.mybatis.map.UserMainMapper是UserMainMapper.xml文件中mapper标签的namespace属性的值, * queryUserMainById是UserMainMapper.xml文件select标签的id属性值,通过select标签的id属性值, * 通过这两个的组合就可以找到要执行的SQL */ //执行查询返回一个唯一user对象的sql,注意:"com.lanhuigu.mybatis.map.UserMainMapper.queryUserMainById"为映射sql的标识字符串 /*User user = session.selectOne("com.lanhuigu.mybatis.map.UserMainMapper.queryUserMainById", 1); System.out.println(user.getUsername());*/ UserMainMapper userMainMapper = session.getMapper(UserMainMapper. class ); User user = userMainMapper.queryUserMainById( 1 ); System.out.println(user.getUsername()); } finally { session.close(); } } } |
把之前的查询部分修改成:
1
2
|
UserMainMapper userMainMapper = session.getMapper(UserMainMapper. class ); User user = userMainMapper.queryUserMainById( 1 ); |
使用对于给定语句能够合理描述参数和返回值的接口(比如说UserMainMapper.class),
现在不但可以执行更清晰和类型安全的代码,而且还不用担心易错的字符串字面值以及强制类型转换。
运行测试代码,效果一样。
userMainMapper接口位置:
既然我们加完了接口,mybatis-config.xml对于映射器部分可以换一种配置,直接映射UserMainMapper接口所在包文件:
也就是将
修改成
完整配置如下,运行测试代码即可检验,这种做法维护更轻松,统一对map进行管理:
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" ?--> <configuration> <environments default = "development" > <environment id= "development" > <transactionmanager type= "JDBC" > <datasource type= "POOLED" > <property name= "driver" value= "com.mysql.jdbc.Driver" > <property name= "url" value= "jdbc:mysql://192.168.200.12:3306/test_mybatis" > <property name= "username" value= "root" > <property name= "password" value= "root123" > </property></property></property></property></datasource> </transactionmanager></environment> </environments> <mappers> <!-- 注册UserMainMapper.xml文件,UserMainMapper.xml位于com.lanhuigu.mybatis.map这个包下, 所以resource写成com/lanhuigu/mybatis/map/UserMainMapper.xml--> <!-- <mapper resource= "com/lanhuigu/mybatis/map/UserMainMapper.xml" ></mapper> --> < package name= "com.lanhuigu.mybatis.map" > </ package ></mappers> </configuration> |
以上我们可以看到不管我们怎么玩,sql是不是还在UserMainMapper.xml中映射?
这种方式实现是唯一的吗?难道我必须要用xml?
当然不是了,如果以上你的代码是一路修改下来测试成功的,那么我们再做最后一个修改,
不用UserMainMapper.xml实现映射,我们采用java注解来实现映射。
主要修改的地方是UserMainMapper.java这个接口,新加一个方法queryUserMainByIdNew,用注解实现映射
mybatis自解析接口映射。
修改后的UserMainMapper.java接口:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
package com.lanhuigu.mybatis.map; import org.apache.ibatis.annotations.Param; import org.apache.ibatis.annotations.Select; import com.lanhuigu.mybatis.entity.User; public interface UserMainMapper { /** * xml */ public User queryUserMainById( int id); /** * java注解 */ @Select ( "select f_id id,f_username username,f_age age from t_user_main where f_id = ${id} " ) public User queryUserMainByIdNew( @Param ( "id" ) int id); } |
修改后的测试代码,运行感受下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
package com.lanhuigu.mybatis; import java.io.IOException; import java.io.InputStream; import org.apache.ibatis.io.Resources; import org.apache.ibatis.session.SqlSession; import org.apache.ibatis.session.SqlSessionFactory; import org.apache.ibatis.session.SqlSessionFactoryBuilder; import org.junit.Test; import com.lanhuigu.mybatis.entity.User; import com.lanhuigu.mybatis.map.UserMainMapper; public class MyBatisTest { @Test public void testMyBatis() throws IOException { SqlSessionFactory sqlSessionFactory = null ; // XML构建SqlSessionFactory工厂实例 SqlSession session = null ; // 从SqlSessionFactory工厂实例中获取SqlSession对象 try { //1.mybatis的配置文件路径,这里放在classpath下,相当于src下 String resource = "mybatis-config.xml" ; //2.读取mybatis配置文件,同时创建SqlSessionFactory工厂实例 //======2.1使用类加载器加载mybatis的配置文件(它也加载关联的映射文件) //InputStream is = MyBatisTest.class.getClassLoader().getResourceAsStream(resource); //构建SqlSessionFactory工厂 //sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); //======2.2使用MyBatis提供的Resources类加载mybatis的配置文件(它也加载关联的映射文件) //Reader reader = Resources.getResourceAsReader(resource); //构建SqlSessionFactory工厂 //sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader); //======2.3 使用MyBatis提供的Resources类加载mybatis的配置文件 InputStream is = Resources.getResourceAsStream(resource); //构建SqlSessionFactory工厂 sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); //3.创建能执行映射文件中sql的sqlSession session = sqlSessionFactory.openSession(); /** * 映射sql的标识字符串: * com.lanhuigu.mybatis.map.UserMainMapper是UserMainMapper.xml文件中mapper标签的namespace属性的值, * queryUserMainById是UserMainMapper.xml文件select标签的id属性值,通过select标签的id属性值, * 通过这两个的组合就可以找到要执行的SQL */ //执行查询返回一个唯一user对象的sql,注意:"com.lanhuigu.mybatis.map.UserMainMapper.queryUserMainById"为映射sql的标识字符串 /*User user = session.selectOne("com.lanhuigu.mybatis.map.UserMainMapper.queryUserMainById", 1); System.out.println(user.getUsername());*/ /*UserMainMapper userMainMapper = session.getMapper(UserMainMapper.class); User user = userMainMapper.queryUserMainById(1); System.out.println(user.getUsername());*/ UserMainMapper userMainMapper = session.getMapper(UserMainMapper. class ); User user = userMainMapper.queryUserMainByIdNew( 1 ); System.out.println(user.getUsername()); } finally { session.close(); } } } |
以上所述是小编给大家介绍的MyBatis入门初体验之使用大全(2),希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对服务器之家网站的支持!