Sz-Admin | SpringBoot3 JDK21 Vue3开源后台RBAC管理系统 | Sz-Admin开发约定

本文链接：https://blog.csdn.net/feiyuchuixue/article/details/139514186

简介

在这里插入图片描述

Sz Admin ，一个基于 Spring Boot 3、JDK21、Vue 3 和 Element-Plus 的开源后台管理框架，致力于为您提供一个流畅、直观且功能强大的开发框架。它不仅融合了最新的技术趋势，而且通过精心设计，确保了系统的简洁性和高效，让使用者可以专注业务。

在线体验

官网地址：https://szadmin.cn
文档地址：https://szadmin.cn/md/Help/doc/start.html
预览地址：https://preview.szadmin.cn
代码仓库：
- 前端：
  - Github：sz-admin
  - Gitee：sz-admin
- 后端：
  - Github：sz-boot-parent
  - Gitee：sz-boot-parent
- 部署：
  - Github：sz-deploy
  - Gitee：sz-deploy

约定

约定是团队的默契，为我们的工作提供了一致性和可预测性。统一的规则和准则确保了代码的清晰、高效和无冲突。因此，约定在团队合作和项目开发中至关重要。

在框架的制作过程中，我们为了满足一些常见需求，对一些部分进行了处理，形成了一些潜在的约定。尽管这些约定并非强制性的，但它们有助于提高开发效率和代码质量

后端

1. 逻辑删除

在创建数据表时，我们推荐使用以下命名和物理类型来实现逻辑删除：

`del_flag` enum('T','F') CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL DEFAULT 'F' COMMENT '删除与否',

这样的设计可以清晰地表示记录的删除状态，并且在数据库层面提供了直观的标识。

除了数据库，我们也需要对PO类进行处理：

@Table("sys_user")
@Schema(description = "系统用户表")
public class SysUser implements Serializable {
	
	...

    @Column(isLogicDelete = true)     // 通过@Column来指定逻辑删除属性  // [!code warning]
    private String delFlag;

    ...

}

我们的Mybatis-Flex也指定了逻辑删除标识为T、F字符。

mybatis-flex:
  configuration:
    map-underscore-to-camel-case: true
    jdbc-type-for-null: null
    auto-mapping-behavior: full
    auto-mapping-unknown-column-behavior: none
    cache-enabled: false
  global-config:
    deleted-value-of-logic-delete: "T" # 逻辑删除字段的已删除值 // [!code warning]
    normal-value-of-logic-delete: "F"  # 逻辑删除字段的未删除值 // [!code warning]

2. 数据填充

当我们操作某些表时，有时候我们有可能需要根据某些情况进行一些更新操作。例如 Insert操作需要更新create_id 和 create_time、Update操作要更新update_id和 update_time。

针对于常见的这四个属性，框架提供了默认的数据填充支持。

在创建数据表时，我们推荐使用以下命名和物理类型来实现数据填充：

以下四个属性根据业务情况自行组合，系统会自动根据命名匹配并填充。

  `create_time` datetime DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `update_time` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  `create_id` int DEFAULT NULL COMMENT '创建人',
  `update_id` int DEFAULT NULL COMMENT '更新人',

针对sys_client表的数据填充需求，我们建议按照以下示例对PO类进行命名和类型处理

[!CAUTION]注意！！

必须遵照以下类型，否则动态填充会异常！！！

@Table(value = "sys_client", onInsert = EntityChangeListener.class, onUpdate = EntityChangeListener.class)
public class SysClient implements Serializable {
	...
    
    @Schema(description ="创建者")
    private Long createId;

    @Schema(description ="创建时间")
    private LocalDateTime createTime;

    @Schema(description ="更新者")
    private Long updateId;

    @Schema(description ="更新时间")
    private LocalDateTime updateTime;     
    ...    
}

这样的处理方式可以清晰地描述这些属性的作用，并为数据填充提供了明确的指导。

那么我们系统中是如何实现“动态填充”的呢？

public class EntityChangeListener implements InsertListener, UpdateListener, SetListener {

    @Override
    public void onInsert(Object o) {
        setPropertyIfPresent(o, "createId", StpUtil.getLoginIdAsLong());
        setPropertyIfPresent(o, "createTime", LocalDateTime.now());
    }

    @Override
    public void onUpdate(Object o) {
        setPropertyIfPresent(o, "updateId", StpUtil.getLoginIdAsLong());
        setPropertyIfPresent(o, "updateTime", LocalDateTime.now());
    }

    @Override
    public Object onSet(Object entity, String property, Object value) {
        return value;
    }

    private void setPropertyIfPresent(Object object, String propertyName, Object propertyValue) {
        try {
            // 获取对象的 Class 对象
            Class<?> clazz = object.getClass();
            // 获取对象的字段
            Field field = clazz.getDeclaredField(propertyName);
            // 设置字段为可访问，以便访问私有字段
            field.setAccessible(true);
            // 设置字段的值
            field.set(object, propertyValue);
        } catch (NoSuchFieldException | IllegalAccessException e) {
            // 如果字段不存在，则忽略异常
            log.warn(" Fill EntityChangeField failed; Property {} not found. ", propertyName);
        }
    }

}