在了解了 MyBatis 的一些基本知识后,通过查阅资料搭建 MyBatis 环境实现了对数据库数据进行增删改查操作的一个入门程序。
这里话不多说,直接上干货。
环境
- JDK1.7
- MySQL 5.5.50
- mybatis 3.3.0
注:MyBatis 下载地址
https://github.com/mybatis/mybatis-3/releases
需要的 jar 包
- MyBatis jar 包: mybatis-3.3.0.jar
- MySQL 驱动 jar 包: mysql-connector-java-xxx.jar
- 日志记录 jar 包: log4j-xxx.jar
项目结构
入门程序
1.数据库准备
程序使用的是 MySQL 数据库。
登录 MySQL 后新建一个数据库并取名 mybatis
。
创建表 user
,sql 代码如下:
create table user(
id int primary key auto_increment,
username varchar(20),
password varchar(20),
sex varchar(10),
address varchar(20));
2. 新建项目工程
(1)首先在 Eclipse 里新建一个动态 Web 工程(Dynamic Web Project),命名为 MyBatisTest
。
(2)将前面提到的三个 jar 包拷贝到工程的/WebContent/WEB-INF/lib/
目录下,如下:
3. 配置文件 mybatis.cfg.xml
在项目目录 /Java Resources/src
下新建 MyBatis 配置文件 mybatis.cfg.xml
,用来配置 Mybatis 的运行环境、数据源、事务等。
<?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运行环境 -->
<environments default="development">
<environment id="development">
<!-- type="JDBC" 代表直接使用 JDBC 的提交和回滚设置 -->
<transactionManager type="JDBC" />
<!-- POOLED 表示支持JDBC数据源连接池 -->
<!-- 数据库连接池,由 Mybatis 管理,数据库名是 mybatis,MySQL 用户名 root,密码为 root -->
<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="root" />
</dataSource>
</environment>
</environments>
</configuration>
4. 实体类 User
在包 com.gler.mybatis.model
下新建类 User.java , 一个用户具有:id、username、password、sex、address 五个属性。作为 mybatis 进行 sql 映射使用,与数据库表对应。
User 类的代码如下:
package com.gler.mybatis.model;
public class User {
private Integer id;
private String username;
private String password;
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 String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
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;
}
}
5.创建方法接口和定义映射文件
新建包 com.gler.mybatis.mapper
,并在包下新建方法接口 UserMapper.java ,提供简单的增删改查数据操作。
UserMapper 接口的代码如下:
package com.gler.mybatis.mapper;
import java.util.List;
import com.gler.mybatis.model.User;
public interface UserMapper {
/*
* 新增用戶
* @param user
* @return
* @throws Exception
*/
public int insertUser(User user) throws Exception;
/*
* 修改用戶
* @param user
* @param id
* @return
* @throws Exception
*/
public int updateUser(User user) throws Exception;
/*
* 刪除用戶
* @param id
* @return
* @throws Exception
*/
public int deleteUser(Integer id) throws Exception;
/*
* 根据id查询用户信息
* @param id
* @return
* @throws Exception
*/
public User selectUserById(Integer id) throws Exception;
/*
* 查询所有的用户信息
* @return
* @throws Exception
*/
public List<User> selectAllUser() throws Exception;
}
在包 com.gler.mybatis.mapper
下新建映射文件 UserMapper.xml
,用来定义各种 SQL 语句和这些语句的参数,以及要返回的类型等。
UserMapper.xml 的配置如下:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org/DTD Mapper 3.0" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.gler.mybatis.mapper.UserMapper">
<!-- 自定义返回结果集 -->
<resultMap id="userMap" type="User">
<id property="id" column="id" javaType="int"></id>
<result property="username" column="username" javaType="String"></result>
<result property="password" column="password" javaType="String"></result>
<result property="sex" column="sex" javaType="String"></result>
<result property="address" column="address" javaType="String"></result>
</resultMap>
<!-- 定义 SQL 语句,其中 id 需要和接口中的方法名一致 -->
<!-- useGeneratedKeys:实现自动生成主键 -->
<!-- keyProperty: 唯一标记一个属性 -->
<!-- parameterType 指明查询时使用的参数类型,resultType 指明查询返回的结果集类型 -->
<insert id="insertUser" useGeneratedKeys="true" keyProperty="id">
insert into user (username,password,sex,address) values
(#{username},#{password},#{sex},#{address})
</insert>
<update id="updateUser" parameterType="User">
update user set
address=#{address} where
id=#{id}
</update>
<delete id="deleteUser" parameterType="int">
delete from user where
id=#{id}
</delete>
<!-- 如未为 Java Bean 起类别名,resultType="com.gler.mybatis.model.User" -->
<!-- 使用resultType时,一定要保证,你属性名与字段名相同;如果不相同,就使用resultMap -->
<select id="selectUserById" parameterType="int" resultType="User">
select * from user where id=#{id}
</select>
<select id="selectAllUser" resultMap="userMap">
select * from user
</select>
</mapper>
UserMapper.xml 映射文件写好后,需要在 mybatis.cfg.xml 中加载它,在 mybatis.cfg.xml 中添加代码:
<mappers>
<!-- 通过 mapper 接口包加载整个包的映射文件 -->
<package name="com/gler/mybatis/mapper" />
</mappers>
同时为 Java Bean 起别名,在
<!-- 为JavaBean起类别名 -->
<typeAliases>
<!-- 指定一个包名起别名,将包内的 Java 类的类名作为类的类别名 -->
<package name="com.gler.mybatis.model" />
</typeAliases>
6.日志记录 log4j.properties
使用日志文件是为了查看控制台输出的 SQL 语句。
在项目目录 /Java Resources/src
下新建 MyBatis 日志记录文件
log4j.properties ,在里面添加如下内容:
# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# 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
7.测试类 UserTest
在包 com.gler.mybatis.test
下新建测试类 UserTest.java
,
用来测试数据的增删改查操作。
UserTest 类的代码如下:
package com.gler.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 com.gler.mybatis.mapper.UserMapper;
import com.gler.mybatis.model.User;
public class UserTest {
private static SqlSessionFactory sqlSessionFactory;
public static void main(String[] args) {
// Mybatis 配置文件
String resource = "mybatis.cfg.xml";
// 得到配置文件流
InputStream inputStream = null;
try {
inputStream = Resources.getResourceAsStream(resource);
} catch (IOException e) {
e.printStackTrace();
}
// 创建会话工厂,传入 MyBatis 的配置文件信息
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
insertUser();
// updateUser();
// deleteUser();
// selectUserById();
// selectAllUser();
}
// 新增用戶
private static void insertUser() {
// 通过工厂得到 SqlSession
SqlSession session = sqlSessionFactory.openSession();
UserMapper mapper = session.getMapper(UserMapper.class);
User user = new User();
user.setUsername("Tom");
user.setPassword("123456");
user.setSex("male");
user.setAddress("chengdu");
try {
mapper.insertUser(user);
session.commit();
} catch (Exception e) {
e.printStackTrace();
session.rollback();
}
// 释放资源
session.close();
}
// 更新用戶
private static void updateUser() {
SqlSession session = sqlSessionFactory.openSession();
UserMapper mapper = session.getMapper(UserMapper.class);
User user = null;
try {
user = mapper.selectUserById(1);
} catch (Exception e1) {
e1.printStackTrace();
}
user.setAddress("chongqing");
try {
mapper.updateUser(user);
session.commit();
} catch (Exception e) {
e.printStackTrace();
session.rollback();
}
session.close();
}
// 删除用戶
private static void deleteUser() {
SqlSession session = sqlSessionFactory.openSession();
UserMapper mapper = session.getMapper(UserMapper.class);
try {
mapper.deleteUser(3);
session.commit();
} catch (Exception e) {
e.printStackTrace();
session.rollback();
}
session.close();
}
// 根据id查询用户信息
private static void selectUserById() {
SqlSession session = sqlSessionFactory.openSession();
UserMapper mapper = session.getMapper(UserMapper.class);
try {
User user = mapper.selectUserById(1);
session.commit();
System.out.println(user.getId() + " " + user.getUsername() + " "
+ user.getPassword() + " " + user.getSex() + " "
+ user.getAddress());
} catch (Exception e) {
e.printStackTrace();
session.rollback();
}
session.close();
}
// 查询所有的用户信息
private static void selectAllUser() {
SqlSession session = sqlSessionFactory.openSession();
UserMapper mapper = session.getMapper(UserMapper.class);
try {
List<User> userList = mapper.selectAllUser();
session.commit();
for (User user : userList) {
System.out.println(user.getId() + " " + user.getUsername() + " "
+ user.getPassword() + " " + user.getSex() + " "
+ user.getAddress());
}
} catch (Exception e) {
e.printStackTrace();
session.rollback();
}
session.close();
}
}
8.运行测试
分别调用 UserTest 类中的增删改查方法。
结果如下:
(1) insertUser()
插入一条用户数据:
1)控制台输出
2)查看数据库
(2) updateUser()
将 id 为1的用户的 address 修改为 chongqing:
1)控制台输出
2)查看数据库
(3) deleteUser()
在进行测试之前,再往数据库表中插入两行用户记录。
insert into user(username,password,sex,address) values('Jack','13579','male','beijing');
insert into user(username,password,sex,address) values('Rose','24680','female','shanghai');
将 id 为3的用户删除:
1)控制台输出
2)查看数据库
(4) selectUserById()
查询 id 为1的用户信息:
(5) selectAllUser()
查询所有用户信息:
参考链接