一、思路(Mapper代理开发的规范)
程序员还需要编写mapper.xml映射文件。
程序员编写mapper接口需要遵循一些开发规范,mybatis可以自动生成mapper接口实现类代理对象。
开发规范:
1、在mapper.xml中namespace等于mapper接口地址:接口类的全名
2、mapper.java接口中的方法名和mapper.xml中statement的id一致
3、mapper.java接口中的方法输入参数类型和mapper.xml中的statement的parameterType一致。
4、mapper.java接口中的方法返回值类型和mapper.xml中statement的resultType指定的类型一致。
SQL定义如下:
<select id="findUserById" parameterType="int"
resultType="cn.sunft.mybatis.po.User">
select * from user where id=#{id}
</select>
接口方法定义如下:
package cn.sunft.mybatis.mapper;
import cn.sunft.mybatis.po.User;
/**
* mapper接口,相当于dao接口,用户管理
*/
public interface UserMapper {
/**
* 根据id查询用户信息
* @param id
* @return
* @throws Exception
*/
public User findUserById(int id) throws Exception;
}
总结:
以上开发规范主要是对下边的代码进行统一生成:
User user = sqlSession.selectOne("test.findUserById", id);
List<User> list = sqlSession.selectList("test.findUserByName", name);
sqlSession.insert("test.insertUser", user);
二、新建UserMapper.java接口
package cn.sunft.mybatis.mapper;
import java.util.List;
import cn.sunft.mybatis.po.User;
/**
* mapper接口,相当于dao接口,用户管理
*/
public interface UserMapper {
/**
* 根据id查询用户信息
* @param id
* @return
* @throws Exception
*/
public User findUserById(int id) throws Exception;
/**
* 根据用户名查询用户列表
* @param name
* @return
* @throws Exception
*/
public List<User> findUserByName(String name) throws Exception;
/**
* 插入用户
* @param user
* @throws Exception
*/
public void insertUser(User user) throws Exception;
/**
* 删除用户
* @param id
* @throws Exception
*/
public void deleteUser(int id) throws Exception;
}
代码分析:
1、findUserByName方法的返回值不符合要求,与规则定义的不符
如果mapper方法返回单个pojo对象(非集合对象),代理对象内部通过selectOne查询数据库。如果查询到多条记录,则会抛出异常。
如果mapper方法返回集合对象,代理对象内部通过selectList查询数据库。
2、mapper接口方法参数只能有一个是否影响系统开发
Mappper接口方法参数只能有一个,系统是否不利于扩展维护?
系统框架中,dao层的代码是被业务层公用的。
即使mapper接口只有一个参数,可以使用包装类型的pojo满足不同的业务方法的需求。
注意:持久层方法的参数可以用包装类型、Map、pojo等,service方法中建议不要使用包装类型(不利于业务层的可扩展)。
三、新建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">
<!-- namwspace命名空间:作用就是对SQL进行分类管理,进行SQL隔离 -->
<!-- namespace命名空间特殊作用:
如果使用mapper动态代理方法,这里就需要配置mapper接口地址-->
<mapper namespace="cn.sunft.mybatis.mapper.UserMapper">
<!-- 在映射文件中配置很多sql语句 -->
<!-- 需求:通过id查询用户表的记录 -->
<!-- 通过select执行数据库查询
id:标识映射文件中的sql
将sql语句封装到mappedStatement对象中,所以将id成为statement的id
parameterType:指定输入参数的类型,这里指定int型
#{}表示一个占位符
#{id}:其中的id表示接收输入的参数,参数名称就是id,如果输入参数是简单类型,
#{}中的参数名可以任意,可以是value或其他名称,例如#{aaa}
resultType:指定SQL输出结果所映射的java对象类型,select指定resultType表示
将单条记录映射成的java对象
-->
<select id="findUserById" parameterType="int"
resultType="cn.sunft.mybatis.po.User">
select * from user where id=#{id}
</select>
<!-- 根据用户名称模糊查询用户信息,可能返回多条
resultType:指定的就是单条记录所映射的java对象类型
${}:表示拼接SQL串,将接收到参数的内容不加任何修饰拼接在SQL中。
使用${}拼接SQL,引起SQL注入。
${value}:接收输入参数的内容,如果传入类型是简单类型,${}中只能使用value
-->
<select id="findUserByName" parameterType="java.lang.String"
resultType="cn.sunft.mybatis.po.User">
select * from user where username like '%${value}%'
</select>
<!-- 添加用户
parameterType:指定输入参数类型是pojo(包括用户信息)
#{}中指定pojo的属性名,接收到pojo对象的属性值,
mybatis也是通过OGNL获取对象的属性值
-->
<insert id="insertUser" parameterType="cn.sunft.mybatis.po.User">
<!-- 将刚刚插入的主键返回,返回到user对象中
SELECT LAST_INSERT_ID():得到insert进去记录的主键值,只适用于自增主键
keyProperty:将查询到主键值设置到parameterType指定的对象的那个属性
order:SELECT LAST_INSERT_ID()执行顺序,相对于insert语句来说它的执行顺序
resultType:指定结果的类型
-->
<selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
SELECT LAST_INSERT_ID()
</selectKey>
insert into user(username, birthday, sex, address)
value(#{username}, #{birthday}, #{sex}, #{address})
</insert>
<insert id="insertStudent" parameterType="cn.sunft.mybatis.po.Student">
<!--
使用MySQL的uuid()生成主键
执行过程:
首先通过uuid()得到主键,将主键设置到student对象的id字段中
其次在insert执行时,从user对象中取出id属性插入数据库
-->
<selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">
SELECT uuid()
</selectKey>
insert into student(id, name) value(#{id}, #{name})
</insert>
<!-- 删除用户
根据id删除用户,需要输入id值
-->
<delete id="deleteUser" parameterType="java.lang.Integer">
delete from user where id=#{id}
</delete>
<!-- 根据id更新用户
分析:
需要传入用户的id
需要传入用户的更新信息
parameterType:指定user对象,包括id和更新信息,注意:id必须存在
#{id}:从输入user对象中获取id
-->
<update id="updateUser" parameterType="cn.sunft.mybatis.po.User">
update user set
username=#{username},
birthday=#{birthday},
sex=#{sex},
address=#{address}
where id=#{id}
</update>
</mapper>
四、在SqlMapConfig.xml下添加UserMapper.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>
<!-- 和spring整合后 environments配置将废除-->
<environments default="development">
<environment id="development">
<!-- 使用JDBC事务管理,由mybatis控制 -->
<transactionManager type="JDBC" />
<!-- 数据库连接池,由mybatis管理 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8" />
<property name="username" value="root" />
<property name="password" value="root" />
</dataSource>
</environment>
</environments>
<!-- 加载映射文件,只能写类路径名,不能带上应用名,否则会报错 -->
<mappers>
<mapper resource="sqlmap/User.xml" />
<mapper resource="mapper/UserMapper.xml" />
</mappers>
</configuration>
五、编写单元测试类进行测试
package cn.sunft.mybatis.mapper;
import java.io.InputStream;
import java.util.List;
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 cn.sunft.mybatis.po.User;
/**
* 测试UserMapper接口
*/
public class UserMapperTest {
private SqlSessionFactory sqlSessionFactory;
/**
* 负责初始化sqlSessionFactory和userDao
* @throws Exception
*/
@Before
public void setUp() throws Exception {
String resource = "SqlMapConfig.xml";
//得到配置文件
InputStream inputStream = this.getClass()
.getClassLoader().getResourceAsStream(resource);
//创建会话工厂,传入mybatis的配置文件信息
sqlSessionFactory = new SqlSessionFactoryBuilder()
.build(inputStream);
}
@Test
public void testFindUserById() throws Exception {
SqlSession sqlSession = sqlSessionFactory.openSession();
//创建UserMapper对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//调用userMapper的方法
User user = userMapper.findUserById(1);
sqlSession.close();
System.out.println(user);
}
@Test
public void testFindUserByName() throws Exception {
SqlSession sqlSession = sqlSessionFactory.openSession();
//创建UserMapper对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//调用userMapper的方法
List<User> list = userMapper.findUserByName("张三");
sqlSession.close();
System.out.println(list);
}
}