Mybatis Update操作返回值修改为受影响条数

男娘i 2022-05-29 10:08 281阅读 0赞

到底 update 返回值代表什么呢？我们来验证一下便知道了，假设有如下一张表以及两条数据：  
![aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMjY1OTk5OD93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA][]

我们来编写一个简单的单元测试用例来验证下,首先使用 mybatis 简单的写个 mapper 进行更新操作，其中 xml 中的内容为：  
![aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzIzMDIxNz93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA][]

**数据库连接配置为：**  
![aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzMyNjUyNz93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA][]

接来下，我们来编写一个简单的单元测试来验证下： update 的返回值是不是受影响的记录的条数 ，对应的单元测试代码如下：  
![aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzQwNDM5OD93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA][]

由单元测试代码可以得知，我们将要把数据库中两条记录的 phone 字段的值由 12345678 修改为 66666666 ,正常情况下， resultCode 将会返回 2 。因为 update 操作影响到数据库中这 2 条记录，这和我们期望 2 是相符合的。那么一切正常的情况下，这次单元测试将会通过，那么我们运行看看结果：  
![aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzQ1MTExMD93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA][]

单元测试通过了，再查看数据库中的记录：  
![aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzUyMzEyNz93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA][]

> 这说明 mybatis 的 update 更新操作返回值的确是返回受影响的行数……真的是这样吗？

我们知道，当数据库中的记录被修改之后，再次执行重复的 update 操作将不会影响到新的行数，为了验证我说的话，我们试试：  
![aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzYwMzg5MT93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA][]

那么，按照这个逻辑：我们再次执行这个单元测试应该是， resultCode 返回的应该是 0 ，和我们的期望的数字 2 不一致，将会导致测试不通过。再次运行单元测试：  
![aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwNDExMTg3OD93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA][]

居然还是 passed ,看到这里聪明的你已经看出来了， 默认情况下，mybatis 的 update 操作返回值是记录的 matched 的条数，并不是影响的记录条数。  
严格意义上来将，这并不是 mybatis 的返回值，mybatis 仅仅只是返回的数据库连接驱动（通常是 JDBC ）的返回值，也就是说，如果驱动告知更新 2 条记录受影响，那么我们将得到 mybatis 的返回值就会是 2 和 mybatis 本身是没有关系的。  
道理我都懂，如果我们非得要 mybatis 的 update 操作明确的返回受影响的记录条数，有没有什么办法呢？  
当然是有的。  
通过对 JDBC URL 显式的指定 useAffectedRows 选项，我们将可以得到受影响的记录的条数：

> jdbc:mysql:// j d b c . h o s t / \{jdbc.host\}/ jdbc.host/\{jdbc.db\}?useAffectedRows=true

我们对我们的数据库连接配置稍做修改，添加 useAffectedRows 字段：  
![aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwNDIxNTc3Nz93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA][]

此时，mybatis 的 update 操作返回的应该是受影响的条数了，我们再次运行单元测试试试看：  
![aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwNDIzOTI4MD93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA][]

update 操作返回的是受影响的记录条数，我们知道为 0 和我们预期的 2 不一致，自然而然单元测试不通过。

[aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMjY1OTk5OD93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA]: /images/20220529/b5143ff17392445589aa975b31c69353.png
[aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzIzMDIxNz93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA]: /images/20220529/c8199e58d54c4b86be045b1f52ae95c7.png
[aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzMyNjUyNz93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA]: /images/20220529/107e8230d18d4146a547310e450aa365.png
[aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzQwNDM5OD93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA]: /images/20220529/cca40fcc702d446bb758213f5b298c36.png
[aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzQ1MTExMD93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA]: /images/20220529/df75a823fd55452b9f3bbb7d388dec99.png
[aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzUyMzEyNz93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA]: /images/20220529/508059260f614f73b043684f6713ab7e.png
[aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwMzYwMzg5MT93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA]: /images/20220529/cdca213f07c840849f42daea8e01ccbc.png
[aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwNDExMTg3OD93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA]: /images/20220529/66217ec26a07488a912441ff19c82573.png
[aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwNDIxNTc3Nz93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA]: /images/20220529/60d9ad9ac4e64db6be29bd8b895164f9.png
[aHR0cHM6Ly9pbWctYmxvZy5jc2RuLm5ldC8yMDE4MDMyMTIwNDIzOTI4MD93YXRlcm1hcmsvMi90ZXh0L0x5OWliRzluTG1OelpHNHVibVYwTDJKbGJtSmxialk0TXpJNE1BPT0vZm9udC81YTZMNUwyVC9mb250c2l6ZS80MDAvZmlsbC9JMEpCUWtGQ01BPT0vZGlzc29sdmUvNzA]: /images/20220529/642ab8462ba44cb4af1b7a6647e962db.png