Home

Awesome

博友圈后端源码

博友圈(v2)是一个前后端分离的 Web 项目,该工程(boyouquan-api )为后端部分。前端部分请参阅 boyouquan-ui

博友圈后端为前端提供 REST API,使用 Java 语言编写,使用了 Spring Boot + MyBatis 框架,使用的数据库为 MySQL。

下面介绍一下该工程的架构以及启动和调试方式。

工程架构

该工程架构如下图所示,自上而下使用了经典的三层模式:即控制器层(Controller Layer)、服务层(Service Layer)和数据访问层(DAO Layer)。

服务架构

此外,附加的调度器层(Scheduler Layer)和帮手层(Helper Layer)则分别包含了一组定时任务和辅助工具类。

设置与启动

启动前请确保您已安装 Java(17 及以上)和 MySQL(8.0 及以上)。

数据库创建及 DDL 执行

本工程已将所有用到的 MySQL 建库与建表语句置于 sql/ddl 目录下。

首先,在您本地安装的 MySQL 上执行如下建库语句:

./sql/ddl/database.sql

然后,在建好的数据库上执行 ./sql/ddl/ 目录下除 database.sql 之外的所有 SQL 文件中的 DDL 语句。

最后,需要对 user 表执行一条插入一句,以设置管理后台的管理员账号和密码:

-- root/root
INSERT INTO `user` (`username`, `md5password`, `role`, `deleted`)
  VALUES ('root', md5('root'), 'admin', false);

编译与运行

在工程根目录使用如下 Maven 命令进行打包:

./mvnw clean package

打包完成后,使用如下命令设置环境变量,并运行:

export DATABASE_URL="jdbc:mysql://localhost:3306/boyouquan?autoReconnect=true&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&serverTimezone=GMT%2B8"
export DATABASE_USER=root # 换成你的账号
export DATABASE_PASSWORD=root # 换成你的密码
export EMAIL_ENABLE=false

java -jar ./target/boyouquan-api-2.0.jar

程序启动后,尝试使用命令行或在浏览器访问一下博客列表 API(http://localhost:8080/api/blogs),无初始数据,所以会返回一个空列表。

curl http://localhost:8080/api/blogs

{"pageNo":1,"pageSize":10,"total":0,"results":[]}

至此,后端程序启动成功,接下来可以接着启动 前端程序 ,启动成功后即可以进行整体调试与测试了。