前言

本栏目内容为橙单代码生成工具的在线帮助文档,可通过橙单工具中每个配置页面右上角的「帮助」按钮直接跳转。

工程信息

在所有的工程配置选项中,除「工程类型」、「数据库类型」、「部门支持」和「权限表主键」之外,其他配置项均可反复修改,并多次重新生成。

配置项说明

  • 中文名称和英文名称,这里不再做过多介绍。
  • 基础包名,后端工程代码使用的基础包名。
  • 工程类型,目前已支持「单体工程」、「微服务工程」和「多租户工程」,其中多租户项目会包含「租户管理」和「租户运营」两个应用工程,前者为单体架构,后者微服务架构。
  • 后端框架,支持 Spring Boot 2 + JDK8 和 Spring Boot 3 + JDK17。
  • 数据库类型,支持 MySQL、PostgresSQL、Oracle、达梦、人大金仓和华为高斯。其中人大金仓和华为高斯没有提供基于 NodeJS 的访问插件,目前无法直接使用。然而由于华为高斯和 PostgreSQL 的 DDL 语法基本一致,因此可以将需要导入到橙单的业务表在 PostgreSQL 中创建,同时这里选择 PostgreSQL 的数据库类型。工程生成后,仅需修改 Jdbc 的驱动包引用和数据源的连接串信息即可。
  • 存储类型,支持 Minio、阿里云 OSS、腾讯云 COS 和华为云 OBS。默认情况下,整个工程仅能使用同一种类型的分布式对象存储插件,本章后面 常问配置项的存储类型小节 会有详细的图文说明。
  • 部门支持,选择支持后,才会生成与部门相关的前后端代码。
  • 数据权限,仅当选择支持部门时,此配置项才可选择,并生成与数据权限相关的前后端代码。
  • 权限表主键,该配置项仅应用于橙单内置的用户权限数据表的主键字段类型。如 sys_user、sys_dept、sys_post、sys_role、sys_menu、sys_perm_code、sys_perm 和 sys_data_perm 等。
  • 逻辑正常值和逻辑删除值,所有配置为逻辑删除字段所对应的两个数值。
  • 多栏目布局,用于控制前端页面布局的配置项,本章后面 常问配置项的多栏目布局小节 会有详细的图文说明。
  • 页面结构,用于控制前端页面布局的配置项,本章后面 常问配置项的页面结构小节 会有详细的图文说明。
  • 前端主题,前端的主题样式。

多租户补充说明

对于多租户工程,默认会生成两个应用「租户管理应用」和「租户运营应用」,下图红框圈住的两个配置项「部门支持」和「数据权限」仅应用于「租户运营应用」,而「租户管理应用」的相关配置项,可在工程创建后进行修改,见如下几张截图。

基础架构

在下图所示的工程配置项中,选择「支持」即会生成与之相关的前后端代码,反之则不会生成。当前页面的工程配置项命名准确且功能清晰,本小节将不再一一介绍,我们仅罗列以下几点注意事项,以供您参考。

  • 仅当「工作流」选项为支持时,「钉钉编辑器」配置项才可用。
  • 仅当「工程类型」选择微服务或多租户时,「单点登录」、「链路监控」和「分布式事务」等配置项才可用。
  • 「全局通用对象」和「实体对象基类」两个配置开关,会在本章后面 常问配置项的全局通用对象常问配置项的实体对象基类 两个小节中给出更为详细的图文说明。

数据库配置

  • 在新建单体和微服务工程时,仅能创建一个默认的数据库链接,而对于多租户工程,则可以创建两个数据库链接,分别对应于「租户管理」和「租户运营」两个业务应用的默认数据库链接。具体见下图及其文字说明。
  • 工程创建后,可以在该工程的「数据库」页面继续创建更多的数据库链接。

常问配置项

以下均为在日常技术支持过程中经常会被问到的问题,为了尽可能的节省用户的时间,我们会根据用户的反馈,持续总结并完善该小节。

存储类型

见以下多张截图中的文字说明。

多栏目布局

以下两张截图分别对应于「多栏目布局」和「非多栏目布局」。

页面结构

见以下截图中的文字说明。

全局通用对象

如打开该配置项开关,全工程中的数据表字段「创建用户」、「创建时间」、「更新用户」和「更新时间」将使用统一的命名规则,具体可见以下几张截图中的文字说明。

实体对象基类

仅当「全局通用对象」的开关被打开时,当前配置项才可用。如果打开该开关,生成后工程的实体对象类将会继承 BaseModel 基类。但是当数据表只匹配部分字段时,如缺少「update_user_id」,该表所对应的实体类将不会继承 BaseModel。具体可见以下几张截图中的文字说明。

结语

赠人玫瑰,手有余香,感谢您的支持和关注,选择橙单,效率乘三,收入翻番。