Merge pull request #83 from hocgin/v1.0.24

feat: sso client logout

Author: hocgin

pom.xml

@@ -16,7 +16,7 @@
   <version>${revision}</version>
 
   <properties>
-    <revision>1.0.23</revision>
+    <revision>1.0.24</revision>
 
     <java.version>1.8</java.version>
     <java.source.version>1.8</java.source.version>

spring-boot-dependencies/pom.xml

@@ -11,13 +11,13 @@
   <modelVersion>4.0.0</modelVersion>
   <packaging>pom</packaging>
 
-  <name>Spring Boot :: Starters :: Parent</name>
+  <name>Spring Boot :: Dependencies</name>
   <artifactId>spring-boot-dependencies</artifactId>
 
   <properties>
     <spring-cloud.version>Hoxton.SR4</spring-cloud.version>
     <spring-cloud-alibaba.version>2.2.1.RELEASE</spring-cloud-alibaba.version>
-    <mybatis-plus.version>3.3.0</mybatis-plus.version>
+    <mybatis-plus.version>3.5.0</mybatis-plus.version>
     <maven-compiler-plugin.version>3.6.0</maven-compiler-plugin.version>
     <guava.version>28.1-jre</guava.version>
     <hutool-all.version>5.3.10</hutool-all.version>

spring-boot-excel/excel-spring-boot-autoconfigure/src/main/java/in/hocg/boot/excel/autoconfiguration/utils/ExcelUtils.java

@@ -1,7 +1,7 @@
 package in.hocg.boot.excel.autoconfiguration.utils;
 
 import com.baomidou.mybatisplus.core.metadata.IPage;
-import in.hocg.boot.mybatis.plus.autoconfiguration.ro.PageRo;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.pojo.ro.PageRo;
 import lombok.experimental.UtilityClass;
 
 import java.util.List;

spring-boot-mybatis-plus/mybatis-plus-spring-boot-autoconfigure/src/main/java/in/hocg/boot/mybatis/plus/autoconfiguration/MyBatisPlusAutoConfiguration.java

@@ -1,15 +1,30 @@
 package in.hocg.boot.mybatis.plus.autoconfiguration;
 
+import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration;
 import com.baomidou.mybatisplus.autoconfigure.MybatisPlusProperties;
 import com.baomidou.mybatisplus.core.config.GlobalConfig;
-import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
+import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
+import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
+import com.baomidou.mybatisplus.extension.plugins.handler.TenantLineHandler;
+import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
+import com.baomidou.mybatisplus.extension.plugins.inner.TenantLineInnerInterceptor;
 import com.google.common.collect.Sets;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.ColumnConstants;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.context.DefaultMybatisContextHolder;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.context.MybatisContextHolder;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.enhance.fill.BootMetaObjectHandler;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.enhance.tenant.BootTenantHandler;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.interceptor.LogicDeleteInterceptor;
 import in.hocg.boot.mybatis.plus.autoconfiguration.properties.MyBatisPlusProperties;
 import in.hocg.boot.utils.LangUtils;
 import lombok.RequiredArgsConstructor;
+import lombok.Setter;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Lazy;
@@ -27,18 +42,57 @@
 @AutoConfigureAfter(MybatisPlusAutoConfiguration.class)
 @EnableConfigurationProperties(MyBatisPlusProperties.class)
 @RequiredArgsConstructor(onConstructor = @__(@Lazy))
