MyBatis开发DAO
Mybatis在项目中主要使用的地方就是开发dao(数据访问层),所以下面讲解一下mybatis开发dao的方法。有两种方式:原始dao开发方式、mapper代理开发方式(推荐)
一、原始DAO开发
程序员需要写dao接口和dao实现类。
根据需求创建po类
编写全局配置文件
根据需求编写映射文件
加载映射文件
编写dao接口
编写dao实现类
编写测试代码
1.PO实现类
package com.cjw.mybatis.po;
import java.util.Date;
public class User {
private int id;
private String username;// 用户姓名
private String sex;// 性别
private Date birthday;// 生日
private String address;// 地址
public int getId() {
return id;
}
public void setId(int 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 + "]";
}
}
2.编写全局配置文件: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">
<configuration>
<!-- 配置mybatis的环境信息 -->
<environments default="development">
<environment id="development">
<!-- 配置JDBC事务控制,由mybatis进行管理 -->
<transactionManager type="JDBC"></transactionManager>
<!-- 配置数据源,采用mybatis连接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value=
"jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<!-- 加载映射文件 -->
<mappers>
<mapper resource="User.xml"/>
</mappers>
</configuration>
3.编写映射文件:User.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">
<!--
namespace:命名空间,它的作用就是对SQL进行分类化管理,可以理解为SQL隔离
注意:使用mapper代理开发时,namespace有特殊且重要的作用
-->
<mapper namespace="test">
<!-- 根据用户ID,查询用户信息 -->
<!--
[id]:statement的id,要求在命名空间内唯一
[parameterType]:入参的java类型
[resultType]:查询出的单条结果集对应的java类型
[#{}]: 表示一个占位符?
[#{id}]:表示该占位符待接收参数的名称为id。注意:如果参数为简单类型时,#{}里面的参数名称可以是任意定义
-->
<select id="findUserById" parameterType="int" resultType="com.cjw.mybatis.po.User">
SELECT * FROM USER WHERE id=#{id}
</select>
<!-- 根据用户名称模糊查询用户列表 -->
<!-- ${}:表示一个sql的连接符 -->
<!-- ${value}:里面的value表示输入参数的参数名称,如果该参数是简单类型,那么${}里面的参数名称必须是value -->
<!-- ${}这种写法存在sql注入的风险,所以要慎用!!但是在一些场景下,必须使用${},比如排序时,动态传入排序的列名,${}会原样输出,不加解释 -->
<select id="findUserByName" parameterType="java.lang.String" resultType="com.cjw.mybatis.po.User">
SELECT * FROM USER WHERE username LIKE '%${value}%'
</select>
<!-- 添加用户 主键返回之MySQL自增主键 -->
<!-- selectKey:查询主键,在标签内需要输入查询主键的sql -->
<!-- keyProperty:指定存放生成主键的属性 -->
<!-- resultType:生成主键所对应的Java类型 -->
<!-- order:指定查询主键的sql和insert语句的执行顺序,相当于insert语句来说 -->
<!-- LAST_INSERT_ID:该函数是mysql的函数,获取自增主键的ID,它必须配合insert语句一起使用 -->
<insert id="insertUser" parameterType="com.cjw.mybatis.po.User">
<selectKey keyProperty="id" resultType="int" order="AFTER">
SELECT LAST_INSERT_ID()
</selectKey>
INSERT INTO USER
(username,birthday,sex,address)
VALUES(#{username},#{birthday},#{sex},#{address})
</insert>
<!-- 扩展 -->
<!-- 添加用户 自增主键之UUID -->
<!--
order="BEFORE":只要主键不是自增,order都设置为BEFORE
#{id}:需要显式的给id赋值,因为该id的值不是通过自增主键来创建的
-->
<insert id="insertUser2" parameterType="com.cjw.mybatis.po.User">
<selectKey keyProperty="id" resultType="string" order="BEFORE">
SELECT UUID()
</selectKey>
INSERT INTO USER
(id,username,birthday,sex,address)
VALUES(#{id},#{username},#{birthday},#{sex},#{address})
</insert>
<!-- 扩展 -->
<!-- 添加用户之sequence返回 -->
<!--
通过Oracle的sequence获取主键方式与MySQL的uuid方式基本一致
order="BEFORE":只要主键不是自增,order都设置为BEFORE
#{id}:需要显式的给id赋值,因为该id的值不是通过自增主键来创建的
-->
<insert id="insertUser3" parameterType="com.cjw.mybatis.po.User">
<selectKey keyProperty="id" resultType="int" order="BEFORE">
SELECT seq.nextval FROM dual
</selectKey>
INSERT INTO USER
(id,username,birthday,sex,address)
VALUES(#{id},#{username},#{birthday},#{sex},#{address})
</insert>
<!-- 根据ID删除用户 -->
<delete id="deleteUser" parameterType="int">
DELETE FROM USER WHERE id= #{id}
</delete>
<!-- 根据传入的用户信息修改用户 -->
<update id="updateUser" parameterType="com.cjw.mybatis.po.User">
UPDATE USER SET username = #{username},sex=#{sex} WHERE id=#{id}
</update>
</mapper>
4. 编写dao接口
public interface UserDao {
//1、根据用户ID来查询用户信息;
public User findUserById(int id) throws Exception;
//2、根据用户名称来模糊查询用户信息列表;
public List<User> findUserByName(String name) throws Exception;
//3、添加用户;
public void insertUser(User user) throws Exception;
}
5.编写dao实现类
SqlSession使用范围
通过入门程序,大家可以看出,在测试代码中,有大量的重复代码。所以我们第一反应就是想给它抽取出共性的部分,但是SqlSession、SqlSessionFactory、SqlSessionFactoryBuilder有着各自的生命周期,因为这些生命周期的不同,抽取时要有针对性的处理。
所以在抽取之前,我们先来了解并总结下它们三个的生命周期。
SqlSessionFactoryBuilder
它的作用只是通过配置文件创建SqlSessionFactory,所以只要创建出SqlSessionFactory,它就可以销毁了。所以说,它的生命周期是在方法之内。
SqlSessionFactory
它的作用是创建SqlSession的工厂,工厂一旦创建,除非应用停掉,不要销毁。
所以说它的生命周期是在应用范围内。这里可以通过单例模式来管理它。
在mybatis整合spring之后,最好的处理方式是把SqlSessionFactory交由spring来做单例管理。
SqlSession
SqlSession是一个面向用户(程序员)的接口,它的默认实现是DefaultSqlSession。
Mybatis是通过SqlSession来操作数据库的。SqlSession中不仅包含要处理的SQL信息,还包括一些数据信息,
/**
* 原始Dao开发方式
* @author DreamWF
*
*/
public class UserDaoImpl implements UserDao {
/**
* 依赖注入需要向dao实现类中注入SqlSessionFactory,
* 在方法体内通过SqlSessionFactory创建SqlSession要注意SqlSession和SqlSessionFactory的生命周期。
*/
private SqlSessionFactory sqlSessionFactory;
public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
this.sqlSessionFactory=sqlSessionFactory;
}
/**
* 通过id查找用户
*/
@Override
public User findUserById(int id) throws Exception {
// 创建SqlSession 通过工厂,在方法内部获取SqlSession,这样就可以避免线程不安全
SqlSession sqlSession = sqlSessionFactory.openSession();
// 调用SQLSession增删改查方法
// 参数1:表示statement的唯一标识
// 参数2:入参的值,它的类型要和映射文件中对应的statement的入参类型一致
User user = sqlSession.selectOne("test.findUserById", id);
System.out.println(user);
// 关闭资源
sqlSession.close();
return user;
}
@Override
public List<User> findUserByName(String name) {
// 创建SqlSession 通过工厂,在方法内部获取SqlSession,这样就可以避免线程不安全
SqlSession sqlSession=sqlSessionFactory.openSession();
// 4、SqlSession执行statement,并返回映射结果
// 第一个参数:statement的id,建议:namespace.statementId(确保唯一)
// 第二个参数:入参的值,它的类型要和映射文件中对应的statement的入参类型一致
List<User> list=sqlSession.selectList("test.findUserByName",name);
System.out.println(list);
//关闭资源
sqlSession.close();
return list;
}
@Override
public void insertUser(User user) {
// 创建SqlSession 通过工厂,在方法内部获取SqlSession,这样就可以避免线程不安全
SqlSession sqlSession = sqlSessionFactory.openSession();
// 调用SqlSession的增删改查方法
// 第一个参数:表示statement的唯一标示
sqlSession.insert("test.insertUser", user);
System.out.println(user.getId());
// 提交事务
sqlSession.commit();
// 关闭资源
sqlSession.close();
}
}
6.问题总结:
存在一定量的模板代码。比如:通过SqlSessionFactory创建SqlSession;调用SqlSession的方法操作数据库;关闭Sqlsession。
存在一些硬编码。调用SqlSession的方法操作数据库时,需要指定statement的id,这里存在了硬编码。
二、Mapper代理开发(推荐)
Mapper代理的开发方式,程序员只需要编写mapper接口(相当于dao接口)即可。Mybatis会自动的为mapper接口生成动态代理实现类。
不过要实现mapper代理的开发方式,需要遵循一些开发规范。
1、mapper接口的全限定名要和mapper映射文件的namespace的值相同。
2、 mapper接口的方法名称要和mapper映射文件中的statement的id相同;
3、mapper接口的方法参数只能有一个,且类型要和mapper映射文件中statement的parameterType值 保持一致。
4、mapper接口的返回值类型要和mapper映射文件中statement的resultType值或resultMap中的type值保持一致;
通过规范式的开发mapper接口,可以解决原始dao开发当中存在的问题:
1、 模板代码已经去掉;
2、 剩下去不掉的操作数据库的代码,其实就是一行代码。这行代码中硬编码的部分,通过第一和第二个规范就可以解决。
1.PO实现类
package com.cjw.mybatis.po;
import java.util.Date;
public class User {
private int id;
private String username;// 用户姓名
private String sex;// 性别
private Date birthday;// 生日
private String address;// 地址
public int getId() {
return id;
}
public void setId(int 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 + "]";
}
}
2.编写全局配置文件: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">
<configuration>
<!-- 配置mybatis的环境信息 -->
<environments default="development">
<environment id="development">
<!-- 配置JDBC事务控制,由mybatis进行管理 -->
<transactionManager type="JDBC"></transactionManager>
<!-- 配置数据源,采用mybatis连接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value=
"jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf8"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<!-- 加载映射文件 -->
<mappers>
<mapper resource="mapper/UserMapper.xml"/>
</mappers>
</configuration>
3.编写映射文件: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.cjw.mybatis.mapper.UserMapper">
<!-- 根据用户ID,查询用户信息 -->
<select id="findUserById" parameterType="int" resultType="com.cjw.mybatis.po.User">
SELECT * FROM USER WHERE id=#{id}
</select>
<!-- 添加用户 -->
<insert id="insertUser" parameterType="com.cjw.mybatis.po.User">
<selectKey keyProperty="id" resultType="int" order="AFTER">
SELECT LAST_INSERT_ID()
</selectKey>
INSERT INTO USER
(id,username,birthday,sex,address)
VALUES(#{id},#{username},#{birthday},#{sex},#{address})
</insert>
</mapper>
4. 编写UserMapper接口
package com.cjw.mybatis.mapper;
import java.util.List;
import com.cjw.mybatis.po.User;
public interface UserMapper {
// 1、根据用户ID来查询用户信息;
public User findUserById(int id) throws Exception;
// 2、根据用户名称来模糊查询用户信息列表;
public List<User> findUserByName(String name) throws Exception;
// 3、添加用户;
public void insertUser(User user) throws Exception;
}
5.编写测试代码
package com.cjw.mybatis.test;
import static org.junit.Assert.fail;
import java.io.InputStream;
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.Before;
import org.junit.Test;
import com.cjw.mybatis.mapper.UserMapper;
import com.cjw.mybatis.po.User;
public class UserMapperTest {
// 声明全局的SqlSessionFactory
private SqlSessionFactory sqlSessionFactory;
@Before
public void setUp() throws Exception {
// 1、读取配置文件
String resource = "SqlMapConfig.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
// 2、根据配置文件创建SqlSessionFactory
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
}
@Test
public void testFindUserById() throws Exception {
//创建UserMapper对象
SqlSession sqlSession=sqlSessionFactory.openSession();
//有MyBatis通过sqlSession来创建代理对象
UserMapper mapper=sqlSession.getMapper(UserMapper.class);
User user=mapper.findUserById(1);
System.out.println(user);
// 关闭SqlSession
sqlSession.close();
}
@Test
public void testFindUserByName() {
fail("Not yet implemented");
}
@Test
public void testInsertUser() throws Exception {
// 创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
// 通过SqlSession,获取mapper接口的动态代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 构造User对象
User user = new User();
user.setUsername("东哥7");
user.setAddress("清河宝盛西里4");
// 调用mapper对象的方法
userMapper.insertUser(user);
System.out.println(user.getId());
// 执行SqlSession的commit操作
sqlSession.commit();
// 关闭SqlSession
sqlSession.close();
}
}