feat($auth-center): import role data from Excel

johnnymillergh · Aug 22, 2021 · 3468082 · 3468082
1 parent a70434f
commit 3468082
Show file tree

Hide file tree

Showing 18 changed files with 213 additions and 149 deletions.
diff --git a/auth-center/pom.xml b/auth-center/pom.xml
@@ -233,5 +233,13 @@
             <version>${poi.version}</version>
             <scope>provided</scope>
         </dependency>
+
+        <!-- OSS Dependencies -->
+        <dependency>
+            <groupId>io.minio</groupId>
+            <artifactId>minio</artifactId>
+            <version>${minio.version}</version>
+            <scope>provided</scope>
+        </dependency>
     </dependencies>
 </project>
diff --git a/...src/main/java/com/jmsoftware/maf/authcenter/permission/entity/persistence/Permission.java b/...src/main/java/com/jmsoftware/maf/authcenter/permission/entity/persistence/Permission.java
@@ -6,7 +6,7 @@
 import com.baomidou.mybatisplus.annotation.TableName;
 import lombok.Data;
 
-import java.util.Date;
+import java.time.LocalDateTime;
 
 import static com.baomidou.mybatisplus.annotation.FieldFill.INSERT;
 import static com.baomidou.mybatisplus.annotation.FieldFill.UPDATE;
@@ -21,109 +21,83 @@
 @Data
 @TableName(value = Permission.TABLE_NAME)
 public class Permission {
+    public static final String TABLE_NAME = "permission";
+    public static final String COL_ID = "id";
+    public static final String COL_URL = "url";
+    public static final String COL_DESCRIPTION = "description";
+    public static final String COL_TYPE = "type";
+    public static final String COL_PERMISSION_EXPRESSION = "permission_expression";
+    public static final String COL_METHOD = "method";
+    public static final String COL_SORT = "sort";
+    public static final String COL_PARENT_ID = "parent_id";
+    public static final String COL_CREATED_BY = "created_by";
+    public static final String COL_CREATED_TIME = "created_time";
+    public static final String COL_MODIFIED_BY = "modified_by";
+    public static final String COL_MODIFIED_TIME = "modified_time";
+    public static final String COL_DELETED = "deleted";
     /**
      * Primary key
      */
     @TableId(value = COL_ID, type = IdType.AUTO)
     private Long id;
-
     /**
      * URL. If type of record is page (1), URL stands for route; if type of record is button (2), URL stands for API
      */
     @TableField(value = COL_URL)
     private String url;
-
     /**
      * Permission description
      */
     @TableField(value = COL_DESCRIPTION)
     private String description;
-
     /**
      * Permission type. 1 - page; 2 - button
      */
     @TableField(value = COL_TYPE)
     private Byte type;
-
     /**
      * Permission expression
      */
     @TableField(value = COL_PERMISSION_EXPRESSION)
     private String permissionExpression;
-
     /**
      * HTTP method of API
      */
     @TableField(value = COL_METHOD)
     private Object method;
-
     /**
      * Sort number
      */
     @TableField(value = COL_SORT)
     private Integer sort;
-
     /**
      * Primary key of parent
      */
     @TableField(value = COL_PARENT_ID)
     private Long parentId;
-
     /**
      * Created by
      */
     @TableField(value = COL_CREATED_BY, fill = INSERT)
     private Long createdBy;
-
     /**
      * Created time
      */
     @TableField(value = COL_CREATED_TIME, fill = INSERT)
-    private Date createdTime;
-
+    private LocalDateTime createdTime;
     /**
      * Modified by
      */
     @TableField(value = COL_MODIFIED_BY, fill = UPDATE)
     private Long modifiedBy;
-
     /**
      * Modified time
      */
     @TableField(value = COL_MODIFIED_TIME, fill = UPDATE)
-    private Date modifiedTime;
-
+    private LocalDateTime modifiedTime;
     /**
      * Deleted flag
      */
     @TableField(value = COL_DELETED, fill = INSERT)
     private Byte deleted;
-
-    public static final String TABLE_NAME = "permission";
-
-    public static final String COL_ID = "id";
-
-    public static final String COL_URL = "url";
-
-    public static final String COL_DESCRIPTION = "description";
-
-    public static final String COL_TYPE = "type";
-
-    public static final String COL_PERMISSION_EXPRESSION = "permission_expression";
-
-    public static final String COL_METHOD = "method";
-
-    public static final String COL_SORT = "sort";
-
-    public static final String COL_PARENT_ID = "parent_id";
-
-    public static final String COL_CREATED_BY = "created_by";
-
-    public static final String COL_CREATED_TIME = "created_time";
-
-    public static final String COL_MODIFIED_BY = "modified_by";
-
-    public static final String COL_MODIFIED_TIME = "modified_time";
-
-    public static final String COL_DELETED = "deleted";
 }
diff --git a/auth-center/src/main/java/com/jmsoftware/maf/authcenter/role/controller/RoleController.java b/auth-center/src/main/java/com/jmsoftware/maf/authcenter/role/controller/RoleController.java
@@ -11,6 +11,7 @@
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody;
 
