Merge branch 'mybatis-flex:main' into main

This commit is contained in:
Jiabin Zhuang 2023-06-02 08:26:41 +08:00 committed by GitHub
commit 7006e27fea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
28 changed files with 513 additions and 168 deletions

View File

@ -1,3 +1,14 @@
mybatis-flex v1.3.4 20230601:
新增:添加 Spring 下的 CacheableServiceImpl 实现类,方便用户缓存。感谢 @王帅
优化:重构 IService使之有更好的方法服用。感谢 @王帅
优化:重命名 QueryWrapper 的 "toDebugSQL()" 方法名为 "toSQL()"
修复:当使用 QueryWrapper 未指定 from 时schema 出错的问题
修复:当配置 config-location 时,出现 IllegalArgumentException 错误的问题
修复case when else 中出现的 column 无法转换的问题 #I7A0B0
文档:添加关于 CacheableServiceImpl 使用的一些文档。感谢 @王帅
mybatis-flex v1.3.3 20230530:
新增:添加动态表名和动态 Schema 的支持 #I6VRMF #I6WS3E #I72X21
新增:添加 @Table(schema=xxx) 配置的支持 #I6VD6U

View File

@ -78,6 +78,7 @@ export default defineConfig({
{text: '乐观锁', link: '/zh/core/version'},
{text: '数据填充', link: '/zh/core/fill'},
{text: '数据脱敏', link: '/zh/core/mask'},
{text: '数据缓存', link: '/zh/core/data-cache'},
{text: 'SQL 审计', link: '/zh/core/audit'},
{text: 'SQL 打印', link: '/zh/core/sql-print'},
{text: '多数据源', link: '/zh/core/multi-datasource'},

170
docs/zh/core/data-cache.md Normal file
View File

@ -0,0 +1,170 @@
# 数据缓存
MyBatis-Flex 是一个 MyBatis 增强框架,所以您可以使用 MyBatis 提供的二级缓存来作为数据缓存。但是它仍然有很多的缺点,比如不适用于分布式环境,在这里推荐使用 [Spring Cache](https://docs.spring.io/spring-framework/docs/5.2.24.RELEASE/spring-framework-reference/integration.html#cache) 模块来处理数据缓存。
## 使用方法
因为要用到 Spring Cache 模块,所以您的项目必须要使用 Spring Framework 框架,这里以 Spring Boot 项目作为例子,实现 MyBatis-Flex 项目将缓存数据存入 Redis 组件中。
1、引入 `spring-boot-starter-cache``spring-boot-starter-data-redis`模块
```xml
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
</dependencies>
```
2、设置 Redis 连接信息(全是默认的话可以跳过这步)
```yaml
spring:
redis:
port: 6379
host: localhost
```
3、在 Spring Boot 配置类上启用 Spring Cache 缓存
```java
@EnableCaching
@Configuration
public class CacheConfig {
}
```
4、将 ServiceImpl 默认实现类换为 CacheableServiceImpl 实现类
```java
public interface AccountService extends IService<Account> {
}
@Service
public class AccountServiceImpl extends CacheableServiceImpl<AccountMapper, Account> implements AccountService {
}
```
5、最后即可使用 Spring Cache 的相关注解实现数据缓存到 Redis 中了
```java
// 设置统一的缓存名称
@Service
@CacheConfig(cacheNames = "account")
public class AccountServiceImpl extends CacheableServiceImpl<AccountMapper, Account> implements AccountService {
// 根据主键缓存数据
@Override
@Cacheable(key = "#id")
public Account getById(Serializable id) {
return super.getById(id);
}
// 根据方法名加查询 SQL 语句缓存结果数据
// 加上方法名是为了避免不同的方法使用一样的 QueryWrapper
@Override
@Cacheable(key = "#root.methodName + ':' + #query.toSQL()")
public List<Account> list(QueryWrapper query) {
return super.list(query);
}
}
```
## 使用说明
MyBatis-Flex 在 IService 接口中做了方法调用链优化,所以您只需将缓存注解加到一些特定的方法上,即可实现所有相关的方法也可以进行数据缓存。相关方法见如下示例:
```java
@Service
@CacheConfig(cacheNames = "account")
public class AccountServiceImpl extends CacheableServiceImpl<MyAccountMapper, Account> {
@Override
@CacheEvict(allEntries = true)
public boolean remove(QueryWrapper query) {
return super.remove(query);
}
@Override
@CacheEvict(key = "#id")
public boolean removeById(Serializable id) {
return super.removeById(id);
}
@Override
@CacheEvict(allEntries = true)
public boolean removeByIds(Collection<? extends Serializable> ids) {
return super.removeByIds(ids);
}
@Override
@CachePut(key = "#entity.id")
public boolean update(Account entity, QueryWrapper query) {
return super.update(entity, query);
}
@Override
@CachePut(key = "#entity.id")
public boolean updateById(Account entity) {
return super.updateById(entity);
}
@Override
@Cacheable(key = "#id")
public Account getById(Serializable id) {
return super.getById(id);
}
@Override
@Cacheable(key = "#root.methodName + ':' + #query.toSQL()")
public Account getOne(QueryWrapper query) {
return super.getOne(query);
}
@Override
@Cacheable(key = "#root.methodName + ':' + #query.toSQL()")
public <R> R getOneAs(QueryWrapper query, Class<R> asType) {
return super.getOneAs(query, asType);
}
@Override
@Cacheable(key = "#root.methodName + ':' + #query.toSQL()")
public List<Account> list(QueryWrapper query) {
return super.list(query);
}
@Override
@Cacheable(key = "#root.methodName + ':' + #query.toSQL()")
public <R> List<R> listAs(QueryWrapper query, Class<R> asType) {
return super.listAs(query, asType);
}
// 无法通过注解进行缓存操作
@Override
@Deprecated
public List<Account> listByIds(Collection<? extends Serializable> ids) {
return super.listByIds(ids);
}
@Override
@Cacheable(key = "#root.methodName + ':' + #query.toSQL()")
public long count(QueryWrapper query) {
return super.count(query);
}
@Override
@Cacheable(key = "#root.methodName + ':' + #query.toSQL()")
public Page<Account> page(Page<Account> page, QueryWrapper query) {
return super.page(page, query);
}
}
```

View File

@ -37,9 +37,11 @@ MyBatis-Flex 主要是和 `MyBatis-Plus` 与 `Fluent-MyBatis` 对比,内容来
| Db + Row | ✅ | ❌ | ❌ |
| Entity 监听 | ✅ | ❌ | ❌ |
| 多数据源支持 | ✅ | 借助其他框架或收费 | ❌ |
| 多数据源是否支持 Spring 的事务管理,比如 `@Transactional` 注解等 | ✅ | ❌ | ❌ |
| 多数据源是否支持 Spring 的事务管理,比如 `@Transactional` `TransactionTemplate` 等 | ✅ | ❌ | ❌ |
| 多数据源是否支持 "非Spring" 项目 | ✅ | ❌ | ❌ |
| 多租户 | ✅ | ✅ | ❌ |
| 动态表名 | ✅ | ✅ | ❌ |
| 动态 Schema | ✅ | ❌ | ❌ |
> 以上内容来自第三方相关产品的官方文档或第三方平台,若有错误,欢迎纠正。

View File

@ -27,12 +27,12 @@ Maven示例
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-core</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-processor</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
<scope>provided</scope>
</dependency>
```
@ -46,7 +46,7 @@ Gradle示例
```groovy
// file: build.gradle
ext {
mybatis_flex_version = '1.3.3'
mybatis_flex_version = '1.3.4'
}
dependencies {
implementation("com.mybatis-flex:mybatis-flex-core:${mybatis_flex_version}")

View File

@ -12,12 +12,12 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-core</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-processor</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
<scope>provided</scope>
</dependency>
```
@ -28,12 +28,12 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-spring</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-processor</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
<scope>provided</scope>
</dependency>
``````
@ -44,12 +44,12 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-spring-boot-starter</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-processor</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
<scope>provided</scope>
</dependency>
```
@ -70,7 +70,7 @@
<path>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-processor</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</path>
</annotationProcessorPaths>
</configuration>

View File

@ -179,7 +179,7 @@ processor.baseMapperClass=com.domain.mapper.MyBaseMapper
```
dependencies {
...
annotationProcessor 'com.mybatis-flex:mybatis-flex-processor:1.3.3'
annotationProcessor 'com.mybatis-flex:mybatis-flex-processor:1.3.4'
}
```

View File

@ -10,7 +10,7 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-codegen</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
```

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>parent</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>parent</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -27,7 +27,7 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-spring</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>parent</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -22,13 +22,13 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-annotation</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-processor</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>

View File

@ -20,7 +20,7 @@ package com.mybatisflex.core;
*/
public class FlexConsts {
public static final String NAME = "MyBatis-Flex";
public static final String VERSION = "1.3.3";
public static final String VERSION = "1.3.4";
public static final String DEFAULT_PRIMARY_FIELD = "id";

View File

@ -15,6 +15,7 @@
*/
package com.mybatisflex.core.query;
import com.mybatisflex.core.dialect.DialectFactory;
import com.mybatisflex.core.dialect.IDialect;
import com.mybatisflex.core.util.ArrayUtil;
import com.mybatisflex.core.util.LambdaGetter;
@ -24,7 +25,7 @@ import com.mybatisflex.core.util.StringUtil;
import java.util.ArrayList;
import java.util.List;
public class CaseQueryColumn extends QueryColumn implements HasParamsColumn{
public class CaseQueryColumn extends QueryColumn implements HasParamsColumn {
private List<When> whens;
private Object elseValue;
@ -83,6 +84,10 @@ public class CaseQueryColumn extends QueryColumn implements HasParamsColumn{
private String buildValue(Object value) {
if (value instanceof Number || value instanceof Boolean) {
return String.valueOf(value);
} else if (value instanceof RawValue) {
return ((RawValue) value).getContent();
} else if (value instanceof QueryColumn) {
return ((QueryColumn) value).toConditionSql(null, DialectFactory.getDialect());
} else {
return "'" + value + "'";
}
@ -90,10 +95,13 @@ public class CaseQueryColumn extends QueryColumn implements HasParamsColumn{
@Override
public Object[] getParamValues() {
Object[] values = new Object[0];
Object[] values = WrapperUtil.NULL_PARA_ARRAY;
for (When when : whens) {
values = ArrayUtil.concat(values, WrapperUtil.getValues(when.whenCondition));
}
if (elseValue instanceof HasParamsColumn){
values = ArrayUtil.concat(values,((HasParamsColumn) elseValue).getParamValues());
}
return values;
}

View File

@ -15,7 +15,9 @@
*/
package com.mybatisflex.core.query;
import com.mybatisflex.core.dialect.DialectFactory;
import com.mybatisflex.core.dialect.IDialect;
import com.mybatisflex.core.util.ArrayUtil;
import com.mybatisflex.core.util.LambdaGetter;
import com.mybatisflex.core.util.LambdaUtil;
import com.mybatisflex.core.util.StringUtil;
@ -23,7 +25,7 @@ import com.mybatisflex.core.util.StringUtil;
import java.util.ArrayList;
import java.util.List;
public class CaseSearchQueryColumn extends QueryColumn {
public class CaseSearchQueryColumn extends QueryColumn implements HasParamsColumn {
private QueryColumn queryColumn;
private List<When> whens;
@ -65,6 +67,10 @@ public class CaseSearchQueryColumn extends QueryColumn {
private String buildValue(Object value) {
if (value instanceof Number || value instanceof Boolean) {
return String.valueOf(value);
} else if (value instanceof RawValue) {
return ((RawValue) value).getContent();
} else if (value instanceof QueryColumn) {
return ((QueryColumn) value).toConditionSql(null, DialectFactory.getDialect());
} else {
return "'" + value + "'";
}
@ -89,6 +95,17 @@ public class CaseSearchQueryColumn extends QueryColumn {
return as(LambdaUtil.getFieldName(fn));
}
@Override
public Object[] getParamValues() {
Object[] values = WrapperUtil.NULL_PARA_ARRAY;
if (elseValue instanceof HasParamsColumn) {
values = ArrayUtil.concat(values, ((HasParamsColumn) elseValue).getParamValues());
}
return values;
}
public static class When {
private Builder builder;
private Object searchValue;

View File

@ -535,7 +535,7 @@ public class QueryWrapper extends BaseQueryWrapper<QueryWrapper> {
}
public String toDebugSQL() {
public String toSQL() {
String sql = DialectFactory.getDialect().forSelectByQuery(this);
return SqlUtil.replaceSqlParams(sql, getValueArray());
}

View File

@ -1,26 +1,26 @@
/**
* Copyright (c) 2022-2023, Mybatis-Flex (fuhai999@gmail.com).
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
/*
* Copyright (c) 2022-2023, Mybatis-Flex (fuhai999@gmail.com).
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mybatisflex.core.service;
import com.mybatisflex.core.BaseMapper;
import com.mybatisflex.core.exception.FlexExceptions;
import com.mybatisflex.core.paginate.Page;
import com.mybatisflex.core.query.QueryCondition;
import com.mybatisflex.core.query.QueryWrapper;
import com.mybatisflex.core.row.Db;
import com.mybatisflex.core.row.RowMapper;
import com.mybatisflex.core.util.ClassUtil;
import com.mybatisflex.core.util.CollectionUtil;
import com.mybatisflex.core.util.SqlUtil;
@ -36,20 +36,22 @@ import java.util.*;
* @author 王帅
* @since 2023-05-01
*/
@SuppressWarnings("unused")
@SuppressWarnings({"unused", "unchecked"})
public interface IService<T> {
int DEFAULT_BATCH_SIZE = 1000;
// ===== 保存操作 =====
/**
* 获取对应实体类Entity的基础映射类BaseMapper
* <p>获取对应实体类Entity的基础映射类BaseMapper
*
* @return 基础映射类BaseMapper
*/
BaseMapper<T> getMapper();
/**
* 保存实体类对象数据
* <p>保存实体类对象数据
*
* @param entity 实体类对象
* @return {@code true} 保存成功{@code false} 保存失败
@ -61,7 +63,7 @@ public interface IService<T> {
}
/**
* 保存或者更新实体类对象数据
* <p>保存或者更新实体类对象数据
*
* @param entity 实体类对象
* @return {@code true} 保存或更新成功{@code false} 保存或更新失败
@ -72,30 +74,30 @@ public interface IService<T> {
}
/**
* 批量保存实体类对象数据
* <p>批量保存实体类对象数据
*
* @param entities 实体类对象
* @return {@code true} 保存成功{@code false} 保存失败
*/
default boolean saveBatch(Collection<T> entities) {
return SqlUtil.toBool(getMapper().insertBatch(new ArrayList<>(entities)));
return saveBatch(entities, DEFAULT_BATCH_SIZE);
}
// ===== 删除操作 =====
/**
* 批量保存实体类对象数据
* <p>批量保存实体类对象数据
*
* @param entities 实体类对象
* @param size 每次保存切分的数量
* @param entities 实体类对象
* @param batchSize 每次保存切分的数量
* @return {@code true} 保存成功{@code false} 保存失败
*/
default boolean saveBatch(Collection<T> entities, int size) {
return SqlUtil.toBool(getMapper().insertBatch(CollectionUtil.toList(entities), size));
default boolean saveBatch(Collection<T> entities, int batchSize) {
return SqlUtil.toBool(getMapper().insertBatch(CollectionUtil.toList(entities), batchSize));
}
/**
* 根据查询条件删除数据
* <p>根据查询条件删除数据
*
* @param query 查询条件
* @return {@code true} 删除成功{@code false} 删除失败
@ -105,17 +107,17 @@ public interface IService<T> {
}
/**
* 根据查询条件删除数据
* <p>根据查询条件删除数据
*
* @param condition 查询条件
* @return {@code true} 删除成功{@code false} 删除失败
*/
default boolean remove(QueryCondition condition) {
return SqlUtil.toBool(getMapper().deleteByCondition(condition));
return remove(query().where(condition));
}
/**
* 根据数据主键删除数据
* <p>根据数据主键删除数据
*
* @param id 数据主键
* @return {@code true} 删除成功{@code false} 删除失败
@ -125,7 +127,7 @@ public interface IService<T> {
}
/**
* 根据数据主键批量删除数据
* <p>根据数据主键批量删除数据
*
* @param ids 数据主键
* @return {@code true} 删除成功{@code false} 删除失败
@ -140,17 +142,54 @@ public interface IService<T> {
// ===== 更新操作 =====
/**
* 根据 {@link Map} 构建查询条件删除数据
* <p>根据 {@link Map} 构建查询条件删除数据
*
* @param query 查询条件
* @return {@code true} 删除成功{@code false} 删除失败
*/
default boolean removeByMap(Map<String, Object> query) {
return SqlUtil.toBool(getMapper().deleteByMap(query));
// 防止全表删除
if (query == null || query.isEmpty()) {
throw FlexExceptions.wrap("deleteByMap is not allow empty map.");
}
return remove(query().where(query));
}
/**
* 根据查询条件更新数据
* <p>根据数据主键更新数据
*
* @param entity 实体类对象
* @return {@code true} 更新成功{@code false} 更新失败
*/
default boolean updateById(T entity) {
return SqlUtil.toBool(getMapper().update(entity));
}
/**
* 根据主键更新数据
*
* @param entity 实体对象
* @param ignoreNulls 是否忽略 null
* @return {@code true} 更新成功{@code false} 更新失败
*/
default boolean updateById(T entity, boolean ignoreNulls) {
return SqlUtil.toBool(getMapper().update(entity, ignoreNulls));
}
/**
* <p>根据 {@link Map} 构建查询条件更新数据
*
* @param entity 实体类对象
* @param query 查询条件
* @return {@code true} 更新成功{@code false} 更新失败
*/
default boolean update(T entity, Map<String, Object> query) {
return update(entity, query().where(query));
}
/**
* <p>根据查询条件更新数据
*
* @param entity 实体类对象
* @param query 查询条件
@ -161,69 +200,48 @@ public interface IService<T> {
}
/**
* 根据查询条件更新数据
* <p>根据查询条件更新数据
*
* @param entity 实体类对象
* @param condition 查询条件
* @return {@code true} 更新成功{@code false} 更新失败
*/
default boolean update(T entity, QueryCondition condition) {
return SqlUtil.toBool(getMapper().updateByCondition(entity, condition));
return update(entity, query().where(condition));
}
/**
* 根据 id 批量更新数据
* <p>根据数据主键批量更新数据
*
* @param entities 实体类对象集合
* @return boolean {@code true} 更新成功{@code false} 更新失败
*/
default boolean updateBatch(Collection<T> entities) {
return updateBatch(entities, RowMapper.DEFAULT_BATCH_SIZE);
return updateBatch(entities, DEFAULT_BATCH_SIZE);
}
/**
* 根据 id 批量更新数据
* <p>根据数据主键批量更新数据
*
* @param entities 实体类对象集合
* @param batchSize 每批次更新数量
* @return boolean {@code true} 更新成功{@code false} 更新失败
* @return {@code true} 更新成功{@code false} 更新失败
*/
@SuppressWarnings("unchecked")
default boolean updateBatch(Collection<T> entities, int batchSize) {
return Db.tx(() -> {
final List<T> entityList = CollectionUtil.toList(entities);
// BaseMapper 是经过 Mybatis 动态代理处理过的对象需要获取原始 BaseMapper 类型
final Class<BaseMapper<T>> usefulClass = (Class<BaseMapper<T>>) ClassUtil.getUsefulClass(getMapper().getClass());
return SqlUtil.toBool(Arrays.stream(Db.executeBatch(entityList.size(), batchSize, usefulClass, (mapper, index) -> mapper.update(entityList.get(index)))).sum());
});
}
/**
* 根据数据主键更新数据
*
* @param entity 实体类对象
* @return {@code true} 更新成功{@code false} 更新失败
*/
default boolean updateById(T entity) {
return SqlUtil.toBool(getMapper().update(entity));
}
/**
* 根据 {@link Map} 构建查询条件更新数据
*
* @param entity 实体类对象
* @param query 查询条件
* @return {@code true} 更新成功{@code false} 更新失败
*/
default boolean updateByMap(T entity, Map<String, Object> query) {
return SqlUtil.toBool(getMapper().updateByMap(entity, query));
}
// ===== 查询操作 =====
/**
* 根据数据主键查询一条数据
* <p>根据数据主键查询一条数据
*
* @param id 数据主键
* @return 查询结果数据
@ -233,7 +251,7 @@ public interface IService<T> {
}
/**
* 根据数据主键查询一条数据
* <p>根据数据主键查询一条数据
*
* @param id 数据主键
* @return 查询结果数据
@ -244,7 +262,7 @@ public interface IService<T> {
}
/**
* 根据查询条件查询一条数据
* <p>根据查询条件查询一条数据
*
* @param query 查询条件
* @return 查询结果数据
@ -253,9 +271,19 @@ public interface IService<T> {
return getMapper().selectOneByQuery(query);
}
/**
* <p>根据查询条件查询一条数据
*
* @param query 查询条件
* @return 查询结果数据
* @apiNote 该方法会将查询结果封装为 {@link Optional} 类进行返回方便链式操作
*/
default Optional<T> getOneOpt(QueryWrapper query) {
return Optional.ofNullable(getOne(query));
}
/**
* 根据查询条件查询一条数据并通过 asType 进行接收
* <p>根据查询条件查询一条数据并通过 asType 进行接收
*
* @param query 查询条件
* @param asType 接收的数据类型
@ -266,41 +294,29 @@ public interface IService<T> {
}
/**
* 根据查询条件查询一条数据
*
* @param query 查询条件
* @return 查询结果数据
* @apiNote 该方法会将查询结果封装为 {@link Optional} 类进行返回方便链式操作
*/
default Optional<T> getOneOpt(QueryWrapper query) {
return Optional.ofNullable(getOne(query));
}
/**
* 根据查询条件查询一条数据
* <p>根据查询条件查询一条数据
*
* @param query 查询条件
* @param asType 接收的数据类型
* @return 查询结果数据
* @apiNote 该方法会将查询结果封装为 {@link Optional} 类进行返回方便链式操作
*/
default <R> Optional<R> getOneOptAs(QueryWrapper query, Class<R> asType) {
default <R> Optional<R> getOneAsOpt(QueryWrapper query, Class<R> asType) {
return Optional.ofNullable(getOneAs(query, asType));
}
/**
* 根据查询条件查询一条数据
* <p>根据查询条件查询一条数据
*
* @param condition 查询条件
* @return 查询结果数据
*/
default T getOne(QueryCondition condition) {
return getMapper().selectOneByCondition(condition);
return getOne(query().where(condition));
}
/**
* 根据查询条件查询一条数据
* <p>根据查询条件查询一条数据
*
* @param condition 查询条件
* @return 查询结果数据
@ -311,37 +327,16 @@ public interface IService<T> {
}
/**
* 查询所有数据
* <p>查询所有数据
*
* @return 所有数据
*/
default List<T> list() {
return getMapper().selectAll();
return list(query());
}
/**
* 根据查询条件查询数据集合
*
* @param condition 查询条件
* @return 数据集合
*/
default List<T> list(QueryCondition condition) {
return getMapper().selectListByCondition(condition);
}
/**
* 根据查询条件查询数据集合
*
* @param condition 查询条件
* @return 数据集合
*/
default List<T> list(QueryCondition condition, int count) {
return getMapper().selectListByCondition(condition, count);
}
/**
* 根据查询条件查询数据集合
* <p>根据查询条件查询数据集合
*
* @param query 查询条件
* @return 数据集合
@ -351,7 +346,17 @@ public interface IService<T> {
}
/**
* 根据查询条件查询数据集合并通过 asType 进行接收
* <p>根据查询条件查询数据集合
*
* @param condition 查询条件
* @return 数据集合
*/
default List<T> list(QueryCondition condition) {
return list(query().where(condition));
}
/**
* <p>根据查询条件查询数据集合并通过 asType 进行接收
*
* @param query 查询条件
* @param asType 接收的数据类型
@ -361,9 +366,8 @@ public interface IService<T> {
return getMapper().selectListByQueryAs(query, asType);
}
/**
* 根据数据主键查询数据集合
* <p>根据数据主键查询数据集合
*
* @param ids 数据主键
* @return 数据集合
@ -373,19 +377,19 @@ public interface IService<T> {
}
/**
* 根据 {@link Map} 构建查询条件查询数据集合
* <p>根据 {@link Map} 构建查询条件查询数据集合
*
* @param query 查询条件
* @return 数据集合
*/
default List<T> listByMap(Map<String, Object> query) {
return getMapper().selectListByMap(query);
return list(query().where(query));
}
// ===== 数量查询操作 =====
/**
* 根据查询条件判断数据是否存在
* <p>根据查询条件判断数据是否存在
*
* @param query 查询条件
* @return {@code true} 数据存在{@code false} 数据不存在
@ -395,7 +399,7 @@ public interface IService<T> {
}
/**
* 根据查询条件判断数据是否存在
* <p>根据查询条件判断数据是否存在
*
* @param condition 查询条件
* @return {@code true} 数据存在{@code false} 数据不存在
@ -405,16 +409,16 @@ public interface IService<T> {
}
/**
* 查询所有数据数量
* <p>查询所有数据数量
*
* @return 所有数据数量
*/
default long count() {
return getMapper().selectCountByQuery(QueryWrapper.create());
return count(query());
}
/**
* 根据查询条件查询数据数量
* <p>根据查询条件查询数据数量
*
* @param query 查询条件
* @return 数据数量
@ -424,29 +428,29 @@ public interface IService<T> {
}
/**
* 根据查询条件查询数据数量
* <p>根据查询条件查询数据数量
*
* @param condition 查询条件
* @return 数据数量
*/
default long count(QueryCondition condition) {
return getMapper().selectCountByCondition(condition);
return count(query().where(condition));
}
// ===== 分页查询操作 =====
/**
* 分页查询所有数据
* <p>分页查询所有数据
*
* @param page 分页对象
* @return 分页对象
*/
default Page<T> page(Page<T> page) {
return getMapper().paginate(page, QueryWrapper.create());
return page(page, query());
}
/**
* 根据查询条件分页查询数据
* <p>根据查询条件分页查询数据
*
* @param page 分页对象
* @param query 查询条件
@ -457,14 +461,18 @@ public interface IService<T> {
}
/**
* 根据查询条件分页查询数据
* <p>根据查询条件分页查询数据
*
* @param page 分页对象
* @param condition 查询条件
* @return 分页对象
*/
default Page<T> page(Page<T> page, QueryCondition condition) {
return getMapper().paginate(page, QueryWrapper.create().where(condition));
return page(page, query().where(condition));
}
default QueryWrapper query() {
return QueryWrapper.create();
}
}

View File

@ -60,7 +60,7 @@ public class AccountSqlTester {
});
TableManager.setDynamicTableProcessor(original -> original+"_01");
System.out.println(query.toDebugSQL());
System.out.println(query.toSQL());
}
@ -75,7 +75,7 @@ public class AccountSqlTester {
TableManager.setDynamicTableProcessor(original -> original+"_01");
TableManager.setDynamicTableProcessor(original -> original+"_01");
System.out.println(query.toDebugSQL());
System.out.println(query.toSQL());
}
@ -409,6 +409,25 @@ public class AccountSqlTester {
}
@Test
public void testCase3() {
IDialect dialect = new CommonsDialectImpl();
QueryWrapper queryWrapper = QueryWrapper.create()
.select(ACCOUNT.ALL_COLUMNS,
case_(ACCOUNT.ID)
.when(100).then(100)
.when(200).then(200)
.else_(convert("varchar", "GETDATE()", "126"))
.end().as("result"))
.from(ACCOUNT)
.and(ACCOUNT.USER_NAME.like("michael"));
String sql = dialect.forSelectByQuery(queryWrapper);
System.out.println(sql);
}
@Test
public void testLimitOffset() {

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>parent</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -20,7 +20,7 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-annotation</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
</dependencies>

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>parent</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -21,7 +21,7 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-core</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
</dependencies>

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>parent</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -21,7 +21,7 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-spring</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>parent</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -20,7 +20,7 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-core</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>

View File

@ -338,7 +338,7 @@ public class FlexSqlSessionFactoryBean extends SqlSessionFactoryBean
*/
@Override
public void setConfiguration(Configuration configuration) {
if (!(configuration instanceof FlexConfiguration)) {
if (configuration != null && !(configuration instanceof FlexConfiguration)) {
throw new IllegalArgumentException("Only support FlexConfiguration.");
}
this.configuration = configuration;

View File

@ -0,0 +1,109 @@
/*
* Copyright (c) 2022-2023, Mybatis-Flex (fuhai999@gmail.com).
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mybatisflex.spring.service.impl;
import com.mybatisflex.core.BaseMapper;
import com.mybatisflex.core.exception.FlexExceptions;
import com.mybatisflex.core.query.QueryWrapper;
import com.mybatisflex.core.service.IService;
import com.mybatisflex.core.table.TableInfo;
import com.mybatisflex.core.table.TableInfoFactory;
import org.springframework.beans.factory.annotation.Autowired;
import java.util.Collection;
/**
* <p>可缓存数据的 Service 实现类
*
* <p>该实现类对缓存做了以下处理
*
* <ul>
* <li>重写 {@link #saveOrUpdate(Object)} 方法分别调用 {@link #save(Object)} {@link #updateById(Object)}
* 方法避免缓存无法更新造成数据不一致
* <li>重写{@link #updateBatch(Collection, int)} 方法默认抛出异常不支持批量更新操作
* 防止批量更新数据缓存不一致
* <li>重写 {@link #query()} 方法解决使用 {@link QueryWrapper#toSQL()} 作为缓存
* 的主键时"SELECT * FROM" 后面没有表名的问题
* </ul>
*
* @author 王帅
* @since 2023-05-30
*/
public class CacheableServiceImpl<M extends BaseMapper<T>, T> implements IService<T> {
@Autowired
@SuppressWarnings("SpringJavaInjectionPointsAutowiringInspection")
private M mapper;
/**
* {@inheritDoc}
*/
@Override
public BaseMapper<T> getMapper() {
return mapper;
}
/**
* {@inheritDoc}
*/
@Override
public boolean saveOrUpdate(T entity) {
TableInfo tableInfo = TableInfoFactory.ofEntityClass(entity.getClass());
Object[] pkArgs = tableInfo.buildPkSqlArgs(entity);
if (pkArgs.length == 0 || pkArgs[0] == null) {
return save(entity);
} else {
return updateById(entity);
}
}
/**
* <p>不支持批量更新操作
*/
@Override
public boolean updateBatch(Collection<T> entities, int batchSize) {
throw FlexExceptions.wrap("Batch update do not support caching operation.");
}
/**
* <p>获取默认的 {@link QueryWrapper}
*
* <p>使用 {@link QueryWrapper#create()} 构建默认查询条件的时候
* 要使用 {@link QueryWrapper#from(String...)} 方法指定从哪个表
* 查询数据不然使用 {@link QueryWrapper#toSQL()} 生成的
* SQL 语句就是 {@code "SELECT * FROM"}没有表名信息
*
* <p>默认通过反射获取表名建议重写根据情况设置默认表名以提升效率
*
* <p>例如
*
* <pre>{@code
* @Override
* public QueryWrapper query() {
* return QueryWrapper.create().from(ACCOUNT);
* }
* }</pre>
*
* @return 默认的 {@link QueryWrapper}
*/
@Override
public QueryWrapper query() {
String tableName = TableInfoFactory.ofMapperClass(getMapper().getClass()).getTableName();
return QueryWrapper.create().from(tableName);
}
}

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>mybatis-flex-test</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -20,7 +20,7 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-core</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>mybatis-flex-test</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -21,7 +21,7 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-spring-boot-starter</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>mybatis-flex-test</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -20,13 +20,13 @@
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-core</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-spring</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</dependency>
<dependency>

View File

@ -5,7 +5,7 @@
<parent>
<artifactId>parent</artifactId>
<groupId>com.mybatis-flex</groupId>
<version>1.3.3</version>
<version>1.3.4</version>
</parent>
<modelVersion>4.0.0</modelVersion>
@ -59,7 +59,7 @@
<path>
<groupId>com.mybatis-flex</groupId>
<artifactId>mybatis-flex-processor</artifactId>
<version>1.3.3</version>
<version>1.3.4</version>
</path>
</annotationProcessorPaths>
</configuration>

View File

@ -7,7 +7,7 @@
<groupId>com.mybatis-flex</groupId>
<artifactId>parent</artifactId>
<packaging>pom</packaging>
<version>1.3.3</version>
<version>1.3.4</version>
<name>mybatis-flex</name>
<url>https://mybatis-flex.com</url>