-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
changelog
- UpsertMapper 添加@RegisterMapper注解,fixed #878
- 解决ColumnType注解的限制问题,fixed #883
- fix:替代Optional方法和lambda表达式,兼容jdk1.6使用环境 by kesyou1991
- feat:新增mapper bean懒加载功能 by kesyou1991
特别注意: 升级 mybatis generator 到 1.4.1,和 1.3.x 完全不兼容,如果使用 mbg,需要自己依赖的插件也用1.4.x版本
4.2.2 版本合并了最近几年的PR,关闭了几百个issues,github还剩余216,gitee还有18。剩余部分pr依赖jdk8。
4.2.x 版本在 2022 年末停止更新,后续会主要维护 4.3.x 版本,这个新版本会将 jdk 升级到 8,不在支持 jdk 6,7。
升级版本:
- 完善pom配置,不在使用旧的mybatis-parent,所有配置都包含在当前项目中
- 升级 mybatis generator 到 1.4.1,和 1.3.x 完全不兼容
- 升级 mybatis 为 3.5.11
- align mybatis-spring to 1.3.2 in all modules huangkaifeng
- 升级 hsqldb 为 2.5.2
- 升级 jps 依赖,使用 2.2 (GAV全变了)
功能和修复:
- 生成model时自动添加逻辑删除字段注解 rse
- 兼容 mybatis generator 1.4 rse
- 通用Mapper接口,保存(save). 判断主键是否存在, 如果存在且不为空执行update语句,如果主键不存在或为空, 执行insert语句 yangb
- 对获取到的所有字段进行去重 wendell
- Add unit tests for tk.mybatis.mapper.util.StringUtil Eric Hettiaratchi
- 添加WeekendSqls的工具类,提供一系列静态方法,减少泛型参数的指定,使代码更简洁、清晰 linweichao
- 修改了SelectByPrimaryKeyMapper的注释 祁玉
- fix:使用Example.buidler创建Example时使用orderBy报NullPointerException korov9
- Use HTTPS instead of HTTP to resolve dependencies
- 增加 virtual 关键字, fixed #272
- 所有 class.getCanonicalName 改为 class.getName fixed gitee#I1B8KL
- fix:修复WeekendSql下or操作value为String问题 Nonlone
- pr#711 修订批量插入,支持设置逻辑删除默认值;扩展支持批量更新;支持PostgreSQL UPSERT语句 ZhaoPengfei
- 修改 test 中的 log4j 为 logback
感谢以下贡献者:
- rse [email protected]
- Jonathan Leitschuh [email protected]
- Talank Baral [email protected]
- yangb [email protected]
- huangkaifeng [email protected]
- contextshuffling [email protected]
- wendell [email protected]
- Eric Hettiaratchi [email protected]
- linweichao [email protected]
- 祁玉 [email protected]
- korov9 [email protected]
- Nonlone [email protected]
- ZhaoPengfei [email protected]
4.2.0 版本中缺少了 gitee 仓库中的两个合并请求,针对这部分代码,再次发布 4.2.1 版本。
-
orderByDesc
只有最后一个字段是倒序,改为所有参与orderby
的字段都倒序 Mr 轩少/V1.1.5-orderByDesc-fix - 增加Lombok 的
@SuperBuilder、@NoArgsConstructor、@AllArgsConstructor
注解 tingwen 2020/12/26 18:29 8c816794
本次更新最大改动就是统一了所有模块的版本,所有版本都升级为 4.2.0,在之前本项目一共有3个版本号,本次升级前后的版本如下:
- mapper, mapper-all, mapper-all-dependencies 从 4.1.5 升级为 4.2.0
- mapper-core, mapper-base, mapper-extra, mapper-generator, mapper-spring, mapper-weekend 从 1.1.5 升级为 4.2.0
- mapper-spring-boot-starter 相关模块从 2.1.5 升级为 4.2.0
本次更新是 2019年1月28日发布 4.1.5 之后的首次发布,此次更新的内容基本上都来自所有热心开发人员的PR,大部分PR都是功能增强或新功能。
-
WeekendSqls
or部分方法参数 String->Object taiyi* 2021/11/29 19:39 1aa5eff6 - 改进对null的查询 改进对空集合的查询 改进对like的查询 Cheng.Wei* 2020/3/19 0:24 1523d57f
- 改进查询对null值的处理策略 Cheng.Wei* 2020/3/19 0:07 afb6ffc8
- Update FieldHelper.java kong-ly* 2020/3/17 16:06 4a5675d6
- 修复一个错误,该错误可能导致
EntityHelper.entityTableMap
被错误清空 glacier* 2020/4/1 18:29 8c57af04 - 扩展一些根据属性及条件值删除的通用方法 jingkaihui* 2020/7/20 17:25 3bf2e1a0
- 修复
Example.Criteria
未设置where
条件查询时,带有逻辑删除注解的表报错问题,fixed #722 jingkaihui* 2020/7/20 15:31 570ef154 - 修改生成的getter方法注释中@return 列名为@return 属性名 wanglei* 2018/1/24 11:04 b08258bc
- 更新地址 https://mybatis.io abel533 2020/7/27 21:52 ba417dc3
- 扩展一些根据属性及条件值查询的通用方法 jingkaihui* 2019/10/19 22:14 bd101038
- 添加日志输出异常和警告信息,fixed #IXNLU isea533 2019/6/18 22:03 1764748e
- 合并 pr #17 isea533 2019/5/30 21:53 8d7819e3
- [新增]
Weekend
对象增加excludeProperties、selectProperties、orderBy、withCountProperty
支持lambda表达式写属性名 使用withXXXXX的命名方式链式设置属性 wugh 2019/5/30 14:41 3e25bb9b - [bug修复] 修复
generateDefaultInstanceMethod
参数,生成的实体类的defaultInstance
静态方式. 1.存在默认值为''::character varying问题 2.支持基本类型 wugh 2019/5/30 13:58 cf3e40aa - [新增] 生成实体类的时候,使用表注释创建类的注释 wugh 2019/5/30 11:28 b4acbf48
- 增加
lombokEqualsAndHashCodeCallSuper
配置,当使用lombok扩展的EqualsAndHashCode
注解时,可通过此配置(true)为此注解添加“callSuper = true”
,这对于有继承父类的实体类,如增加支持动态表名时,有用。 calvinit 2019/2/14 13:52 ae901608
- [新增] 代码生成工具增加 swagger支持 by wugh
- [新增] 代码生成工具增 生成generateColumnConsts时候,增加DB_XXX 记录字段名,用于pageHelper分页 或 排序 by wugh
- [新增] 代码生成工具增加 generateDefaultInstanceMethod 生成实体类时候增加defaultInstance静态方法,创建带数据库默认值的实例,主要用于批量插入时,减少重复添加数据库默认值操作,办不支持时间类型 by wugh
- [BUG] Example 更新方法中,set 更新列中排除乐观锁字段
- 解决乐观锁使用 Timestamp 类型时的赋值错误,使用 标签临时存储值,sql 中通过 #{} 赋值解决。针对乐观锁时间戳和数字类型添加测试,fixed #IQY5R.
- 因为 updateByExample 和 updateByExampleSelective 是批量更新,所以去掉了乐观锁条件,这两个方法不支持乐观锁。
- fix: 根据条件更新,version参数获取不到的bug 王福顺 #pr506
- lombok 增加 Data 和 EqualsAndHashCode 注解支持,如果使用了 Data,Getter Setter ToString EqualsAndHashCode 会被忽略。
Spring Boot Starter 升级到 2.1.3 版本。
在 Spring Boot 项目中,使用 generator 时,指定最新版本:
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-generator</artifactId>
<version>1.1.3</version>
</dependency>
强烈推荐升级,尤其是 mapper-spring-boot-starter 需要升级到 2.1.2 版本
- 解决判断
MapperFactoryBean
包名错误的大 BUG(2.x 版本),应该是tk.mybatis.spring.mapper.MapperFactoryBean
而不是org.mybatis.spring.mapper.MapperFactoryBean
,这个 BUG 导致了 issues 中出现的 WARN 警告。 - 现在即使扫描到了基类Mapper,也会排除带有
@RegisterMapper
注解的接口。 - 使用 starter 时,可以配置 mybatis.base-packages 属性,配置该属性后在自动扫描时,会扫描指定的目录,并且不会要求接口带
@Mapper
注解。 - 和 MyBatis 官方 Starter 同步,增加
mybatis.typeAliasesSuperType
属性。 - 升级 Spring Boot 版本到 2.1.1.RELEASE
通用 Mapper 3.x 版本的时候是必须配置 mapper.mappers 属性的,从 4.x 开始增加了 @RegisterMapper 注解,该注解用于所有通用方法接口上,也用于所有作为基类的接口。该注解有以下主要作用。
- 初始化扫描 Mapper 时,如果发现了接口的 super interface 中(递归)存在带有 @RegisterMapper 注解,就会认为当前 Mapper 继承了通用方法,就会对该 Mapper 进行特殊处理。通用 Mapper 提供的所有通用接口都带有该注解。
- 如果你实现了自己的基类接口例如 MyMapper,你可以给这个接口添加 @RegisterMapper 注解,添加后所有继承 MyMapper 的接口都会被自动处理,不需要配置 mapper.mappers 属性。
- 和 Spring 集成时,从 basePackages 扫描的时候,如果发现接口上有 @RegisterMapper 注解,就会忽略该接口。
- 修复正常场景下逻辑删除注解会出现的严重 Bug
- 去掉了4.0.3版本增加的更新时的 set id = id 功能,避免不必要的更新,需要自己在业务层避免更新空对象时的 SQL 语法错误。
- ColumnType、LogicDelete、Order、Version 四个注解现在可以用于方法上了。
- 解决 @KeySql GenId 覆盖已有 ID 的问题 fixed #482
- 解决 Example 中 public Criteria andEqualTo(Object param) 参数可能为 null 时的错误 fixed #425
- 新增
@Order(value = "DESC", priority = 2)
注解,可以配置排序的优先级 by qrqhuangcy #457 - 增加 Oracle 批量插入方法,在
OracleMapper
中 by qrqhuangcy #467 - 通过反射设置主键值,解决 issue #445 和 #461,mysql 和 sqlserver 特殊的插入操作不在需要指定
keyProperty
by 孙昊 #469 - delete 所有相关方法去掉乐观锁条件 by JiangYongKang #405
- (逻辑删除注解功能严重Bug,请勿使用该版本的逻辑删除功能。)逻辑删除功能的selectByExample,updateByExample,updateByExampleSelective条件where中加入逻辑删除字段的未删除条件 by duwey #458
- insertList 方法增加非空校验
- 避免多处潜在的 NPE 风险 by 何昇邦 #398
-
在生成的 model中,增加字段名的常量,便于使用
Example
拼接查询条件的时候使用。 by zhiguangliu #404 针对该功能还有一个可配置参数(generateColumnConsts
),默认不启用,配置为true
后,会生成类似下面部分的代码:@Table(name = "`COUNTRY`") public class Country { @Id @Column(name = "`ID`") @GeneratedValue(generator = "JDBC") private Integer id; @Column(name = "`COUNTRYNAME`") private String countryname; @Column(name = "`COUNTRYCODE`") private String countrycode; @Column(name = "`VERSION`") private Integer version; //下面是该功能增加的静态字段,值为属性名,方便在 Example 中使用 public static final String ID = "id"; public static final String COUNTRYNAME = "countryname"; public static final String COUNTRYCODE = "countrycode"; public static final String VERSION = "version"; }
-
增加 model 代码生成时,可以直接生成 lombok 的
@Getter@Setter@ToString@Accessors(chain = true)
四类注解, 使用者在插件配置项中增加<property name="lombok" value="Getter,Setter,ToString,Accessors"/>
即可生成对应包含注解的 model 类 by finira #296 生成效果如下:@Getter @Setter @ToString @Accessors(chain = true) @Table(name = "`COUNTRY`") public class Country { //忽略其他 }
- 增加一个差异更新的方法 updateByDiffer 根据两个参数 old 和 newer 进行差异更新,当对应某个字段值不同时才会更新。
- 添加
updateByPrimaryKeySelectiveWithForceUpdate
(#344) by Huang Changyuan - KeySql 注解增加 GenSql 配置,允许自定义主键 SQL 生成方式。
- 修改两个 insertList 参数为 List<? extends T>, fixed #370。
- 增加一个基于通用 Mapper 的全套完整架构的多个项目,这些项目在 guozilanTK 组织中。
- 完善对 devtools 的支持。
-
@KeySql
注解增加genId
方式,后续提供详细使用文档。 -
tk.mybatis.mapper.additional.insert.InsertListMapper
增加对@KeySql
注解genId
方法的支持。 -
tk.mybatis.mapper.additional.insert.InsertListMapper
增加@RegisterMapper
注解,此问题应该是之前导致常见问题的主要原因。 -
增加
MetaObjectUtil
兼容 MyBatis 不同版本,该工具类来自分页插件 PageHelper。 -
完善乐观锁,增加
NextVersion
实例缓存。 -
乐观锁增加对
java.sql.Timestamp
的支持。 -
增加拆分项目后缺失的 spring-devtools.properties。
-
增加通用聚合查询方法 by liuchan
-
重构聚合查询,改为执行的时候进行拼接查询语句。
-
wrapKeyword
增加对表名关键字的处理。 -
增加
IdListMapper
,完善 IdList 方法,增加测试。 -
@Id
列设置set id = id
时,增加判断updateable
属性,默认true
,设置false
后,不添加set id = id
。
- 解决 Config 中 ORDER 配置在 Spring Boot 中无法生效的问题
- 更新 4.1 专用代码生成器 文档,使用全新的内容
- 升级 mapper-core 到 1.0.1 (和 4.0.1 中的 core 相同)
- 升级 mybatis 到 3.4.6
- 升级 mybatis-spring 到 1.3.2
地址:https://github.com/abel533/mapper-base2
该项目直接从 mapper/base 模块复制而来,对接口中的泛型增加了主键和 Example,可以更严格的控制参数。
主要 Mapper 接口为 tk.mybatis.mapper.common2.Mapper<T, ID, EXAMPLE>
。
注意包名中的 common2
使用示例如下:
public interface CountryMapper
extends Mapper<Country, Integer, Example>,
HsqldbMapper<Country>,
MySqlMapper<Country>,
IdsMapper<Country> {
}
和
public interface UserInfoMapper extends Mapper<UserInfo, Integer, Example> {
}
tk.mybatis:mapper 项目默认聚合了 mapper-base 项目,而当前这个是 mapper-base2 项目。
由于包名完全不同,因此可以在原来基础上直接引入 mapper-base2 :
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-base2</artifactId>
<version>1.0.0</version>
</dependency>
<selectKey>
中的order
属性,可选值为BEFORE
和AFTER
。
后来为了方便在 Spring Boot 中配置该参数,符合 Boot 的规范,增加了 order
和 before
两个别名。
在 3.1 的配置以及 2.3.2 和 2.3.3 中都提到了这个参数。
在支持主键递增,满足 2.3.2 中的情况时,配置如下:
//Properties 方式配置时
ORDER=AFTER
//还可以
order=AFTER
//或
before=false
//Spring Boot 中,比上面多个前缀,并且 ORDER 不能使用
mapper.order=AFTER
//或者(Spring Boot)
mapper.before=false
在类似Oracle序列或者通用的 UUID 时,配置如下:
//Properties 方式配置时
ORDER=BEFORE
//还可以
order=BEFORE
//或
before=true
//Spring Boot 中,比上面多个前缀,并且 ORDER 不能使用
mapper.order=BEFORE
//或者(Spring Boot)
mapper.before=true
上面示例中有多种写法,使用时按照需要选择一种即可,切勿同时配置!
更新内容太多,请查看 4.0 更新日志。
- 解决 MapperHelper.setConfig 方法中没有处理 mappers 的 BUG,主要影响 starter 中的使用。
测试用例如下:
/**
* 乐观锁删除
*/
@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
增加javaTypeClass
by 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.MapperScannerConfigurer
tk.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 - [email protected] 提供 - 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. 配置介绍