优化：🔥 深度优化后端 CRUD 公共组件，并抽取前端下载功能到 CRUD 公共组件

1. 后端抽取导出功能到 CRUD 公共组件 2. 查询列表及导出接口支持排序参数 3. 深度优化 BaseServiceImpl 中的 CRUD 公共实现 4. 前端抽取公共下载组件 5. 优化部分细节并修复部分错误
2025-09-14 10:57:19 +08:00 · 2023-02-13 21:15:06 +08:00
parent 142d315a8d
commit 03b57fb021
25 changed files with 457 additions and 307 deletions
--- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/annotation/CrudRequestMapping.java
+++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/annotation/CrudRequestMapping.java
@@ -37,7 +37,7 @@ public @interface CrudRequestMapping {
    /**
     * API 列表
     */
-    Api[] api() default {Api.PAGE, Api.GET, Api.CREATE, Api.UPDATE, Api.DELETE};
+    Api[] api() default {Api.PAGE, Api.GET, Api.CREATE, Api.UPDATE, Api.DELETE, Api.EXPORT};

    /**
     * API 枚举
@@ -70,6 +70,10 @@ public @interface CrudRequestMapping {
        /**
         * 删除
         */
-        DELETE,;
+        DELETE,
+        /**
+         * 导出
+         */
+        EXPORT,;
    }
 }
--- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/BaseController.java
+++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/BaseController.java
@@ -18,6 +18,8 @@ package top.charles7c.cnadmin.common.base;

 import java.util.List;

+import javax.servlet.http.HttpServletResponse;
+
 import lombok.NoArgsConstructor;

 import io.swagger.v3.oas.annotations.Operation;
@@ -29,6 +31,7 @@ import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;

 import top.charles7c.cnadmin.common.model.query.PageQuery;
+import top.charles7c.cnadmin.common.model.query.SortQuery;
 import top.charles7c.cnadmin.common.model.vo.PageDataVO;
 import top.charles7c.cnadmin.common.model.vo.R;

@@ -76,13 +79,15 @@ public abstract class BaseController<S extends BaseService<V, D, Q, C>, V, D, Q,
     *
     * @param query
     *            查询条件
+     * @param sortQuery
+     *            排序查询条件
     * @return 列表信息
     */
    @Operation(summary = "查询列表")
    @ResponseBody
-    @GetMapping("/all")
-    protected R<List<V>> list(@Validated Q query) {
-        List<V> list = baseService.list(query);
+    @GetMapping("/list")
+    protected R<List<V>> list(@Validated Q query, @Validated SortQuery sortQuery) {
+        List<V> list = baseService.list(query, sortQuery);
        return R.ok(list);
    }

@@ -147,4 +152,20 @@ public abstract class BaseController<S extends BaseService<V, D, Q, C>, V, D, Q,
        baseService.delete(ids);
        return R.ok("删除成功");
    }
+
+    /**
+     * 导出
+     *
+     * @param query
+     *            查询条件
+     * @param sortQuery
+     *            排序查询条件
+     * @param response
+     *            响应对象
+     */
+    @Operation(summary = "导出数据")
+    @GetMapping("/export")
+    protected void export(@Validated Q query, @Validated SortQuery sortQuery, HttpServletResponse response) {
+        baseService.export(query, sortQuery, response);
+    }
 }
--- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/BaseService.java
+++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/BaseService.java
@@ -18,7 +18,10 @@ package top.charles7c.cnadmin.common.base;

 import java.util.List;

+import javax.servlet.http.HttpServletResponse;
+
 import top.charles7c.cnadmin.common.model.query.PageQuery;
+import top.charles7c.cnadmin.common.model.query.SortQuery;
 import top.charles7c.cnadmin.common.model.vo.PageDataVO;

 /**
@@ -53,9 +56,11 @@ public interface BaseService<V, D, Q, C extends BaseRequest> {
     *
     * @param query
     *            查询条件
+     * @param sortQuery
+     *            排序查询条件
     * @return 列表信息
     */
-    List<V> list(Q query);
+    List<V> list(Q query, SortQuery sortQuery);

    /**
     * 查看详情
@@ -90,4 +95,16 @@ public interface BaseService<V, D, Q, C extends BaseRequest> {
     *            ID 列表
     */
    void delete(List<Long> ids);
+
+    /**
+     * 导出
+     *
+     * @param query
+     *            查询条件
+     * @param sortQuery
+     *            排序查询条件
+     * @param response
+     *            响应对象
+     */
+    void export(Q query, SortQuery sortQuery, HttpServletResponse response);
 }
--- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/BaseServiceImpl.java
+++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/base/BaseServiceImpl.java
@@ -16,20 +16,35 @@

 package top.charles7c.cnadmin.common.base;

+import java.util.Collections;
 import java.util.List;

