MyBatis02_快速入门
本教程源码请访问:tutorial_demo
通过前面的学习我们已经对 MyBatis 有了一个简单的了解,学习框架最终的目的是做项目,既然是做项目,那么一切都要以代码落地。 下面我们就开启 MyBatis 的学习。项目的结构,后面有图片展示,建议大家详细的把这篇教程浏览一遍再去动手做。
一、搭建MyBatis开发环境
1.1、建库建表
DROP DATABASE IF EXISTS mybatisdb;
CREATE DATABASE mybatisdb;
USE mybatisdb;
-- ----------------------------
-- 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 datetime DEFAULT NULL COMMENT '生日',
sex char(1) DEFAULT NULL COMMENT '性别',
address varchar(256) DEFAULT NULL COMMENT '地址',
PRIMARY KEY (id)
) ENGINE=InnoDB AUTO_INCREMENT=56 DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO user VALUES ('41', '王一', '2011-12-27 17:47:08', '男', '北京');
INSERT INTO user VALUES ('42', '王二', '2011-03-12 15:09:37', '女', '上海');
INSERT INTO user VALUES ('43', '老李', '2012-03-14 11:34:34', '女', '天津');
INSERT INTO user VALUES ('45', 'Max', '2010-05-04 12:04:06', '男', '西宁');
INSERT INTO user VALUES ('46', '老王', '1999-08-07 17:37:26', '女', '拉萨');
INSERT INTO user VALUES ('48', 'John', '1990-01-08 11:44:00', '女', '广州');
INSERT INTO user VALUES ('50', 'Lucy', '2008-12-03 20:09:32', 'm', '哈尔滨');
DROP TABLE IF EXISTS account;
CREATE TABLE account (
ID int(11) NOT NULL COMMENT '编号',
UID int(11) DEFAULT NULL COMMENT '用户编号',
MONEY double DEFAULT NULL COMMENT '金额',
PRIMARY KEY (ID),
KEY FK_Reference_8 (UID),
CONSTRAINT FK_Reference_8 FOREIGN KEY (UID) REFERENCES user (id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of account
-- ----------------------------
INSERT INTO account VALUES ('1', '41', '1000');
INSERT INTO account VALUES ('2', '45', '1000');
INSERT INTO account VALUES ('3', '41', '2000');
-- ----------------------------
-- Table structure for role
-- ----------------------------
DROP TABLE IF EXISTS role;
CREATE TABLE role (
ID int(11) NOT NULL COMMENT '编号',
ROLE_NAME varchar(30) DEFAULT NULL COMMENT '角色名称',
ROLE_DESC varchar(60) DEFAULT NULL COMMENT '角色描述',
PRIMARY KEY (ID)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of role
-- ----------------------------
INSERT INTO role VALUES ('1', '院长', '管理整个学院');
INSERT INTO role VALUES ('2', '总裁', '管理整个公司');
INSERT INTO role VALUES ('3', '校长', '管理整个学校');
-- ----------------------------
-- Table structure for user_role
-- ----------------------------
DROP TABLE IF EXISTS user_role;
CREATE TABLE user_role (
UID int(11) NOT NULL COMMENT '用户编号',
RID int(11) NOT NULL COMMENT '角色编号',
PRIMARY KEY (UID,RID),
KEY FK_Reference_10 (RID),
CONSTRAINT FK_Reference_10 FOREIGN KEY (RID) REFERENCES role (ID),
CONSTRAINT FK_Reference_9 FOREIGN KEY (UID) REFERENCES user (id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
-- ----------------------------
-- Records of user_role
-- ----------------------------
INSERT INTO user_role VALUES ('41', '1');
INSERT INTO user_role VALUES ('45', '1');
INSERT INTO user_role VALUES ('41', '2');
这里我使用的是MySQL5.6,创建了四张表user表、account表、role表、user_role表,后面几篇文章涉及的操作也是在这个数据库基础之上进行。
1.2、创建Maven工程并添加相关坐标
- 在Idea中新建Maven工程;
- 工程创建完成后添加相应的坐标;
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.codeaction</groupId>
<artifactId>mybatis</artifactId>
<version>1.0-SNAPSHOT</version>
<!-- 打包方式 -->
<packaging>jar</packaging>
<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>5.1.47</version>
</dependency>
<!-- log4j -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<!-- junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
1.3、编写User实体类
目前只对User表进行操作,我们暂时只创建对应的实体类User即可,这个类在org.codeaction.domain包下,不要忘记创建相应的包。
package org.codeaction.domain;
import java.io.Serializable;
import java.util.Date;
public class User implements Serializable {
private Integer id;
private String username;
private Date birthday;
private String sex;
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 Date getBirthday() {
return birthday;
}
public void setBirthday(Date birthday) {
this.birthday = birthday;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", username='" + username + '\'' +
", birthday=" + birthday +
", sex='" + sex + '\'' +
", address='" + address + '\'' +
'}';
}
}
1.4、编写持久层接口IUserDao
IUserDao是持久层接口,在org.codeaction.dao包下。
package org.codeaction.dao;
import org.codeaction.domain.User;
import java.util.List;
public interface IUserDao {
//查询所有User
List<User> findAll();
}
1.5、编写持久层接口的映射文件
- 创建位置:必须和持久层接口在相同的包中,在resources目录下依次创建org、codeaction、dao三个文件夹,具体目录关系请看后面的截图;
- 名称:必须和持久层接口文件名(.之前的内容)相同,扩展名是.xml;
- 作用:用来生成持久层接口IUserDao的代理对象,其实就是之前学习JavaWeb时Dao接口的实现类。有了这个配置文件,我们就不用自己写Dao的实现类了,MyBatis会使用代理的方式自动为我们生成。
<?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="org.codeaction.dao.IUserDao">
<!-- 配置查询所有 -->
<select id="findAll" resultType="org.codeaction.domain.User">
select * from user
</select>
</mapper>
1.6、编写主配置文件SqlMapConfig.xml配置
- 创建位置:resource根目录下;
- 作用:创建数据源连接池,加载接口的映射文件,当然还有其它作用,后面的文章还会讲到。
<?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">
<!-- mybatis的主配置文件 -->
<configuration>
<!-- 配置环境 -->
<environments default="mysql">
<!-- 配置mysql的环境 -->
<environment id="mysql">
<!-- 配置事务的类型 -->
<transactionManager type="JDBC"></transactionManager>
<!-- 配置数据源连接池-->
<dataSource type="POOLED">
<!-- 配置连接数据库的4个基本信息 -->
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatisdb"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!-- 指定映射配置文件的位置,映射配置文件指的是每个dao独立的配置文件 -->
<mappers>
<mapper resource="org/codeaction/dao/IUserDao.xml"/>
</mappers>
</configuration>
1.7、编写测试类
在resource目录下创建log4j.properties文件,用于配置log4j。
# Set root category priority to INFO and its only appender to CONSOLE.
#log4j.rootCategory=INFO, CONSOLE debug info warn error fatal
log4j.rootCategory=debug, CONSOLE, LOGFILE
# Set the enterprise logger category to FATAL and its only appender to CONSOLE.
log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE
# CONSOLE is set to be a ConsoleAppender using a PatternLayout.
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n
# LOGFILE is set to be a File appender using a PatternLayout.
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=d:\mybatis.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n
测试类内容如下,注意所在的包。
package org.codeaction.test;
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.codeaction.dao.IUserDao;
import org.codeaction.domain.User;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.sql.*;
import java.util.List;
public class MyBatisTest {
public static void main(String[] args) throws IOException {
//1.读取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.创建SqlSessionFactory工厂
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory factory = builder.build(in);
//3.使用工厂生产SqlSession对象
SqlSession session = factory.openSession();
//4.使用SqlSession创建Dao接口的代理对象
IUserDao userDao = session.getMapper(IUserDao.class);
//5.使用代理对象执行方法
List<User> list = userDao.findAll();
list.forEach(System.out::println);
//6.释放资源
session.close();
in.close();
}
}
以上就是入门案例涉及的代码,具体的工程结构如下图所示,大家按照这个图把相应的包建好并创建相应的文件。
运行main方法测试,如果控制台出现如下的信息,说明测试成功
User{id=41, username='王一', birthday=Tue Dec 27 17:47:08 CST 2011, sex='男', address='北京'}
User{id=42, username='王二', birthday=Sat Mar 12 15:09:37 CST 2011, sex='女', address='上海'}
User{id=43, username='老李', birthday=Wed Mar 14 11:34:34 CST 2012, sex='女', address='天津'}
User{id=45, username='Max', birthday=Tue May 04 12:04:06 CST 2010, sex='男', address='西宁'}
User{id=46, username='老王', birthday=Sat Aug 07 17:37:26 CST 1999, sex='女', address='拉萨'}
User{id=48, username='John', birthday=Mon Jan 08 11:44:00 CST 1990, sex='女', address='广州'}
User{id=50, username='Lucy', birthday=Wed Dec 03 20:09:32 CST 2008, sex='m', address='哈尔滨'}
1.8、环境搭建注意事项
- 创建IUserDao.xml 和 IUserDao.java时名称是为了和我们之前的知识保持一致。在Mybatis中它把持久层的操作接口名称和映射文件也叫做:Mapper,所以:IUserDao 和 IUserMapper是一样的;
- 在idea中创建目录的时候,它和包是不一样的,包在创建时:org.codeaction.dao它是三级结构,目录在创建时:org.codeaction.dao是一级目录,所以在“编写持久层接口的映射文件”这一步中,目录要分三次依次创建;
- mybatis的映射配置文件位置必须和dao接口的包结构相同;
- 映射配置文件的mapper标签namespace属性的取值必须是dao接口的全限定类名;
- 映射配置文件的操作配置(select),id属性的取值必须是dao接口的方法名。
当我们遵从了第3、4、5点之后,我们在开发中就无须再写dao的实现类。我们在实际开发中,都是越简便越好,所以都是采用不写dao实现类的方式,不管使用XML还是注解配置(下面讲)。但是Mybatis它是支持写dao实现类的,这里就不给大家展开了。
二、基于注解的MyBatis的使用
2.1、在持久层接口IUserDao中添加注解
package org.codeaction.dao;
import org.apache.ibatis.annotations.Select;
import org.codeaction.domain.User;
import java.util.List;
public interface IUserDao {
@Select("select * from user")
List<User> findAll();
}
2.2、修改SqlMapConfig.xml
<mappers>
<!-- 告知 mybatis 映射配置的位置, 注意这里是class -->
<mapper class="org.codeaction.dao.IUserDao" />
</mappers>
2.3、注意事项
在使用注解配置MyBatis时,接口的映射配置文件就不用配置了。
微信公众号:CodeAction
Github:https://github.com/codeaction