-public class MyBatisPlusAutoConfiguration {
+public class MyBatisPlusAutoConfiguration implements ApplicationContextAware {
+    private final MyBatisPlusProperties properties;
+    @Setter
+    private ApplicationContext applicationContext;
 
     @Bean
-    public PaginationInterceptor paginationInterceptor() {
-        return new PaginationInterceptor();
+    @ConditionalOnMissingBean
+    public MybatisPlusInterceptor mybatisPlusInterceptor(MybatisContextHolder contextHolder) {
+        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
+        if (properties.getTenant().getEnable()) {
+            interceptor.addInnerInterceptor(new TenantLineInnerInterceptor(tenantLineHandler(properties, contextHolder)));
+        }
+        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
+        interceptor.addInnerInterceptor(new LogicDeleteInterceptor(contextHolder));
+        return interceptor;
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    public TenantLineHandler tenantLineHandler(MyBatisPlusProperties properties, MybatisContextHolder contextHolder) {
+        return new BootTenantHandler(properties, contextHolder);
+    }
+
+
+    @Bean
+    @ConditionalOnMissingBean
+    public MetaObjectHandler metaObjectHandler(MybatisContextHolder contextHolder) {
+        return new BootMetaObjectHandler(applicationContext, contextHolder);
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    public MybatisContextHolder mybatisPlusContextHolder() {
+        return new DefaultMybatisContextHolder();
     }
 
     @Bean
     @Primary
-    public MybatisPlusProperties myBatisPlusProperties(MybatisPlusProperties properties) {
+    public MybatisPlusProperties myBatisPlusProperties(MybatisPlusProperties properties,
+                                                       MetaObjectHandler metaObjectHandler) {
         GlobalConfig globalConfig = LangUtils.getOrDefault(properties.getGlobalConfig(), new GlobalConfig());
         globalConfig.setBanner(false);
+
+        GlobalConfig.DbConfig dbConfig = LangUtils.getOrDefault(globalConfig.getDbConfig(), new GlobalConfig.DbConfig());
+        dbConfig.setIdType(IdType.ASSIGN_ID);
+        dbConfig.setLogicDeleteField(ColumnConstants.DELETED_AT);
+        dbConfig.setLogicDeleteValue("NOW(6)");
+        dbConfig.setLogicNotDeleteValue("NULL");
+        globalConfig.setDbConfig(dbConfig);
+
+        globalConfig.setMetaObjectHandler(metaObjectHandler);
         properties.setGlobalConfig(globalConfig);
 
         Set<String> locations = Sets.newHashSet(properties.getMapperLocations());

spring-boot-mybatis-plus/mybatis-plus-spring-boot-autoconfigure/src/main/java/in/hocg/boot/mybatis/plus/autoconfiguration/core/ColumnConstants.java

@@ -0,0 +1,18 @@
+package in.hocg.boot.mybatis.plus.autoconfiguration.core;
+
+/**
+ * Created by hocgin on 2021/12/31
+ * email: [email protected]
+ *
+ * @author hocgin
+ */
+public class ColumnConstants {
+    public static final String TENANT_ID = "tenant_id";
+    public static final String ID = "id";
+    public static final String CREATED_AT = "created_at";
+    public static final String CREATOR = "creator";
+    public static final String LAST_UPDATED_AT = "last_updated_at";
+    public static final String LAST_UPDATER = "last_updater";
+    public static final String DELETED_AT = "deleted_at";
+    public static final String DELETER = "deleter";
+}

spring-boot-mybatis-plus/mybatis-plus-spring-boot-autoconfigure/src/main/java/in/hocg/boot/mybatis/plus/autoconfiguration/core/context/DefaultMybatisContextHolder.java

@@ -0,0 +1,11 @@
+package in.hocg.boot.mybatis.plus.autoconfiguration.core.context;
+
+/**
+ * Created by hocgin on 2022/1/2
+ * email: [email protected]
+ *
+ * @author hocgin
+ */
+public class DefaultMybatisContextHolder implements MybatisContextHolder {
+
+}

spring-boot-mybatis-plus/mybatis-plus-spring-boot-autoconfigure/src/main/java/in/hocg/boot/mybatis/plus/autoconfiguration/core/context/MybatisContextHolder.java

@@ -0,0 +1,29 @@
+package in.hocg.boot.mybatis.plus.autoconfiguration.core.context;
+
+/**
+ * Created by hocgin on 2022/1/2
+ * email: [email protected]
+ *
+ * @author hocgin
+ */
+public interface MybatisContextHolder {
+
+    /**
+     * 当前操作人
+     *
+     * @return id
+     */
+    default Long getUserId() {
+        return null;
+    }
+
+
+    /**
+     * 当前租户
+     *
+     * @return id
+     */
+    default Long getTenantId() {
+        return null;
+    }
+}

spring-boot-mybatis-plus/mybatis-plus-spring-boot-autoconfigure/src/main/java/in/hocg/boot/mybatis/plus/autoconfiguration/core/context/TenantContextHolder.java

@@ -0,0 +1,27 @@
+package in.hocg.boot.mybatis.plus.autoconfiguration.core.context;
+
+import lombok.experimental.UtilityClass;
+
+/**
+ * Created by hocgin on 2021/12/31
+ * email: [email protected]
+ *
+ * @author hocgin
+ */
+@UtilityClass
+@Deprecated
+public class TenantContextHolder {
+    private final ThreadLocal<Long> TENANT = ThreadLocal.withInitial(() -> null);
+
+    public void setTenantId(Long tenantId) {
+        TENANT.set(tenantId);
+    }
+
+    public Long getTenantId() {
+        return TENANT.get();
+    }
+
+    public void clear() {
+        TENANT.remove();
+    }
+}

spring-boot-mybatis-plus/mybatis-plus-spring-boot-autoconfigure/src/main/java/in/hocg/boot/mybatis/plus/autoconfiguration/core/context/UserContextHolder.java

@@ -0,0 +1,27 @@
+package in.hocg.boot.mybatis.plus.autoconfiguration.core.context;
+
+import lombok.experimental.UtilityClass;
+
+/**
+ * Created by hocgin on 2021/12/31
+ * email: [email protected]
+ *
+ * @author hocgin
+ */
+@UtilityClass
+@Deprecated
+public class UserContextHolder {
+    private final ThreadLocal<Long> USER_ID = ThreadLocal.withInitial(() -> null);
+
+    public void setUserId(Long tenantId) {
+        USER_ID.set(tenantId);
+    }
+
+    public Long getUserId() {
+        return USER_ID.get();
+    }
+
+    public void clear() {
+        USER_ID.remove();
+    }
+}

spring-boot-mybatis-plus/mybatis-plus-spring-boot-autoconfigure/src/main/java/in/hocg/boot/mybatis/plus/autoconfiguration/core/enhance/fill/BootMetaObjectHandler.java

@@ -0,0 +1,94 @@
+package in.hocg.boot.mybatis.plus.autoconfiguration.core.enhance.fill;
+
+import cn.hutool.core.collection.CollUtil;
+import cn.hutool.core.util.ClassUtil;
+import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
+import com.baomidou.mybatisplus.core.metadata.TableInfo;
+import com.baomidou.mybatisplus.core.toolkit.LambdaUtils;
+import com.baomidou.mybatisplus.core.toolkit.support.SFunction;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.context.MybatisContextHolder;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.enhance.listeners.EntityListeners;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.enhance.listeners.PreInsert;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.enhance.listeners.PreUpdate;
+import in.hocg.boot.mybatis.plus.autoconfiguration.core.struct.basic.enhance.CommonEntity;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.ibatis.reflection.MetaObject;
+import org.apache.ibatis.reflection.property.PropertyNamer;
+import org.springframework.context.ApplicationContext;
+
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.time.LocalDateTime;
+import java.util.List;
+
+/**
+ * Created by hocgin on 2021/12/31
+ * email: [email protected]
+ * <br/>
+ * 职责:
+ * <br/>
+ * 1. 填充基础字段
+ * <br/>
+ * - 填充创建人、创建时间
+ * <br/>
+ * - 填充修改人、修改时间
+ * <br/>
+ * 2. 触发实体监听器
+ * <br/>
+ *
+ * @author hocgin
+ */
+@Slf4j
+@RequiredArgsConstructor
+public class BootMetaObjectHandler implements MetaObjectHandler {
+    private final ApplicationContext applicationContext;
+    private final MybatisContextHolder contextHolder;
+
+    @Override
+    public void insertFill(MetaObject metaObject) {
+        hookEntityListeners(metaObject, true);
+
+        this.strictInsertFill(metaObject, getFieldName(CommonEntity<CommonEntity<?>>::getCreatedAt), LocalDateTime::now, LocalDateTime.class);
+        this.strictInsertFill(metaObject, getFieldName(CommonEntity<CommonEntity<?>>::getCreator), contextHolder::getUserId, Long.class);
+    }
+
+    @Override
+    public void updateFill(MetaObject metaObject) {
+        hookEntityListeners(metaObject, false);
+
+        this.strictUpdateFill(metaObject, getFieldName(CommonEntity<CommonEntity<?>>::getLastUpdatedAt), LocalDateTime::now, LocalDateTime.class);
+        this.strictUpdateFill(metaObject, getFieldName(CommonEntity<CommonEntity<?>>::getLastUpdater), contextHolder::getUserId, Long.class);
+    }
+
+    private void hookEntityListeners(MetaObject metaObject, boolean isInsert) {
+        TableInfo tableInfo = this.findTableInfo(metaObject);
+        Class<?> entityType = tableInfo.getEntityType();
+
+        // 未使用注解的情况下，直接返回
+        if (!entityType.isAnnotationPresent(EntityListeners.class)) {
+            return;
+        }
+
+        Class<?>[] classes = entityType.getAnnotation(EntityListeners.class).value();
+        for (Class<?> aClass : classes) {
+            List<Method> methods = ClassUtil.getPublicMethods(aClass, method -> isInsert ? method.isAnnotationPresent(PreInsert.class) : method.isAnnotationPresent(PreUpdate.class));
+            if (CollUtil.isEmpty(methods)) {
+                break;
+            }
+            Object bean = applicationContext.getBean(aClass);
+            Object originalObject = metaObject.getOriginalObject();
+            for (Method method : methods) {
+                try {
+                    method.invoke(bean, originalObject);
+                } catch (IllegalAccessException | InvocationTargetException e) {
+                    log.warn("{} 的 @{} 扩展事件[@{}]调用失败", aClass.getName(), EntityListeners.class.getSimpleName(), isInsert ? PreInsert.class.getSimpleName() : PreUpdate.class.getSimpleName());
+                }
+            }
+        }
+    }
+
+    private <T> String getFieldName(SFunction<T, ?> func) {
+        return PropertyNamer.methodToProperty(LambdaUtils.extract(func).getImplMethodName());
+    }
+}