增删改
使用接口式编程,在接口中直接增加对应的方法。
public interface EmployeeMapper {
public Employee getEmpById(Integer id);
public Long addEmp(Employee emlpoyee);
public Boolean updateEmp(Employee employee);
public void deleteEmp(Integer id);
}
注意:mybatis允许增删改直接定义以下的类型返回值,Integer、Long、Boolean、Void,它会自动将返回结果封装成这边基本类型(封装类型)。
在映射文件中编写对应的sql语句:
<!-- public void addEmp(Employee emlpoyee); -->
<!-- parameterType可以省略 -->
<insert id="addEmp" parameterType="com.shen.mybaties.bean.Employee">
insert into tbl_employee (last_name,email,gender)
values (#{lastName},#{email},#{gender})
</insert>
<!-- public void updateEmp(Employee employee); -->
<update id="updateEmp">
update tbl_employee
set last_name=#{lastName},email=#{email},gender=#{gender}
where id = #{id}
</update>
<!-- public void deleteEmp(Integer id); -->
<delete id="deleteEmp">
delete from tbl_employee where id = #{id}
</delete>
编写对应的测试方法即可,有一点需要注意:
SqlSession openSession = sqlSessionFactory.openSession();获取的SqlSession默认是不会自动提交的,做完事务需要我们手动进行提交,即openSession.commit()。
当然也可以在获取的时候,使用sqlSessionFactory.openSession(true)
来获取一个自动提交的SqlSession。
获取自增的主键值
在自增时,如果设置了自增的主键,该如何获取自动生成的值呢?
在JDBC中,用的是statement.getGenreatedKeys()
;MyBatis也是用的同样的方法,需要在映射文件中配置即可。
<!-- public void addEmp(Employee emlpoyee); -->
<!-- parameterType可以省略 -->
<!--
获取自增主键的值:
mysql支持自增主键,自增主键值的获取,mybatis也是利用statement.getGeneratedKeys(),
useGeneratedKeys="true";使用自增主键获取主键值策略
keyProperty:指定对应的主键属性,也就是mybatis获取到主键值以后,将这个值封装给javaBean的哪个属性
-->
<insert id="addEmp" parameterType="com.shen.mybaties.bean.Employee" useGeneratedKeys="true"
keyProperty="id">
insert into tbl_employee (last_name,email,gender)
values (#{lastName},#{email},#{gender})
</insert>
在Java测试代码中,增加完成后,这个Bean对象即被更新,可以获取到自增逐渐的值。
@Test
public void testAdd() throws IOException {
SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
// 获取到的sqlSession不会自动提交数据
SqlSession openSession = sqlSessionFactory.openSession();
try {
EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);
Employee employee = new Employee(null, "jerry", "511460468@qq.com", "1");
Long addEmpResult = mapper.addEmp(employee);
if (addEmpResult != 0) {
System.out.println("员工id:" + employee.getId());
}
// 手动提交
openSession.commit();
} finally {
openSession.close();
}
}
新建时,员工Id为null,增加完成后,我们可以发现员工对象的id有值,即mybatis帮我们进行了主键设置。
注意:当事务rollback时,自增主键并不会回滚,依然会增长下去。
Oracle版本
<!--
获取非自增主键的值:
Oracle不支持自增;Oracle使用序列来模拟自增;
每次插入的数据的主键是从序列中拿到的值;如何获取到这个值;
-->
<insert id="addEmp" databaseId="oracle">
<!--
keyProperty:查出的主键值封装给javaBean的哪个属性
order="BEFORE":当前sql在插入sql之前运行
AFTER:当前sql在插入sql之后运行
resultType:查出的数据的返回值类型
BEFORE运行顺序:
先运行selectKey查询id的sql;查出id值封装给javaBean的id属性
在运行插入的sql;就可以取出id属性对应的值
AFTER运行顺序:
先运行插入的sql(从序列中取出新值作为id);
再运行selectKey查询id的sql;
-->
<selectKey keyProperty="id" order="BEFORE" resultType="Integer">
<!-- 编写查询主键的sql语句 -->
<!-- BEFORE-->
select EMPLOYEES_SEQ.nextval from dual
<!-- AFTER:
select EMPLOYEES_SEQ.currval from dual -->
</selectKey>
<!-- 插入时的主键是从序列中拿到的 -->
<!-- BEFORE:-->
insert into employees(EMPLOYEE_ID,LAST_NAME,EMAIL)
values(#{id},#{lastName},#{email<!-- ,jdbcType=NULL -->})
<!-- AFTER:
insert into employees(EMPLOYEE_ID,LAST_NAME,EMAIL)
values(employees_seq.nextval,#{lastName},#{email}) -->
</insert>
由于Oracle不支持自增主键,它使用序列模拟自增,mybatis有两种方式去获取主键,分为Before版本和After版本。
Before:查询序列的下一个值,赋值给JavaBean的Id,再插入。
After:使用序列的下一个值先插入,在使用查序列,查当前值。
参数处理(重要)
- 单个参数:mybatis不做特殊处理。
#{参数名}
:取出参数值,但其实,只有单个参数,参数名随便写都可以取的到。 - 多个参数:mybatis做特殊处理
多个参数会被封装成一个map
key:param1,……paramN,或者参数的索引也可以
value:传入的参数值
#{}就是从map中获取指定key的值
异常:
org.apache.ibatis.binding.BindingException:
Parameter 'id' not found.
Available parameters are [0, 1, param1, param2]
操作:
方法:public Employee getEmoByIdAndLastName(Integer id, String lastName);
取值:#{id},#{lastName}
推荐做法
- 命名参数:明确定值封装参数时map的key,
@Param("id")
多个参数会被封装成一个map:
key:使用@param注解
指定的值
value:参数值
此时使用#{指定的key}
取出对应的值。 - POJO:
如果多个参数正好是业务逻辑的数据模型,我们就直接传入POJO:
/#{属性名}:取出传入的pojo的属性值。 - Map:
如果多个参数不是业务模型中的模型,没有对应的pojo,不经常使用,为了方便,我们也可以直接传入map。
/#{key}:取出map中对应的值 - TO:
如果多个参数不是业务模型中的数据,但是经常使用,推荐来编写一个TO(Transfer Object)数据传输对象,如分页处理的模型,需要传入起始位置和大小。
Page{
int index;
int size;
}
思考
(1)public Employee getEmp(@Param("id") Integer id, String lastName);
取值:id====>#{id/param1}, lastName====>#{param2}
(2)public Employee getEmp(Integer id, @Param("e") Employee emp);
取值:id====>#{param1}, lastName====>#{param2.lastName/e.lastName}
(3)public Employee getEmpById(List<Integer> ids);
取值:取出第一个id的值,id====>#{collection[0]/list[0]}
特别注意,如果是Collection(List、Set)类型或者是数组,也会做特殊处理,也是把list或者数组封装在map中。
其中的key:Collection类型统一的key是collection
,如果是List还可以使用list
,如果是数组使用array
。
所以上面可以使用collection[0]/list[0]
。
参数处理源码分析
在ParamNameResolver的getNamedParams方法中,为我们处理了参数,返回一个map。
========================结合源码,mybatis怎么处理参数==========================
总结:参数多时会封装map,为了不混乱,我们可以使用@Param来指定封装时使用的key;
#{key}就可以取出map中的值;
(@Param("id")Integer id,@Param("lastName")String lastName);
ParamNameResolver解析参数封装map的;
//1、names:{0=id, 1=lastName};构造器的时候就确定好了
确定流程:
1.获取每个标了param注解的参数的@Param的值:id,lastName; 赋值给name;
2.每次解析一个参数给map中保存信息:(key:参数索引,value:name的值)
name的值:
标注了param注解:注解的值
没有标注:
1.全局配置:useActualParamName(jdk1.8):name=参数名
2.name=map.size();相当于当前元素的索引
如{0=id, 1=lastName,2=2}
入参args【1,"Tom",'hello'】:
//其中names,在构造器中进行初始化,names的value:若有注解则使用注解的value,若没注解则使用索引,names的key是索引序号.
public Object getNamedParams(Object[] args) {
final int paramCount = names.size();
//1、参数为null直接返回
if (args == null || paramCount == 0) {
return null;
//2、如果只有一个元素,并且没有Param注解;args[0]:单个参数直接返回
//所以单个参数,#{随意}都可以取到参数值
} else if (!hasParamAnnotation && paramCount == 1) {
return args[names.firstKey()];
//3、多个元素或者有@Param标注
} else {
final Map<String, Object> param = new ParamMap<Object>();
int i = 0;
//4、遍历names集合;{0=id, 1=lastName,2=2}
for (Map.Entry<Integer, String> entry : names.entrySet()) {
//names集合的value作为key(id,lastName,2);
//names集合的key(0,1,2)又作为取值的索引,args[0]:args【1,"Tom"】;
//eg:{id=args[0]:1,lastName=args[1]:Tom,2=args[2]}
param.put(entry.getValue(), args[entry.getKey()]);
// add generic param names (param1, param2, ...)param
//额外的将每一个参数也保存到map中,使用新的key:param1...paramN
//效果:有Param注解可以#{指定的key},或者#{param1}
final String genericParamName = GENERIC_NAME_PREFIX + String.valueOf(i + 1);
// ensure not to overwrite parameter named with @Param
if (!names.containsValue(genericParamName)) {
param.put(genericParamName, args[entry.getKey()]);
}
i++;
}
return param;
}
}
}
参数值的获取
#{}:可以获取map中的值或者pojo对象属性的值;
${}:可以获取map中的值或者pojo对象属性的值; select * from tbl_employee where id = ${id} and last_name=#{lastName}
select * from tbl_employee where id = 1 and last_name=?
区别:
- #{}:是以预编译的形式,将参数设置到sql语句中,PreparedStatement,防止sql注入
- ${}:取出的值直接拼装在sql语句中,会有安全问题
大多数情况下,我们取参数的值都应该去使用#{}
。原生sql(jdbc)不支持占位符
的地方我们就可以使用${}
进行取值
比如本表、排序:按照年份表拆分: select * from ${year}_salary where xxx;
select * from tbl_employee order by ${f_name} ${order}
总之,${}更多用在拼字符串的形式上,而不是取参数。
#{}:更丰富的用法
规定参数的一些规则:
javaType、jdbcType、mode(存储过程)、numericScale、
resultType、typeHandler、jdbcTypeName、expression(未来准备支持的功能)
jdbcType
通常需要在某种特定的条件下被设置:
在我们数据为null的时候,有些数据库可能不能识别mybatis对null的默认处理
,比如Oracle(报错),JdbcType OTHER
:无效的类型。
因为mybatis对有所的null都映射的是原生jdbc的OTHER类型
,Oracle不能正确处理,Mysql可以处理。
由于全局配置中:默认的jdbcTypeForNull=OTHER,Oracle不支持。
两种办法:
- 解决: #{xxx,jdbcType=NULL};当前sql语句管用
- jdbcTypeForNull=NULL;全局管用