+import java.time.Instant;
 import java.util.List;
 
 /**
@@ -33,15 +34,22 @@ public ResponseEntity<StreamingResponseBody> downloadRoleStat() {
     @Override
     public void onExceptionOccurred() {
         log.error("Exception occurred when uploading excel for role.");
+        this.fileName.set("role-stat" + Instant.now() + ".xlsx");
     }
 
     @Override
-    protected void executeDatabaseOperation(List<RoleExcelImport> beanList) throws Exception {
+    protected void beforeDatabaseOperation(List<RoleExcelImport> beanList) {
+        log.info("BeforeDatabaseOperation: {}", beanList);
+    }
 
+    @Override
+    protected void executeDatabaseOperation(List<RoleExcelImport> beanList) throws Exception {
+        log.info("ExecuteDatabaseOperation: {}", beanList);
+        this.roleService.save(beanList);
     }
 
     @Override
     protected boolean validateBeforeAddToBeanList(List<RoleExcelImport> beanList, RoleExcelImport bean, int index) throws IllegalArgumentException {
-        return false;
+        return this.roleService.validateBeforeAddToBeanList(beanList, bean, index);
     }
 }
diff --git a/auth-center/src/main/java/com/jmsoftware/maf/authcenter/role/entity/RoleExcelImport.java b/auth-center/src/main/java/com/jmsoftware/maf/authcenter/role/entity/RoleExcelImport.java
@@ -39,4 +39,17 @@ public static RoleExcelImport transformBy(Role role) {
         roleExcelImport.setDescription(role.getDescription());
         return roleExcelImport;
     }
+
+    /**
+     * Transform by role.
+     *
+     * @param roleExcelImport the role excel import
+     * @return the role excel import
+     */
+    public static Role transformTo(RoleExcelImport roleExcelImport) {
+        val role = new Role();
+        role.setName(roleExcelImport.getName());
+        role.setDescription(roleExcelImport.getDescription());
+        return role;
+    }
 }
diff --git a/auth-center/src/main/java/com/jmsoftware/maf/authcenter/role/entity/persistence/Role.java b/auth-center/src/main/java/com/jmsoftware/maf/authcenter/role/entity/persistence/Role.java
@@ -6,7 +6,7 @@
 import com.baomidou.mybatisplus.annotation.TableName;
 import lombok.Data;
 
-import java.util.Date;
+import java.time.LocalDateTime;
 
 import static com.baomidou.mybatisplus.annotation.FieldFill.INSERT;
 import static com.baomidou.mybatisplus.annotation.FieldFill.UPDATE;
@@ -21,69 +21,53 @@
 @Data
 @TableName(value = Role.TABLE_NAME)
 public class Role {
+    public static final String TABLE_NAME = "role";
+    public static final String COL_ID = "id";
+    public static final String COL_NAME = "name";
+    public static final String COL_DESCRIPTION = "description";
+    public static final String COL_CREATED_BY = "created_by";
+    public static final String COL_CREATED_TIME = "created_time";
+    public static final String COL_MODIFIED_BY = "modified_by";
+    public static final String COL_MODIFIED_TIME = "modified_time";
+    public static final String COL_DELETED = "deleted";
     /**
      * Primary key
      */
     @TableId(value = COL_ID, type = IdType.AUTO)
     private Long id;
-
     /**
      * Role name
      */
     @TableField(value = COL_NAME)
     private String name;
-
     /**
      * Role description
      */
     @TableField(value = COL_DESCRIPTION)
     private String description;
-
     /**
      * Created by
      */
     @TableField(value = COL_CREATED_BY, fill = INSERT)
     private Long createdBy;
-
     /**
      * Created time
      */
     @TableField(value = COL_CREATED_TIME, fill = INSERT)
-    private Date createdTime;
-
+    private LocalDateTime createdTime;
     /**
      * Modified by
      */
     @TableField(value = COL_MODIFIED_BY, fill = UPDATE)
     private Long modifiedBy;
-
     /**
      * Modified time
      */
     @TableField(value = COL_MODIFIED_TIME, fill = UPDATE)
-    private Date modifiedTime;
-
+    private LocalDateTime modifiedTime;
     /**
      * Deleted flag.
      */
     @TableField(value = COL_DELETED, fill = INSERT)
     private Byte deleted;
-
-    public static final String TABLE_NAME = "role";
-
-    public static final String COL_ID = "id";
-
-    public static final String COL_NAME = "name";
-
-    public static final String COL_DESCRIPTION = "description";
-
-    public static final String COL_CREATED_BY = "created_by";
-
-    public static final String COL_CREATED_TIME = "created_time";
-
-    public static final String COL_MODIFIED_BY = "modified_by";
-
-    public static final String COL_MODIFIED_TIME = "modified_time";
-
-    public static final String COL_DELETED = "deleted";
 }
