前置条件

在开发之前，请确保本地项目已经创建成功，详见 新建项目

介绍

项目创建成功之后，需要初始化本地数据库。

  • 创建用户
  • 创建数据库
  • 编写表结构对应的groovy脚本
  • 初始化表结构
  • 验证表结构
  • 项目数据库配置

创建用户

确保数据库启动成功，并创建项目访问的用户。

  1. CREATE USER 'choerodon'@'%' IDENTIFIED BY "123456";

创建数据库

用户创建成功之后，创建项目对应的数据库，并将新创建的数据库权限赋予用户。

  1. CREATE DATABASE todo_service DEFAULT CHARACTER SET utf8mb4;
  2. GRANT ALL PRIVILEGES ON todo_service.* TO choerodon@'%';
  3. FLUSH PRIVILEGES;

编写表结构对应的groovy脚本

Choerodon 采用Liquibase + groovy 的方式对数据库管理。

更多有关Liguibase的资料见 Liquibase 官网。

创建groovy文件存储的文件夹，并且创建groovy文件。

  1. $ mkdir -p src/main/resources/script/db
  2. $ cd src/main/resources/script/db
  3. $ touch todo_user.groovy todo_task.groovy
  1. // todo_user.groovy
  2. package script.db
  4. databaseChangeLog(logicalFilePath: 'todo_user.groovy') {
  5.     changeSet(id: '2019-05-30-todo_user', author: 'your.email@email.com') {
  6.         createTable(tableName: "TODO_USER") {
  7.             column(name: 'ID', type: 'BIGINT UNSIGNED', remarks: 'ID', autoIncrement: true) {
  8.                 constraints(primaryKey: true)
  9.             }
  10.             column(name: 'EMPLOYEE_NAME', type: 'VARCHAR(32)', remarks: '员工名')
  11.             column(name: 'EMPLOYEE_NUMBER', type: 'VARCHAR(32)', remarks: '员工号') {
  12.                 constraints(unique: true)
  13.             }
  14.             column(name: 'EMAIL', type: 'VARCHAR(32)', remarks: '邮箱')
  16.             column(name: "OBJECT_VERSION_NUMBER", type: "BIGINT", defaultValue: "1")
  17.             column(name: "CREATED_BY", type: "BIGINT", defaultValue: "-1")
  18.             column(name: "CREATION_DATE", type: "DATETIME", defaultValueComputed: "CURRENT_TIMESTAMP")
  19.             column(name: "LAST_UPDATED_BY", type: "BIGINT", defaultValue: "-1")
  20.             column(name: "LAST_UPDATE_DATE", type: "DATETIME", defaultValueComputed: "CURRENT_TIMESTAMP")
  21.         }
  22.     }
  23. }
  1. // todo_task.groovy
  2. package script.db
  4. databaseChangeLog(logicalFilePath: 'todo_task.groovy') {
  5.     changeSet(id: '2019-05-30-todo_task', author: 'your.email@email.com') {
  6.         createTable(tableName: "TODO_TASK") {
  7.             column(name: 'ID', type: 'BIGINT UNSIGNED', remarks: 'ID', autoIncrement: true) {
  8.                 constraints(primaryKey: true)
  9.             }
  10.             column(name: 'EMPLOYEE_ID', type: 'BIGINT', remarks: '员工ID')
  11.             column(name: 'STATE', type: 'VARCHAR(36)', remarks: '状态')
  12.             column(name: 'TASK_NUMBER', type: 'VARCHAR(64)', remarks: '任务编号') {
  13.                 constraints(unique: true)
  14.             }
  15.             column(name: 'TASK_DESCRIPTION', type: 'VARCHAR(256)', remarks: '任务描述')
  17.             column(name: "OBJECT_VERSION_NUMBER", type: "BIGINT", defaultValue: "1")
  18.             column(name: "CREATED_BY", type: "BIGINT", defaultValue: "-1")
  19.             column(name: "CREATION_DATE", type: "DATETIME", defaultValueComputed: "CURRENT_TIMESTAMP")
  20.             column(name: "LAST_UPDATED_BY", type: "BIGINT", defaultValue: "-1")
  21.             column(name: "LAST_UPDATE_DATE", type: "DATETIME", defaultValueComputed: "CURRENT_TIMESTAMP")
  22.         }
  23.     }
  24. }

