在创建项目之前,首先在 MySQL 数据库中创建 mybatis 数据库和 user 表,sql 语句如下所示:
CREATE DATABASE mybatis;
USE mybatis;
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` tinyint(2) NOT NULL,
`username` varchar(20) DEFAULT NULL,
`password` varchar(10) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
下面通过一个实例讲解如何使用 Eclipse 开发 MyBatis 入门程序。
1)创建 Web 应用,并添加相关 JAR 包
在 MyEclipse 中创建一个名为 myBatisDemo01 的 Web 应用,将 MyBatis 的核心 JAR 包、依赖 JAR 包以及 MySQL 数据库的驱动 JAR 包一起复制到 /WEB-INF/lib 目录下。添加后的 lib 目录如图 1 所示。
2)创建日志文件
MyBatis 默认使用 log4j 输出日志信息,如果开发者需要查看控制台输出的 SQL 语句,那么需要在 classpath 路径下配置其日志文件。在 myBatis应用的 src 目录下创建 log4j.properties 文件,其内容如下:
# Global logging configuration
log4j.rootLogger=ERROR,stdout
# MyBatis logging configuration...
log4j.logger.com.mybatis=DEBUG
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
在日志文件中配置了全局的日志配置、MyBatis 的日志配置和控制台输出,其中 MyBatis 的日志配置用于将 com.mybatis 包下所有类的日志记录级别设置为 DEBUG。该配置文件内容不需要开发者全部手写,可以从 MyBatis 使用手册中的 Logging 小节复制,然后进行简单修改。
3)创建持久化类
在 src 目录下创建一个名为 com.mybatis.po 的包,在该包中创建持久化类 User,注意在类中声明的属性与数据表 user 的字段一致。
User 的代码如下:
package com.mybatis.po;
public class User {
private Integer id;
private String username;
private String password;
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 getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", password=" + password + "]";
}
}
4)创建映射文件
在 src 目录下创建一个名为 com.mybatis.mapper 的包,在该包中创建映射文件 UserMapper.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="com.mybatis.mapper.UserMapper">
<!-- 根据uid查询一个用户信息 -->
<select id="selectUserById" parameterType="Integer"
resultType="com.mybatis.po.User">
select * from user where id = #{id}
</select>
<!-- 查询所有用户信息 -->
<select id="selectAllUser" resultType="com.mybatis.po.User">
select * from user
</select>
<!-- 添加一个用户,#{username}为 com.mybatis.po.User 的属性值 -->
<insert id="addUser" parameterType="com.mybatis.po.User">
insert into user (username,password)
values(#{username},#{password})
</insert>
<!--修改一个用户 -->
<update id="updateUser" parameterType="com.mybatis.po.User">
update user set username =
#{username},password = #{password} where id = #{id}
</update>
<!-- 删除一个用户 -->
<delete id="deleteUser" parameterType="Integer">
delete from user where id
= #{id}
</delete>
</mapper>
在上述映射文件中, 元素是配置文件的根元素,它包含了一个 namespace 属性,该属性值通常设置为“包名+SQL映射文件名”,指定了唯一的命名空间。
子元素 、、 以及 中的信息是用于执行查询、添加、修改以及删除操作的配置。在定义的 SQL 语句中,“#{}”表示一个占位符,相当于“?”,而“#{uid}”表示该占位符待接收参数的名称为 uid。
5)创建 MyBatis 的配置文件
在 src 目录下创建 MyBatis 的核心配置文件 mybatis-config.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>
<settings>
<setting name="logImpl" value="LOG4J" />
</settings>
<!-- 配置mybatis运行环境 -->
<environments default="development">
<environment id="development">
<!-- 使用JDBC的事务管理 -->
<transactionManager type="JDBC" />
<dataSource type="POOLED">
<!-- MySQL数据库驱动 -->
<property name="driver" value="com.mysql.cj.jdbc.Driver" />
<!-- 连接数据库的URL -->
<property name="url"
value="jdbc:mysql:///mybatis?serverTimezone=Asia/Shanghai&useSSL=true" />
<property name="username" value="root" />
<property name="password" value="root" />
</dataSource>
</environment>
</environments>
<!-- 将mapper文件加入到配置文件中 -->
<mappers>
<mapper resource="com/mybatis/mapper/UserMapper.xml" />
</mappers>
</configuration>
上述映射文件和配置文件都不需要读者完全手动编写,都可以从 MyBatis 使用手册中复制,然后做简单修改。
6)创建测试类
在 src 目录下创建一个名为 com.mybatis.test 的包,在该包中创建 MyBatisTest 测试类。在测试类中首先使用输入流读取配置文件,然后根据配置信息构建 SqlSessionFactory 对象。
接下来通过 SqlSessionFactory 对象创建 SqlSession 对象,并使用 SqlSession 对象的方法执行数据库操作。 MyBatisTest 测试类的代码如下:
package com.mybatis.test;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
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.mybatis.po.User;
public class MyBatisTest {
@Test
public void test() throws IOException {
// 读取配置文件 mybatis-config.xml
InputStream inputStream=Resources.getResourceAsStream("mybatis-config.xml");
// 根据配置文件构建SqlSessionFactory
SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);
// 通过 SqlSessionFactory 创建 SqlSession
SqlSession sqlSession=sqlSessionFactory.openSession();
// SqlSession执行映射文件中定义的SQL,并返回映射结果
//添加一个用户
User addUser=new User();
addUser.setUsername("addUserName");
addUser.setPassword("addUserPassword");
sqlSession.insert("com.mybatis.mapper.UserMapper.addUser",addUser);
/*
* com.mybatis.mapper.UserMapper.selectUserById 为 UserMapper.xml
* 中的命名空间+select 的 id
*/
// 查询id=5的一个用户
User user=sqlSession.selectOne("com.mybatis.mapper.UserMapper.selectUserById", 1);
System.out.println(user);
// 修改一个用户
User updatemu = new User();
updatemu.setId(7);
updatemu.setUsername("张三");
updatemu.setPassword("zhangsan");
sqlSession.update("com.mybatis.mapper.UserMapper.updateUser", updatemu);
// 删除一个用户
sqlSession.delete("com.mybatis.mapper.UserMapper.deleteUser", 4);
// 查询所有用户
List<User> listMu = sqlSession
.selectList("com.mybatis.mapper.UserMapper.selectAllUser");
for (User myUser : listMu) {
System.out.println(myUser);
}
// 提交事务
sqlSession.commit();
// 关闭 SqlSession
sqlSession.close();
}
}
上述测试类的运行结果如图 所示。