MyBatis是主流的Java持久层框架之一,它与Hibernate一样,也是ORM(Object Relation Mapping)框架即对象关系映射。与Hibernate相比,它无疑更容易入手,虽然MyBatis需要程序员手动去写SQL语句,以及ResultMap,但是我个人是喜欢去自己把握这些细节。In short,两个框架各有好处,需要针对不同的业务场景去使用。
1. 环境搭建
我这里使用的是idea的编译器,它集成了maven。如果没有的话,去下一个插件就好。在搭建之前,我们需要下一个让开发更有效率的插件,如下:
我们新建一个Maven WEB项目,可参考这篇文章
创建完了之后,需要java与resource
配置一下pom.xml文件,pom.xml是maven项目对所有包进行管理用的。
打开pom.xml文件后,有一部分maven已经配置好了,我们只需要配置一部分。
<dependencies>
<!-- 导入mybatis坐标-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<!-- 导入mysql坐标-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.21</version>
</dependency>
<dependency>
<groupId>com.sun.jersey</groupId>
<artifactId>jersey-server</artifactId>
<version>1.9</version>
</dependency>
</dependencies>
另外在这里我踩过一个坑,我们需要还配置一项,稍后我会把这个坑给埋上
<!-- 在build中配置resources,来防止资源导出失败问题-->
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
准备数据
要用MyBatis,没数据怎么能行呢?
准备了两个表,一个用户表,一个订单表
DROP TABLE IF EXISTS `orders`;
CREATE TABLE `orders` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`user_id` int(11) NOT NULL COMMENT '下单用户id',
`number` varchar(32) NOT NULL COMMENT '订单号',
`createtime` datetime NOT NULL COMMENT '创建订单时间',
`note` varchar(100) DEFAULT NULL COMMENT '备注',
PRIMARY KEY (`id`),
KEY `FK_orders_1` (`user_id`),
CONSTRAINT `FK_orders_id` FOREIGN KEY (`user_id`) REFERENCES `user` (`id`) ON DELETE NO ACTION ON UPDATE NO ACTION
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of orders
-- ----------------------------
INSERT INTO `orders` VALUES ('3', '1', '1000010', '2021-02-04 13:22:35', null);
INSERT INTO `orders` VALUES ('4', '1', '1000011', '2021-02-03 13:22:41', null);
INSERT INTO `orders` VALUES ('5', '10', '1000012', '2021-02-12 16:13:23', null);
-- ----------------------------
-- Table structure for `user`
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`username` varchar(32) NOT NULL COMMENT '用户名称',
`birthday` date DEFAULT NULL COMMENT '生日',
`sex` char(1) DEFAULT NULL COMMENT '性别',
`address` varchar(256) DEFAULT NULL COMMENT '地址',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=27 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES ('1', '王五', null, '2', null);
INSERT INTO `user` VALUES ('10', '张三', '2014-07-10', '1', '北京市');
INSERT INTO `user` VALUES ('16', '张小明', null, '1', '河南郑州');
INSERT INTO `user` VALUES ('22', '陈小明', null, '1', '河南郑州');
INSERT INTO `user` VALUES ('24', '张三丰', null, '1', '河南郑州');
INSERT INTO `user` VALUES ('25', '陈小明', null, '1', '河南郑州');
INSERT INTO `user` VALUES ('26', '王五', null, null, null);
2.创建POJO类
What is POJO?
我理解POJO: POJO是一个简单的、普通Java对象,它包含业务逻辑处理或持久化逻辑等,但不是JavaBean、EntityBean等,不具有任何特殊角色,不继承或不实现任何其它Java框架的类或接口
上面下载的插件可以帮助你生成POJO、Mapper
但是我这里还是手动去写一下
user
package cn.hy.pojo;
import java.io.Serializable;
import java.util.Date;
public class User implements Serializable {
/**
*
*/
private static final long serialVersionUID = 1L;
private Integer id;
private String username;// 用户姓名
private String sex;// 性别
private Date birthday;// 生日
private String address;// 地址
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 String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public Date getBirthday() {
return birthday;
}
public void setBirthday(Date birthday) {
this.birthday = birthday;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", sex=" + sex
+ ", birthday=" + birthday + ", address=" + address + "]";
}
}
order
package cn.hy.pojo;
import java.io.Serializable;
import java.util.Date;
public class Orders implements Serializable{
/**
*
*/
private static final long serialVersionUID = 1L;
private Integer id;
private Integer userId;
private String number;
private Date createtime;
private String note;
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public Integer getUserId() {
return userId;
}
public void setUserId(Integer userId) {
this.userId = userId;
}
public String getNumber() {
return number;
}
public void setNumber(String number) {
this.number = number == null ? null : number.trim();
}
public Date getCreatetime() {
return createtime;
}
public void setCreatetime(Date createtime) {
this.createtime = createtime;
}
public String getNote() {
return note;
}
public void setNote(String note) {
this.note = note == null ? null : note.trim();
}
}
3. 在dao层创建接口与映射文件
这里的业务是简单的增删改查
import cn.hy.pojo.User;
import java.util.List;
public interface UserMapper {
//mapper动态代理开发的四个原则
// 1. 接口方法名==xml中的id名
// 2. 返回值类型与xml中返回值要一致
// 3. 方法的参数类型与xml中参数类型一致
// 4. 命名空间绑定此接口
List<User> getAllUser();
User findUserById();
//基于名字模糊查询
List<User> getUserByUsername();
//添加用户
int insertUser(User u);
//修改用户
int updateUser(User u);
//删除用户
int deleteUserById(Integer id);
}
映射文件
<mapper namespace="cn.hy.dao.UserMapper">
<!--添加用户 ,用于返回主键 -->
<!-- 配置了别名,使用parameterType可以写别名 -->
<insert id="insertUser" parameterType="user">
<selectKey keyProperty="id" resultType="integer" order="AFTER">
select LAST_INSERT_ID()
</selectKey>
insert into user (username,birthday,address,sex)
values (#{username},#{birthday},#{address},#{sex})
</insert>
<!-- 修改用户 -->
<update id="updateUser" parameterType="cn.hy.pojo.User">
update user
set username=#{username},sex=#{sex},birthday=#{birthday},address=#{address}
where id=#{id}
</update>
<!-- 删除用户 -->
<delete id="deleteUserById" parameterType="Integer">
delete from user
where id=#{id}
</delete>
<!--查询所有的user -->
<select id="getAllUser" resultType="cn.hy.pojo.User">
select * from user
</select>
<!--
#{} select * from user where id = ? 占位符? == '五'
${} select * from user where username like '%五%' 字符串拼接
-->
<!--通过ID查询一个用户 -->
<select id="findUserById" resultType="cn.hy.pojo.User" parameterType="integer">
select * from user where id=#{v}
</select>
<select id="getUserByUsername" resultType="cn.hy.pojo.User" parameterType="string">
select * from user where username like '%${value}%'
</select>
</mapper>
其实这些插件是可以自动生成的,不过第一次嘛,还是了解一下流程好。而且使用插件后,可以实现接口与映射的跳转
4.创建MyBatis的核心配置文件
把配置文件mybatis-config.xml放在rescoure下
介绍一下重要的属性
properties: 可以使用db.properties配置文件去连接数据库,同样把db.properties也放在rescoure下
**typeAliases:**可以使用别名去加载,如添加用户的方法就是使用了别名
mapper: 管理mapper映射文件
<?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>
<!-- 顺序不可乱 -->
<properties resource="db.properties"/>
<!--别名 package可以配置子包下所有类 头字母大小写都可-->
<typeAliases>
<typeAlias type="cn.hy.pojo.User" alias="user" />
</typeAliases>
<!--spring框架下environments将不再使用 -->
<environments default="development">
<environment id="development">
<!--使用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>
<!-- mapper的位置 -->
<mappers>
<mapper resource="cn/hy/dao/UserMapper.xml"/>
</mappers>
</configuration>
5.测试
创建一个测试类
测试getAllUser与getUserByUsername
@Test
public void fun1() throws Exception{
//加载核心配置文件
InputStream config= Resources.getResourceAsStream("mybatis-config.xml");
//创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(config);
//创建SqlSession
SqlSession sqlSession=sqlSessionFactory.openSession();
//执行sql语句
User u=sqlSession.selectOne("cn.hy.dao.UserMapper.findUserById",1);
System.err.println(u);
//测试第二种
List<User> users=sqlSession.selectList("cn.hy.dao.UserMapper.getAllUser");
for(User user:users){
System.err.println(user);
}
//测试模糊查询
List<User> users2=sqlSession.selectList("cn.hy.dao.UserMapper.getUserByUsername","五");
for(User user3:users2){
System.err.println(user3);
}
}
如果每次测试。我们都要去加载配置事实上是很浪费的
所有可以利用junit的before去每这些重复加载放在before中
public SqlSessionFactory sqlSessionFactory;
@Before
public void before() throws Exception{
//加载核心配置文件
InputStream config= Resources.getResourceAsStream("mybatis-config.xml");
//创建SqlSessionFactory
sqlSessionFactory=new SqlSessionFactoryBuilder().build(config);
}
测试添加用户
/**
* 添加用户
* @throws Exception
*/
@Test
public void fun2() throws Exception{
// //加载核心配置文件
// InputStream config= Resources.getResourceAsStream("mybatis-config.xml");
// //创建SqlSessionFactory
// SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(config);
//创建SqlSession
SqlSession sqlSession=sqlSessionFactory.openSession();
//执行sql语句
User u=new User();
u.setUsername("小JJ");
u.setBirthday(new Date());
u.setAddress("wsasa");
u.setSex("男");
int i=sqlSession.insert("cn.hy.dao.UserMapper.insertUser",u);
sqlSession.commit();
System.err.println(u.getId());
}
测试修改
/**
* 修改用户
* @throws Exception
*/
@Test
public void fun3() throws Exception{
// //加载核心配置文件
// InputStream config= Resources.getResourceAsStream("mybatis-config.xml");
// //创建SqlSessionFactory
// SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(config);
//创建SqlSession
SqlSession sqlSession=sqlSessionFactory.openSession();
//执行sql语句
User u=new User();
u.setId(31);
u.setUsername("小Zsds");
u.setBirthday(new Date());
u.setAddress("wsasaWQ");
u.setSex("女");
int i=sqlSession.update("cn.hy.dao.UserMapper.updateUser",u);
sqlSession.commit();
}
测试删除
/**
* 删除用户
* @throws Exception
*/
@Test
public void fun4() throws Exception{
// //加载核心配置文件
// InputStream config= Resources.getResourceAsStream("mybatis-config.xml");
// //创建SqlSessionFactory
// SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(config);
//创建SqlSession
SqlSession sqlSession=sqlSessionFactory.openSession();
// //执行sql语句
int i=sqlSession.delete("cn.hy.dao.UserMapper.deleteUserById",27);
sqlSession.commit();
}