MyBatis入门初体验之使用大全(2)
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中放入如下配置:
<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 或其他位置加载资源文件更加容易。
例如:
string resource = "mybatis-config.xml"; inputstream is = resources.getresourceasstream(resource); sqlsessionfactory sqlsessionfactory = new sqlsessionfactorybuilder().build(is);
xml 配置文件(configuration xml)中包含了对 mybatis 系统的核心设置,包含获取数据库连接实例的数据源(datasource)
和决定事务范围和控制方式的事务管理器(transactionmanager)。配置文件详细往后再说。
例如:
<!--?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 语句。例如:
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),
你现在不但可以执行更清晰和类型安全的代码,而且还不用担心易错的字符串字面值以及强制类型转换。例如:
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方法测试也行)
项目结构:
数据库:
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:
<!--?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:
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:
<!--?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测试代码:
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(); } } }
控制台输出:
对于以上实例,在测试代码中:
user user = session.selectone("com.lanhuigu.mybatis.map.usermainmapper.queryusermainbyid", 1); system.out.println(user.getusername());
这段代码使用起来是不是很不爽,我们说过有种更直接的方式:
在项目结构map下加上一个映射接口:
package com.lanhuigu.mybatis.map; import com.lanhuigu.mybatis.entity.user; public interface usermainmapper { public user queryusermainbyid(int id); }
同时,将测试的代码做如下修改:
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(); } } }
把之前的查询部分修改成:
usermainmapper usermainmapper = session.getmapper(usermainmapper.class); user user = usermainmapper.queryusermainbyid(1);
使用对于给定语句能够合理描述参数和返回值的接口(比如说usermainmapper.class),
现在不但可以执行更清晰和类型安全的代码,而且还不用担心易错的字符串字面值以及强制类型转换。
运行测试代码,效果一样。
usermainmapper接口位置:
既然我们加完了接口,mybatis-config.xml对于映射器部分可以换一种配置,直接映射usermainmapper接口所在包文件:
也就是将
修改成
完整配置如下,运行测试代码即可检验,这种做法维护更轻松,统一对map进行管理:
<!--?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接口:
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); }
修改后的测试代码,运行感受下:
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),希望对大家有所帮助
推荐阅读