📝 开发步骤

一、新建模块

1、新建子模块(以safe为前缀)

① 选择 File -> New -> Module 菜单，如下图所示：
image.png
② 选择 Maven 类型，并点击 Next 按钮，如下图所示：
image.png
③ 选择父模块为 ykkj，输入名字为 ykkj-module-safe，并点击 Finish 按钮，如下图所示
image.png
④ 打开 ykkj-module-safe 模块，删除 src 文件.

⑤ 打开 ykkj-module-safe 模块的 pom.xml 文件，新建其他模块时仅需修改ykkj-module-safe部分，如下：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.   <parent>
  6.     <artifactId>ykkj</artifactId>
  7.     <groupId>com.ykkj.boot</groupId>
  8.     <version>${revision}</version> <!-- 1. 修改 version 为 ${revision} -->
  9.   </parent>
  10.   <modelVersion>4.0.0</modelVersion>
  12.   <artifactId>ykkj-module-safe</artifactId>
  13.   <packaging>pom</packaging> <!-- 2. 新增 packaging 为 pom -->
  15.   <name>${project.artifactId}</name> <!-- 3. 新增 name 为 ${project.artifactId} -->
  16.   <description> <!-- 4. 新增 description 为该模块的描述 -->
  17.     safe模块，主要实现智慧安监等功能。
  18.   </description>
  19.   <modules>
  20.     <module>ykkj-module-safe-api</module>
  21.     <module>ykkj-module-safe-biz</module>
  22.   </modules>
  24. </project>

2、新建safe-api子模块

① 新建 ykkj-module-safe-api 子模块，整个过程和“新建 safe模块”是一致的，如下图所示：
image.png
② 打开 ykkj-module-safe-api 模块的 pom.xml 文件，新建其他模块时仅需修改ykkj-module-safe部分，如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <parent>
    <artifactId>ykkj-module-safe</artifactId>
    <groupId>com.ykkj.boot</groupId>
    <version>${revision}</version> <!-- 1. 修改 version 为 ${revision} -->
  </parent>
  <modelVersion>4.0.0</modelVersion>
  <artifactId>ykkj-module-safe-api</artifactId>
  <packaging>jar</packaging> <!-- 2. 新增 packaging 为 jar -->

  <name>${project.artifactId}</name> <!-- 3. 新增 name 为 ${project.artifactId} -->
  <description> <!-- 4. 新增 description 为该模块的描述 -->
    safe 模块 API，暴露给其它模块调用
  </description>

  <dependencies>  <!-- 5. 新增 ykkj-common 依赖 -->
    <dependency>
      <groupId>com.ykkj.boot</groupId>
      <artifactId>ykkj-common</artifactId>
    </dependency>
  </dependencies>

</project>

③ 【可选】新建 com.ykkj.cdp.module.safe基础包，其中 safe为模块名。之后，新建 api 和 enums 包。如下图所示：
image.png
其中enums.ErrorCodeConstants类为必建类，每个表对应的错误代码，下个章节的代码生成中会生成。

import com.ykkj.cdp.framework.common.exception.ErrorCode;

public interface ErrorCodeConstants {
     ErrorCode BASE_POWERPLANT_NOT_EXISTS = new ErrorCode(20000000, "电厂信息不存在");
}

3、新建safe-biz子模块

① 新建 ykkj-module-safe-biz 子模块，整个过程和“新建 safe模块”也是一致的，如下图所示：
image.png
② 打开 ykkj-module-safe-biz 模块的 pom.xml 文件，新建其他模块时仅需修改ykkj-module-safe部分如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <parent>
    <artifactId>ykkj-module-safe</artifactId>
    <groupId>com.ykkj.boot</groupId>
    <version>${revision}</version> <!-- 1. 修改 version 为 ${revision} -->
  </parent>
  <modelVersion>4.0.0</modelVersion>
  <packaging>jar</packaging> <!-- 2. 新增 packaging 为 jar -->

  <artifactId>ykkj-module-safe-biz</artifactId>

  <name>${project.artifactId}</name> <!-- 3. 新增 name 为 ${project.artifactId} -->
  <description> <!-- 4. 新增 description 为该模块的描述 -->
    safe 模块，主要实现 安监等功能。
  </description>

  <dependencies>  <!-- 5. 新增依赖，这里引入的都是比较常用的业务组件、技术组件 -->
    <dependency>
      <groupId>com.ykkj.boot</groupId>
      <artifactId>ykkj-module-safe-api</artifactId>
      <version>${revision}</version>
    </dependency>

    <!-- 业务组件 -->
    <dependency>
      <groupId>com.ykkj.boot</groupId>
      <artifactId>ykkj-spring-boot-starter-biz-operatelog</artifactId>
    </dependency>

    <!-- Web 相关 -->
    <dependency>
      <groupId>com.ykkj.boot</groupId>
      <artifactId>ykkj-spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
      <groupId>com.ykkj.boot</groupId>
      <artifactId>ykkj-spring-boot-starter-security</artifactId>
    </dependency>

    <!-- DB 相关 -->
    <dependency>
      <groupId>com.ykkj.boot</groupId>
      <artifactId>ykkj-spring-boot-starter-mybatis</artifactId>
    </dependency>

    <!-- Test 测试相关 -->
    <dependency>
      <groupId>com.ykkj.boot</groupId>
      <artifactId>ykkj-spring-boot-starter-test</artifactId>
    </dependency>
    <dependency>
      <groupId>com.ykkj.boot</groupId>
      <artifactId>ykkj-spring-boot-starter-excel</artifactId>
    </dependency>
  </dependencies>

</project>

③ 在ykkj-server中的pom.xml增加对ykkj-module-safe-biz配置

<dependency>
  <groupId>com.ykkj.boot</groupId>
  <artifactId>ykkj-module-safe-biz</artifactId>
  <version>${revision}</version>
</dependency>

image.png
④ 在application.yaml中下图中添加 com.ykkj.cdp.module.safe.enums.ErrorCodeConstants
image.png

二、代码生成

1. 数据库表结构设计

① 表名的前缀，要和 Maven Module 的模块名保持一致。例如说，用户组在 ykkj-module-system 模块，所以表名的前缀是 system_。
疑问：为什么要保持一致？
代码生成器会自动解析表名的前缀，获得其所属的 Maven Module 模块，简化配置过程。
② 设置 ID 主键，一般推荐使用 bigint 长整形，并设置自增长。
如果使用雪花算法需要放开下图所示代码，否则前段js会截取导致显示不全
image.png
③ 正确设置每个字段是否允许空，代码生成器会根据它生成参数是否允许空的校验规则。
④ 正确设置注释，代码生成器会根据它生成字段名与提示等信息。
⑤ 添加 creator、create_time、updater、update_time、deleted 是必须设置的系统字段；如果开启多租户的功能，并且该表需要多租户的隔离，则需要添加 tenant_id 字段。

2. 代码生成

① 点击 [基础设施 -> 代码生成] 菜单，点击 [基于 DB 导入] 按钮，选择 safe_base_powerplant表，后点击 [确认] 按钮。
image.png
② 点击 safe_base_powerplant 所在行的 [编辑] 按钮，修改生成配置。后操作如下：
image.png
去掉查询信息
image.png
设置上级菜单
image.png
③ 点击 safe_base_powerplant所在行的 [预览] 按钮，在线预览生成的代码，检查是否符合预期。
④ 点击 safe_base_powerplant 所在行的 [生成代码] 按钮，下载生成代码的压缩包，双击进行解压，解压后拷贝到相应目录。
image.png
如果不是id主键需要修改如下：
image.png
生成之后刷新Maven
image.png