开发环境搭建

本文介绍了本系统后端开发所需要的一些软件依赖，以及安装使用

开发工具

• Git
• JDK 1.8.0 及以上版本
• Docker
• Mysql 5.7

安装

Mac OS 环境

安装前准备

• 在 Homebrew官网 根据说明安装homebrew

Git安装

1. 运行 brew install git 安装git。
2. 在终端输入 git --version，确认Git是否安装成功。

JDK

1. 在 JDK下载官网 下载相应的安装包。
2. 在本地执行安装文件，安装Java环境。
3. 在终端输入 java --version，确认java是否安装成功。

Docker

1. 安装：

   • 方式1： brew install --cask docker
   • 方式2: 在 Docker 官方 MAC 安装文档 来安装。

2. 在终端输入 docker --version，确认docker是否安装成功。

   • 若显示 command not found，请先确认docker app是否打开

Mysql

1. 拉取镜像：docker pull mysql:5.7
2. 运行容器：docker run --name mysql -e MYSQL_ROOT_PASSWORD=pass -d -i -p 3306:3306 --restart=always mysql:5.7

Linux 环境

Git安装

1. 运行 apt-get install git 安装git。
2. 在终端输入 git --version，确认Git是否安装成功。

JDK

1. 在 JDK下载官网 下载相应的安装包。
2. 在本地执行安装文件，安装Java环境。
3. 在终端输入 java --version，确认node是否安装成功。

Docker

• 通过 Docker 官方 Ubuntu 安装文档 来安装。
• 在终端输入 docker --version，确认node是否安装成功。

Mysql

1. 拉取镜像：docker pull mysql:5.7
2. 运行容器：docker run --name mysql -e MYSQL_ROOT_PASSWORD=pass -d -i -p 3306:3306 --restart=always mysql:5.7

Windows 环境

Git安装

1. 在 Git 官网 下载用于Windows平台的 Git。
2. 在本地执行安装文件，安装Git环境。
3. 在终端输入 git --version，确认Git是否安装成功。

JDK

1. 在 JDK下载官网 下载相应的安装包。
2. 在本地执行安装文件，安装Java环境。
3. 在终端输入 java --version，确认node是否安装成功。

Docker

• 通过 Docker 官方 Windows 安装文档 来安装。
• 在终端输入 docker --version，确认node是否安装成功。

Mysql

1. 拉取镜像：docker pull mysql:5.7
2. 运行容器：docker run --name mysql -e MYSQL_ROOT_PASSWORD=pass -d -i -p 3306:3306 --restart=always mysql:5.7

使用框架

• Spring Framework

开发步骤

1. clone tws-dev-config-server 到本地，执行./gradlew bootRun启动该服务.
2. 需要手动创建该服务的数据库

• 进入mysql容器中并连接mysql：docker exec -i -t mysql /usr/bin/mysql -uroot -h 127.0.0.1 -ppass
• 创建数据库：create database 数据库名 character set utf8 collate utf8_general_ci;
• 导入初始化数据: cat ./sql/数据库名.sql | docker exec -i mysql /usr/bin/mysql -uroot -h 127.0.0.1 -ppass 数据库名

初始化数据文件：SQL文件
数据库名参考如下：

服务名称                  数据库名
activity-center：        ActivityCenter
diff-center：            DiffCenter
organization-center：    OrganizationCenter
paper-center：           PaperCenter
growth-note-app：        PractiseDiary
program-center：         ProgramCenter
quiz-center：            QuizCenter
subscription-center：    SubscriptionCenter
user-center：            UserCenter
visualization-center：   VisualizationCenter

3. 启动待开发的项目：./gradlew bootRun

注意

• 项目开发过程中各服务间是有依赖关系，开发过程中，需要同时启动有互相依赖的后端服务。

运行契约测试

目前本项目的契约测试不止用来验证契约，也用来了验证API功能。

需要先创建数据库，创建过程参考开发步骤里创建数据的过程。

数据库的名字是在产品数据库名后加Test，如下：

服务名称                  数据库名
activity-center：        ActivityCenterTest
diff-center：            DiffCenterTest
organization-center：    OrganizationCenterTest
paper-center：           PaperCenterTest
growth-note-app：        PractiseDiaryTest
program-center：         ProgramCenterTest
quiz-center：            QuizCenterTest
subscription-center：    SubscriptionCenterTest
user-center：            UserCenterTest
visualization-center：   VisualizationCenterTest

生成契约测试： ./gradlew generateContractTests

执行契约测试： ./gradlew test