+import javax.servlet.http.HttpServletResponse;
+
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.domain.Sort;
 import org.springframework.transaction.annotation.Transactional;

 import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
 import com.baomidou.mybatisplus.core.mapper.BaseMapper;
 import com.baomidou.mybatisplus.core.metadata.IPage;
+import com.baomidou.mybatisplus.core.metadata.TableInfo;
+import com.baomidou.mybatisplus.core.metadata.TableInfoHelper;
+import com.baomidou.mybatisplus.core.toolkit.Assert;
 import com.baomidou.mybatisplus.core.toolkit.ReflectionKit;

 import cn.hutool.core.bean.BeanUtil;
+import cn.hutool.core.collection.CollUtil;
+import cn.hutool.core.convert.Convert;
+import cn.hutool.core.util.StrUtil;
+import cn.hutool.extra.spring.SpringUtil;

 import top.charles7c.cnadmin.common.model.query.PageQuery;
+import top.charles7c.cnadmin.common.model.query.SortQuery;
 import top.charles7c.cnadmin.common.model.vo.PageDataVO;
+import top.charles7c.cnadmin.common.service.CommonUserService;
+import top.charles7c.cnadmin.common.util.ExcelUtils;
+import top.charles7c.cnadmin.common.util.ExceptionUtils;
 import top.charles7c.cnadmin.common.util.helper.QueryHelper;
 import top.charles7c.cnadmin.common.util.validate.CheckUtils;

@@ -65,32 +80,39 @@ public abstract class BaseServiceImpl<M extends BaseMapper<T>, T, V, D, Q, C ext
    public PageDataVO<V> page(Q query, PageQuery pageQuery) {
        QueryWrapper<T> queryWrapper = QueryHelper.build(query);
        IPage<T> page = baseMapper.selectPage(pageQuery.toPage(), queryWrapper);
-        return PageDataVO.build(page, voClass);
+        PageDataVO<V> pageDataVO = PageDataVO.build(page, voClass);
+        pageDataVO.getList().forEach(this::fill);
+        return pageDataVO;
    }

    @Override
-    public List<V> list(Q query) {
-        QueryWrapper<T> queryWrapper = QueryHelper.build(query);
-        List<T> entityList = baseMapper.selectList(queryWrapper);
-        return BeanUtil.copyToList(entityList, voClass);
+    public List<V> list(Q query, SortQuery sortQuery) {
+        List<V> list = this.list(query, sortQuery, voClass);
+        list.forEach(this::fill);
+        return list;
    }

    @Override
    public D get(Long id) {
        T entity = this.getById(id);
-        return BeanUtil.copyProperties(entity, detailVoClass);
+        D detailVO = BeanUtil.copyProperties(entity, detailVoClass);
+        this.fillDetail(detailVO);
+        return detailVO;
    }

-    /**
-     * 新增
-     *
-     * @param request
-     *            创建信息
-     * @return 自增 ID
-     */
    @Override
    @Transactional(rollbackFor = Exception.class)
-    public abstract Long create(C request);
+    public Long create(C request) {
+        if (request == null) {
+            return 0L;
+        }
+        // 保存信息
+        T entity = BeanUtil.copyProperties(request, entityClass);
+        baseMapper.insert(entity);
+        TableInfo tableInfo = TableInfoHelper.getTableInfo(entityClass);
+        Object idValue = tableInfo.getPropertyValue(entity, this.currentEntityIdName());
+        return Convert.toLong(idValue);
+    }

    @Override
    @Transactional(rollbackFor = Exception.class)
@@ -105,6 +127,35 @@ public abstract class BaseServiceImpl<M extends BaseMapper<T>, T, V, D, Q, C ext
        baseMapper.deleteBatchIds(ids);
    }