初始化表结构

在根目录下，创建init-local-database.sh 文件。

  1. $ touch init-local-database.sh

修改初始化脚本。

  1. #!/usr/bin/env bash
  3. MAVEN_LOCAL_REPO=$(cd / && mvn help:evaluate -Dexpression=settings.localRepository -q -DforceStdout)
  4. TOOL_GROUP_ID=io.choerodon
  5. TOOL_ARTIFACT_ID=choerodon-tool-liquibase
  6. TOOL_VERSION=${1:-0.11.0.RELEASE}
  7. TOOL_JAR_PATH=${MAVEN_LOCAL_REPO}/${TOOL_GROUP_ID/\./\/}/${TOOL_ARTIFACT_ID}/${TOOL_VERSION}/${TOOL_ARTIFACT_ID}-${TOOL_VERSION}.jar
  8. mvn org.apache.maven.plugins:maven-dependency-plugin:get \
  9.  -Dartifact=${TOOL_GROUP_ID}:${TOOL_ARTIFACT_ID}:${TOOL_VERSION} \
  10.  -Dtransitive=false
  12. #java -Dspring.datasource.url="jdbc:oracle:thin:@127.0.0.1:1521:xe" \
  13. java -Dspring.datasource.url="jdbc:mysql://localhost/todo_service?useUnicode=true&characterEncoding=utf-8&useSSL=false&useInformationSchema=true&remarks=true&allowMultiQueries=true&serverTimezone=Asia/Shanghai" \
  14.  -Dspring.datasource.username=choerodon \
  15.  -Dspring.datasource.password=123456 \
  16.  -Ddata.drop=false -Ddata.init=true \
  17.  -Ddata.dir=src/main/resources \
  18.  -jar ${TOOL_JAR_PATH}

进入根目录执行如下命令：

  1. $ sh init-local-database.sh [version]    #如未指定version，则默认使用tool version为0.11.0.

控制台打印出如下信息，则表示初始化成功。

  1. 数据库初始化任务完成

脚本执行程序会自动扫描resources 中的groovy 数据库初始化文件以及excel 初始化数据。

执行 init-local-database.sh 脚本，若出现错误：

  1. Error: Unable to access jarfile

则需自行检查脚本中TOOL_JAR_PATH路径是否正确。

您也可以手动下载最新版本的 choerodon-tool-liquibase.jar，自行指定TOOL_JAR_PATH路径进行数据初始化。

验证表结构

登录数据库，查询现有的表结构。

  1. mysql> use todo_service;
  2. Database changed
  3. mysql> show tables;
  4. +------------------------+
  5. | Tables_in_todo_service |
  6. +------------------------+
  7. | DATABASECHANGELOG      |
  8. | DATABASECHANGELOGLOCK  |
  9. | TODO_TASK              |
  10. | TODO_USER              |
  11. +------------------------+
  12. 4 rows in set (0.00 sec)

项目数据库配置

在pom.xml 文件中添加数据库依赖。

  1. <dependency>
  2.     <groupId>io.choerodon</groupId>
  3.     <artifactId>choerodon-starter-mybatis</artifactId>
  4.     <version>${choerodon.starters.version}</version>
  5. </dependency>
  6. <dependency>
  7.     <groupId>mysql</groupId>
  8.     <artifactId>mysql-connector-java</artifactId>
  9. </dependency>

在项目的application.yml 文件中添加数据库连接信息：

  1. spring:
  2.   datasource:
  3.     url: jdbc:mysql://localhost:3306/todo_service?useUnicode=true&characterEncoding=utf-8&useSSL=false&useInformationSchema=true&remarks=true&allowMultiQueries=true&serverTimezone=Asia/Shanghai
  4.     username: choerodon
  5.     password: 123456

项目根目录下执行命令。项目正常启动，则数据库连接配置正常。

  1. $ mvn clean spring-boot:run