diff --git a/auth-center/src/main/java/com/jmsoftware/maf/authcenter/role/service/RoleService.java b/auth-center/src/main/java/com/jmsoftware/maf/authcenter/role/service/RoleService.java
@@ -1,6 +1,7 @@
 package com.jmsoftware.maf.authcenter.role.service;
 
 import com.baomidou.mybatisplus.extension.service.IService;
+import com.jmsoftware.maf.authcenter.role.entity.RoleExcelImport;
 import com.jmsoftware.maf.authcenter.role.entity.persistence.Role;
 import com.jmsoftware.maf.common.domain.authcenter.role.GetRoleListByUserIdResponse;
 import com.jmsoftware.maf.common.domain.authcenter.role.GetRoleListByUserIdSingleResponse;
@@ -9,6 +10,7 @@
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody;
 
+import javax.validation.Valid;
 import javax.validation.constraints.NotEmpty;
 import javax.validation.constraints.NotNull;
 import java.util.List;
@@ -23,6 +25,8 @@
  */
 @Validated
 public interface RoleService extends IService<Role> {
+    String ROLE_TEMPLATE_EXCEL = "role-stat.xlsx";
+
     /**
      * Gets role list by user id.
      *
@@ -53,4 +57,21 @@ public interface RoleService extends IService<Role> {
      * @return the response entity
      */
     ResponseEntity<StreamingResponseBody> downloadRoleStat();
+
+    /**
+     * Validate before add to bean list boolean.
+     *
+     * @param beanList the bean list
+     * @param bean     the bean
+     * @param index    the index
+     * @return the boolean
+     */
+    boolean validateBeforeAddToBeanList(List<RoleExcelImport> beanList, RoleExcelImport bean, int index);
+
+    /**
+     * Save.
+     *
+     * @param beanList the bean list
+     */
+    void save(@NotEmpty List<@Valid RoleExcelImport> beanList);
 }
diff --git a/...center/src/main/java/com/jmsoftware/maf/authcenter/role/service/impl/RoleServiceImpl.java b/...center/src/main/java/com/jmsoftware/maf/authcenter/role/service/impl/RoleServiceImpl.java
@@ -4,6 +4,7 @@
 import cn.hutool.core.util.BooleanUtil;
 import cn.hutool.core.util.RandomUtil;
 import cn.hutool.core.util.StrUtil;
+import cn.hutool.extra.validation.ValidationUtil;
 import cn.hutool.poi.excel.ExcelWriter;
 import com.baomidou.mybatisplus.core.toolkit.Wrappers;
 import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
@@ -23,6 +24,7 @@
 import lombok.NonNull;
 import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
+import lombok.extern.slf4j.Slf4j;
 import lombok.val;
 import org.springframework.data.redis.core.RedisTemplate;
 import org.springframework.http.ContentDisposition;
@@ -31,6 +33,7 @@
 import org.springframework.stereotype.Service;
 import org.springframework.web.servlet.mvc.method.annotation.StreamingResponseBody;
 
+import javax.validation.Valid;
 import javax.validation.constraints.NotEmpty;
 import javax.validation.constraints.NotNull;
 import java.lang.reflect.Field;
@@ -46,10 +49,10 @@
  * @author Johnny Miller (锺俊)
  * @date 2020-05-10 22:39:50
  */
+@Slf4j
 @Service
 @RequiredArgsConstructor
 public class RoleServiceImpl extends ServiceImpl<RoleMapper, Role> implements RoleService {
-    private static final String ROLE_TEMPLATE_EXCEL = "role-stat.xlsx";
     private final MafProjectProperty mafProjectProperty;
     private final MafConfiguration mafConfiguration;
     private final RedisTemplate<String, String> redisTemplate;
@@ -116,4 +119,25 @@ public ResponseEntity<StreamingResponseBody> downloadRoleStat() {
                         ContentDisposition.builder("attachment").filename(ROLE_TEMPLATE_EXCEL).build().toString())
                 .body(outputStream -> excelWriter.flush(outputStream, true));
     }
+
+    @Override
+    public boolean validateBeforeAddToBeanList(List<RoleExcelImport> beanList, RoleExcelImport bean, int index) {
+        val beanValidationResult = ValidationUtil.warpValidate(bean);
+        if (!beanValidationResult.isSuccess()) {
+            log.warn("Validation failed! beanList: {}, bean: {}, index: {}", beanList, bean, index);
+            val firstErrorMessage = CollUtil.getFirst(beanValidationResult.getErrorMessages());
+            throw new IllegalArgumentException(
+                    String.format("%s %s", firstErrorMessage.getPropertyName(), firstErrorMessage.getMessage()));
+        }
+        return true;
+    }
+
+    @Override
+    public void save(@NotEmpty List<@Valid RoleExcelImport> beanList) {
+        val roleList = beanList.stream().map(RoleExcelImport::transformTo).collect(Collectors.toList());
+        val saved = this.saveBatch(roleList);
+        if (!saved) {
+            log.error("Cannot save batch role list. {}", roleList);
+        }
+    }
 }