-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
changelog
测试用例如下：
/**
* 乐观锁删除
*/
@Test
public void testDeleteByPrimaryKeyAndVersion() {
SqlSession sqlSession = MybatisHelper.getSqlSession();
try {
CountryVersionMapper mapper = sqlSession.getMapper(CountryVersionMapper.class);
//根据主键删除，没有指定版本时删除不了
Assert.assertEquals(0, mapper.deleteByPrimaryKey(100));
CountryVersion countryVersion = new CountryVersion();
countryVersion.setId(100);
countryVersion.setVersion(2);
//版本不对的时候的时候删除不了
Assert.assertEquals(0, mapper.deleteByPrimaryKey(countryVersion));
countryVersion.setId(100);
countryVersion.setVersion(1);
//版本正确的时候可以真正删除
Assert.assertEquals(1, mapper.deleteByPrimaryKey(countryVersion));
} finally {
sqlSession.rollback();
sqlSession.close();
}
}日志如下：
DEBUG [main] - ==> Preparing: DELETE FROM country WHERE id = ? AND version = ?
DEBUG [main] - ==> Parameters: 100(Integer), 100(Integer)
DEBUG [main] - <== Updates: 0
DEBUG [main] - ==> Preparing: DELETE FROM country WHERE id = ? AND version = ?
DEBUG [main] - ==> Parameters: 100(Integer), 2(Integer)
DEBUG [main] - <== Updates: 0
DEBUG [main] - ==> Preparing: DELETE FROM country WHERE id = ? AND version = ?
DEBUG [main] - ==> Parameters: 100(Integer), 1(Integer)
DEBUG [main] - <== Updates: 1
特别注意： 上面测试用例已经展示了增加乐观锁后的参数如何传递，当主键多个值或者使用乐观锁的时候就需要通过实体（Map也可以）传递多个参数值。和之前的 update 一样，需要自己对执行结果进行判断来判断是否执行成功。
4. Example.Builder 增加类似 Weekend 中 Java8 方法引用的用法，该功能由 chinaerserver 提交(#pr207)
示例如下：
@Test
public void testWeekend() {
SqlSession sqlSession = MybatisHelper.getSqlSession();
try {
CountryMapper mapper = sqlSession.getMapper(CountryMapper.class);
//普通方式
List<Country> selectByExample = mapper.selectByExample(
new Example.Builder(Country.class).where(Sqls.custom().andLike("countryname", "China")).build());
//Java8 方式
List<Country> selectByWeekendSql = mapper.selectByExample(new Example.Builder(Country.class)
.where(WeekendSqls.<Country>custom().andLike(Country::getCountryname, "China")).build());
// 判断两个结果数组内容是否相同
Assert.assertArrayEquals(selectByExample.toArray(), selectByWeekendSql.toArray());
} finally {
sqlSession.close();
}
}5. 当项目中使用了自定义classloader的时候，可以通过设置classloader上下文的方式来使得自己的mapper class能够被找到(这里的修改参照了 mybatis 源码中的 ClassLoaderWrapper 类)，by liyongjun1 #pr185
6. 重点提醒，3.5.0 中 useSimpleType 默认值改为 true，默认忽略复杂类型的字段，复杂类型不需要加 @Transient 注解，具体类型可以参考 SimpleTypeUtil 类。
在 SimpleTypeUtil 类中，由于一般的 JavaBean （尤其是 MyBatis）规范中，不能使用基本类型，这主要是由于基本类型有默认值，在一些动态 SQL 情况下（如所有 Selective 方法），无法判断基本类型的值是不是 null。
所以在这里的简单类型是不包含 byte,short,int,long,float,double,char,boolean 这八种基本类型的。
如果你要升级通用 Mapper 但是不想修改原来的基本类型，就设置 useSimpleType=false。
-
兼容 mbg 1.3.6 版本。
-
EntityColumn记录EntityField信息，方便后续扩展使用。 -
针对 update 两个基本方法增加乐观锁功能，在实体类对版本字段增加
@Version注解即可，默认支持Integer和Long类型，其他情况可以实现NextVersion接口并在注解中指定该实现，一个实体类中最多只能有一个加@Version注解的字段。 -
3.4.0增加的
useSimpleType默认值改为true，默认忽略复杂类型的字段，复杂类型不需要加@Transient注解，具体类型可以参考SimpleTypeUtil类。 -
新增
annotationAsSimpleType参数，默认false，设置为true后会把枚举作为简单类型对待，需要配合useSimpleType = true使用。 -
新增
wrapKeyword参数，配置后会自动处理关键字，可以配的值和数据库有关，例如 sqlserver 可以配置为[{0}]，使用{0}替代原来的列名。 -
FieldHelper改为判断当前jdk版本是否为6和7，其他情况按jdk8处理，因此支持jdk9+ -
新增
selectOneByExample方法，必须保证返回值最多 1 个，否则抛出异常。 -
增加新的
tk.mybatis.mapper.additional.insert.InsertListMapper，这个批量插入方法不支持主键策略，不会返回自动生成的主键
使用 @Version 注解的效果如下：
DEBUG [main] - ==> Preparing: UPDATE country SET countryname = ?,countrycode = ?,version = 2 WHERE id = ? AND version = ?
DEBUG [main] - ==> Parameters: 美国2(String), US(String), 174(Integer), 1(Integer)自动处理关键字代码：
//自动处理关键字
if (StringUtil.isNotEmpty(wrapKeyword) && SqlReservedWords.containsWord(columnName)) {
columnName = MessageFormat.format(wrapKeyword, columnName);
}一个简单的 builder 用法示例：
/*
* @description: 多个where连接的查询语句测试
*
*/
@Test
public void testWhereAndWhereCompound() {
SqlSession sqlSession = MybatisHelper.getSqlSession();
try {
CountryMapper mapper = sqlSession.getMapper(CountryMapper.class);
Example example = Example.builder(Country.class)
.where(Sqls.custom()
.andEqualTo("countryname", "China")
.andEqualTo("id", 35)
)
.andWhere(Sqls.custom()
.andEqualTo("id", 183)
)
.build();
List<Country> countries = mapper.selectByExample(example);
Assert.assertEquals(0, countries.size());
} finally {
sqlSession.close();
}
}更多用法可以通过测试 TestExampleBuilder 了解。
- 插件增加一个
<context>属性配置，可以控制是否使用通用 Mapper 自带的MapperCommentGenerator，用法如下：
<generatorConfiguration>
<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
<!--新增的参数，默认true 使用-->
<property name="useMapperCommentGenerator" value="false"/>
<!-- 其他 -->
</context>
</generatorConfiguration>- 增加基于 MBG 的代码生成器插件，参考使用文档。
- 增加 mapper-weekend（作者 liuyuyu），支持jdk8函数式引用方法，用法如下：
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
Weekend<User> weekend = Weekend.of(User.class);
weekend.weekendCriteria()
.andIsNull(User::getId)
.andBetween(User::getId,0,10)
.andIn(User::getUserName, Arrays.asList("a","b","c"));可以在
Example.Criteria的条件方法里传 lambada(再也不用担心改数据库了......)。
后续会继续在 3.x 版本更新和维护。
原来计划的 4.0 版本打算用 mybatis 更原生的方式实现，所以需要尽快配合官方合并一个新功能，只有等合并后才会开始 4.0 的开发。
-
MapperPlugin增加forceAnnotation参数，默认false，设置为true后一定会生成@Table和@Column注解。 - 为实例化
TypeHandler增加javaTypeClassby junchao。 - 更新
Example类，在获取property时，判断有没有该property并抛出异常 by chengcheng.feng。 - 所有类的属性从
HashMap改为ConcurrentHashMap。
- 简化Example的xml逻辑，解决由于and,or位置错误导致Example使用空条件时的错误，完善测试
-
Example增加复杂的and和or功能。 -
Example增加排除查询字段的方法excludeProperties(selectProperties优先级更高) #261. -
SqlHelper中复杂的if改为choose方式。 - 解决通过
@Column配置关键字的分隔符时，无法得到该列值的bug。
-
Example增加 for update 支持，仅能用于 selectByExample 和 selectCountByExample 方法 #210 -
Example.Criteria增加andAllEqualTo方法，将此对象的所有字段参数作为相等查询条件，如果字段为 null，则为 is null #206 - 增加参数
checkExampleEntityClass，默认false用于校验通用 Example 构造参数 entityClass 是否和当前调用的 Mapper 类型一致 #201 - 增加参数
useSimpleType，默认false，启用后判断实体类属性是否为表字段时校验字段是否为简单类型，如果不是就忽略该属性，这个配置优先级高于所有注解 - 增加参数
simpleTypes，默认的简单类型在SimpleTypeUtil中，使用该参数可以增加额外的简单类型，通过逗号隔开的全限定类名添加 - 所有
RuntimeException异常改为tk.mybatis.mapper.MapperException异常 - 所有 Update 方法添加
@Options(useCache = false, useGeneratedKeys = false)，fix #216 - 使用自定义的
SelectKeyGenerator，防止有默认值时被替换掉 fix #213 - 将 MapperTemplate 属性改为 protected
- MBG 插件中 generatedKey 元素的 sqlStatement 属性可以配置为形如 select SEQ_{1} from dual 的 SQL，其中 {0} 代表小写的表名，{1} 是大写的表名
MBG 配置示例如下,类似 Oracle 序列的配置方式：
这个配置生成的代码会像下面这样：
<generatedKey column="id" sqlStatement="select SEQ_{1}.nextval from dual" identity="false" type="pre"/>
public class Author { @Id @GeneratedValue(strategy = GenerationType.IDENTITY, generator = "select SEQ_AUTHOR.nextval from dual") private Integer id; // 省略其他 }
- 增加
selectByIds和deleteByIds，用法见通用Mapper接口大全 - 根据李领北建议修改
Example中的propertyMap#159 -
Example中的andIn和andNotIn中的参数Collection改为Iterable - 解决驼峰转下划线的错误，感谢 ptma, piggsoft 和 liufor 的PR
- 增加对MBG1.3.4的支持
- MBG插件支持
beginningDelimiter和endingDelimiter - MBG插件增加schema配置（catalog也可以用这个），会自动在表的注解名字前面加上
schema.tablename - MBG插件支持oracle获取注释，其他数据库可以尝试#114
- MBG扩展，详情看MyBatis Generator 1.3.4 扩展，可以设置 Mapper（Dao）后缀
-
Example的andIn和andNotIn方法参数改为Collection#109 - 解决ResultMapping.Builder3.2.6版本新增
lazy方法导致无法兼容3.2.4~3.2.5版本的问题，仍然兼容3.2.4+ - 解决github#12 问题
- 解决#107
- 解决和分页插件PageHelper中orderBy默认属性名相同导致排序的错误
-
Example增加orderBy方法，使用属性进行排序，例如：example.orderBy("id").desc().orderBy("countryname").orderBy("countrycode").asc(); - 当实体类包含数组类型的字段时，在
resultMap中不使用javaType，这种情况如果出错，可以通过@ColumnType注解设置jdbcType#103 - 实体类中忽略
transient类型的字段#106
- 增加对mybatis-spring 1.2.4版本的支持，兼容之前的版本
-
Example增加对动态表名支持，通过setTableName设置表名 - 在example相关的两个
update方法中，参数为实体类和Example，这个方法只能通过Example来设置动态表名，不支持通过实体设置动态表名 - 优化两个
select count查询，当表只有一个主键的时候，使用select count(pk)，其他时候使用select count(*)
- 解决insertList的bug#86
-
Example构造方法增加notNull参数，默认false，允许值为null，值为null的时候不加入到条件中。 -
seqFormat格式化参数增加第四个可配置值TableName
- 解决OGNL中的and,or大写导致的错误
- 解决SpecialProvider不支持insertable的bug#77
- 解决JDK6,7无法获取字段泛型类型的问题。
- 提供一个Spring Boot集成的示例: https://github.com/abel533/MyBatis-Spring-Boot
- 解决数据越界bug#73
- 解决and少空格问题
- 解决order by错误#74
-
tk.mybatis.spring.mapper.MapperScannerConfigurer中的属性mapperHelper增加setter和getter方法，方便通过代码进行配置
- 增加
enableMethodAnnotation参数，可以控制是否支持方法上的JPA注解，默认false。 设置enableMethodAnnotation = true的时候注意，如getRealName或setYourName都会产生realName属性或yourName属性，如果该方法对应的属性不是表中的字段，就需要给方法增加@Transient注解。 同样如果你的实体是继承Map类型的，你不需要在实体中写private String userName这样的属性，你只需要写setUserName或getUserName这样的方法就可以。 - 在处理的注解的时候，优先从
Field获取，然后是setter方法，最后是getter方法，注解重复的情况下，只获取按顺序得到的第一个 - 为了支持如
public class Country extends Entity<Integer, String>这样的泛型类型,在生成#{propertyName}的时候都带上了javaType属性。 产生的结果就是#{propertyName, javaType=java.lang.Integer}这样子的，这会导致当你调用方法时，必须保证类型一致。 也就是假设主键是Integer id，调用selectByPrimaryKey(Object id)的时候，参数id必须使用100这样的数字，不能使用"100"字符串（以前版本可以）。 如果不带javaType，那么如果id是个泛型，MyBatis查找的时候就会因为找不到正确的类型而抛出异常。 - 为了让扩展更方便，将
tk.mybatis.mapper.provider包下所有的通用接口的实现方法改为了String形式。 自己扩展单表操作的方法是非常容易的事情，建议有一定通用Mapper使用基础的自行扩展，扩展可以参考如何扩展通用接口 - 新增
SqlHelper工具类，其中包含了大量可用的现成的SQL方法 -
@Column注解增加对insertable和updatable属性的支持
-
增加对动态表名的支持，需要实体类继承
IDynamicTableName接口，用法见详细说明 -
Example增加自定义查询条件，提供了4个方法，具体方法和用法见详细说明 -
新增
@ColumnType注解，可以单独设置列的jdbcType和typeHandler -
Example的in和not in中的List<Object>参数改为List<?>，允许任意类型 -
select查询方法返回类型不在使用
resultType，改为resultMap，因此可以支持typeHandler的读取 -
Style自动转方式新增camelhumpAndUppercase驼峰转下划线大写形式,camelhumpAndLowercase驼峰转下划线小写形式 -
MapperTemplate中的
getSelectReturnType方法改为getEntityClass，getBEFORE改为isBEFORE -
文档中增加
@GeneratedValue(strategy = GenerationType.IDENTITY)的一种重要用法说明 -
修复selectAll不支持
@OrderBy注解的bug -
解决一个驼峰转换bug，例如
helloWorld会转换为hello_world（原先是hello_World）
- 和Spring集成时，允许通过
markerInterface属性配置通用接口（注意该属性的原有作用不变），想要让该接口自动注册，该接口就需要继承tk.mybatis.mapper.common.Marker接口，Mapper<T>默认继承该接口，所以如果自己的接口是继承Mapper<T>的，不需要再继承。 - 解决注册默认接口时存在的bug
- 解决spring集成中可能出现definition.getBeanClassName()空指针异常bug#49
- 关于3.2.x版本，请仔细看3.2.0的更新日志，最新版本的文档也是针对3.2.x版本的
- 移除
MapperInterceptor拦截器，以后不能在通过拦截器配置 - 增加mybatis-spring特殊支持，主要是根据mybatis-spring项目增加了下面两个类：
tk.mybatis.spring.mapper.MapperScannerConfigurertk.mybatis.spring.mapper.MapperFactoryBean
- 这两个类和MyBatis提供的区别是增加了MapperHelper属性，通过在
MapperScannerConfigurer中使用properties属性注入配置 - 这两个类，在全名上和MyBatis的区别是
org.mybatis.xxx改为了tk.mybatis.xxx，名字相近，更方便修改配置 - 和Spring集成方法：
<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.isea533.mybatis.mapper"/>
<property name="properties">
<value>
mappers=tk.mybatis.mapper.common.Mapper
</value>
</property>
</bean>- 这种配置方式是不是简单的不能再简单了?
- 增加
style属性配置，用来配置对象名/字段和表名/字段之间的转换方式，可选值：-
normal:使用实体类名/属性名作为表名/字段名 -
camelhump:这是默认值，驼峰转换为下划线形式 -
uppercase:转换为大写 -
lowercase:转换为小写
-
- 增加实体注解
@NameStyle，该注解优先于全局配置style - 解决
example.selectProperties映射错误的bug#48
- 去掉了3.1.3-SNAPSHOT版本中的
MapperOnceInterceptor拦截器，下个版本会完善MapperHelper的配置方式 -
Example增加了example.selectProperties("id", "countryname", ...)方法，可以指定查询列，注意这里参数写的是属性名，Example会自动映射到列名 -
Example增加andEqualTo(实体对象)方法，可以将一个实体放进去，会自动根据属性和值拼出column=value的条件 Bob - 0haizhu0@gmail.com 提供 - MyBatis在处理
<cache/>和@CacheNamespace的时候不统一，只有一个能生效，这导致xml中配置二级缓存对通用Mapper注解形式的方法无效，该问题已解决 - 二级缓存配置方法，如果接口有对应的xml，在xml中配置二级缓存。如果只有接口没有xml，用注解配置二级缓存即可
- 需要注意的是，二级缓存在xml配置时，只对通用Mapper方法有效，自己用
@Select等注解定义的这种仍然无效，这种情况只能在xml中定义
- 解决别名时的一种特殊情况，例如
@Column(name="desc")的时候，就不需要自动添加别名 - 反射获取所有列名的时候，不在自动转换为大写形式，对数据库区分大小写的情况有用
- 解决
ConditionMapper中selectByCondition和updateByCondition方法错误
- 基础包名从
com.github.abel533改为tk.mybatis.mapper - Maven的groupId改为
tk.mybatis,artifactId为mapper - 增加和Example功能类似的Condition查询，仅仅名字不同
- 更多详细变化请看Mapper3通用接口大全
- 关于3.0.x版本请看Mapper3.0.x
- 将
EntityMapper和SqlMapper移出，现在是独立项目EntityMapper - 将
Mapper<T>全部接口方法拆分为独立接口，方便选择集成 - 增加
MySqlMapper<T>包含批量插入和单个插入，批量插入可以回写全部id - 增加
RowBoundsMapper<T>包含两个分页查询，可以配合PageHelper实现物理分页 - 详细变化请看Mapper3变化
- Mapper2资深用户请看Mapper3高级应用
- Mapper3通用接口大全
- 快速开发自己的通用接口
-
高并发时selectKey会产生异常，解决#32
-
兼容MyBatis3.3.0版本
-
提前预告：下个版本3.0.0会将通用Mapper项目拆分为两个项目，会有一些大的改动
-
解决Example查询中的
and缺少空格的问题 -
去掉UUID和JDBC两种主键策略类型中对字段类型的限制 不再限制为
String，可以是任意简单类型，需要自己保证类型匹配。例如UUID配置的策略可以返回Integer,那么字段类型必须是Integer。 -
JDBC类型的主键策略可以配置多个，就相当于
keyProperties="id1,id2..." -
EntityHelper的getOrderByClause方法返回值从StringBuilder改为String，解决@OrderBy注解时的异常 -
提前预告：下个版本3.0.0会将通用Mapper项目拆分为两个项目，会有一些大的改动
- 解决Example查询中in,notin无效的bug#24
-
完善所有和PrimaryKey有关的通用查询
-
修复Mapper接口中update操作会更新主键的bug
-
修复Mapper接口中使用Example查询的时候，条件and前面缺少空格，影响美观
-
MBG插件增加caseSensitive默认false，当数据库表名区分大小写时，可以将该属性设置为true
-
Mapper接口和EntityMapper都增加了
selectOne方法，该查询返回值最多只能有一个，存在多个时抛出异常 -
Mapper接口和EntityMapper中，返回List的查询方法都支持JPA的
@Orderby注解。其中Example查询中的orderby会覆盖注解的@Orderby设置。 -
通过实体类获取表名的时候，不对表名进行强制的大小写转换。如果数据库大小写敏感，请通过
@Table注解和数据库保持一致。
- 新增
SqlMapper，可以使用MyBatis直接执行sql，详细文档
-
通用Mapper接口增加Example查询方法，包括以下方法：
int selectCountByExample(Object example);
int deleteByExample(Object example);
List selectByExample(Object example);
int updateByExampleSelective(@Param("record") T record, @Param("example") Object example);
int updateByExample(@Param("record") T record, @Param("example") Object example);
-
通用
Example增加了一个exists的参数，当true的时候如果使用的字段不存在会抛出异常，false时不抛出异常，但是不使用该字段的条件。
- 增加拦截器，完善相应的文档
- 增加一个
CommonMapper和包装类EntityMapper，建议使用EntityMapper - 有关
EntityMapper的内容请看独立文档，这个类足以独立成一个开源项目 - 增加对JPA注解
OrderBy的支持，仅对select一个方法有效
简单说明，为什么版本这么快就到了2.0?，因为EntityMapper，这是另一种形式的通用Mapper。
这里说说EntityMapper和通用Mapper的区别。
通用Mapper需要有继承的接口，需要指定泛型类型，可以缓存，和手写的效果一样。
EntityMapper无需继承，可以直接使用，而且这一个对象就可以操作全部的实体对象（和通用Mapper注解要求一样，不支持主键策略）和表，是一个更接近Hibernate用法的类，这个类非常强大，支持Mybatis生成的Example查询，还支持一个通用Example查询。
EntityMapper功能更全面，但是不支持主键策略，由于该类足以独立成一个开源项目，简单几句不能说明用法，因此详细内容请看独立的文档。
- 完善文档
- 解决主键selectKey的一个bug
- 解决@Column注解为空时的bug
- 完善自动增长的配置，增加对JDBC的支持
@GeneratedValue(generator = "JDBC"),详细请看下面关于主键策略的详细内容 - 增加了一个
notEmpty参数，该参数会影响所有使用getAllIfColumnNode方法的地方,具体到Mapper<T>,影响3个方法：select,selectCount,delete。如果设置为true，那么<if ...的条件中会包含String类型property!=''的条件。
-
增加通用Mapper专用的MyBatis Generator插件，可以自动生成实体类注解以及Mapper接口和一个空的xml文件
-
插件后续可能会增加更多的自动生成代码。
-
有关插件的使用，后续完善文档
移除了MapperInterceptor类，不在提供拦截器方式的使用。如果有需要可以自己从0.3.1版本获取。
支持Spring4泛型注入，详细请看文档在Spring4中使用通用Mapper
这个版本的主要目的是消除拦截器，因此针对常用的情况增加了两种更方便的使用方式。
该版本做了大量的重构，在原有基础上增加了两个类，分别为MapperTemplate和MapperProvider，其他几个类都有相当大的改动。
但是，这次重构并不影响原有的业务代码。
这次重构的目的是为了方便开发者自行扩展，增加自己需要的通用Mapper。这次重构后，扩展变的更容易。稍后会写一篇如何进行扩展的文档。
这次更新还修复Oracle序列的BUG。
1. 集成通用 Mapper || 2. 对象关系映射 || 3. 配置介绍