+    @Override
+    public void export(Q query, SortQuery sortQuery, HttpServletResponse response) {
+        List<D> list = this.list(query, sortQuery, detailVoClass);
+        list.forEach(this::fillDetail);
+        ExcelUtils.export(list, "导出数据", detailVoClass, response);
+    }
+
+    /**
+     * 查询列表
+     *
+     * @param query
+     *            查询条件
+     * @param sortQuery
+     *            排序查询条件
+     * @param targetClass
+     *            指定类型
+     * @return 列表信息
+     */
+    protected <E> List<E> list(Q query, SortQuery sortQuery, Class<E> targetClass) {
+        QueryWrapper<T> queryWrapper = QueryHelper.build(query);
+        // 设置排序
+        Sort sort = sortQuery.getSort();
+        for (Sort.Order order : sort) {
+            queryWrapper.orderBy(order != null, order.isAscending(), StrUtil.toUnderlineCase(order.getProperty()));
+        }
+        List<T> entityList = baseMapper.selectList(queryWrapper);
+        return CollUtil.isNotEmpty(entityList) ? BeanUtil.copyToList(entityList, targetClass) : Collections.emptyList();
+    }
+
    /**
     * 根据 ID 查询
     *
@@ -118,6 +169,57 @@ public abstract class BaseServiceImpl<M extends BaseMapper<T>, T, V, D, Q, C ext
        return entity;
    }

+    /**
+     * 填充数据
+     *
+     * @param baseObj
+     *            待填充列表信息
+     */
+    protected void fill(Object baseObj) {
+        if (baseObj instanceof BaseVO) {
+            BaseVO baseVO = (BaseVO)baseObj;
+            Long createUser = baseVO.getCreateUser();
+            if (createUser == null) {
+                return;
+            }
+            CommonUserService userService = SpringUtil.getBean(CommonUserService.class);
+            baseVO.setCreateUserString(ExceptionUtils.exToNull(() -> userService.getNicknameById(createUser)));
+        }
+    }
+
+    /**
+     * 填充详情数据
+     *
+     * @param detailObj
+     *            待填充详情信息
+     */
+    protected void fillDetail(Object detailObj) {
+        if (detailObj instanceof BaseDetailVO) {
+            BaseDetailVO detailVO = (BaseDetailVO)detailObj;
+            this.fill(detailVO);
+
+            Long updateUser = detailVO.getUpdateUser();
+            if (updateUser == null) {
+                return;
+            }
+            CommonUserService userService = SpringUtil.getBean(CommonUserService.class);
+            detailVO.setUpdateUserString(ExceptionUtils.exToNull(() -> userService.getNicknameById(updateUser)));
+        }
+    }
+
+    /**
+     * 获取实体类 ID 名称
+     *
+     * @return 实体类 ID 名称
+     */
+    protected String currentEntityIdName() {
+        TableInfo tableInfo = TableInfoHelper.getTableInfo(entityClass);
+        Assert.notNull(tableInfo, "error: can not execute. because can not find cache of TableInfo for entity!");
+        String keyProperty = tableInfo.getKeyProperty();
+        Assert.notEmpty(keyProperty, "error: can not execute. because can not find column for id from entity!");
+        return keyProperty;
+    }
+
    /**
     * 获取实体类 Class 对象
     *
--- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/model/query/PageQuery.java
+++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/model/query/PageQuery.java
@@ -16,14 +16,13 @@

 package top.charles7c.cnadmin.common.model.query;

-import java.io.Serializable;
-import java.util.ArrayList;
-import java.util.List;
+import javax.validation.constraints.Min;

 import lombok.Data;

 import io.swagger.v3.oas.annotations.media.Schema;

+import org.hibernate.validator.constraints.Range;
 import org.springdoc.api.annotations.ParameterObject;
 import org.springframework.data.domain.Sort;

@@ -32,7 +31,6 @@ import com.baomidou.mybatisplus.core.metadata.OrderItem;
 import com.baomidou.mybatisplus.extension.plugins.pagination.Page;

 import cn.hutool.core.collection.CollUtil;
-import cn.hutool.core.util.ArrayUtil;
 import cn.hutool.core.util.StrUtil;

 /**
@@ -44,7 +42,7 @@ import cn.hutool.core.util.StrUtil;
@Data
@ParameterObject
@Schema(description = "分页查询条件")
-public class PageQuery implements Serializable {
+public class PageQuery extends SortQuery {

    private static final long serialVersionUID = 1L;

@@ -52,60 +50,44 @@ public class PageQuery implements Serializable {
     * 页码
     */
    @Schema(description = "页码")
-    private int page;
+    @Min(value = 1, message = "页码最小值为 1")
+    private Integer page;

    /**
-     * 每页记录数
+     * 每页条数
     */
-    @Schema(description = "每页记录数")
-    private int size;
-
-    /**
-     * 排序条件
-     */
-    @Schema(description = "排序条件", example = "sort=published,desc&sort=title,asc")
-    private String[] sort;
+    @Schema(description = "每页条数")
+    @Range(min = 1, max = 1000, message = "每页条数（取值范围 1-1000）")
+    private Integer size;

    /** 默认页码：1 */
    private static final int DEFAULT_PAGE = 1;
-
-    /** 默认每页记录数：10 */
+    /** 默认每页条数：10 */
    private static final int DEFAULT_SIZE = 10;
-    private static final String DELIMITER = ",";
+    /** 默认每页最大条数：1000 */
+    private static final int DEFAULT_MAX_SIZE = 1000;

    public PageQuery() {
-        this.page = DEFAULT_PAGE;
-        this.size = DEFAULT_SIZE;
+        this(DEFAULT_PAGE, DEFAULT_SIZE);
    }

