MyBatis入门案例
什么是 MyBatis
MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。(摘抄官网)
准备工作
创建一个数据库,自己可以随便创建,我创建的是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=3 DEFAULT CHARSET=utf8;
搭建maven工程
pom文件导入坐标
<dependencies>
<!--mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.3</version>
</dependency>
<!-- 数据库连接-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!--单元测试-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<!--日志-->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
</dependencies>
创建实体类User和dao接口
User.java:
public class User {
private Integer id;
private String username;
private Date birthday;
private String sex;
private String address;
//此处我省略了getXXX(),setXXX(),toString()方法
}
dao层的UserMapper接口:
public interface UserMapper {
/***
* @Description 查询所有
* @Param: []
* @return: java.util.List<com.zy.domin.User>
* @Date: 2021/2/22
*/
List<User> findAll();
}
创建SqlMapConfig.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">
<!-- 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/mybatis"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!-- 指定映射配置文件的位置,映射配置文件指的是每个dao独立的配置文件 -->
<mappers>
<mapper resource="com/zy/dao/UserMapper.xml"/>
</mappers>
</configuration>
创建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="com.zy.dao.UserMapper">
<!--查询所有-->
<select id="findAll" resultType="com.zy.domin.User">
select * from user
</select>
</mapper>
这里有几个注意点:namespace="com.zy.dao.UserMapper"写的是dao层接口的全限定类明。select标签中的id一般写的都是接口中的方法名。
测试类
public class MybatisTest {
public static void main(String[] args) throws Exception {
//读取SqlMapConfig.xml配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//创建SqlSessionFactory工厂
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
SqlSessionFactory build = builder.build(in);
//使用工厂生产SqlSession
SqlSession session = build.openSession();
//使用SqlSession创建dao接口代理对象
UserMapper userDao = session.getMapper(UserMapper.class);
//使用代理对象执行方法
List<User> users = userDao.findAll();
//循环遍历打印
for (User user : users){
System.out.println(user);
}
}
}
运行结果:
注解方式
我们只需要修改SqlMapConfig.xml配置文件中的mappers标签中的
<?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/mybatis"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!-- 告知 mybatis 映射配置的位置 -->
<mappers>
<mapper class="com.zy.dao.UserMapper"></mapper>
</mappers>
</configuration>
在接口文件中的方法上添加注解
public interface UserMapper {
/***
* @Description 查询所有
* @Param: []
* @return: java.util.List<com.zy.domin.User>
* @Date: 2021/2/22
*/
@Select("select * from user")
List<User> findAll();
}
使用注解开发我们就不需要UserMapper.xml文件了,此时我们需要把该文件移除。测试代码和上面是一样的。
加油吧!!!