基础框架文档中心

外观

快速起步 ​

本篇介绍如何快速搭建并启动一个使用基础框架的项目。

脚手架 ​

首先获取脚手架项目，它是一个按照项目规范创建的多模块 Maven 项目。包含了api、model、mapper、service 模块，同时配置了对基础框架的依赖。

项目结构如下：

hzcc-scaffold-api
├─ docs # 放置项目相关的设计、说明文档
├─ framework # 基础框架（Git 子模块）
├─ hzcc-biz-api
├─ hzcc-biz-mapper
├─ hzcc-biz-model
├─ hzcc-biz-service
├─ logs # 运行日志
├─ .dockerignore
├─ .gitignore
├─ .gitlab-ci.yml
├─ dockerfile
├─ pom.xml
└─ README.md # 项目说明文档

设置 ​

在启动项目前，还要对脚手架做一些修改和配置。

根目录 ​

首先要根据项目名称修改根目录名，格式为hzcc-{SYSCODE}-api，SYSCODE 为项目英文名缩写。

提示

关于项目命名和其它要求，请查看项目规范。

POM ​

接下来要修改 POM 文件，包含根POM和 API 模块 POM文件。

  1. 根 POM

    需要修改的内容是整个项目的友好名称和简述信息。

    xml
    <!-- pom.xml -->
<name>HZCC Scaffold Project</name>
<description>JavaWeb 脚手架项目</description>

    注意

    不推荐修改 <artifactId>，否则需要同时修改其它模块对它的引用。

  2. API 模块 POM

    需要修改的是 artifactId，它决定了最终打包文件的名称。格式为hzcc-{SYSCODE}-api，SYSCODE 为项目英文名缩写。

    xml
    <!-- hzcc-biz-api/pom.xml -->
<artifactId>hzcc-biz-api</artifactId>

    注意

    此处修改后，需要同步修改 dockerfile 文件中的 “hzcc-biz-api”。

配置文件 ​

然后需要修改配置文件 application.yml 和 application-dev.yml，配置数据库、Redis、密钥等信息。

  1. application.yml

    修改以下内容：

    yaml
    hzcc:
  name: # 项目名称
swagger:
  title: Java基础框架脚手架 # 文档标题
  description: Java基础框架脚手架接口文档 # 文档描述

    注意

    同时还需要将 application.yml 文件中所有的 “jbiz” 替换为项目英文简称，以标识当前系统。

  2. application-dev.yml

    修改以下内容：

    yaml
    # application-dev.yml
token:
  # JWT 令牌密钥，随机生成一个
  secret: 468e9659e18254388ef4
logging:
  datasource:
    url: # 日志库连接信息
    username: # 用户名
    password: # 密码
spring:
  datasource:
    druid:
      # 主库数据源
      master:
        url: # 日志库连接信息
        username: # 用户名
        password: # 密码
  redis:
    host: # 地址
    port: 6379 # 端口，默认为6379
    password: # 密码

基础框架 ​

  1. 基础框架代码默认添加为 Git 子模块，因此需要拉取子模块，获取最新代码。

    执行以下命令：

    bash
    git submodule update --progress --init --merge --remote

    提示

    如果在 Git 客户端工具“更新子模块（Submodule Update ）”，注意勾选“init”、“merge”、“remote”选项。

  2. 确认一下基础框架版本是否正确。进入 framework 目录检查 Git 分支（以版本号命名），如果非预期分支则需要手动切换。

Git ​

从 Git 仓库获取的脚手架项目，其默认推送地址（orgin）自然与托管当前项目的地址不同。 因此可以修改推送地址，方便未来推送代码。

执行以下命令：

bash
git remote set-url origin <项目仓库地址>

数据库 ​

  1. 业务库

    创建一个新的数据库，命名格式为 hzcc.{SYSCODE}.db。然后执行初始化 SQL，路径为：hzcc-{syscode}-api/resources/db/migration/V2021_0730_0000__initDB.sql。

  2. 日志库

    如果无法使用公用的日志数据库，可以自行创建。然后执行初始化 SQL，路径为 docs/logdb_tables_create.sql。

启动 ​

现在可以尝试启动项目，然后请求 /api/about/version。如果一切正常，接口将返回默认的版本号信息。

现在，你已经成功地使用了基础框架，准备开始业务功能开发吧！