一、Mybatis介绍
MyBatis是一个支持普通SQL查询,存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装。MyBatis可以使用简单的XML或注解用于配置和原始映射,将接口和Java的POJO(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录。
二、mybatis快速入门
2.1、准备开发环境
1、创建测试项目,普通java项目或者是JavaWeb项目均可,如下图所示:
2、添加相应的jar包
【mybatis】
mybatis-3.1.1.jar
【MYSQL驱动包】
mysql-connector-java-5.1.7-bin.jar
3、创建数据库和表,针对MySQL数据库
SQL脚本如下:
create database mybatis;
use mybatis;
CREATE TABLE users(id INT PRIMARY KEY AUTO_INCREMENT, NAME VARCHAR(20), age INT);
INSERT INTO users(NAME, age) VALUES(‘孤傲苍狼’, 27);
INSERT INTO users(NAME, age) VALUES(‘白虎神皇’, 27);
select * from users;
将SQL脚本在MySQL数据库中执行,完成创建数据库和表的操作,如下:
到此,前期的开发环境准备工作全部完成。
2.2、使用MyBatis查询表中的数据
1、添加Mybatis的配置文件conf.xml
在src目录下创建一个conf.xml文件,如下图所示:
conf.xml文件中的内容如下:
<?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>
<!—
配置MyBatis运行环境。
development : 开发模式
work : 工作模式
-->
<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://localhost:3306/mybatis" />
<property name="username" value="root" />
<property name="password" value="java" />
</dataSource>
</environment>
</environments>
</configuration>
2、定义表所对应的实体类,如下图所示:
User类的代码如下:
package com.cn.entity;
/**
* @author gacl
* users表所对应的实体类
*/
public class Users {
//实体类的属性和表的字段名称一一对应
private int id;
private String name;
private int age;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public String toString() {
return "User [id=" + id + ", name=" + name + ", age=" + age + "]";
}
}
3、定义操作users表的sql映射文件userMapper.xml
创建一个com.cn.mapping包,专门用于存放sql映射文件,在包中创建一个userMapper.xml文件,如下图所示:
在创建XML前要先引入DTD文件,步骤如下
点击add按钮
点击File System按钮
找到DTD文件,key中输入-//mybatis.org//DTD Mapper 3.0//EN点击OK
在com.cn.mapping包下创建XML文件
输入名字后点击NEXT
选择第一项,点击next
选择第二项
点击finish
userMapper.xml文件的内容如下:
<?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,namespace的值习惯上设置成包名+sql映射文件名,这样就能够保证namespace的值是唯一的
例如namespace="me.gacl.mapping.userMapper"就是me.gacl.mapping(包名)+userMapper(userMapper.xml文件去除后缀)
-->
<mapper namespace="com.cn.mapping.usersMapper">
<!-- 在select标签中编写查询的SQL语句, 设置select标签的id属性为getUser,id属性值必须是唯一的,不能够重复
使用parameterType属性指明查询时使用的参数类型,resultType属性指明查询返回的结果集类型
resultType="me.gacl.domain.User"就表示将查询结果封装成一个User类的对象返回
User类就是users表所对应的实体类
-->
<!--
根据id查询得到一个user对象
-->
<select id="getUser" parameterType="int"
resultType="com.cn.entity.Users">
select * from users where id=#{id}
</select>
</mapper>
4、在conf.xml文件中注册userMapper.xml文件
<?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.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
<property name="username" value="root" />
<property name="password" value="java" />
</dataSource>
</environment>
</environments>
<mappers>
<!-- 注册userMapper.xml文件,
userMapper.xml位于me.gacl.mapping这个包下,所以resource写成me/gacl/mapping/userMapper.xml-->
<mapper resource="com/cn/mapping/usersMapper.xml"/>
</mappers>
</configuration>
5、编写测试代码:执行定义的select语句
创建一个Test1类,编写如下的测试代码:
package me.gacl.test;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import me.gacl.domain.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
publicclass Test1 {
public static void main(String[] args) throws IOException {
//mybatis的配置文件
String resource = "conf.xml";
//使用类加载器加载mybatis的配置文件(它也加载关联的映射文件)
InputStream is = Test1.class.getClassLoader().getResourceAsStream(resource);
//构建sqlSession的工厂
SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(is);
//创建能执行映射文件中sql的sqlSession
SqlSession session = sessionFactory.openSession();
/**
* 映射sql的标识字符串,
* me.gacl.mapping.userMapper是userMapper.xml文件中mapper标签的namespace属性的值,
* getUser是select标签的id属性值,通过select标签的id属性值就可以找到要执行的SQL
*/
String statement = "com.cn.mapping.usersMapper.getUser";//映射sql的标识字符串
//执行查询返回一个唯一user对象的sql
Users user = session.selectOne(statement, 1);
System.out.println(user); }
}
执行结果如下:
可以看到,数据库中的记录已经成功查询出来了。
一、使用MyBatis对表执行CRUD操作——基于XML的实现
- 先创建类MyBatisUtil.java类
package com.cn.util;
import java.io.InputStream;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
public class MyBatisUtil {
/**
* 获取SqlSessionFactory
* @return SqlSessionFactory
*/
public static SqlSessionFactory getSqlSessionFactory() {
String resource = "conf.xml";
InputStream is = MyBatisUtil.class.getClassLoader().getResourceAsStream(resource);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(is);
return factory;
}
/**
* 获取SqlSession
* @return SqlSession
*/
public static SqlSession getSqlSession() {
return getSqlSessionFactory().openSession();
}
/**
* 获取SqlSession
* @param isAutoCommit
* true 表示创建的SqlSession对象在执行完SQL之后会自动提交事务
* false 表示创建的SqlSession对象在执行完SQL之后不会自动提交事务,这时就需要我们手动调用sqlSession.commit()提交事务
* @return SqlSession
*/
public static SqlSession getSqlSession(boolean isAutoCommit) {
return getSqlSessionFactory().openSession(isAutoCommit);
}
}
1、定义sql映射xml文件
userMapper.xml文件的内容如下:
<?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,namespace的值习惯上设置成包名+sql映射文件名,这样就能够保证namespace的值是唯一的
例如namespace="me.gacl.mapping.userMapper"就是me.gacl.mapping(包名)+userMapper(userMapper.xml文件去除后缀)
-->
<mapper namespace="com.cn.mapping.usersMapper">
<!-- 在select标签中编写查询的SQL语句, 设置select标签的id属性为getUser,id属性值必须是唯一的,不能够重复
使用parameterType属性指明查询时使用的参数类型,resultType属性指明查询返回的结果集类型
resultType="me.gacl.domain.User"就表示将查询结果封装成一个User类的对象返回
User类就是users表所对应的实体类
-->
<!--
根据id查询得到一个user对象
-->
<select id="getUser" parameterType="int"
resultType="com.cn.entity.Users">
select * from users where id=#{id}
</select>
<!-- 创建用户(Create) -->
<insert id="addUser" parameterType="com.cn.entity.Users">
insert into users(name,age) values(#{name},#{age})
</insert>
<!-- 删除用户(Remove) -->
<delete id="deleteUser" parameterType="int">
delete from users where id=#{id}
</delete>
<!-- 修改用户(Update) -->
<update id="updateUser" parameterType="com.cn.entity.Users">
update users set name=#{name},age=#{age} where id=#{id}
</update>
<!-- 查询全部用户-->
<select id="getAllUsers" resultType="com.cn.entity.Users">
select * from users
</select>
</mapper>
单元测试类代码如下:
package com.cn.test;
import java.util.List;
import javax.xml.registry.infomodel.User;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import com.cn.entity.Users;
import com.cn.util.MyBatisUtil;
public class TestCRUDByXmlMapper {
@Test
public void testAdd(){
//SqlSession sqlSession = MyBatisUtil.getSqlSession(false);
SqlSession sqlSession = MyBatisUtil.getSqlSession(true);
/**
* 映射sql的标识字符串,
* com.cn.mapping.usersMapper是usersMapper.xml文件中mapper标签的namespace属性的值,
* addUser是insert标签的id属性值,通过insert标签的id属性值就可以找到要执行的SQL
*/
String statement = "com.cn.mapping.usersMapper.addUser";//映射sql的标识字符串
Users user = new Users();
user.setName("用户孤傲苍狼");
user.setAge(20);
//执行插入操作
int retResult = sqlSession.insert(statement,user);
//手动提交事务
//sqlSession.commit();
//使用SqlSession执行完SQL之后需要关闭SqlSession
sqlSession.close();
System.out.println(retResult);
}
@Test
public void testUpdate(){
SqlSession sqlSession = MyBatisUtil.getSqlSession(true);
/**
* 映射sql的标识字符串,
* com.cn.mapping.usersMapper是usersMapper.xml文件中mapper标签的namespace属性的值,
* updateUser是update标签的id属性值,通过update标签的id属性值就可以找到要执行的SQL
*/
String statement = "com.cn.mapping.usersMapper.updateUser";//映射sql的标识字符串
Users user = new Users();
user.setId(3);
user.setName("孤傲苍狼");
user.setAge(25);
//执行修改操作
int retResult = sqlSession.update(statement,user);
//使用SqlSession执行完SQL之后需要关闭SqlSession
sqlSession.close();
System.out.println(retResult);
}
@Test
public void testDelete(){
SqlSession sqlSession = MyBatisUtil.getSqlSession(true);
/**
* 映射sql的标识字符串,
* com.cn.mapping.usersMapper是usersMapper.xml文件中mapper标签的namespace属性的值,
* deleteUser是delete标签的id属性值,通过delete标签的id属性值就可以找到要执行的SQL
*/
String statement = "com.cn.mapping.usersMapper.deleteUser";//映射sql的标识字符串
//执行删除操作
int retResult = sqlSession.delete(statement,5);
//使用SqlSession执行完SQL之后需要关闭SqlSession
sqlSession.close();
System.out.println(retResult);
}
@Test
public void testGetAll(){
SqlSession sqlSession = MyBatisUtil.getSqlSession();
/**
* 映射sql的标识字符串,
* com.cn.mapping.usersMapper是usersMapper.xml文件中mapper标签的namespace属性的值,
* getAllUsers是select标签的id属性值,通过select标签的id属性值就可以找到要执行的SQL
*/
String statement = "com.cn.mapping.usersMapper.getAllUsers";//映射sql的标识字符串
//执行查询操作,将查询结果自动封装成List<User>返回
List<User> lstUsers = sqlSession.selectList(statement);
//使用SqlSession执行完SQL之后需要关闭SqlSession
sqlSession.close();
System.out.println(lstUsers);
}
}
一、连接数据库的配置单独放在一个properties文件中
之前,我们是直接将数据库的连接配置信息写在了MyBatis的conf.xml文件中,如下:
<?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.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
<property name="username" value="root"/>
<property name="password" value="java"/>
</dataSource>
</environment>
</environments>
</configuration>
其实我们完全可以将数据库的连接配置信息写在一个properties文件中,然后在conf.xml文件中引用properties文件,具体做法如下:
1、在src目录下新建一个db.properties文件,如下图所示:
在db.properties文件编写连接数据库需要使用到的数据库驱动,连接URL地址,用户名,密码,如下:
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis
name=root
password=java
2、在MyBatis的conf.xml文件中引用db.properties文件,如下:
<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
3<configuration>
4
5<!-- 引用db.properties配置文件 -->
6<properties resource="db.properties"/>
7<!--
8 development : 开发模式
9 work : 工作模式
10-->
11<environments default="development">
12<environment id="development">
13<transactionManager type="JDBC"/>
14<!-- 配置数据库连接信息 -->
15<dataSource type="POOLED">
16<!-- value属性值引用db.properties配置文件中配置的值 -->
17<property name="driver" value="${driver}"/>
18<property name="url" value="${url}"/>
19<property name="username" value="${name}"/>
20<property name="password" value="${password}"/>
21</dataSource>
22</environment>
23</environments>
24
25</configuration>
二、为实体类定义别名,简化sql映射xml文件中的引用
之前,我们在sql映射xml文件中的引用实体类时,需要写上实体类的全类名(包名+类名),如下:
<!-- 创建用户(Create) -->
<insert id="addUser" parameterType="me.gacl.domain.User">
insert into users(name,age) values(#{name},#{age})
</insert>
parameterType="me.gacl.domain.User"这里写的实体类User的全类名me.gacl.domain.User,每次都写这么一长串内容挺麻烦的,而我们希望能够简写成下面的形式
<insert id="addUser2" parameterType="_User">
insert into users(name,age) values(#{name},#{age})
</insert>
parameterType="_User"这样写就简单多了,为了达到这种效果,我们需要在conf.xml文件中为实体类=“me.gacl.domain.User"定义一个别名为”_User",具体做法如下:
在conf.xml文件中标签中添加如下配置:
<typeAliases>
<typeAlias type="me.gacl.domain.User" alias="_User"/>
</typeAliases>
这样就可以为me.gacl.domain.User类定义了一个别名为_User,以后_User就代表了me.gacl.domain.User类,这样sql映射xml文件中的凡是需要引用me.gacl.domain.User类的地方都可以使用_User来代替,这就达到了一个简化实体类引用的目的。
除了可以使用这种方式单独为某一个实体类设置别名之外,我们还可以使用如下的方式批量为某个包下的所有实体类设置别名,如下:
<!-- 配置实体类的别名,配置实体类别名的目的是为了在引用实体类时可以使用实体类的别名来代替实体类,达到简写的目的 -->
<typeAliases>
<!-- 为实体类me.gacl.domain.User配置一个别名_User -->
<!-- <typeAlias type="me.gacl.domain.User" alias="_User"/> -->
<!-- 为me.gacl.domain包下的所有实体类配置别名,MyBatis默认的设置别名的方式就是去除类所在的包后的简单的类名
比如me.gacl.domain.User这个实体类的别名就会被设置成User
-->
<package name="me.gacl.domain"/>
</typeAliases>
<package name="me.gacl.domain"/>就表示为这个包下面的所有实体类设置别名
MyBatis默认的设置别名的方式就是去除类所在的包后的简单的类名,比如me.gacl.domain.User这个实体类的别名就会被设置成User。
在平时的开发中,我们表中的字段名和表对应实体类的属性名称不一定都是完全相同的,下面来演示一下这种情况下的如何解决字段名与实体类属性名不相同的冲突。