wzk1015 / ReedSailing-BackEnd

后端代码

基于django开发

本地部署指南

1、mysql安装

• 安装mysql
• 运行mysql_secure_installation设置root账号密码
  • 建议暂时设置为12345678，否则 请修改backend/settings.py中的DATABASES['default']['password']为实际设置的密码
• 启动mysql：mysql.server start（每次重启电脑后需要运行）
• 运行mysql -u root -p，输入密码后create database BUAA;创建数据库

2、django配置

• 克隆本仓库
• 在仓库根目录下运行pip install -r requirements.txt
• 进入django_backend目录，运行python manage.py makemigrations
• 运行python manage.py migrate

3、运行框架

• 运行python manage.py collectstatic将静态文件复制到django_backend/static

• 运行python manage.py createcachetable建立缓存表

• 运行python manage.py runserver

  • 运行时不要在本地开vpn代理，会导致报错退出
  • 会在默认的http://127.0.0.1:8000部署服务器

• 检验运行是否成功：

  1. 打开小程序开发工具，进入”我的“——”我的账户“，输入邮箱地址点击”发送验证码“
  • 开发者工具中需要在”详情“——”本地配置“里勾选 ”不校验合法域名…“，否则request会无法访问
  • 此时后端console上显示”发送邮件成功“，邮箱里会收到验证码邮件
  • 小程序的app.js里的server指定了服务器为http://127.0.0.1:8000续部署到云端并设置域名时需要修改
  2. 打开http://127.0.0.1:8000/api/docs/，找到对应接口点击interact进行交互

※ 服务器部署

服务器基本信息

• mysql账号root，密码12345678
• alias的便捷指令
  • pi：封装了pip install -i 清华源，直接pi numpy即可安装
  • upload：封装了git add, commit, push，直接upload "hello world"即可上传
  • run：封装了进入后端目录、运行runserver的操作，直接run即可部署后端
• 已安装配置：git、python（pip、django及依赖库、pymysql）、mysql、vim（colorscheme等）、nginx、uwsgi

运行与调试

• 输入nginx启动nginx
• 在~/ReedSailing-BackEnd/django_backend下输入uwsgi uwsgi.ini启动uwsgi，配置文件为uwsgi.ini
• 在~/ReedSailing-BackEnd/django_backend下输入daphne -p 8001 backend.asgi:application启动daphne
• 修改django代码后ps -ef | grep daphne,获取daphne进程pid，kill -9 pid杀死正在运行的daphne进程。然后按照上一条重启daphne。
• 修改nginx配置文件后要输入nreload使nginx重新加载配置文件
• 修改django代码后要输入ureload
• 前端调试：在自己的电脑上（首先要保证后端已经在运行上述命令）
  • 小程序开发工具—右上角“详情”—本地设置—勾选“不校验合法域名”
  • 确认app.js中的server为http://reedsailing.xyz/api/
  • 此时尝试编译运行，点击首页登录并查看调试器，或者直接在浏览器中输入reedsailing.xyz/api/users/，可以看到返回结果；后端（即服务器python运行窗口）可以看到收到的请求

日志文件位置

nginx的访问日志：/var/log/nginx/access.log

nginx的报错日志：/var/log/nginx/error.log

uwsgi的日志：~/ReedSailing-Backend/django_backend/buaa.log

django的日志：~/ReedSailing-Backend/django_backend/logs/all.log

服务器重启后恢复服务的流程

#启动nginx
nginx
#启动uwsgi
uwsgi --ini ~/ReedSailing-Backend/django_backend/uwsgi.ini

#启动mysql
#建议在tmux中做，执行完后kill-session，不会导致mysql被关闭
#因为启动完会阻塞命令行而且按Ctrl+C不能退出
tmux new
mysqld --user=root
#按Ctrl+B,然后按X,之后输入y

#启动daphne
cd ~/ReedSailing-BackEnd/django_backend/
tmux new -s daphne
daphne -p 8001 backend.asgi:application
#按Ctrl+B，然后按D，脱离tmux会话（tmux会话会后台运行，不会被杀死）

#在tmux中启动博雅爬取脚本
tmux new -s boya
#启动博雅脚本，记得输入用户名和密码
python ~/ReedSailing-Backend/liberal_query/bykc.py
#按下Ctrl+B，然后按%（要按Shift+5）
#在新打开的空格中启动定时任务
python ~/ReedSailing-Backend/django_backend/manage.py crontab add
#跟踪输出的日志
tail -f /home/get_boya.log
#按下Ctrl+B，然后按D，脱离tmux会话

说明

以后尽可能都直接用这个服务器上的后端，首先可以避免每个人都反复pull、migrate（理想情况下后端代码只存在于服务器上），其次可以保证数据库一致便于测试

API接口

运行后端

在http://reedsailing.xyz/api/docs可以查看API接口

消息发送

定时获取access_token

由于微信小程序的消息推送需要使用access_token，而access_token两个小时过期，因此需要定期向微信服务接口发送请求获取。

定时任务需要用到django-crontab，运行和django无关，依赖的是linux的crontab定时服务，因此无法在windowns下运行。

安装：pip install django-crontab

启动定时任务 python manage.py crontab add

显示定时任务 python manage.py crontab show

删除定时任务 python manage.py crontab remove

参考资料：https://www.cnblogs.com/linqiaobao/p/14230337.html

消息队列，异步执行：celery

小程序内部消息通知

• 采用离线缓存+上线push的模式，参考消息推送的工作模式
• 采用websocket通信技术，参考https://www.cnblogs.com/huchong/p/8595644.html
• 采用nginx+daphne在服务器端部署websocket

附录

修改MySQL密码

在mysql命令行中依次输入以下内容（mysql命令对大小写不敏感）

use mysql;
ALTER USER 'root'@'localhost' IDENTIFIEED WITH mysql_native_password BY "12345678";
FLUSH privileges;
quit;

然后用新密码重新登录。