目录
☕Mybatis-Plus提供了一些常用的增删改查函数,例如:
☕在Mybatis-Plus的配置文件中增加多租户的配置,例如:
☕我们需要自定义一个租户处理器,这个处理器需要根据当前的租户ID设置数据源,例如:
☕我们需要在动态数据源中添加多个数据源,根据租户ID选择对应的数据源,例如:
☕☕使用Mybatis-Plus进行数据操作时,需要在Mapper接口中添加@TableName注解和@TableField注解,例如:
☕我们需要实现租户ID的动态传递,例如在Web请求中,从请求头或者参数中获取租户ID,然后将租户ID保存到当前线程中,例如:
☕上面的代码实现了Mybatis-Plus的多租户数据隔离功能,其实现逻辑如下:
综上所述,上面的代码中租户隔离是在使用Mybatis-Plus进行数据操作时实现的,通过在SQL语句中加入租户ID条件,以实现数据隔离。
☕Mybatis-Plus提供了分页函数,可以方便地进行分页查询,例如:
☕Mybatis-Plus提供了条件构造器,可以方便地构造查询条件,例如:
☕Mybatis-Plus提供了使用Lambda表达式进行查询的方式,可以更加方便地构造查询条件,例如:
☕数据库主键生成策略:支持多数据方式以 native 总结组合生成、可单类里直接 使用 @Options 注解,借助增品并发的生成编号办法很舒服,
☕前言:
之前也是经常接触使用这个框架,想着沉淀一下内容吧,这里稍微讲解了一下多租户数据隔离,其他的就是一些函数介绍和使用.....
☕Mybatis-Plus适用于以下开发场景:
-
快速开发:Mybatis-Plus提供了许多常用的持久化操作函数,可以快速进行开发,减少重复代码的编写。
-
代码生成:Mybatis-Plus提供了代码生成器,可以根据数据库表自动生成实体类、Mapper接口、XML文件等,减少手动编写代码的工作量。
-
多租户:Mybatis-Plus提供了多租户的支持,可以根据不同的租户进行数据隔离。
-
分页查询:Mybatis-Plus提供了分页查询的支持,可以方便地进行分页查询操作。
-
乐观锁:Mybatis-Plus提供了乐观锁的支持,可以避免并发更新时的数据冲突。
-
数据库操作:Mybatis-Plus提供了许多数据库操作的支持,如批量插入、批量更新、批量删除等。
-
Lambda表达式:Mybatis-Plus提供了Lambda表达式的支持,可以使用Lambda表达式进行查询,代码更加简洁易懂。
☕Mybatis-Plus提供了一些常用的增删改查函数,例如:
- insert():插入一条记录
- insertBatch():批量插入记录
- updateById():根据ID更新记录
- update():根据条件更新记录
- deleteById():根据ID删除记录
- delete():根据条件删除记录
- selectById():根据ID查询记录
- selectBatchIds():根据ID列表查询记录
- selectByMap():根据Map中的条件查询记录
- selectOne():根据条件查询单条记录
- selectList():根据条件查询多条记录
这些函数都可以在BaseMapper中找到。
☕Mybatis-plus多租户 数据隔离示例:
- Mybatis-Plus提供了多租户的支持,可以根据不同的租户进行数据隔离。下面是一个简单的demo,假设我们有一个租户表和一个用户表,用户表中存储了租户的ID,我们需要实现多租户的数据隔离。
☕在Mybatis-Plus的配置文件中增加多租户的配置,例如:
其中,logic-not-delete-value表示逻辑删除的默认值,tenant-column为租户ID字段名,tenant-handler为租户处理器
mybatis-plus:
global-config:
db-config:
# 多租户配置,设置租户ID的字段名
logic-not-delete-value: 1
tenant-column: tenant_id
tenant-handler: com.example.handler.MyTenantHandler
☕我们需要自定义一个租户处理器,这个处理器需要根据当前的租户ID设置数据源,例如:
getTenantId方法返回当前线程中保存的租户ID,getTenantIdColumn返回租户ID字段名,doTableFilter方法可以过滤掉一些不需要进行租户隔离的表。
public class MyTenantHandler implements TenantHandler {
@Override
public Expression getTenantId() {
// 从当前线程中获取租户ID
String tenantId = TenantContextHolder.getTenantId();
// 返回租户ID的值
return new LongValue(tenantId);
}
@Override
public String getTenantIdColumn() {
// 返回租户ID的字段名
return "tenant_id";
}
@Override
public boolean doTableFilter(String tableName) {
// 过滤掉一些不需要进行租户隔离的表
return !"user".equalsIgnoreCase(tableName);
}
}
☕我们需要定义多个数据源,每个租户对应一个数据源,例如:
我们创建了两个数据源,分别对应两个租户。
@Configuration
public class DataSourceConfig {
@Bean
public DataSource dataSource1() {
// 创建数据源1
return new DruidDataSource();
}
@Bean
public DataSource dataSource2() {
// 创建数据源2
return new DruidDataSource();
}
}
☕我们需要在动态数据源中添加多个数据源,根据租户ID选择对应的数据源,例如:
我们创建了一个DynamicDataSource,并在其中添加了两个数据源,根据租户ID选择对应的数据源。
@Configuration
public class DynamicDataSourceConfig {
@Autowired
private DataSource dataSource1;
@Autowired
private DataSource dataSource2;
@Bean
@Primary
public DataSource dynamicDataSource() {
Map<Object, Object> targetDataSources = new HashMap<>();
targetDataSources.put("1", dataSource1); // 租户1对应数据源1
targetDataSources.put("2", dataSource2); // 租户2对应数据源2
DynamicDataSource dynamicDataSource = new DynamicDataSource();
dynamicDataSource.setTargetDataSources(targetDataSources);
return dynamicDataSource;
}
}
☕☕使用Mybatis-Plus进行数据操作时,需要在Mapper接口中添加@TableName注解和@TableField注解,例如:
@TableName("user")
public interface UserMapper extends BaseMapper<User> {
@TableField("tenant_id")
Integer getTenantId();
@Select("SELECT id, name FROM user WHERE tenant_id = #{tenantId}")
List<User> selectListByTenantId(@Param("tenantId") Integer tenantId);
}
@TableName注解指定了对应的表名,@TableField注解指定了租户ID字段名。在查询时,我们需要根据租户ID过滤掉不属于当前租户的数据。
☕在进行数据操作时,我们需要设置当前线程的租户ID,例如:
我们通过设置租户ID来选择对应的数据源,然后调用用户Mapper的查询函数来获取对应租户ID的用户列表。
@Service
public class UserService {
@Autowired
private UserMapper userMapper;
public List<User> getUserListByTenantId(Integer tenantId) {
TenantContextHolder.setTenantId(tenantId.toString()); // 动态设置租户ID
try {
return userMapper.selectListByTenantId(tenantId);
} finally {
TenantContextHolder.clear(); // 清空租户ID
}
}
}
☕我们需要实现租户ID的动态传递,例如在Web请求中,从请求头或者参数中获取租户ID,然后将租户ID保存到当前线程中,例如:
public class TenantInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String tenantId = request.getHeader("tenantId");
if (StringUtils.isNotBlank(tenantId)) {
TenantContextHolder.setTenantId(tenantId);
}
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
TenantContextHolder.clear();
}
}
☕上面的代码实现了Mybatis-Plus的多租户数据隔离功能,其实现逻辑如下:
配置Mybatis-Plus的多租户支持,通过设置logic-not-delete-value、tenant-column和tenant-handler等参数来启用多租户功能。
自定义租户处理器,实现TenantHandler接口中的getTenantId、getTenantIdColumn和doTableFilter等方法,其中getTenantId方法返回当前线程中保存的租户ID,getTenantIdColumn返回租户ID字段名,doTableFilter方法可以过滤掉一些不需要进行租户隔离的表。
定义数据源,在动态数据源中添加多个数据源,根据租户ID选择对应的数据源。
使用Mybatis-Plus进行数据操作,在Mapper接口中添加@TableName注解和@TableField注解,其中@TableName注解指定了对应的表名,@TableField注解指定了租户ID字段名。在查询时,需要根据租户ID过滤掉不属于当前租户的数据。
实现租户ID的动态设置,通过设置当前线程的租户ID,选择对应的数据源。
实现租户ID的动态传递,在Web请求中,从请求头或者参数中获取租户ID,然后将租户ID保存到当前线程中。使用完后,需要清空当前线程中的租户ID。
☕小伙伴肯定很疑问如何实现的租户隔离,具体在那一步?
在上面的代码中,租户隔离是在使用Mybatis-Plus进行数据操作时实现的。具体来说,是在UserService中的list方法中实现的。
在list方法中,我们通过TenantContextHolder获取当前租户的标识,并构造了一个QueryWrapper对象,加入了租户ID条件。然后调用baseMapper的selectList方法进行查询操作,Mybatis-Plus会自动解析SQL语句中的租户信息,并进行数据隔离。
具体来说,Mybatis-Plus会在SQL语句中加入租户ID条件,以实现数据隔离。例如,如果我们查询用户列表的SQL语句为:
SELECT * FROM user
则在使用Mybatis-Plus进行查询时,会自动加入租户ID条件,变为:
SELECT * FROM user WHERE tenant_id = 'xxx'
其中,xxx为当前租户的标识。这样就可以实现数据隔离,确保不同租户之间的数据不会相互干扰。
综上所述,上面的代码中租户隔离是在使用Mybatis-Plus进行数据操作时实现的,通过在SQL语句中加入租户ID条件,以实现数据隔离。
☕Mybatis-Plus部分函数示例:
☕Mybatis-Plus提供了分页函数,可以方便地进行分页查询,例如:
Page<User> page = new Page<>(1, 10);
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("status", 1);
IPage<User> userPage = userMapper.selectPage(page, wrapper);
List<User> userList = userPage.getRecords(); //查询结果
int totalPages = userPage.getPages(); //总页数
☕Mybatis-Plus提供了条件构造器,可以方便地构造查询条件,例如:
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("status", 1)
.like("username", "test")
.between("age", 20, 30)
.orderByAsc("age");
List<User> userList = userMapper.selectList(wrapper);
☕Mybatis-Plus提供了使用Lambda表达式进行查询的方式,可以更加方便地构造查询条件,例如:
LambdaQueryWrapper<User> wrapper = Wrappers.lambdaQuery();
wrapper.eq(User::getStatus, 1)
.like(User::getUsername, "test")
.between(User::getAge, 20, 30)
.orderByAsc(User::getAge);
List<User> userList = userMapper.selectList(wrapper);
☕数据库主键生成策略:支持多数据方式以 native 总结组合生成、可单类里直接 使用 @Options 注解,借助增品并发的生成编号办法很舒服,
public interface UserMapper extends BaseMapper<User> {
@Insert("insert into user(name) values(#{name})")
@Options(useGeneratedKeys = true, keyProperty = "id")
int insertUser(User user);
}