-    public int getPage() {
-        return page < 0 ? DEFAULT_PAGE : page;
+    public PageQuery(Integer page, Integer size) {
+        this.setPage(page);
+        this.setSize(size);
    }

-    /**
-     * 解析排序条件为 Spring 分页排序实体
-     *
-     * @return Spring 分页排序实体
-     */
-    public Sort getSort() {
-        if (ArrayUtil.isEmpty(sort)) {
-            return Sort.unsorted();
-        }
+    public void setPage(Integer page) {
+        this.page = page == null ? DEFAULT_PAGE : page;
+    }

-        List<Sort.Order> orders = new ArrayList<>(sort.length);
-        if (sort[0].contains(DELIMITER)) {
-            // e.g "sort=published,desc&sort=title,asc"
-            for (String s : sort) {
-                String[] sortArr = s.split(DELIMITER);
-                Sort.Order order = new Sort.Order(Sort.Direction.valueOf(sortArr[1].toUpperCase()), sortArr[0]);
-                orders.add(order);
-            }
+    public void setSize(Integer size) {
+        if (size == null) {
+            this.size = DEFAULT_SIZE;
+        } else if (size > DEFAULT_MAX_SIZE) {
+            this.size = DEFAULT_MAX_SIZE;
        } else {
-            // e.g "sort=published,desc"
-            Sort.Order order = new Sort.Order(Sort.Direction.valueOf(sort[1].toUpperCase()), sort[0]);
-            orders.add(order);
+            this.size = size;
        }
-        return Sort.by(orders);
    }

    /**
--- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/model/query/SortQuery.java
+++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/model/query/SortQuery.java
@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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 top.charles7c.cnadmin.common.model.query;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.List;
+
+import lombok.Data;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+import org.springdoc.api.annotations.ParameterObject;
+import org.springframework.data.domain.Sort;
+
+import cn.hutool.core.util.ArrayUtil;
+import cn.hutool.core.util.StrUtil;
+
+import top.charles7c.cnadmin.common.consts.CharConstants;
+
+/**
+ * 排序查询条件
+ *
+ * @author Charles7c
+ * @since 2023/2/12 21:30
+ */
+@Data
+@ParameterObject
+@Schema(description = "排序查询条件")
+public class SortQuery implements Serializable {
+
+    private static final long serialVersionUID = 1L;
+
+    /**
+     * 排序条件
+     */
+    @Schema(description = "排序条件", example = "sort=published,desc&sort=title,asc")
+    private String[] sort;
+
+    /**
+     * 解析排序条件为 Spring 分页排序实体
+     *
+     * @return Spring 分页排序实体
+     */
+    public Sort getSort() {
+        if (ArrayUtil.isEmpty(sort)) {
+            return Sort.unsorted();
+        }
+
+        List<Sort.Order> orders = new ArrayList<>(sort.length);
+        if (StrUtil.contains(sort[0], CharConstants.COMMA)) {
+            // e.g "sort=published,desc&sort=title,asc"
+            for (String s : sort) {
+                List<String> sortList = StrUtil.split(s, CharConstants.COMMA);
+                Sort.Order order =
+                    new Sort.Order(Sort.Direction.valueOf(sortList.get(1).toUpperCase()), sortList.get(0));
+                orders.add(order);
+            }
+        } else {
+            // e.g "sort=published,desc"
+            Sort.Order order = new Sort.Order(Sort.Direction.valueOf(sort[1].toUpperCase()), sort[0]);
+            orders.add(order);
+        }
+        return Sort.by(orders);
+    }
+}
--- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/model/vo/PageDataVO.java
+++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/model/vo/PageDataVO.java
@@ -102,7 +102,7 @@ public class PageDataVO<V> {
     * @param page
     *            页码
     * @param size
-     *            每页记录数
+     *            每页条数
     * @param list
     *            列表数据
     * @param <V>
--- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/service/CommonUserService.java
+++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/service/CommonUserService.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ *
+ * 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
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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 top.charles7c.cnadmin.common.service;
+
+/**
+ * 公共用户业务接口
+ *
+ * @author Charles7c
+ * @since 2023/2/13 20:37
+ */
+public interface CommonUserService {
+
+    /**
+     * 根据 ID 查询昵称
+     *
+     * @param userId
+     *            用户 ID
+     * @return 昵称
+     */
+    String getNicknameById(Long userId);
+}
--- a/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/util/helper/QueryHelper.java
+++ b/continew-admin-common/src/main/java/top/charles7c/cnadmin/common/util/helper/QueryHelper.java
@@ -69,10 +69,10 @@ public class QueryHelper {
    }

    /**
-     * 获取指定类的所有属性（包括私有的和父类的）
+     * 获取指定类型的所有属性（包括私有的和父类的）
     *
     * @param clazz
-     *            指定类
+     *            指定类型
     * @param fieldList
     *            属性列表
     * @param <Q>